second_step 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bad3548d109de8ab6c13a1d343a79c9e8cdef17
-  data.tar.gz: 2de7cc8cce84147b6852201b8543f1c9cd235edb
+  metadata.gz: f6b8435b1e80fe14da8d36a11a2bd309a815be66
+  data.tar.gz: 095f5144fa64a895fa2240c5ebf03007195ce4dc
 SHA512:
-  metadata.gz: 598e7816de76389ef2b2a0b1a64fc53d96b430bc06dedd5619cabc42249ddc5a9b9322e85e2e8827a85bcd5923be44f937cd95349abc5f1f4150d6f4a42c3deb
-  data.tar.gz: f959495efb8c3cbe577324da1d1a92f9dc28f650a2b9cb43962dad87c2b69365996ef448053d241674a8a8d804aa5c197baa833a8479354dcb87cb1576bf3455
+  metadata.gz: 2e93ea32224e0df172ba8c5820d4df04582fde32af1384d5305ea6c831ebda158aa4647209c3a00c6eca9bc636b881eefa1186f6c8ec6e251563cf86ecad9597
+  data.tar.gz: 07242808b457251113369052a2f23b521d83aeb71ef82d1b5736756f7681a94d9c414a017f60677ef73aa3f9cf7f35b1cb0e5a4f06104dacee8b8042b2339bc0

data/.ruby-gemset

@@ -0,0 +1 @@
+secondstep

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/Rakefile

@@ -0,0 +1,11 @@
+require "rake/clean"
+CLOBBER.include "pkg"
+
+require "bundler/gem_helper"
+Bundler::GemHelper.install_tasks name: 'second_step'
+Bundler::GemHelper.install_tasks name: 'secondstep'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'second_step/tasks'

data/docs/creating_an_adapter.md

@@ -0,0 +1,34 @@
+# Creating an ORM adapter
+
+To use SecondStep with a orm other then ActiveRecord, you'll need to create an
+orm.
+
+The orm should have a class for each model, implementing attributes and
+relations for each model. All models are stored in </lib/second_step/models> as
+an ActiveSupport::Concern. When creating a class to wrap the model, you should
+include the concern. There is a comment on each model listing what an orm
+implementation must provide. You can look at the memory and active_record
+adapters to see an example of how to implement a model.
+
+```ruby
+# ORM implementation:
+#
+# Attributes: token
+# Belongs to: application_user
+```
+
+Once you finish that, package your adapter in a module. If chosen as the orm to
+use, it will be included into `SecondStep`. Make sure not to override any
+SecondStep classes.
+
+Now, register your adapter with SecondStep. This must be done before SecondStep
+is configured.
+
+```ruby
+SecondStep.register_orm_adapter your_adapter_name: 'Name::Of::AdapterModule'
+```
+
+A user can chose to use your adapter by changing this line in their config to:
+```ruby
+orm_adapter :your_adapter_name
+```

data/docs/getting_started.md

