jwt.rb in jwt-1.5.2

- old
+ new

@@ -5,11 +5,11 @@
 require 'jwt/json'
 
 # JSON Web Token implementation
 #
 # Should be up to date with the latest spec:
-# http://self-issued.info/docs/draft-jones-json-web-token-06.html
+# https://tools.ietf.org/html/rfc7519#section-4.1.5
 module JWT
   class DecodeError < StandardError; end
   class VerificationError < DecodeError; end
   class ExpiredSignature < DecodeError; end
   class IncorrectAlgorithm < DecodeError; end
@@ -28,29 +28,29 @@
   }
 
   module_function
 
   def sign(algorithm, msg, key)
-    if ['HS256', 'HS384', 'HS512'].include?(algorithm)
+    if %w(HS256 HS384 HS512).include?(algorithm)
       sign_hmac(algorithm, msg, key)
-    elsif ['RS256', 'RS384', 'RS512'].include?(algorithm)
+    elsif %w(RS256 RS384 RS512).include?(algorithm)
       sign_rsa(algorithm, msg, key)
-    elsif ['ES256', 'ES384', 'ES512'].include?(algorithm)
+    elsif %w(ES256 ES384 ES512).include?(algorithm)
       sign_ecdsa(algorithm, msg, key)
     else
-      fail NotImplementedError.new('Unsupported signing method')
+      fail NotImplementedError, 'Unsupported signing method'
     end
   end
 
   def sign_rsa(algorithm, msg, private_key)
     private_key.sign(OpenSSL::Digest.new(algorithm.sub('RS', 'sha')), msg)
   end
 
   def sign_ecdsa(algorithm, msg, private_key)
     key_algorithm = NAMED_CURVES[private_key.group.curve_name]
     if algorithm != key_algorithm
-      fail IncorrectAlgorithm.new("payload algorithm is #{algorithm} but #{key_algorithm} signing key was provided")
+      fail IncorrectAlgorithm, "payload algorithm is #{algorithm} but #{key_algorithm} signing key was provided"
     end
 
     digest = OpenSSL::Digest.new(algorithm.sub('ES', 'sha'))
     asn1_to_raw(private_key.dsa_sign_asn1(digest.digest(msg)), private_key)
   end
@@ -60,11 +60,11 @@
   end
 
   def verify_ecdsa(algorithm, public_key, signing_input, signature)
     key_algorithm = NAMED_CURVES[public_key.group.curve_name]
     if algorithm != key_algorithm
-      fail IncorrectAlgorithm.new("payload algorithm is #{algorithm} but #{key_algorithm} verification key was provided")
+      fail IncorrectAlgorithm, "payload algorithm is #{algorithm} but #{key_algorithm} verification key was provided"
     end
 
     digest = OpenSSL::Digest.new(algorithm.sub('ES', 'sha'))
     public_key.dsa_verify_asn1(digest.digest(signing_input), raw_to_asn1(signature, public_key))
   end
@@ -80,11 +80,11 @@
 
   def base64url_encode(str)
     Base64.encode64(str).tr('+/', '-_').gsub(/[\n=]/, '')
   end
 
-  def encoded_header(algorithm='HS256', header_fields={})
+  def encoded_header(algorithm = 'HS256', header_fields = {})
     header = { 'typ' => 'JWT', 'alg' => algorithm }.merge(header_fields)
     base64url_encode(encode_json(header))
   end
 
   def encoded_payload(payload)
@@ -98,92 +98,92 @@
       signature = sign(algorithm, signing_input, key)
       base64url_encode(signature)
     end
   end
 
-  def encode(payload, key, algorithm='HS256', header_fields={})
+  def encode(payload, key, algorithm = 'HS256', header_fields = {})
     algorithm ||= 'none'
     segments = []
     segments << encoded_header(algorithm, header_fields)
     segments << encoded_payload(payload)
     segments << encoded_signature(segments.join('.'), key, algorithm)
     segments.join('.')
   end
 
