Namespace

Class/Module Index [+]

Quicksearch

JWT

Public Instance Methods

base64url_decode(str) click to toggle source
# File lib/jwt.rb, line 40
def base64url_decode(str)
  str += "=" * (4 - str.length.modulo(4))
  Base64.decode64(str.tr("-_", "+/"))
end
base64url_encode(str) click to toggle source
# File lib/jwt.rb, line 45
def base64url_encode(str)
  Base64.encode64(str).tr("+/", "-_").gsub(/[\n=]/, "")
end
decode(jwt, key=nil, verify=true, options={}, &keyfinder) click to toggle source
# File lib/jwt.rb, line 97
def decode(jwt, key=nil, verify=true, options={}, &keyfinder)
  raise JWT::DecodeError.new("Nil JSON web token") unless jwt

  header, payload, signature, signing_input = decoded_segments(jwt, verify)
  raise JWT::DecodeError.new("Not enough or too many segments") unless header && payload
  
  default_options = {
    :verify_expiration => true,
    :leeway => 0
  }
  options = default_options.merge(options)
  
  if verify
    algo, key = signature_algorithm_and_key(header, key, &keyfinder)
    verify_signature(algo, key, signing_input, signature)
  end
  if options[:verify_expiration] && payload.include?('exp')
    raise JWT::ExpiredSignature.new("Signature has expired") unless payload['exp'] > (Time.now.to_i - options[:leeway])
  end
  return payload,header
end
decode_header_and_payload(header_segment, payload_segment) click to toggle source
# File lib/jwt.rb, line 83
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
decoded_segments(jwt, verify=true) click to toggle source
# File lib/jwt.rb, line 89
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
encode(payload, key, algorithm="HS256", header_fields={}) click to toggle source
# File lib/jwt.rb, line 67
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
encoded_header(algorithm="HS256", header_fields={}) click to toggle source
# File lib/jwt.rb, line 49
def encoded_header(algorithm="HS256", header_fields={})
  header = {"typ" => "JWT", "alg" => algorithm}.merge(header_fields)
  base64url_encode(encode_json(header))
end
encoded_payload(payload) click to toggle source
# File lib/jwt.rb, line 54
def encoded_payload(payload)
  base64url_encode(encode_json(payload))
end
encoded_signature(signing_input, key, algorithm) click to toggle source
# File lib/jwt.rb, line 58
def encoded_signature(signing_input, key, algorithm)
  if algorithm == "none"
    ""
  else
    signature = sign(algorithm, signing_input, key)
    base64url_encode(signature)
  end
end
raw_segments(jwt, verify=true) click to toggle source
# File lib/jwt.rb, line 76
def raw_segments(jwt, verify=true)
  segments = jwt.split(".")
  required_num_segments = verify ? [3] : [2,3]
  raise JWT::DecodeError.new("Not enough or too many segments") unless required_num_segments.include? segments.length
  segments
end
secure_compare(a, b) click to toggle source

From devise constant-time comparison algorithm to prevent timing attacks

# File lib/jwt.rb, line 144
def secure_compare(a, b)
  return false if a.nil? || b.nil? || a.empty? || b.empty? || a.bytesize != b.bytesize
  l = a.unpack "C#{a.bytesize}"

  res = 0
  b.each_byte { |byte| res |= byte ^ l.shift }
  res == 0
end
sign(algorithm, msg, key) click to toggle source
# File lib/jwt.rb, line 18
def sign(algorithm, msg, key)
  if ["HS256", "HS384", "HS512"].include?(algorithm)
    sign_hmac(algorithm, msg, key)
  elsif ["RS256", "RS384", "RS512"].include?(algorithm)
    sign_rsa(algorithm, msg, key)
  else
    raise NotImplementedError.new("Unsupported signing method")
  end
end
sign_hmac(algorithm, msg, key) click to toggle source
# File lib/jwt.rb, line 36
def sign_hmac(algorithm, msg, key)
  OpenSSL::HMAC.digest(OpenSSL::Digest.new(algorithm.sub("HS", "sha")), key, msg)
end
sign_rsa(algorithm, msg, private_key) click to toggle source
# File lib/jwt.rb, line 28
def sign_rsa(algorithm, msg, private_key)
  private_key.sign(OpenSSL::Digest.new(algorithm.sub("RS", "sha")), msg)
end
signature_algorithm_and_key(header, key, &keyfinder) click to toggle source
# File lib/jwt.rb, line 119
def signature_algorithm_and_key(header, key, &keyfinder)
  if keyfinder
    key = keyfinder.call(header)
  end
  [header['alg'], key]
end
verify_rsa(algorithm, public_key, signing_input, signature) click to toggle source
# File lib/jwt.rb, line 32
def verify_rsa(algorithm, public_key, signing_input, signature)
  public_key.verify(OpenSSL::Digest.new(algorithm.sub("RS", "sha")), signature, signing_input)
end
verify_signature(algo, key, signing_input, signature) click to toggle source
# File lib/jwt.rb, line 126
def verify_signature(algo, key, signing_input, signature)
  begin
    if ["HS256", "HS384", "HS512"].include?(algo)
      raise JWT::DecodeError.new("Signature verification failed") unless secure_compare(signature, sign_hmac(algo, signing_input, key))
    elsif ["RS256", "RS384", "RS512"].include?(algo)
      raise JWT::DecodeError.new("Signature verification failed") unless verify_rsa(algo, key, signing_input, signature)
    else
      raise JWT::DecodeError.new("Algorithm not supported")
    end
  rescue OpenSSL::PKey::PKeyError
    raise JWT::DecodeError.new("Signature verification failed")
  ensure
    OpenSSL.errors.clear
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.