multi_factor_auth 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 88c4f71cb48564cb65693d855c357fb3eaa37cd4
4
+ data.tar.gz: 5a26bdfdb9b91c03587b0d86d2c7e02255da6f59
5
+ SHA512:
6
+ metadata.gz: b600ca7c937d81d5d3f7788c7b61d152fec31592ef2c15314efc6598d6d2506b7711ce048ef848e68436e3a86822d0854a4507203f784e660d478862eb94cd48
7
+ data.tar.gz: 16a031077b38d1095ec12d46ebe1e75c7684fbef554f0b8ebdfb304a10d6e0c5b02c38202d3becf37d180742cde918f5ec96e767efa9e68ee653c5bf61327eba
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at dean.wang@tbwa.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in multi_factor_auth.gemspec
4
+ gemspec
@@ -0,0 +1,40 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ multi_factor_auth (0.1.0)
5
+ base32 (~> 0.3.2)
6
+ rotp (~> 3.1.0)
7
+ rqrcode (~> 0.10.1)
8
+
9
+ GEM
10
+ remote: https://rubygems.org/
11
+ specs:
12
+ awesome_print (1.7.0)
13
+ base32 (0.3.2)
14
+ chunky_png (1.3.6)
15
+ coderay (1.1.1)
16
+ method_source (0.8.2)
17
+ minitest (5.9.0)
18
+ pry (0.10.4)
19
+ coderay (~> 1.1.0)
20
+ method_source (~> 0.8.1)
21
+ slop (~> 3.4)
22
+ rake (10.5.0)
23
+ rotp (3.1.0)
24
+ rqrcode (0.10.1)
25
+ chunky_png (~> 1.0)
26
+ slop (3.6.0)
27
+
28
+ PLATFORMS
29
+ ruby
30
+
31
+ DEPENDENCIES
32
+ awesome_print
33
+ bundler (~> 1.12)
34
+ minitest (~> 5.0)
35
+ multi_factor_auth!
36
+ pry
37
+ rake (~> 10.0)
38
+
39
+ BUNDLED WITH
40
+ 1.12.5
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Dean Wang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,80 @@
1
+ # MultiFactorAuth
2
+
3
+ A ruby library for generating one time passwords and QR Codes.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'multi_factor_auth'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install multi_factor_auth
20
+
21
+ ## Usage
22
+
23
+ ### Time based OTP's
24
+
25
+ ```ruby
26
+ totp = MultiFactorAuth::TOTP.new("base32secret3232", issuer: "My Service")
27
+ totp.now # => "492039"
28
+
29
+ # OTP verified for current time
30
+ totp.verify("492039") # => true
31
+ sleep 30
32
+ totp.verify("492039") # => false
33
+ totp.provisioning_uri("alice@google.com")
34
+ ```
35
+
36
+ ### Counter based OTP's
37
+
38
+ ```ruby
39
+ hotp = MultiFactorAuth::HOTP.new("base32secretkey3232")
40
+ hotp.at(0) # => "260182"
41
+ hotp.at(1) # => "055283"
42
+ hotp.at(1401) # => "316439"
43
+
44
+ # OTP verified with a counter
45
+ hotp.verify("316439", 1401) # => true
46
+ hotp.verify("316439", 1402) # => false
47
+ ```
48
+
49
+ ### Generating a Base32 Secret key
50
+
51
+ ```ruby
52
+ MultiFactorAuth::Base32.random_base32 # returns a 16 character base32 secret. Compatible with Google Authenticator
53
+ ```
54
+
55
+ ### Generating a QR Code
56
+
57
+ ```ruby
58
+ totp = MultiFactorAuth::TOTP.new("base32secretkey3232")
59
+ qrcode = totp.qr_code("alice@google.com")
60
+ image = qrcode.as_png
61
+ svg = qrcode.as_svg
62
+ html = qrcode.as_html
63
+ string = qrcode.as_ansi
64
+ string = qrcode.to_s
65
+ ```
66
+ ## Resources
67
+
68
+ * [QR Codes](https://github.com/whomwah/rqrcode)
69
+ * [Base32 Library](https://github.com/stesla/base32)
70
+ * [The Ruby One Time Password Library](https://github.com/mdp/rotp)
71
+
72
+ ## Contributing
73
+
74
+ * Fork the project
75
+ * Send a pull request
76
+
77
+ ## License
78
+
79
+ Open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
80
+
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "multi_factor_auth"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+ require "multi_factor_auth/version"
3
+ require "multi_factor_auth/totp"
4
+ require "multi_factor_auth/hotp"
5
+
6
+ module MultiFactorAuth
7
+
8
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ require 'forwardable'
3
+ require "multi_factor_auth/methods"
4
+
5
+ module MultiFactorAuth
6
+
7
+ class HOTP
8
+ extend Methods
9
+ extend Forwardable
10
+
11
+ delegate [:at, :verify, :verify_with_retries, :provisioning_uri] => :@instance
12
+
13
+ def initialize base32, options = {}
14
+ @instance = ROTP::HOTP.new base32, options
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+ require 'rotp'
3
+ require 'rqrcode'
4
+ require 'base32'
5
+ require 'securerandom'
6
+
7
+ module MultiFactorAuth
8
+
9
+ module Methods
10
+
11
+ def self.extended base
12
+ base.class_eval do
13
+ def qr_code email, opts = {}
14
+ self.singleton_class.generate_qr_code provisioning_uri(email), opts
15
+ end
16
+ end
17
+ end
18
+
19
+ def generate_secret str_or_arr = nil
20
+ case str_or_arr
21
+ when Array
22
+ Base32.encode Digest::MD5.hexdigest("#{str_or_arr.join(SecureRandom.uuid)}")
23
+ when String
24
+ Base32.encode Digest::MD5.hexdigest(str_or_arr)
25
+ else
26
+ random_base32
27
+ end
28
+ end
29
+
30
+ def random_base32
31
+ ROTP::Base32.random_base32
32
+ end
33
+
34
+ def generate_qr_code link, opts = {}
35
+ RQRCode::QRCode.new(link, {level: :h}.merge(opts))
36
+ end
37
+
38
+ end
39
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ require 'forwardable'
3
+ require "multi_factor_auth/methods"
4
+
5
+ module MultiFactorAuth
6
+
7
+ class TOTP
8
+ extend Methods
9
+ extend Forwardable
10
+
11
+ delegate [:at, :now, :verify ,:verify_with_drift, :provisioning_uri] => :@instance
12
+
13
+ def initialize base32, options = {}
14
+ @instance = ROTP::TOTP.new base32, options
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MultiFactorAuth
4
+ VERSION = "0.1.0"
5
+ end
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'multi_factor_auth/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "multi_factor_auth"
8
+ spec.version = MultiFactorAuth::VERSION
9
+ spec.authors = ["cfanbase"]
10
+ spec.email = ["cfanbase@gmail.com"]
11
+
12
+ spec.summary = "Two-factor authentication"
13
+ spec.description = "A ruby library for generating one time passwords and QR Codes"
14
+ spec.homepage = "https://github.com/cfanbase/multi_factor_auth"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency "base32", "~> 0.3.2"
23
+ spec.add_dependency "rotp", "~> 3.1.0"
24
+ spec.add_dependency "rqrcode", "~> 0.10.1"
25
+ spec.add_development_dependency "bundler", "~> 1.12"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "minitest", "~> 5.0"
28
+ spec.add_development_dependency "awesome_print"
29
+ spec.add_development_dependency "pry"
30
+ end
metadata ADDED
@@ -0,0 +1,170 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: multi_factor_auth
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - cfanbase
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-07-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: base32
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.3.2
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.3.2
27
+ - !ruby/object:Gem::Dependency
28
+ name: rotp
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 3.1.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 3.1.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: rqrcode
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.10.1
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.10.1
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.12'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.12'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '10.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '10.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: minitest
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '5.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '5.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: awesome_print
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: pry
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: A ruby library for generating one time passwords and QR Codes
126
+ email:
127
+ - cfanbase@gmail.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - CODE_OF_CONDUCT.md
133
+ - Gemfile
134
+ - Gemfile.lock
135
+ - LICENSE.txt
136
+ - README.md
137
+ - Rakefile
138
+ - bin/console
139
+ - bin/setup
140
+ - lib/multi_factor_auth.rb
141
+ - lib/multi_factor_auth/hotp.rb
142
+ - lib/multi_factor_auth/methods.rb
143
+ - lib/multi_factor_auth/totp.rb
144
+ - lib/multi_factor_auth/version.rb
145
+ - multi_factor_auth.gemspec
146
+ homepage: https://github.com/cfanbase/multi_factor_auth
147
+ licenses:
148
+ - MIT
149
+ metadata: {}
150
+ post_install_message:
151
+ rdoc_options: []
152
+ require_paths:
153
+ - lib
154
+ required_ruby_version: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - ">="
157
+ - !ruby/object:Gem::Version
158
+ version: '0'
159
+ required_rubygems_version: !ruby/object:Gem::Requirement
160
+ requirements:
161
+ - - ">="
162
+ - !ruby/object:Gem::Version
163
+ version: '0'
164
+ requirements: []
165
+ rubyforge_project:
166
+ rubygems_version: 2.4.5.1
167
+ signing_key:
168
+ specification_version: 4
169
+ summary: Two-factor authentication
170
+ test_files: []