Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add audience to the client_options #179

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ These are the configuration options for the client_options hash of the configura
| scheme | The http scheme to use | https | |
| host | The host of the authorization server | nil | |
| port | The port for the authorization server | 443 | |
| audience | The intended consumer (`aud` field) of the id_token | nil | |
| authorization_endpoint | The authorize endpoint on the authorization server | /authorize | yes |
| token_endpoint | The token endpoint on the authorization server | /token | yes |
| userinfo_endpoint | The user info endpoint on the authorization server | /userinfo | yes |
Expand Down
12 changes: 9 additions & 3 deletions lib/omniauth/strategies/openid_connect.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ class OpenIDConnect # rubocop:disable Metrics/ClassLength
scheme: 'https',
host: nil,
port: 443,
audience: nil,
authorization_endpoint: '/authorize',
token_endpoint: '/token',
userinfo_endpoint: '/userinfo',
Expand Down Expand Up @@ -464,9 +465,14 @@ def configured_response_type
def verify_id_token!(id_token)
return unless id_token

decode_id_token(id_token).verify!(issuer: options.issuer,
client_id: client_options.identifier,
nonce: params['nonce'].presence || stored_nonce)
verify_kwargs = {
issuer: options.issuer,
client_id: client_options.identifier,
nonce: params['nonce'].presence || stored_nonce,
}
verify_kwargs.merge!(audience: client_options.audience) if client_options.audience

decode_id_token(id_token).verify!(**verify_kwargs)
end

class CallbackError < StandardError
Expand Down
21 changes: 21 additions & 0 deletions test/lib/omniauth/strategies/openid_connect_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,27 @@ def test_callback_phase_with_id_token
strategy.callback_phase
end

def test_callback_phase_with_audience
state = SecureRandom.hex(16)
strategy.options.response_type = 'id_token'
strategy.options.issuer = 'example.com'
strategy.options.client_options.audience = 'my_audience'

id_token = stub('OpenIDConnect::ResponseObject::IdToken')
id_token.expects(:verify!).with(issuer: strategy.options.issuer, client_id: @identifier, audience: 'my_audience',
nonce: nonce).returns(true)
id_token.stubs(:raw_attributes, :to_h).returns(payload)

request.stubs(:params).returns('state' => state, 'nounce' => nonce, 'id_token' => id_token)
request.stubs(:path).returns('')

strategy.stubs(:decode_id_token).returns(id_token)
strategy.stubs(:stored_state).returns(state)

strategy.call!('rack.session' => { 'omniauth.state' => state, 'omniauth.nonce' => nonce })
strategy.callback_phase
end

def test_callback_phase_with_id_token_and_param_provided_nonce # rubocop:disable Metrics/AbcSize
code = SecureRandom.hex(16)
state = SecureRandom.hex(16)
Expand Down