@@ -0,0 +1,89 @@
+# Getting Started
+
+Thanks for choosing to use SecondStep. We'll get you started in just a few steps.
+
+## Rails
+
+SecondStep provides a Rails generator to make getting started a breeze.
+First, run the generator. This will create the initializer and, if using
+ActiveRecord, the migration.
+
+```bash
+$ rails generate second_step:install # Defaults to active_record
+$ rails generate second_step:install --orm=memory # Store data in memory
+$ rails generate second_step:install --orm=none # Don't do any specific orm configuration
+```
+
+After running the generator, you'll need an RSA private key. If you don't
+already have one, you'll need to create it. You can use openssl to do this. Put
+the passphrase in an environmental variable (we recommend the fabulous [dotenv]
+gem for this). You should keep the private key and passphrase hidden from
+version control. You should use a separate key for production and development.
+
+```bash
+$ openssl genrsa -des3 -out private.pem 2048
+```
+
+Next, get your api credentials from [SecondStep] and configure the gem using the
+initializer.
+
+If you're using ActiveRecord and you'd like to link your user model with the
+corresponding SecondStep::ApplicationUser, you can automatically generate the
+relationship like so:
+
+```bash
+$ rails g second_step:user_relationship # Defaults to User
+$ rails g second_step:user_relationship Admin
+```
+
+Once you finish configuring the gem, link your public key with SecondStep. Run
+the following command:
+
+```bash
+$ rake second_step:link_key
+```
+
+## Other
+
+To use SecondStep without Rails, you'll need to create the files manually.
+
+First, you'll need an RSA private key. If you don't
+already have one, you'll need to create it. You can use openssl to do this. Put
+the passphrase in an environmental variable (we recommend the fabulous [dotenv]
+gem for this). You should keep the private key and passphrase hidden from
+version control. You should use a separate key for production and development.
+
+Next, get your api credentials from [SecondStep] and configure the gem. Here is
+an [example configuration file][configuration].
+
+If you are using ActiveRecord, you'll need to add the [migration][migration]. If
+you would like to link your user model with the corresponding
+SecondStep::ApplicationUser, you can specify the relationship by adding this
+line to your model:
+
+```ruby
+has_one :second_step_application_user, class_name: 'SecondStep::ApplicationUser', foreign_key: :user_id
+```
+
+Now that you've finished configuring the gem, you'll need to add SecondStep's
+[rake] tasks. Prepend this line to your `Rakefile`:
+
+```ruby
+require 'second_step/tasks'
+```
+
+Once you finish configuring the gem, you'll need to link your public key with
+SecondStep if you created a new one. Run the following command:
+
+```bash
+$ rake second_step:link_key
+```
+
+Congrats! You've installed SecondStep. You can move onto [usage].
+
+[configuration]: /lib/generators/second_step/install/templates/initializer.rb.erb
+[migration]: /lib/generators/second_step/migration/templates/migration.rb
+[SecondStep]: https://secondstep.bensites.com
+[dotenv]: https://github.com/bkeepers/dotenv/
+[rake]: https://github.com/ruby/rake
+[usage]: /docs/usage.md

data/docs/usage.md

@@ -0,0 +1,5 @@
+# Usage
+
+You must follow the [getting started guide][getting started] to configure the gem.
+
+[getting started]: /docs/getting_started.md

data/lib/generators/second_step/install/install_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/active_record'
+
+module SecondStep
+  class InstallGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+    argument :orm, type: :string, default: 'active_record', description: <<-EOF
+The orm adapter to use for storing SecondStep data. Options are:
+
+active_record:
+  Use ActiveRecord. This generator will also generate a migration for you.
+
+memory:
+  Store data in memory. This is not recommended as a restart of your server
+  will force you to re-link all of your users.
+
+none:
+  Don't use any orm specific code. SecondStep will not work unless you create
+  your own.
+EOF
+    def create_initializer_file
+      orm = options.orm.to_sym
+      b = binding
+      erb_result = ERB.new(File.open("initializer.rb.erb")).result b
+      create_file "config/initializers/second_step.rb", erb_result
+    end
+
+    def create_migration
+      generate 'second_step:migration' if options.orm == 'activerecord'
+    end
+
+    def readme
+      readme 'README'
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/second_step/install/templates/README

@@ -0,0 +1,6 @@
+Thanks for installing SecondStep! You're a few steps away from seamless and
+secure 2 step authentication for your users.
+
+Visit the getting started documentation on GitHub:
+
+https://github.com/penne12/secondstep.rb/blob/master/docs/getting_started.md

data/lib/generators/second_step/install/templates/initializer.rb.erb

