seraph 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87a649e9b8023837802c9437c543efaa7f469015
+  data.tar.gz: d45906cdf355f54da00e42b219c1f9757c560819
+SHA512:
+  metadata.gz: 3194065256e655a84637ea53b122184ad8777f6909bf850ccc44ab6deba25aa471aa582706b70a473897be039ae880d18360393443626582aff4876ddf682323
+  data.tar.gz: b4b5eb110e7a57a951e575288791aba5014194eb085e275a1543c4786fa4fc092ac8e0a04e02a13247b96bc4a9b30d1c3187313ba4bdab7ac8a1842e23259ab0

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/Gemfile.lock
+/html/
+/pkg/
+/vendor/cache/*.gem

data/.pryrc

@@ -0,0 +1 @@
+require 'seraph'

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format Fuubar

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  Exclude:
+    - 'script/**/*'
+    - 'Guardfile'
+    - 'Rakefile'
+    - 'seraph.gemspec'
+Documentation:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 150
+Metrics/LineLength:
+  Enabled: true
+  Max: 100
+Rails/ActionFilter:
+  Enabled: false
+SignalException:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+  Enabled: true
+TrailingCommaInArguments:
+  Enabled: false
+Style/DotPosition:
+  EnforcedStyle: leading
+  Enabled: true

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.3.1

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2016-06-14
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Szymon Szeliga
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# seraph
+[![Build Status](https://secure.travis-ci.org//seraph.svg?branch=master)](https://travis-ci.org//seraph)
+
+* [Homepage](https://rubygems.org/gems/seraph)
+* [Documentation](http://rubydoc.info/gems/seraph/frames)
+* [Email](mailto:szymon.szeliga at netguru.co)
+
+## Installation
+
+Type
+```
+gem install seraph
+```
+or put
+```
+gem 'seraph'
+```
+inside your Gemfile
+
+## Description
+
+A simple framework-agnostic library for authentication. seraph provides an API for implementing User authentication inside your app. It doesn't make any assumptions about your setup, so you do not have to have a `User` class that inherits from `ActiveRecord::Base`.
+
+### What do you get?
+
+seraph offers two basic functionalities:
+
+* encrypting the password (registration)
+* checking if provided password matches the encrypted password (authentication)
+
+#### Encrypting the password
+
+seraph uses [BCrypt](https://github.com/codahale/bcrypt-ruby) to hash the password. Additionally a pepper can be provided:
+
+To get a random, high-entropy pepper, you can use `/dev/urandom`:
+
+```
+⇒ xxd -l 32 -p /dev/urandom
+435a501746f35834862e49fd6654680803bc37a2a83bc67318342603b7176aaa
+```
+
+Save this value as a constant in you application code, so even if you have an SQL Injection vulnerability in your code, the attacker won't be able to get the passwords, because the pepper will be added to each password without encryption. This is of course true only if the attacker doesn't have access to your application code!
+
+So with that out of the way, to encrypt a password, run the following code:
+
+``` ruby
+PEPPER = '435a501746f35834862e49fd6654680803bc37a2a83bc67318342603b7176aaa'
+seraph::PasswordEncryptor.call('foobar12')
+# => "$2a$10$MvzzJOcgCbxmVAUqwq7Zye.3Hn9L0ahB4M8riQTK6cPUfJCR6x3ZW"
+```
+
+As a result you get the encrypted password, which you can persist in the database alongside other user data (e-mail, login, etc.)
+
+#### Comparing a provided password with the encrypted one
+
+Comparison is done using a constant-time secure comparison method, from the gem (fast_secure_compare)[https://github.com/daxtens/fast_secure_compare]
+
+To do it simply run:
+
+``` ruby
+PEPPER = '435a501746f35834862e49fd6654680803bc37a2a83bc67318342603b7176aaa'
+seraph::Authenticator.call(encrypted_password, plaintext_password)
+# => true or false
+```
+
+## Copyright
+
+Copyright (c) 2016 Szymon Szeliga
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/lib/seraph/extensions/nil_class_blank.rb

@@ -0,0 +1,11 @@
+module Seraph
+  module Extensions
+    module NilClassBlank
+      refine NilClass do
+        def blank?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/seraph/password_encryptor.rb

@@ -0,0 +1,14 @@
+require 'bcrypt'
+require 'fast_blank'
+require 'seraph/extensions/nil_class_blank'
+
+module Seraph
+  class PasswordEncryptor
+    using Extensions::NilClassBlank
+
+    def self.call(password)
+      return false if String(password).blank?
+      BCrypt::Password.create(password)
+    end
+  end
+end

data/lib/seraph/version.rb

@@ -0,0 +1,3 @@
+module Seraph
+  VERSION = '0.0.1'.freeze
+end

data/lib/seraph.rb

@@ -0,0 +1,2 @@
+require 'seraph/version'
+require 'seraph/password_encryptor'

data/seraph.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seraph/version'
+require 'English'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'seraph'
+  gem.version       = Seraph::VERSION
+  gem.summary       = 'A simple framework-agnostic library for authentication'
+  gem.description   = "Looking for an authentication gem that doesn't make any assumptions about your setup? You've came to the right place."
+  gem.license       = 'MIT'
+  gem.authors       = ['Szymon Szeliga']
+  gem.email         = 'szeliga.szymon@gmail.com'
+  gem.homepage      = 'https://rubygems.org/gems/seraph'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+
+  `git submodule --quiet foreach --recursive pwd`.split($INPUT_RECORD_SEPARATOR).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/", '')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($INPUT_RECORD_SEPARATOR).map do |subpath|
+        gem.files << File.join(submodule, subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'bcrypt', '~> 3.1'
+  gem.add_dependency 'fast_secure_compare', '~> 1.0'
+  gem.add_dependency 'fast_blank', '~> 1.0'
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'fuubar'
+  gem.add_development_dependency 'pry'
+end

data/spec/password_encryptor_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'seraph/password_encryptor'
+
+RSpec.describe Seraph::PasswordEncryptor do
+  describe '.call' do
+    let(:password) { 'foobar12' }
+    subject { described_class.call(password) }
+
+    it 'encrypts the password using BCrypt' do
+      encrypted = subject
+      expect(encrypted.to_s).to eq BCrypt::Engine.hash_secret(password, encrypted.salt)
+    end
+  end
+end

data/spec/serafin_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'seraph'
+
+describe Seraph do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'seraph/version'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: seraph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Szymon Szeliga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: fast_secure_compare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fast_blank
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Looking for an authentication gem that doesn't make any assumptions about
+  your setup? You've came to the right place.
+email: szeliga.szymon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/seraph.rb
+- lib/seraph/extensions/nil_class_blank.rb
+- lib/seraph/password_encryptor.rb
+- lib/seraph/version.rb
+- seraph.gemspec
+- spec/password_encryptor_spec.rb
+- spec/serafin_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/seraph
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple framework-agnostic library for authentication
+test_files:
+- spec/password_encryptor_spec.rb
+- spec/serafin_spec.rb
+- spec/spec_helper.rb