seraph 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c38bec486a10c2137abb51d2960a95863594eb71
-  data.tar.gz: ea8f366ee742c81b9bf61f0b90a2da7e0b60389a
+  metadata.gz: 9062ea4972e3a44b97a05b4935c8f5936b05fe24
+  data.tar.gz: a0117bd6c8d5b547b1ff0f2dcb018fa6e06946c4
 SHA512:
-  metadata.gz: 1e5d554f25769f57f42cc5d9e916ae00cb2f85cc15b229884f25e3a57d41f7c9c485efdb24682c8671ff78abb14b20367f8bdac9686ca1adc6a5db34d90fa709
-  data.tar.gz: 82c075c768a468fe62b7714e13ec9ca5714884aee418b064fb8676a4f766eec5e0df5fd018a5946ea108c67e6d90862aa701800d5d2786b465a2a2e57f1e01c3
+  metadata.gz: 0e5b596ae436664b9b9f38cc1d51e86e2be6e1fefdb63e51268daf8bc46fc7d13f9c1667930fd4dfc072d086045fec12cadc63a4f315b9a524c90f0015e9fde1
+  data.tar.gz: 2b619e40492e7663987ba48d6684b5382ff38c4f02961a57d30bf525359880e1197fcf9a35401e11ced508ff0e25f55420290fc724d680cae51282b09377d453

data/README.md

@@ -11,50 +11,61 @@ Enter in your terminal
 gem install seraph
 ```
 or put
-```
+``` ruby
 gem 'seraph'
 ```
 inside your `Gemfile`
 
-### What do you get?
-
-seraph offers two basic functionalities:
+## Configuration
 
-* encrypting the password (registration)
-* checking if provided password matches the encrypted password (authentication)
+You can set the pepper that will be used when encrypting the password.
 
-#### Encrypting the password
-
-seraph uses [BCrypt](https://github.com/codahale/bcrypt-ruby) to hash the password. Additionally a pepper can be provided:
+Pepper strenghtens the security of your encrypted passwords, because 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 before encryption. This is ofcourse true only if the attacker doesn't have access to your application code!
 
 To get a random, high-entropy pepper, you can use `/dev/urandom`:
 
 ```
-⇒ xxd -l 32 -p /dev/urandom
-435a501746f35834862e49fd6654680803bc37a2a83bc67318342603b7176aaa
+xxd -l 32 -p /dev/urandom
 ```
 
-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!
+Then use in the configuration block
+
+``` ruby
+Seraph.configure do |config|
+  config.pepper = 'GENERATED-PEPPER'
+end
+```
+
+But remember to save the pepper, because if you lose it, none of your users will be able to login!
+
+## 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. If you configure Seraph and set the pepper, it will be used in the encryption process.
 
-So with that out of the way, to encrypt a password, run the following code:
+To encrypt a password simply run:
 
 ``` ruby
-PEPPER = '435a501746f35834862e49fd6654680803bc37a2a83bc67318342603b7176aaa'
-seraph::PasswordEncryptor.call('foobar12')
-# => "$2a$10$MvzzJOcgCbxmVAUqwq7Zye.3Hn9L0ahB4M8riQTK6cPUfJCR6x3ZW"
+Seraph::PasswordEncryptor.call('foobar12')
+# => "$2a$10$f1PWs.Qi3mtcL/fMaypEJu9HI0SchWLhsMd9kRhHEjP4v/3oqnB5G"
 ```
 
-As a result you get the encrypted password, which you can persist in the database alongside other user data (e-mail, login, etc.)
+As a result you get the encrypted password, which you can be persisted in the database, alongside other user data (e-mail, login, etc.)
 
-#### Comparing a provided password with the encrypted one
+### WIP - 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)
+Seraph::Authenticator.call(encrypted_password, plaintext_password)
 # => true or false
 ```
 

data/lib/seraph/configuration.rb

@@ -5,5 +5,9 @@ module Seraph
     include ::Singleton
 
     attr_accessor :pepper
+
+    def reset
+      self.pepper = nil
+    end
   end
 end

data/lib/seraph/version.rb

@@ -1,3 +1,3 @@
 module Seraph
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/spec/spec_helper.rb

@@ -10,6 +10,10 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
+  config.before(:each) do
+    Seraph.configuration.reset
+  end
+
   config.order = :random
   Kernel.srand config.seed
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seraph
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Szymon Szeliga