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.

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

Jump to bottom

docs: updated brackets in OAuth Authentication #1798

Merged
merged 8 commits into from
Apr 8, 2022
Merged

docs: updated brackets in OAuth Authentication #1798

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f2c3e4
updated brackets in OAuth Authentication
davidnateberg Jan 31, 2022
e50ec79
aligned bracket with 'remote_app'
davidnateberg Feb 14, 2022
9877f25
Merge branch 'master' into fix/update-security.rst-brackets
davidnateberg Feb 14, 2022
7359f21
Properly aligned brackets, for real this time.
davidnateberg Feb 21, 2022
4f88bc7
Merge branch 'master' into fix/update-security.rst-brackets
davidnateberg Feb 21, 2022
bed0922
updated security.rst OAUTH_PROVIDERS brackets again
davidnateberg Feb 24, 2022
5ec037c
Merge branch 'master' into fix/update-security.rst-brackets
davidnateberg Feb 24, 2022
b597de7
Merge branch 'master' into fix/update-security.rst-brackets
dpgaspar Apr 8, 2022
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
121 changes: 64 additions & 57 deletions docs/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,67 +165,74 @@ Specify a list of OAUTH_PROVIDERS in **config.py** that you want to allow for yo

# the list of providers which the user can choose from
OAUTH_PROVIDERS = [
{'name':'twitter', 'icon':'fa-twitter',
'token_key':'oauth_token',
'remote_app': {
'client_id':'TWITTER_KEY',
'client_secret':'TWITTER_SECRET',
'api_base_url':'https://api.twitter.com/1.1/',
'request_token_url':'https://api.twitter.com/oauth/request_token',
'access_token_url':'https://api.twitter.com/oauth/access_token',
'authorize_url':'https://api.twitter.com/oauth/authenticate'}
{
"name": "twitter",
"icon": "fa-twitter",
"token_key": "oauth_token",
"remote_app": {
"client_id": "TWITTER_KEY",
"client_secret": "TWITTER_SECRET",
"api_base_url": "https://api.twitter.com/1.1/",
"request_token_url": "https://api.twitter.com/oauth/request_token",
"access_token_url": "https://api.twitter.com/oauth/access_token",
"authorize_url": "https://api.twitter.com/oauth/authenticate",
},
},
{'name':'google', 'icon':'fa-google',
'token_key':'access_token',
'remote_app': {
'client_id':'GOOGLE_KEY',
'client_secret':'GOOGLE_SECRET',
'api_base_url':'https://www.googleapis.com/oauth2/v2/',
'client_kwargs':{
'scope': 'email profile'
},
'request_token_url':None,
'access_token_url':'https://accounts.google.com/o/oauth2/token',
'authorize_url':'https://accounts.google.com/o/oauth2/auth'}
{
"name": "google",
"icon": "fa-google",
"token_key": "access_token",
"remote_app": {
"client_id": "GOOGLE_KEY",
"client_secret": "GOOGLE_SECRET",
"api_base_url": "https://www.googleapis.com/oauth2/v2/",
"client_kwargs": {"scope": "email profile"},
"request_token_url": None,
"access_token_url": "https://accounts.google.com/o/oauth2/token",
"authorize_url": "https://accounts.google.com/o/oauth2/auth",
},
},
{'name':'openshift', 'icon':'fa-circle-o',
'token_key':'access_token',
'remote_app': {
'client_id':'system:serviceaccount:mynamespace:mysa',
'client_secret':'<mysa serviceaccount token here>',
'api_base_url':'https://openshift.default.svc.cluster.local:443',
'client_kwargs':{
'scope': 'user:info'
},
'redirect_uri':'https://myapp-mynamespace.apps.<cluster_domain>',
'access_token_url':'https://oauth-openshift.apps.<cluster_domain>/oauth/token',
'authorize_url':'https://oauth-openshift.apps.<cluster_domain>/oauth/authorize',
'token_endpoint_auth_method':'client_secret_post'}
{
"name": "openshift",
"icon": "fa-circle-o",
"token_key": "access_token",
"remote_app": {
"client_id": "system:serviceaccount:mynamespace:mysa",
"client_secret": "<mysa serviceaccount token here>",
"api_base_url": "https://openshift.default.svc.cluster.local:443",
"client_kwargs": {"scope": "user:info"},
"redirect_uri": "https://myapp-mynamespace.apps.<cluster_domain>",
"access_token_url": "https://oauth-openshift.apps.<cluster_domain>/oauth/token",
"authorize_url": "https://oauth-openshift.apps.<cluster_domain>/oauth/authorize",
"token_endpoint_auth_method": "client_secret_post",
},
},
{'name': 'okta', 'icon': 'fa-circle-o',
'token_key': 'access_token',
'remote_app': {
'client_id': 'OKTA_KEY',
'client_secret': 'OKTA_SECRET',
'api_base_url': 'https://OKTA_DOMAIN.okta.com/oauth2/v1/',
'client_kwargs': {
'scope': 'openid profile email groups'
},
'access_token_url': 'https://OKTA_DOMAIN.okta.com/oauth2/v1/token',
'authorize_url': 'https://OKTA_DOMAIN.okta.com/oauth2/v1/authorize',
{
"name": "okta",
"icon": "fa-circle-o",
"token_key": "access_token",
"remote_app": {
"client_id": "OKTA_KEY",
"client_secret": "OKTA_SECRET",
"api_base_url": "https://OKTA_DOMAIN.okta.com/oauth2/v1/",
"client_kwargs": {"scope": "openid profile email groups"},
"access_token_url": "https://OKTA_DOMAIN.okta.com/oauth2/v1/token",
"authorize_url": "https://OKTA_DOMAIN.okta.com/oauth2/v1/authorize",
},
},
{
"name": "aws_cognito",
"icon": "fa-amazon",
"token_key": "access_token",
"remote_app": {
"client_id": "COGNITO_CLIENT_ID",
"client_secret": "COGNITO_CLIENT_SECRET",
"api_base_url": "https://COGNITO_APP.auth.REGION.amazoncognito.com/",
"client_kwargs": {"scope": "openid email aws.cognito.signin.user.admin"},
"access_token_url": "https://COGNITO_APP.auth.REGION.amazoncognito.com/token",
"authorize_url": "https://COGNITO_APP.auth.REGION.amazoncognito.com/authorize",
},
},
{'name': 'aws_cognito', 'icon': 'fa-amazon',
'token_key': 'access_token',
'remote_app': {
'client_id': 'COGNITO_CLIENT_ID',
'client_secret': 'COGNITO_CLIENT_SECRET',
'api_base_url': 'https://COGNITO_APP.auth.REGION.amazoncognito.com/',
'client_kwargs': {
'scope': 'openid email aws.cognito.signin.user.admin'
},
'access_token_url': 'https://COGNITO_APP.auth.REGION.amazoncognito.com/token',
'authorize_url': 'https://COGNITO_APP.auth.REGION.amazoncognito.com/authorize',
}
]

This needs a small explanation, you basically have five special keys:
Expand Down