-  def raw_segments(jwt, verify=true)
+  def raw_segments(jwt, verify = true)
     segments = jwt.split('.')
     required_num_segments = verify ? [3] : [2, 3]
-    fail JWT::DecodeError.new('Not enough or too many segments') unless required_num_segments.include? segments.length
+    fail(JWT::DecodeError, 'Not enough or too many segments') unless required_num_segments.include? segments.length
     segments
   end
 
   def decode_header_and_payload(header_segment, payload_segment)
     header = decode_json(base64url_decode(header_segment))
     payload = decode_json(base64url_decode(payload_segment))
     [header, payload]
   end
 
-  def decoded_segments(jwt, verify=true)
+  def decoded_segments(jwt, verify = true)
     header_segment, payload_segment, crypto_segment = raw_segments(jwt, verify)
     header, payload = decode_header_and_payload(header_segment, payload_segment)
     signature = base64url_decode(crypto_segment.to_s) if verify
     signing_input = [header_segment, payload_segment].join('.')
     [header, payload, signature, signing_input]
   end
 
-  def decode(jwt, key=nil, verify=true, options={}, &keyfinder)
-    fail JWT::DecodeError.new('Nil JSON web token') unless jwt
+  def decode(jwt, key = nil, verify = true, options = {}, &keyfinder)
+    fail(JWT::DecodeError, 'Nil JSON web token') unless jwt
 
     header, payload, signature, signing_input = decoded_segments(jwt, verify)
-    fail JWT::DecodeError.new('Not enough or too many segments') unless header && payload
+    fail(JWT::DecodeError, 'Not enough or too many segments') unless header && payload
 
     default_options = {
-      :verify_expiration => true,
-      :verify_not_before => true,
-      :verify_iss => false,
-      :verify_iat => false,
-      :verify_jti => false,
-      :verify_aud => false,
-      :verify_sub => false,
-      :leeway => 0
+      verify_expiration: true,
+      verify_not_before: true,
+      verify_iss: false,
+      verify_iat: false,
+      verify_jti: false,
+      verify_aud: false,
+      verify_sub: false,
+      leeway: 0
     }
 
     options = default_options.merge(options)
 
     if verify
       algo, key = signature_algorithm_and_key(header, key, &keyfinder)
       if options[:algorithm] && algo != options[:algorithm]
-        fail JWT::IncorrectAlgorithm.new('Expected a different algorithm')
+        fail JWT::IncorrectAlgorithm, 'Expected a different algorithm'
       end
       verify_signature(algo, key, signing_input, signature)
     end
 
     if options[:verify_expiration] && payload.include?('exp')
-      fail JWT::ExpiredSignature.new('Signature has expired') unless payload['exp'].to_i > (Time.now.to_i - options[:leeway])
+      fail(JWT::ExpiredSignature, 'Signature has expired') unless payload['exp'].to_i > (Time.now.to_i - options[:leeway])
     end
     if options[:verify_not_before] && payload.include?('nbf')
-      fail JWT::ImmatureSignature.new('Signature nbf has not been reached') unless payload['nbf'].to_i < (Time.now.to_i + options[:leeway])
+      fail(JWT::ImmatureSignature, 'Signature nbf has not been reached') unless payload['nbf'].to_i <= (Time.now.to_i + options[:leeway])
     end
-    if options[:verify_iss] && options['iss']
-      fail JWT::InvalidIssuerError.new("Invalid issuer. Expected #{options['iss']}, received #{payload['iss'] || '<none>'}") unless payload['iss'].to_s == options['iss'].to_s
+    if options[:verify_iss] && options[:iss]
+      fail(JWT::InvalidIssuerError, "Invalid issuer. Expected #{options[:iss]}, received #{payload['iss'] || '<none>'}") unless payload['iss'].to_s == options[:iss].to_s
     end
     if options[:verify_iat] && payload.include?('iat')
-      fail JWT::InvalidIatError.new('Invalid iat') unless payload['iat'].is_a?(Integer) && payload['iat'].to_i <= Time.now.to_i
+      fail(JWT::InvalidIatError, 'Invalid iat') unless payload['iat'].is_a?(Integer) && payload['iat'].to_i <= (Time.now.to_i + options[:leeway])
     end
