├── spec ├── spec_helper.rb ├── openid-store-couchdb_spec.rb └── openid │ └── store │ └── couchdb.rb ├── lib ├── openid-store-couchdb.rb └── openid │ └── store │ └── couchdb.rb ├── README.rdoc ├── script ├── destroy └── generate ├── Rakefile └── LICENSE /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | $TESTING=true 2 | $:.push File.join(File.dirname(__FILE__), '..', 'lib') 3 | -------------------------------------------------------------------------------- /lib/openid-store-couchdb.rb: -------------------------------------------------------------------------------- 1 | $:.unshift File.dirname(__FILE__) 2 | require 'openid/store/couchdb' 3 | -------------------------------------------------------------------------------- /spec/openid-store-couchdb_spec.rb: -------------------------------------------------------------------------------- 1 | require File.dirname(__FILE__) + '/spec_helper' 2 | 3 | describe "openid-store-couchdb" do 4 | it "should do nothing" do 5 | true.should == true 6 | end 7 | end -------------------------------------------------------------------------------- /README.rdoc: -------------------------------------------------------------------------------- 1 | == openid-store-couchdb 2 | 3 | A CouchDB association/nonce store for OpenID 4 | 5 | == CouchDB setup 6 | 7 | The CouchDB store requires 2 databases to function: associations and nonces. Both must be available at the same base URI, generally meaning on the same server, and must have the same credentials for the username/password of the OpenID consumer client. 8 | -------------------------------------------------------------------------------- /script/destroy: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) 3 | 4 | begin 5 | require 'rubigen' 6 | rescue LoadError 7 | require 'rubygems' 8 | require 'rubigen' 9 | end 10 | require 'rubigen/scripts/destroy' 11 | 12 | ARGV.shift if ['--help', '-h'].include?(ARGV[0]) 13 | RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit] 14 | RubiGen::Scripts::Destroy.new.run(ARGV) 15 | -------------------------------------------------------------------------------- /script/generate: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) 3 | 4 | begin 5 | require 'rubigen' 6 | rescue LoadError 7 | require 'rubygems' 8 | require 'rubigen' 9 | end 10 | require 'rubigen/scripts/generate' 11 | 12 | ARGV.shift if ['--help', '-h'].include?(ARGV[0]) 13 | RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit] 14 | RubiGen::Scripts::Generate.new.run(ARGV) 15 | -------------------------------------------------------------------------------- /spec/openid/store/couchdb.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Benjamin Black () 3 | # Copyright:: Copyright (c) 2009 Opscode, Inc. 4 | # License:: Apache License, Version 2.0 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | require File.dirname(__FILE__) + '../../spec_helper' 20 | 21 | describe "couchdb" do 22 | it "should do nothing" do 23 | true.should == true 24 | end 25 | end -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | require 'rake/gempackagetask' 3 | require 'rubygems/specification' 4 | require 'date' 5 | require 'spec/rake/spectask' 6 | 7 | GEM = "openid-store-couchdb" 8 | GEM_VERSION = "0.0.1" 9 | AUTHOR = "Benjamin Black" 10 | EMAIL = "bb@opscode.com" 11 | HOMEPAGE = "http://opscode.com" 12 | SUMMARY = "A CouchDB association/nonce store for OpenID" 13 | 14 | spec = Gem::Specification.new do |s| 15 | s.name = GEM 16 | s.version = GEM_VERSION 17 | s.platform = Gem::Platform::RUBY 18 | s.has_rdoc = true 19 | s.extra_rdoc_files = ["README.rdoc", "LICENSE"] 20 | s.summary = SUMMARY 21 | s.description = s.summary 22 | s.author = AUTHOR 23 | s.email = EMAIL 24 | s.homepage = HOMEPAGE 25 | 26 | ["json", 27 | "rest-client", 28 | "ruby-openid"].each { |g| s.add_dependency g} 29 | 30 | s.require_path = 'lib' 31 | s.autorequire = GEM 32 | s.files = %w(LICENSE README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*") 33 | end 34 | 35 | task :default => :spec 36 | 37 | desc "Run specs" 38 | Spec::Rake::SpecTask.new do |t| 39 | t.spec_files = FileList['spec/**/*_spec.rb'] 40 | t.spec_opts = %w(-fs --color) 41 | end 42 | 43 | 44 | Rake::GemPackageTask.new(spec) do |pkg| 45 | pkg.gem_spec = spec 46 | end 47 | 48 | desc "install the gem locally" 49 | task :install => [:package] do 50 | sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}} 51 | end 52 | 53 | desc "create a gemspec file" 54 | task :make_spec do 55 | File.open("#{GEM}.gemspec", "w") do |file| 56 | file.puts spec.to_ruby 57 | end 58 | end -------------------------------------------------------------------------------- /lib/openid/store/couchdb.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Benjamin Black () 3 | # Copyright:: Copyright (c) 2009 Opscode, Inc. 4 | # License:: Apache License, Version 2.0 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | require 'openid' 20 | require 'openid/util' 21 | require 'openid/store/interface' 22 | require 'openid/association' 23 | require 'restclient' 24 | require 'json' 25 | require 'base64' 26 | 27 | module OpenID 28 | module Store 29 | class CouchDB < Interface 30 | attr_reader :astore, :nstore, :version 31 | 32 | def initialize(base_uri, username = "", password = "") 33 | store = RestClient::Resource.new("#{base_uri}", :user => username, :password => password) 34 | @version = JSON.parse(store.get(:content_type => 'application/json'))['version'].split('-').first 35 | @astore = RestClient::Resource.new("#{base_uri}/associations", :user => username, :password => password) 36 | @nstore = RestClient::Resource.new("#{base_uri}/nonces", :user => username, :password => password) 37 | end 38 | 39 | def cleanup 40 | cleanup_associations 41 | cleanup_nonces 42 | end 43 | 44 | def cleanup_associations 45 | # BUGBUG - this doesn't work yet. 46 | if version.match(/^0\.8\./) 47 | doc = astore["_all_docs"].get(:content_type => 'application/json') 48 | rows = JSON.parse(doc)['rows'] 49 | rows.each do |row| 50 | doc = astore[row['id']].get(:content_type => 'application/json') 51 | associations = JSON.parse(doc) ; modified = false 52 | associations.delete('_id') ; associations.delete('_rev') 53 | associations.each_pair do |handle, association| 54 | unless association['issued'].to_i + association['lifetime'].to_i > Time.now.to_i 55 | associations.delete(handle) ; modified = true 56 | end 57 | store_associations(Base64.decode64(row['id']), associations) if modified 58 | end 59 | else 60 | doc = astore["_all_docs?include_docs=true"].get(:content_type => 'application/json') 61 | rows = JSON.parse(doc)['rows'] 62 | rows.each do |associations| 63 | associations = associations['doc'] ; modified = false 64 | associations.delete('_id') ; associations.delete('_rev') 65 | associations.each_pair do |handle, association| 66 | unless association['issued'].to_i + association['lifetime'].to_i > Time.now.to_i 67 | associations.delete(handle) ; modified = true 68 | end 69 | store_associations(Base64.decode64(row['id']), associations) if modified 70 | end 71 | end 72 | end 73 | 74 | def cleanup_nonces 75 | if version.match(/^0\.8\./) 76 | doc = nstore["_all_docs"].get(:content_type => 'application/json') 77 | rows = JSON.parse(doc)['rows'] 78 | rows.each do |row| 79 | doc = nstore[row['id']].get(:content_type => 'application/json') 80 | nonce = JSON.parse(doc) 81 | if (nonce['timestamp'].to_i - Time.now.to_i).abs > Nonce.skew 82 | res = nstore[row['id']].delete(:content_type => 'application/json') 83 | end 84 | end 85 | else 86 | doc = nstore["_all_docs?include_docs=true"].get(:content_type => 'application/json') 87 | rows = JSON.parse(doc)['rows'] 88 | rows.each do |row| 89 | if (row['doc']['timestamp'].to_i - Time.now.to_i).abs > Nonce.skew 90 | res = nstore[row['id']].delete(:content_type => 'application/json') 91 | end 92 | end 93 | end 94 | end 95 | 96 | def get_association(server_url, handle = nil) 97 | associations = get_associations(server_url) 98 | unless associations.nil? 99 | if handle 100 | a = associations[handle] 101 | else 102 | a = associations.values.sort{ |a, b| a['issued'].to_i <=> b['issued'].to_i }[-1] 103 | end 104 | association = Association.new( a['handle'], 105 | Base64.decode64(a['secret']), 106 | a['issued'].to_i, 107 | a['lifetime'].to_i, 108 | a['assoc_type'] ) 109 | return association unless association.expires_in == 0 110 | end 111 | nil 112 | end 113 | 114 | def remove_association(server_url, handle) 115 | associations = get_associations(server_url) 116 | unless associations.nil? 117 | if associations.has_key?(handle) && associations.delete(handle) 118 | store_associations(server_url, associations) 119 | return true 120 | end 121 | end 122 | false 123 | end 124 | 125 | def store_association(server_url, association) 126 | associations = get_associations(server_url) 127 | associations ||= {} 128 | associations.merge!({ association.handle => { 129 | :handle => association.handle, 130 | :secret => Base64.encode64(association.secret), 131 | :issued => association.issued.to_i, 132 | :lifetime => association.lifetime.to_i, 133 | :assoc_type => association.assoc_type 134 | } 135 | } 136 | ) 137 | store_associations(server_url, associations) 138 | end 139 | 140 | def use_nonce(server_url, timestamp, salt) 141 | return false if (timestamp - Time.now.to_i).abs > Nonce.skew 142 | 143 | # this little block is from OpenID::Store::Filesystem. i don't like it. 144 | if server_url and !server_url.empty? 145 | proto, rest = server_url.split('://', 2) 146 | else 147 | proto, rest = '','' 148 | end 149 | raise "Bad server URL" unless proto && rest 150 | 151 | nonce = '%08x-%s-%s'%[timestamp, Base64.encode64(server_url).chomp, Base64.encode64(salt.to_s).chomp] 152 | 153 | begin 154 | res = nstore[nonce].get(:content_type => 'application/json') 155 | return false 156 | rescue RestClient::ResourceNotFound => e 157 | res = nstore[nonce].put({ :server_url => server_url, 158 | :timestamp => timestamp, 159 | :salt => salt 160 | }.to_json, :content_type => 'application/json') 161 | return true 162 | end 163 | end 164 | 165 | protected 166 | 167 | def get_associations(server_url) 168 | begin 169 | doc = astore[Base64.encode64(server_url)].get(:content_type => 'application/json') 170 | return JSON.parse(doc) 171 | rescue 172 | nil 173 | end 174 | end 175 | 176 | def store_associations(server_url, associations) 177 | associations['_rev'] = generate_doc_version if associations['_rev'] 178 | 179 | begin 180 | astore[Base64.encode64(server_url)].put(associations.to_json, 181 | :content_type => 'application/json') 182 | rescue 183 | # BUGBUG - figure out what a version conflict looks like and recover from it 184 | nil 185 | end 186 | end 187 | 188 | def generate_doc_version 189 | t = Time.now 190 | (t.tv_sec * 1000000 + t.tv_usec).to_s(16) 191 | end 192 | 193 | end 194 | end 195 | end -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [2009] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------