@@ -0,0 +1,137 @@
+SecondStep.config do
+  # SecondStep URI
+  #   The path to the root of SecondStep.
+  #
+  # secondstep_uri 'https://getsecondstep.com/'
+
+  # SecondStep JWT Audience
+  #   The `aud` claim for JWT
+  #
+  # secondstep_aud "SecondStep Authentication - Env: production - Host: https://getsecondstep.com - Tech Edge Advisors, LLC."
+
+  # Api Path
+  #   The path from secondstep_uri to the API root (penne12/path-builder syntax)
+  #
+  # api_path path.api(version)
+
+  # Version
+  #   The api version.
+  #
+  # version 'v1'
+
+  # Application ID (required)
+  #   The application ID provided by SecondStep. This is seperate from the OAuth
+  #   client id.
+  #
+  application_id ENV['SECONDSTEP_APPLICATION_ID']
+
+  # OAuth 2
+  #  - Redirect URI
+  #     The URI to redirect to when getting an OAuth2 authorization_code.
+  #     Use "urn:ietf:wg:oauth:2.0:oob" to show the user the code and ask them to
+  #     enter it into your app. Most applications don't use this
+  #
+  # redirect_uri "urn:ietf:wg:oauth:2.0:oob"
+
+  #  - Client Credentials (required)
+  #     Client credentials required for use of the api. It's recommended to
+  #     store then in environmental variables to prevent accidental leakage.
+  #
+  client_id ENV['SECONDSTEP_CLIENT_ID']
+  client_secret ENV['SECONDSTEP_CLIENT_SECRET']
+
+  # RSA Key (required)
+  #   An `OpenSSL::PKey::RSA` public/private RSA key pair. You should store the
+  #   key with a passphrase and hidden from version controll (with .gitignore).
+  #   You must link this with SecondStep when changed. You can use this Rake
+  #   task to do so:
+  #
+  #   $ rake second_step:link_key
+  #
+  rsa_key OpenSSL::PKey::RSA.new File.read(Rails.root.join('private.pem')), ENV['SECONDSTEP_RSA_PASSPHRASE']
+
+  # Word List (required for token phrase generator)
+  #   A path to a line seperated word list for generating token phrases.
+  #   Unix has a standard word list, normally located at /usr/share/dict/words
+  #   or /usr/dict/words. You might want to set this as an ENV variable on your
+  #   computer.
+  #
+  #   If the word list is too short, you may encounter a
+  #   SecondStep::NotEnoughEntropyForPhraseError. Either increase the phrase
+  #   generator's length, replace this file with something bigger, or add
+  #   more delimiters.
+  #
+  # word_list_path '/usr/share/dict/words'
+
+  # Phrase Length for Phrase Generator
+  #   The amount of words to generate when creating a phrase. Lowering this
+  #   expodentally lowers entropy, while raising this expodentally raises
+  #   entropy. More words will take longer to generate and will be harder to
+  #   type. This number was chosen as most humans can hold about 7±2 objects in
+  #   their working memory (Miller, http://psychclassics.yorku.ca/Miller/).
+  #
+  #   If you encounter a SecondStep::NotEnoughEntropyForPhraseError, you should
+  #   raise this value.
+  #
+  # phrase_generator_length 5
+
+  # Minimum Entropy for Phrase Generator
+  #   The minimum amount of entropy that should be required to use the phrase
+  #   generator. Raises a SecondStep::NotEnoughEntropyForPhraseError if there
+  #   are not enough words in the word list to give the generator enough entropy
+  #
+  #   Changing this to a lower value will phrases generated by the phrase
+  #   generator expodentally less secure. Changing it to a higher value may
+  #   break compatability with other operating systems.
+  #
+  #   If you encounter a SecondStep::NotEnoughEntropyForPhraseError, it's much
+  #   safer to raise `phrase_generator_length` instead of lowering this value.
+  #
+  # phrase_generator_min_entropy 92 # bits
+
+  # Phrase Delimiters
+  #   An array of characters to seperate words in phrases. Chosen randomly for
+  #   each phrase.
+  #
+  # phrase_delimiters %{., -:_+}.split ''
+
+  # QR Token length
+  #   The length of the random string to generate to use as the token when
+  #   encoded into a QR code.
+  #
+  # token_qr_length 64
+
+  # JWT Leeway
+  #   An amount (in seconds) of leeway to add when verifying claims.
+  #   Seehttps://github.com/jwt/ruby-jwt#expiration-time-claim
+  #
+  # jwt_leeway 0 # seconds
+
+  # JWT HMAC Algorithm
+  #   The JWT algorithm to use for HMAC tokens. You really shouldn't change this
+  #
+  # jwt_hmac_algorithm 'HS512'
+
+  # JWT RSA Algorithm
+  #   The JWT algorithm to use for RSA tokens. You really shouldn't change this
+  #
+  # jwt_rsa_algorithm 'RS512'
+
+  # orm (required)
+  #   The ORM to use with SecondStep. Only :none, :memory and :active_record are
+  #   supported by default.
+  #
+  #   active_record:
+  #     Store data in ActiveRecord. If you haven't created the migration to use
+  #     this adapter, create it by running:
+  #
+  #      $ rails g second_step:migration
+  #
+  #   memory:
+  #     Store data in memory. This is not recommended as a restart of your server
+  #     will force you to re-link all of your users.
+  #
+  #   none:
+  #     Don't use any orm specific code. SecondStep will not work.
+  orm_adapter <%= orm %>
+end

