Module: JWT

Includes:

DefaultOptions

Defined in:

lib/jwt.rb,
lib/jwt/jwk.rb,
lib/jwt/json.rb,
lib/jwt/error.rb,
lib/jwt/base64.rb,
lib/jwt/decode.rb,
lib/jwt/encode.rb,
lib/jwt/verify.rb,
lib/jwt/jwk/rsa.rb,
lib/jwt/version.rb,
lib/jwt/algos/ps.rb,
lib/jwt/algos/rsa.rb,
lib/jwt/signature.rb,
lib/jwt/algos/hmac.rb,
lib/jwt/algos/ecdsa.rb,
lib/jwt/algos/eddsa.rb,
lib/jwt/jwk/key_finder.rb,
lib/jwt/security_utils.rb,
lib/jwt/default_options.rb,
lib/jwt/claims_validator.rb,
lib/jwt/algos/unsupported.rb

Overview

JWT::Signature module

Defined Under Namespace

Modules: Algos, DefaultOptions, JWK, SecurityUtils, Signature, VERSION Classes: Base64, ClaimsValidator, Decode, Encode, JSON, Verify

Constant Summary

EncodeError =

Class.new(StandardError)

DecodeError =

Class.new(StandardError)

RequiredDependencyError =

Class.new(StandardError)

VerificationError =

Class.new(DecodeError)

ExpiredSignature =

Class.new(DecodeError)

IncorrectAlgorithm =

Class.new(DecodeError)

ImmatureSignature =

Class.new(DecodeError)

InvalidIssuerError =

Class.new(DecodeError)

InvalidIatError =

Class.new(DecodeError)

InvalidAudError =

Class.new(DecodeError)

InvalidSubError =

Class.new(DecodeError)

InvalidJtiError =

Class.new(DecodeError)

InvalidPayload =

Class.new(DecodeError)

JWKError =

Class.new(DecodeError)

Constants included from DefaultOptions

DefaultOptions::DEFAULT_OPTIONS

Class Method Summary

• .decode(jwt, key = nil, verify = true, options = {}, &keyfinder) ⇒ Object
• .encode(payload, key, algorithm = 'HS256', header_fields = {}) ⇒ Object
• .gem_version ⇒ Object

Class Method Details

.decode(jwt, key = nil, verify = true, options = {}, &keyfinder) ⇒ Object

# File 'lib/jwt.rb', line 27

def decode(jwt, key = nil, verify = true, options = {}, &keyfinder)
  Decode.new(jwt, key, verify, DEFAULT_OPTIONS.merge(options), &keyfinder).decode_segments
end

.encode(payload, key, algorithm = 'HS256', header_fields = {}) ⇒ Object

# File 'lib/jwt.rb', line 20

def encode(payload, key, algorithm = 'HS256', header_fields = {})
  Encode.new(payload: payload,
             key: key,
             algorithm: algorithm,
             headers: header_fields).segments
end

.gem_version ⇒ Object

# File 'lib/jwt/version.rb', line 6

def self.gem_version
  Gem::Version.new VERSION::STRING
end