fernet 2.0.rc2 → 2.0

data/README.md

@@ -1,7 +1,7 @@
 # Fernet
 
-[![Build Status](https://secure.travis-ci.org/hgmnz/fernet.png)](http://travis-ci.org/hgmnz/fernet)
-[![Code Climate](https://codeclimate.com/github/hgmnz/fernet.png)](https://codeclimate.com/github/hgmnz/fernet)
+[![Build Status](https://secure.travis-ci.org/fernet/fernet-rb.png)](http://travis-ci.org/fernet/fernet-rb)
+[![Code Climate](https://codeclimate.com/github/fernet/fernet-rb.png)](https://codeclimate.com/github/fernet/fernet-rb)
 
 Fernet allows you to easily generate and verify **HMAC based authentication
 tokens** for issuing API requests between remote servers. It also **encrypts**

data/lib/fernet.rb

@@ -15,12 +15,12 @@ module Fernet
   # secret  - a base64 encoded, 32 byte string
   # message - the message being secured in plain text
   #
-  # Returns the fernet token as a string
-  #
   # Examples
   #
   #   secret = ...
   #   token = Fernet.generate(secret, 'my secrets')
+  #
+  # Returns the fernet token as a string
   def self.generate(secret, message = '', opts = {})
     Generator.new(opts.merge({secret: secret, message: message})).
       generate
@@ -30,36 +30,39 @@ module Fernet
   #
   # secret - the secret used to generate the token
   # token  - the token to verify as a string
-  # opts - an optional hash containing
-  #   enforce_ttl: whether to enforce TTL in this verification
-  #   ttl: number of seconds token is valid
+  # opts   - an optional hash containing
+  # * enforce_ttl - whether to enforce TTL in this verification
+  # * ttl         - number of seconds token is valid
   #
   # Both enforce_ttl and ttl can be configured globally via Configuration
   #
-  # Returns a verifier object, which responds to valid? and message
-  #
   # Raises Fernet::Token::InvalidToken if token is invalid and message
   #   is attempted to be extracted
   #
   # Examples
   #
-  # secret = ...
-  # token = ...
-  # verifier = Fernet.verifier(secret, old_token, enforce_ttl: false)
-  # if verifier.valid?
-  #   verifier.message # original message in plain text
-  # end
+  #   secret = ...
+  #   token = ...
+  #   verifier = Fernet.verifier(secret, old_token, enforce_ttl: false)
+  #   if verifier.valid?
+  #     verifier.message # original message in plain text
+  #   end
+  #
+  #   verifier = Fernet.verifier(secret, old_token)
+  #   if verifier.valid?
+  #     verifier.message
+  #   else
+  #     verifier.errors
+  #     # => { issued_timestamp: "is too far in the past: token expired" }
+  #     verifier.error_messages
+  #     # => ["issued_timestamp is too far in the past: token expired"]
+  #   end
   #
-  # verifier = Fernet.verifier(secret, old_token)
-  # if verifier.valid?
+  #   verifier = Fernet.verifier(secret, old_token)
   #   verifier.message
-  # else
-  #   verifier.errors
-  #   # -> { issued_timestamp: "is too far in the past: token expired" }
-  #   verifier.error_messages
-  #   # -> ["issued_timestamp is too far in the past: token expired"]
-  # end
+  #   # => raises Fernet::Token::InvalidToken if token too old or invalid
   #
+  # Returns a verifier object, which responds to `#valid?` and `#message`
   def self.verifier(secret, token, opts = {})
     Verifier.new(opts.merge({secret: secret, token: token}))
   end

data/lib/fernet/configuration.rb

@@ -1,7 +1,7 @@
 require 'singleton'
 module Fernet
-  # Public - singleton class used to globally set various
-  #          configuration defaults
+  # Public: singleton class used to globally set various
+  # configuration defaults
   class Configuration
     include Singleton
 
@@ -24,9 +24,9 @@ module Fernet
     #
     # Examples
     #
-    # Fernet::Configuration.run do |config|
-    #   config.enforce_ttl = false
-    # end
+    #   Fernet::Configuration.run do |config|
+    #     config.enforce_ttl = false
+    #   end
     def self.run
       self.instance.enforce_ttl = true
       self.instance.ttl         = 60

data/lib/fernet/encryption.rb

@@ -9,17 +9,17 @@ module Fernet
     #   random IV and the provided encryption key
     #
     # opts - a hash containing
-    #   message: the message to encrypt
-    #   key: the encryption key
-    #   iv: override for the random IV, only used for testing
-    #
-    # Returns a two-element array containing the ciphertext and the random IV
+    # * message - the message to encrypt
+    # * key     - the encryption key
+    # * iv      - override for the random IV, only used for testing
     #
     # Examples
     #
-    # ciphertext, iv = Fernet::Encryption.encrypt(
-    #   message: 'this is a secret', key: encryption_key
-    # )
+    #   ciphertext, iv = Fernet::Encryption.encrypt(
+    #     message: 'this is a secret', key: encryption_key
+    #   )
+    #
+    # Returns a two-element array containing the ciphertext and the random IV
     def self.encrypt(opts)
       cipher = OpenSSL::Cipher.new('AES-128-CBC')
       cipher.encrypt
@@ -33,17 +33,17 @@ module Fernet
     #   the provided IV and encryption key
     #
     # opts - a hash containing
-    #   ciphertext: encrypted message
-    #   key: encryption key used to encrypt the message
-    #   iv: initialization vector used in the ciphertext's cipher
-    #
-    # Returns a two-element array containing the ciphertext and the random IV
+    # * ciphertext - encrypted message
+    # * key        - encryption key used to encrypt the message
+    # * iv         - initialization vector used in the ciphertext's cipher
     #
     # Examples
     #
-    # ciphertext, iv = Fernet::Encryption.encrypt(
-    #   message: 'this is a secret', key: encryption_key
-    # )
+    #   ciphertext, iv = Fernet::Encryption.encrypt(
+    #     message: 'this is a secret', key: encryption_key
+    #   )
+    #
+    # Returns a two-element array containing the ciphertext and the random IV
     def self.decrypt(opts)
       decipher = OpenSSL::Cipher.new('AES-128-CBC')
       decipher.decrypt
@@ -55,7 +55,7 @@ module Fernet
     # Internal: Creates an HMAC signature (sha356 hashing) of the given bytes
     #   with the provided signing key
     #
-    # key - the signing key
+    # key   - the signing key
     # bytes - blob of bytes to sign
     #
     # Returns the HMAC signature as a string

data/lib/fernet/generator.rb

@@ -6,14 +6,14 @@ require 'date'
 module Fernet
   # Internal: Generates Fernet tokens
   class Generator
-    # Returns the token's message
+    # Internal: Returns the token's message
     attr_accessor :message
 
     # Internal: Initializes a generator
     #
     # opts - a hash containing the following keys:
-    #   secret: a string containing a secret, optionally Base64 encoded
-    #   message: the message
+    # * secret  - a string containing a secret, optionally Base64 encoded
+    # * message - the message
     def initialize(opts)
       @secret  = opts.fetch(:secret)
       @message = opts[:message]
@@ -25,17 +25,18 @@ module Fernet
     #
     # Yields itself, useful for setting or overriding the message
     #
-    # Returns the token as a string
-    #
     # Examples
-    # generator = Generator.new(secret: some_secret)
-    # token = generator.generate do |g|
-    #   g.message = 'this is my message'
-    # end
     #
-    # generator = Generator.new(secret: some_secret,
-    #                           message: 'this is my message')
-    # token = generator.generate
+    #   generator = Generator.new(secret: some_secret)
+    #   token = generator.generate do |g|
+    #     g.message = 'this is my message'
+    #   end
+    #
+    #   generator = Generator.new(secret: some_secret,
+    #                             message: 'this is my message')
+    #   token = generator.generate
+    #
+    # Returns the token as a string
     def generate
       yield self if block_given?
 

data/lib/fernet/token.rb

@@ -18,10 +18,11 @@ module Fernet
     #
     # token - the string representation of this token
     # opts  - a has containing
-    #   secret: the secret, optionally base 64 encoded (required)
-    #   enforce_ttl: whether to enforce TTL upon validation. Defaults to value
-    #                set in Configuration.enforce_ttl
-    #   ttl: number of seconds token is valid, defaults to Configuration.ttl
+    # * secret       - the secret, optionally base 64 encoded (required)
+    # * enforce_ttl  - whether to enforce TTL upon validation. Defaults to
+    #                  value set in Configuration.enforce_ttl
+    # * ttl          - number of seconds token is valid, defaults to
+    #                  Configuration.ttl
     def initialize(token, opts = {})
       @token       = token
       @secret      = Secret.new(opts.fetch(:secret))
@@ -65,16 +66,18 @@ module Fernet
     # Internal: generates a Fernet Token
     #
     # opts - a hash containing
-    #   secret: a string containing the secret, optionally base64 encoded
-    #   message: the message in plain text
+    # * secret  - a string containing the secret, optionally base64 encoded
+    # * message - the message in plain text
     def self.generate(opts)
       unless opts[:secret]
         raise ArgumentError, 'Secret not provided'
       end
       secret = Secret.new(opts.fetch(:secret))
-      encrypted_message, iv = Encryption.encrypt(key:     secret.encryption_key,
-                                                 message: opts[:message],
-                                                 iv:      opts[:iv])
+      encrypted_message, iv = Encryption.encrypt(
+        key:     secret.encryption_key,
+        message: opts[:message],
+        iv:      opts[:iv]
+      )
       issued_timestamp = (opts[:now] || Time.now).to_i
 
       payload = [DEFAULT_VERSION].pack("C") +

data/lib/fernet/verifier.rb

@@ -14,10 +14,10 @@ module Fernet
     # Internal: initializes a Verifier
     #
     # opts - a hash containing
-    #   secret: the secret used to create the token (required)
-    #   token: the fernet token string (required)
-    #   enforce_ttl: whether to enforce TTL, defaults to Configuration.enforce_ttl
-    #   ttl: number of seconds the token is valid
+    # * secret      - the secret used to create the token (required)
+    # * token       - the fernet token string (required)
+    # * enforce_ttl - whether to enforce TTL, defaults to Configuration.enforce_ttl
+    # * ttl         - number of seconds the token is valid
     def initialize(opts = {})
       enforce_ttl = opts.has_key?(:enforce_ttl) ? opts[:enforce_ttl] : Configuration.enforce_ttl
       @token = Token.new(opts.fetch(:token),
@@ -46,7 +46,8 @@ module Fernet
       message
     end
 
-    # Public: String representation of this verifier, masks the secret to avoid leaks.
+    # Public: String representation of this verifier, masks the secret to avoid
+    #   leaks
     def inspect
       "#<Fernet::Verifier @secret=[masked] @token=#{@token} @message=#{@message.inspect} @ttl=#{@ttl} @enforce_ttl=#{@enforce_ttl}>"
     end

data/lib/fernet/version.rb

@@ -1,3 +1,3 @@
 module Fernet
-  VERSION = "2.0.rc2"
+  VERSION = "2.0"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fernet
 version: !ruby/object:Gem::Version
-  version: 2.0.rc2
-  prerelease: 4
+  version: '2.0'
+  prerelease: 
 platform: ruby
 authors:
 - Harold Giménez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: valcro
@@ -91,9 +91,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23