class OAuth2::Strategy::Assertion

The Client Assertion Strategy

@see tools.ietf.org/html/draft-ietf-oauth-v2-10#section-4.1.3

Sample usage:

client = OAuth2::Client.new(client_id, client_secret,
                            :site => 'http://localhost:8080')

params = {:hmac_secret => "some secret",
          # or :private_key => "private key string",
          :iss => "http://localhost:3001",
          :prn => "me@here.com",
          :exp => Time.now.utc.to_i + 3600}

access = client.assertion.get_token(params)
access.token                 # actual access_token string
access.get("/api/stuff")     # making api calls with access token in header

Public Instance Methods

authorize_url() click to toggle source

Not used for this strategy

@raise [NotImplementedError]

# File lib/oauth2/strategy/assertion.rb, line 27
def authorize_url
  raise(NotImplementedError, 'The authorization endpoint is not used in this strategy')
end
build_assertion(params) click to toggle source
# File lib/oauth2/strategy/assertion.rb, line 60
def build_assertion(params)
  claims = {
    :iss => params[:iss],
    :aud => params[:aud],
    :prn => params[:prn],
    :exp => params[:exp],
  }
  if params[:hmac_secret]
    JWT.encode(claims, params[:hmac_secret], 'HS256')
  elsif params[:private_key]
    JWT.encode(claims, params[:private_key], 'RS256')
  end
end
build_request(params) click to toggle source
# File lib/oauth2/strategy/assertion.rb, line 50
def build_request(params)
  assertion = build_assertion(params)
  {
    :grant_type     => 'assertion',
    :assertion_type => 'urn:ietf:params:oauth:grant-type:jwt-bearer',
    :assertion      => assertion,
    :scope          => params[:scope],
  }
end
get_token(params = {}, opts = {}) click to toggle source

Retrieve an access token given the specified client.

@param [Hash] params assertion params pass either :hmac_secret or :private_key, but not both.

params :hmac_secret, secret string.
params :private_key, private key string.

params :iss, issuer
params :aud, audience, optional
params :prn, principal, current user
params :exp, expired at, in seconds, like Time.now.utc.to_i + 3600

@param [Hash] opts options

# File lib/oauth2/strategy/assertion.rb, line 45
def get_token(params = {}, opts = {})
  hash = build_request(params)
  @client.get_token(hash, opts.merge('refresh_token' => nil))
end