-    if options[:verify_aud] && options['aud']
-      if payload['aud'].is_a?(Array)
-        fail JWT::InvalidAudError.new('Invalid audience') unless payload['aud'].include?(options['aud'].to_s)
+    if options[:verify_aud] && options[:aud]
+      if payload[:aud].is_a?(Array)
+        fail(JWT::InvalidAudError, 'Invalid audience') unless payload['aud'].include?(options[:aud].to_s)
       else
-        fail JWT::InvalidAudError.new("Invalid audience. Expected #{options['aud']}, received #{payload['aud'] || '<none>'}") unless payload['aud'].to_s == options['aud'].to_s
+        fail(JWT::InvalidAudError, "Invalid audience. Expected #{options[:aud]}, received #{payload['aud'] || '<none>'}") unless payload['aud'].to_s == options[:aud].to_s
       end
     end
-    if options[:verify_sub] && payload.include?('sub')
-      fail JWT::InvalidSubError.new("Invalid subject. Expected #{options['sub']}, received #{payload['sub']}") unless payload['sub'].to_s == options['sub'].to_s
+    if options[:verify_sub] && options.include?(:sub)
+      fail(JWT::InvalidSubError, "Invalid subject. Expected #{options[:sub]}, received #{payload['sub'] || '<none>'}") unless payload['sub'].to_s == options[:sub].to_s
     end
     if options[:verify_jti] && payload.include?('jti')
-      fail JWT::InvalidJtiError.new('need iat for verify jwt id') unless payload.include?('iat')
-      fail JWT::InvalidJtiError.new('Not a uniq jwt id') unless options['jti'].to_s == Digest::MD5.hexdigest("#{key}:#{payload['iat']}")
+      fail(JWT::InvalidJtiError, 'need iat for verify jwt id') unless payload.include?('iat')
+      fail(JWT::InvalidJtiError, 'Not a uniq jwt id') unless options[:jti].to_s == Digest::MD5.hexdigest("#{key}:#{payload['iat']}")
     end
 
     [payload, header]
   end
 
@@ -191,20 +191,20 @@
     key = keyfinder.call(header) if keyfinder
     [header['alg'], key]
   end
 
   def verify_signature(algo, key, signing_input, signature)
-    if ['HS256', 'HS384', 'HS512'].include?(algo)
-      fail JWT::VerificationError.new('Signature verification failed') unless secure_compare(signature, sign_hmac(algo, signing_input, key))
-    elsif ['RS256', 'RS384', 'RS512'].include?(algo)
-      fail JWT::VerificationError.new('Signature verification failed') unless verify_rsa(algo, key, signing_input, signature)
-    elsif ['ES256', 'ES384', 'ES512'].include?(algo)
-      fail JWT::VerificationError.new('Signature verification failed') unless verify_ecdsa(algo, key, signing_input, signature)
+    if %w(HS256 HS384 HS512).include?(algo)
+      fail(JWT::VerificationError, 'Signature verification raiseed') unless secure_compare(signature, sign_hmac(algo, signing_input, key))
+    elsif %w(RS256 RS384 RS512).include?(algo)
+      fail(JWT::VerificationError, 'Signature verification raiseed') unless verify_rsa(algo, key, signing_input, signature)
+    elsif %w(ES256 ES384 ES512).include?(algo)
+      fail(JWT::VerificationError, 'Signature verification raiseed') unless verify_ecdsa(algo, key, signing_input, signature)
     else
-      fail JWT::VerificationError.new('Algorithm not supported')
+      fail JWT::VerificationError, 'Algorithm not supported'
     end
   rescue OpenSSL::PKey::PKeyError
-    raise JWT::VerificationError.new('Signature verification failed')
+    raise JWT::VerificationError, 'Signature verification raised'
   ensure
     OpenSSL.errors.clear
   end
 
   # From devise