Skip to content

Fix client options #1

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.

Sign up for GitHub

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

Merged
dandrews merged 2 commits into from
Mar 14, 2019
Merged

Fix client options #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7de0724
Use client options instead of environment variables for config
jduff Mar 27, 2018
6c45bd9
Update readme to remove environment variables
jduff Mar 28, 2018
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
22 changes: 12 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,19 @@ Or install it yourself as:
$ gem install omniauth-okta
```

### Environment Variables

```bash
OKTA_CLIENT_ID # required
OKTA_CLIENT_SECRET # required
OKTA_ORG # required - defaults to 'your-org' if unset
OKTA_DOMAIN # optional - defaults to 'okta.com' if unset
```

### OmniAuth

Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:

```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :okta, ENV['OKTA_CLIENT_ID'], ENV['OKTA_CLIENT_SECRET']
provider :okta, ENV['OKTA_CLIENT_ID'], ENV['OKTA_CLIENT_SECRET'], {
client_options: {
site: 'https://your-org.okta.com',
authorize_url: 'https://your-org.okta.com/oauth2/v1/authorize',
token_url: 'https://your-org.okta.com/oauth2/v1/token'
}
}
end
```

Expand All @@ -59,6 +56,11 @@ or add options like the following:
ENV['OKTA_CLIENT_SECRET'],
:scope => 'openid profile email',
:fields => ['profile', 'email'],
:client_options => {
:site => 'https://your-org.okta.com',
:authorize_url => 'https://your-org.okta.com/oauth2/v1/authorize',
:token_url => 'https://your-org.okta.com/oauth2/v1/token'
}
:strategy_class => OmniAuth::Strategies::Okta)
```

Expand Down
14 changes: 5 additions & 9 deletions lib/omniauth/strategies/okta.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@
module OmniAuth
module Strategies
class Okta < OmniAuth::Strategies::OAuth2

ORG = ENV['OKTA_ORG'] || 'your-org'
DOMAIN = ENV['OKTA_DOMAIN'] || 'okta'
BASE_URL = "https://#{ORG}.#{DOMAIN}.com"
Copy link

@jgoerz jgoerz May 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 11 is a bugfix as well, because what if the domain is not a .com TLD?

DEFAULT_SCOPE = %[openid profile email].freeze

option :name, 'okta'
Expand All @@ -17,9 +13,9 @@ class Okta < OmniAuth::Strategies::OAuth2
option :jwt_leeway, 60

option :client_options, {
site: BASE_URL,
authorize_url: "#{BASE_URL}/oauth2/v1/authorize",
token_url: "#{BASE_URL}/oauth2/v1/token",
site: 'https://your-org.okta.com',
authorize_url: 'https://your-org.okta.com/oauth2/v1/authorize',
token_url: 'https://your-org.okta.com/oauth2/v1/token',
response_type: 'id_token'
}

Expand Down Expand Up @@ -79,9 +75,9 @@ def validated_token(token)
nil,
false,
verify_iss: true,
iss: BASE_URL,
iss: options[:client_options][:site],
verify_aud: true,
aud: BASE_URL,
aud: options[:client_options][:site],
verify_sub: true,
verify_expiration: true,
verify_not_before: true,
Expand Down