data/lib/generators/second_step/install/templates/secondstep.rake

@@ -0,0 +1 @@
+require 'second_step/tasks'

data/lib/generators/second_step/migration/USAGE

@@ -0,0 +1 @@
+Create a migration for using the active_record adpater with SecondStep.

data/lib/generators/second_step/migration/migration_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/active_record'
+
+module SecondStep
+  class InitializerGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+    def create_migration
+      migration_template 'migration.rb', 'db/migrate/create_secondstep_tables.rb'
+    end
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/second_step/migration/templates/migration.rb

@@ -0,0 +1,19 @@
+class CreateSecondstepTables < ActiveRecord::Migration
+  def change
+    create_table :second_step_application_users do |t|
+      t.string     :phone
+      t.string     :uuid
+      t.references :user, polymorphic: true, index: true
+      t.timestamps
+    end
+
+    add_index :second_step_application_users, [:uuid, :phone], unique: true
+
+    create_table :second_step_application_user_links do |t|
+      t.string     :secret
+      t.string     :uuid
+      t.references :second_step_application_users, index: true, forgein_key: true
+      t.timestamps
+    end
+  end
+end

data/lib/generators/second_step/user_relationship_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/active_record'
+
+module SecondStep
+  class UserRelationshipGenerator < Rails::Generators::Base
+    argument :model, type: :string, default: 'User', description: 'User Model'
+    def add_relation
+      model_file_name = options.model.underscore << '.rb'
+      model_path = Rails.root.join 'app', 'models', model_file_name
+      inject_into_class model_path, options.model, <<-RUBY
+  has_one :second_step_application_user, class_name: 'SecondStep::ApplicationUser', foreign_key: :user_id
+RUBY
+    end
+  end
+end

data/lib/second_step.rb

@@ -0,0 +1,20 @@
+require 'active_support/dependencies/autoload'
+
+require 'second_step/version'
+require 'second_step/config'
+require 'second_step/second_step_error'
+
+module SecondStep
+  extend ActiveSupport::Autoload
+
+  autoload :ActiveRecordAdapter
+  autoload :MemoryAdapter
+
+  module Models
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :ApplicationUser
+      autoload :ApplicationUserLink
+    end
+  end
+end

data/lib/second_step/active_record_adapter.rb

@@ -0,0 +1,4 @@
+require_relative 'active_record_adapter/application_user_link'
+require_relative 'active_record_adapter/application_user'
+
+module SecondStep::ActiveRecordAdapter; end

data/lib/second_step/active_record_adapter/application_user.rb

@@ -0,0 +1,12 @@
+require_relative '../models/application_user'
+
+module SecondStep::ActiveRecordAdapter
+  class ApplicationUser < ActiveRecord::Base
+    self.table_name = "second_step_application_users"
+
+    prepend Models::ApplicationUser
+
+    belongs_to :user, optional: true, polymorphic: true
+    has_one :application_user_link, forgein_key: :second_step_application_user_id, dependent: :destroy
+  end
+end