Module: JWT

Extended by:

Configuration

Defined in:

lib/jwt.rb,
lib/jwt/jwk.rb,
lib/jwt/json.rb,
lib/jwt/algos.rb,
lib/jwt/error.rb,
lib/jwt/base64.rb,
lib/jwt/decode.rb,
lib/jwt/encode.rb,
lib/jwt/jwk/ec.rb,
lib/jwt/verify.rb,
lib/jwt/jwk/rsa.rb,
lib/jwt/version.rb,
lib/jwt/algos/ps.rb,
lib/jwt/jwk/hmac.rb,
lib/jwt/algos/rsa.rb,
lib/jwt/signature.rb,
lib/jwt/algos/hmac.rb,
lib/jwt/algos/none.rb,
lib/jwt/algos/ecdsa.rb,
lib/jwt/algos/eddsa.rb,
lib/jwt/jwk/key_base.rb,
lib/jwt/configuration.rb,
lib/jwt/jwk/key_finder.rb,
lib/jwt/jwk/thumbprint.rb,
lib/jwt/security_utils.rb,
lib/jwt/x5c_key_finder.rb,
lib/jwt/claims_validator.rb,
lib/jwt/algos/unsupported.rb,
lib/jwt/jwk/kid_as_key_digest.rb,
lib/jwt/configuration/container.rb,
lib/jwt/configuration/jwk_configuration.rb,
lib/jwt/configuration/decode_configuration.rb

Overview

JWT::Signature module

Defined Under Namespace

Modules: Algos, Configuration, JWK, SecurityUtils, Signature, VERSION Classes: Base64, ClaimsValidator, Decode, DecodeError, Encode, EncodeError, ExpiredSignature, ImmatureSignature, IncorrectAlgorithm, InvalidAudError, InvalidIatError, InvalidIssuerError, InvalidJtiError, InvalidPayload, InvalidSubError, JSON, JWKError, MissingRequiredClaim, RequiredDependencyError, UnsupportedEcdsaCurve, VerificationError, Verify, X5cKeyFinder

Class Method Summary

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

  rubocop:disable Style/OptionalBooleanParameter.

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

Methods included from Configuration

configuration, configure

Class Method Details

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

rubocop:disable Style/OptionalBooleanParameter

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

def decode(jwt, key = nil, verify = true, options = {}, &keyfinder) # rubocop:disable Style/OptionalBooleanParameter
  Decode.new(jwt, key, verify, configuration.decode.to_h.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 5

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