@@ -0,0 +1,691 @@
1+---
2+id: oauth_provider
3+title: OAuth Provider Configuration
4+---
5+
6+You will need to register an OAuth application with a Provider (Google, GitHub or another provider), and configure it with Redirect URI(s) for the domain you intend to run `oauth2-proxy` on.
7+
8+Valid providers are :
9+
10+- [Google](#google-auth-provider) _default_
11+- [Azure](#azure-auth-provider)
12+- [ADFS](#adfs-auth-provider)
13+- [Facebook](#facebook-auth-provider)
14+- [GitHub](#github-auth-provider)
15+- [Keycloak](#keycloak-auth-provider)
16+- [GitLab](#gitlab-auth-provider)
17+- [LinkedIn](#linkedin-auth-provider)
18+- [Microsoft Azure AD](#microsoft-azure-ad-provider)
19+- [OpenID Connect](#openid-connect-provider)
20+- [login.gov](#logingov-provider)
21+- [Nextcloud](#nextcloud-provider)
22+- [DigitalOcean](#digitalocean-auth-provider)
23+- [Bitbucket](#bitbucket-auth-provider)
24+- [Gitea](#gitea-auth-provider)
25+
26+The provider can be selected using the `provider` configuration value.
27+
28+Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the OpenID Connect provider.
29+
30+### Google Auth Provider
31+
32+For Google, the registration steps are:
33+
34+1. Create a new project: https://console.developers.google.com/project
35+2. Choose the new project from the top right project dropdown (only if another project is selected)
36+3. In the project Dashboard center pane, choose **"APIs & Services"**
37+4. In the left Nav pane, choose **"Credentials"**
38+5. In the center pane, choose **"OAuth consent screen"** tab. Fill in **"Product name shown to users"** and hit save.
39+6. In the center pane, choose **"Credentials"** tab.
40+ - Open the **"New credentials"** drop down
41+ - Choose **"OAuth client ID"**
42+ - Choose **"Web application"**
43+ - Application name is freeform, choose something appropriate
44+ - Authorized JavaScript origins is your domain ex: `https://internal.yourcompany.com`
45+ - Authorized redirect URIs is the location of oauth2/callback ex: `https://internal.yourcompany.com/oauth2/callback`
46+ - Choose **"Create"**
47+7. Take note of the **Client ID** and **Client Secret**
48+
49+It's recommended to refresh sessions on a short interval (1h) with `cookie-refresh` setting which validates that the account is still authorized.
50+
51+#### Restrict auth to specific Google groups on your domain. (optional)
52+
53+1. Create a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) and download the json
54+file if you're not using [Application Default Credentials / Workload Identity / Workload Identity Federation (recommended)](#using-application-default-credentials-adc--workload-identity--workload-identity-federation-recommended).
55+2. Make note of the Client ID for a future step.
56+3. Under "APIs & Auth", choose APIs.
57+4. Click on Admin SDK and then Enable API.
58+5. Follow the steps on https://developers.google.com/admin-sdk/directory/v1/guides/delegation#delegate_domain-wide_authority_to_your_service_account and give the client id from step 2 the following oauth scopes:
59+
60+
61+##### Using Application Default Credentials (ADC) / Workload Identity / Workload Identity Federation (recommended)
62+oauth2-proxy can make use of [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials).
63+When deployed within GCP, this means that it can automatically use the service account attached to the resource. When deployed to GKE, ADC
64+can be leveraged through a feature called Workload Identity. Follow Google's [guide](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity)
65+to set up Workload Identity.
66+
67+When deployed outside of GCP, [Workload Identity Federation](https://cloud.google.com/docs/authentication/provide-credentials-adc#wlif) might be an option.
68+
69+```
70+https://www.googleapis.com/auth/admin.directory.group.readonly
71+https://www.googleapis.com/auth/admin.directory.user.readonly
72+```
73+
74+6. Follow the steps on https://support.google.com/a/answer/60757 to enable Admin API access.
75+7. Create or choose an existing administrative email address on the Gmail domain to assign to the `google-admin-email` flag. This email will be impersonated by this client to make calls to the Admin SDK. See the note on the link from step 5 for the reason why.
76+8. Create or choose an existing email group and set that email to the `google-group` flag. You can pass multiple instances of this flag with different groups
77+ and the user will be checked against all the provided groups.
78+9. Lock down the permissions on the json file downloaded from step 1 so only oauth2-proxy is able to read the file and set the path to the file in the `google-service-account-json` flag.
79+10. Restart oauth2-proxy.
80+
81+Note: The user is checked against the group members list on initial authentication and every time the token is refreshed ( about once an hour ).
82+
83+### Azure Auth Provider
84+
85+1. Add an application: go to [https://portal.azure.com](https://portal.azure.com), choose **Azure Active Directory**, select
86+**App registrations** and then click on **New registration**.
87+2. Pick a name, check the supported account type(single-tenant, multi-tenant, etc). In the **Redirect URI** section create a new
88+**Web** platform entry for each app that you want to protect by the oauth2 proxy(e.g.
89+https://internal.yourcompanycom/oauth2/callback). Click **Register**.
90+3. Next we need to add group read permissions for the app registration, on the **API Permissions** page of the app, click on
91+**Add a permission**, select **Microsoft Graph**, then select **Application permissions**, then click on **Group** and select
92+**Group.Read.All**. Hit **Add permissions** and then on **Grant admin consent** (you might need an admin to do this).
93+<br/>**IMPORTANT**: Even if this permission is listed with **"Admin consent required=No"** the consent might actually be required, due to AAD policies you won't be able to see. If you get a **"Need admin approval"** during login, most likely this is what you're missing!
94+4. Next, if you are planning to use v2.0 Azure Auth endpoint, go to the **Manifest** page and set `"accessTokenAcceptedVersion": 2`
95+in the App registration manifest file.
96+5. On the **Certificates & secrets** page of the app, add a new client secret and note down the value after hitting **Add**.
97+6. Configure the proxy with:
98+- for V1 Azure Auth endpoint (Azure Active Directory Endpoints - https://login.microsoftonline.com/common/oauth2/authorize)
99+
100+```
101+ --provider=azure
102+ --client-id=<application ID from step 3>
103+ --client-secret=<value from step 5>
104+ --azure-tenant={tenant-id}
105+ --oidc-issuer-url=https://sts.windows.net/{tenant-id}/
106+```
107+
108+- for V2 Azure Auth endpoint (Microsoft Identity Platform Endpoints - https://login.microsoftonline.com/common/oauth2/v2.0/authorize)
109+```
110+ --provider=azure
111+ --client-id=<application ID from step 3>
112+ --client-secret=<value from step 5>
113+ --azure-tenant={tenant-id}
114+ --oidc-issuer-url=https://login.microsoftonline.com/{tenant-id}/v2.0
115+```
116+
117+***Notes***:
118+- When using v2.0 Azure Auth endpoint (`https://login.microsoftonline.com/{tenant-id}/v2.0`) as `--oidc_issuer_url`, in conjunction
119+with `--resource` flag, be sure to append `/.default` at the end of the resource name. See
120+https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent#the-default-scope for more details.
121+- When using the Azure Auth provider with nginx and the cookie session store you may find the cookie is too large and doesn't
122+get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the [redis session storage](sessions.md#redis-storage)
123+should resolve this.
124+
125+### ADFS Auth Provider
126+
127+1. Open the ADFS administration console on your Windows Server and add a new Application Group
128+2. Provide a name for the integration, select Server Application from the Standalone applications section and click Next
129+3. Follow the wizard to get the client-id, client-secret and configure the application credentials
130+4. Configure the proxy with
131+
132+```
133+ --provider=adfs
134+ --client-id=<application ID from step 3>
135+ --client-secret=<value from step 3>
136+```
137+
138+Note: When using the ADFS Auth provider with nginx and the cookie session store you may find the cookie is too large and doesn't get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the [redis session storage](sessions.md#redis-storage) should resolve this.
139+
140+### Facebook Auth Provider
141+
142+1. Create a new FB App from <https://developers.facebook.com/>
143+2. Under FB Login, set your Valid OAuth redirect URIs to `https://internal.yourcompany.com/oauth2/callback`
144+
145+### GitHub Auth Provider
146+
147+1. Create a new project: https://github.com/settings/developers
148+2. Under `Authorization callback URL` enter the correct url ie `https://internal.yourcompany.com/oauth2/callback`
149+
150+The GitHub auth provider supports two additional ways to restrict authentication to either organization and optional team level access, or to collaborators of a repository. Restricting by these options is normally accompanied with `--email-domain=*`
151+
152+NOTE: When `--github-user` is set, the specified users are allowed to login even if they do not belong to the specified org and team or collaborators.
153+
154+To restrict by organization only, include the following flag:
155+
156+ -github-org="": restrict logins to members of this organisation
157+
158+To restrict within an organization to specific teams, include the following flag in addition to `-github-org`:
159+
160+ -github-team="": restrict logins to members of any of these teams (slug), separated by a comma
161+
162+If you would rather restrict access to collaborators of a repository, those users must either have push access to a public repository or any access to a private repository:
163+
164+ -github-repo="": restrict logins to collaborators of this repository formatted as orgname/repo
165+
166+If you'd like to allow access to users with **read only** access to a **public** repository you will need to provide a [token](https://github.com/settings/tokens) for a user that has write access to the repository. The token must be created with at least the `public_repo` scope:
167+
168+ -github-token="": the token to use when verifying repository collaborators
169+
170+To allow a user to login with their username even if they do not belong to the specified org and team or collaborators, separated by a comma
171+
172+ -github-user="": allow logins by username, separated by a comma
173+
174+If you are using GitHub enterprise, make sure you set the following to the appropriate url:
175+
176+ -login-url="http(s)://<enterprise github host>/login/oauth/authorize"
177+ -redeem-url="http(s)://<enterprise github host>/login/oauth/access_token"
178+ -validate-url="http(s)://<enterprise github host>/api/v3"
179+
180+### Keycloak Auth Provider
181+
182+:::note
183+This is the legacy provider for Keycloak, use [Keycloak OIDC Auth Provider](#keycloak-oidc-auth-provider) if possible.
184+:::
185+
186+1. Create new client in your Keycloak realm with **Access Type** 'confidental' and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'
187+2. Take note of the Secret in the credential tab of the client
188+3. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.
189+
190+Make sure you set the following to the appropriate url:
191+
192+```
193+ --provider=keycloak
194+ --client-id=<client you have created>
195+ --client-secret=<your client's secret>
196+ --login-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/auth"
197+ --redeem-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/token"
198+ --profile-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/userinfo"
199+ --validate-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/userinfo"
200+ --keycloak-group=<first_allowed_user_group>
201+ --keycloak-group=<second_allowed_user_group>
202+```
203+
204+For group based authorization, the optional `--keycloak-group` (legacy) or `--allowed-group` (global standard)
205+flags can be used to specify which groups to limit access to.
206+
207+If these are unset but a `groups` mapper is set up above in step (3), the provider will still
208+populate the `X-Forwarded-Groups` header to your upstream server with the `groups` data in the
209+Keycloak userinfo endpoint response.
210+
211+The group management in keycloak is using a tree. If you create a group named admin in keycloak
212+you should define the 'keycloak-group' value to /admin.
213+
214+### Keycloak OIDC Auth Provider
215+
216+```
217+ --provider=keycloak-oidc
218+ --client-id=<your client's id>
219+ --client-secret=<your client's secret>
220+ --redirect-url=https://internal.yourcompany.com/oauth2/callback
221+ --oidc-issuer-url=https://<keycloak host>/auth/realms/<your realm>
222+ --email-domain=<yourcompany.com> // Validate email domain for users, see option documentation
223+ --allowed-role=<realm role name> // Optional, required realm role
224+ --allowed-role=<client id>:<client role name> // Optional, required client role
225+ --allowed-group=</group name> // Optional, requires group client scope
226+ --code-challenge-method=S256 // PKCE
227+```
228+
229+:::note
230+Keycloak has updated its admin console and as of version 19.0.0, the new admin console is enabled by default. The legacy admin console has been announced for removal with the release of version 21.0.0.
231+:::
232+
233+**Keycloak legacy admin console**
234+
235+1. Create new client in your Keycloak realm with **Access Type** 'confidential', **Client protocol** 'openid-connect' and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'
236+2. Take note of the Secret in the credential tab of the client
237+3. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.
238+4. Create a mapper with **Mapper Type** 'Audience' and **Included Client Audience** and **Included Custom Audience** set to your client name.
239+
240+**Keycloak new admin console (default as of v19.0.0)**
241+
242+The following example shows how to create a simple OIDC client using the new Keycloak admin2 console. However, for best practices, it is recommended to consult the Keycloak documentation.
243+
244+The OIDC client must be configured with an _audience mapper_ to include the client's name in the `aud` claim of the JWT token.
245+The `aud` claim specifies the intended recipient of the token, and OAuth2 Proxy expects a match against the values of either `--client-id` or `--oidc-extra-audience`.
246+
247+_In Keycloak, claims are added to JWT tokens through the use of mappers at either the realm level using "client scopes" or through "dedicated" client mappers._
248+
249+**Creating the client**
250+
251+1. Create a new OIDC client in your Keycloak realm by navigating to:
252+ **Clients** -> **Create client**
253+* **Client Type** 'OpenID Connect'
254+* **Client ID** `<your client's id>`, please complete the remaining fields as appropriate and click **Next**.
255+ * **Client authentication** 'On'
256+ * **Authentication flow**
257+ * **Standard flow** 'selected'
258+ * **Direct access grants** 'deselect'
259+ * _Save the configuration._
260+ * **Settings / Access settings**:
261+ * **Valid redirect URIs** `https://internal.yourcompany.com/oauth2/callback`
262+ * _Save the configuration._
263+ * Under the **Credentials** tab you will now be able to locate `<your client's secret>`.
264+2. Configure a dedicated *audience mapper* for your client by navigating to **Clients** -> **<your client's id>** -> **Client scopes**.
265+* Access the dedicated mappers pane by clicking **<your client's id>-dedicated**, located under *Assigned client scope*.
266+ _(It should have a description of "Dedicated scope and mappers for this client")_
267+ * Click **Configure a new mapper** and select **Audience**
268+ * **Name** 'aud-mapper-<your client's id>'
269+ * **Included Client Audience** select `<your client's id>` from the dropdown.
270+ * _OAuth2 proxy can be set up to pass both the access and ID JWT tokens to your upstream services.
271+ If you require additional audience entries, you can use the **Included Custom Audience** field in addition to the "Included Client Audience" dropdown. Note that the "aud" claim of a JWT token should be limited and only specify its intended recipients._
272+ * **Add to ID token** 'On'
273+ * **Add to access token** 'On' - [#1916](https://github.com/oauth2-proxy/oauth2-proxy/pull/1916)
274+ * _Save the configuration._
275+* Any subsequent dedicated client mappers can be defined by clicking **Dedicated scopes** -> **Add mapper** -> **By configuration** -> *Select mapper*
276+
277+You should now be able to create a test user in Keycloak and get access to the OAuth2 Proxy instance, make sure to set an email address matching `<yourcompany.com>` and select _Email verified_.
278+
279+**Authorization**
280+
281+_OAuth2 Proxy will perform authorization by requiring a valid user, this authorization can be extended to take into account a user's membership in Keycloak `groups`, `realm roles`, and `client roles` using the keycloak-oidc provider options
282+`--allowed-role` or `--allowed-group`_
283+
284+**Roles**
285+
286+_A standard Keycloak installation comes with the required mappers for **realm roles** and **client roles** through the pre-defined client scope "roles".
287+This ensures that any roles assigned to a user are included in the `JWT` tokens when using an OIDC client that has the "Full scope allowed" feature activated, the feature is enabled by default._
288+
289+_Creating a realm role_
290+* Navigate to **Realm roles** -> **Create role**
291+ * **Role name**, *`<realm role name>`* -> **save**
292+
293+_Creating a client role_
294+* Navigate to **Clients** -> `<your client's id>` -> **Roles** -> **Create role**
295+ * **Role name**, *`<client role name>`* -> **save**
296+
297+
298+_Assign a role to a user_
299+
300+**Users** -> _Username_ -> **Role mapping** -> **Assign role** -> _filter by roles or clients and select_ -> **Assign**.
301+
302+Keycloak "realm roles" can be authorized using the `--allowed-role=<realm role name>` option, while "client roles" can be evaluated using `--allowed-role=<your client's id>:<client role name>`.
303+
304+You may limit the _realm roles_ included in the JWT tokens for any given client by navigating to:
305+**Clients** -> `<your client's id>` -> **Client scopes** -> _<your client's id>-dedicated_ -> **Scope**
306+Disabling **Full scope allowed** activates the **Assign role** option, allowing you to select which roles, if assigned to a user, will be included in the user's JWT tokens. This can be useful when a user has many associated roles, and you want to reduce the size and impact of the JWT token.
307+
308+
309+**Groups**
310+
311+You may also do authorization on group memberships by using the OAuth2 Proxy option `--allowed-group`.
312+We will only do a brief description of creating the required _client scope_ **groups** and refer you to read the Keycloak documentation.
313+
314+To summarize, the steps required to authorize Keycloak group membership with OAuth2 Proxy are as follows:
315+
316+* Create a new Client Scope with the name **groups** in Keycloak.
317+ * Include a mapper of type **Group Membership**.
318+ * Set the "Token Claim Name" to **groups** or customize by matching it to the `--oidc-groups-claim` option of OAuth2 Proxy.
319+ * If the "Full group path" option is selected, you need to include a "/" separator in the group names defined in the `--allowed-group` option of OAuth2 Proxy. Example: "/groupname" or "/groupname/childgroup".
320+
321+After creating the _Client Scope_ named _groups_ you will need to attach it to your client.
322+**Clients** -> `<your client's id>` -> **Client scopes** -> **Add client scope** -> Select **groups** and choose Optional and you should now have a client that maps group memberships into the JWT tokens so that Oauth2 Proxy may evaluate them.
323+
324+Create a group by navigating to **Groups** -> **Create group** and _add_ your test user as a member.
325+
326+The OAuth2 Proxy option `--allowed-group=/groupname` will now allow you to filter on group membership
327+
328+Keycloak also has the option of attaching roles to groups, please refer to the Keycloak documentation for more information.
329+
330+**Tip**
331+
332+To check if roles or groups are added to JWT tokens, you can preview a users token in the Keycloak console by following these steps:
333+**Clients** -> `<your client's id>` -> **Client scopes** -> **Evaluate**.
334+Select a _realm user_ and optional _scope parameters_ such as groups, and generate the JSON representation of an access or id token to examine its contents.
335+
336+
337+### GitLab Auth Provider
338+
339+This auth provider has been tested against Gitlab version 12.X. Due to Gitlab API changes, it may not work for version prior to 12.X (see [994](https://github.com/oauth2-proxy/oauth2-proxy/issues/994)).
340+
341+Whether you are using GitLab.com or self-hosting GitLab, follow [these steps to add an application](https://docs.gitlab.com/ce/integration/oauth_provider.html). Make sure to enable at least the `openid`, `profile` and `email` scopes, and set the redirect url to your application url e.g. https://myapp.com/oauth2/callback.
342+
343+If you need projects filtering, add the extra `read_api` scope to your application.
344+
345+The following config should be set to ensure that the oauth will work properly. To get a cookie secret follow [these steps](./overview.md#generating-a-cookie-secret)
346+
347+```
348+ --provider="gitlab"
349+ --redirect-url="https://myapp.com/oauth2/callback" // Should be the same as the redirect url for the application in gitlab
350+ --client-id=GITLAB_CLIENT_ID
351+ --client-secret=GITLAB_CLIENT_SECRET
352+ --cookie-secret=COOKIE_SECRET
353+```
354+
355+Restricting by group membership is possible with the following option:
356+
357+ --gitlab-group="mygroup,myothergroup": restrict logins to members of any of these groups (slug), separated by a comma
358+
359+If you are using self-hosted GitLab, make sure you set the following to the appropriate URL:
360+
361+ --oidc-issuer-url="<your gitlab url>"
362+
363+If your self-hosted GitLab is on a sub-directory (e.g. domain.tld/gitlab), as opposed to its own sub-domain (e.g. gitlab.domain.tld), you may need to add a redirect from domain.tld/oauth pointing at e.g. domain.tld/gitlab/oauth.
364+
365+### LinkedIn Auth Provider
366+
367+For LinkedIn, the registration steps are:
368+
369+1. Create a new project: https://www.linkedin.com/secure/developer
370+2. In the OAuth User Agreement section:
371+ - In default scope, select r_basicprofile and r_emailaddress.
372+ - In "OAuth 2.0 Redirect URLs", enter `https://internal.yourcompany.com/oauth2/callback`
373+3. Fill in the remaining required fields and Save.
374+4. Take note of the **Consumer Key / API Key** and **Consumer Secret / Secret Key**
375+
376+### Microsoft Azure AD Provider
377+
378+For adding an application to the Microsoft Azure AD follow [these steps to add an application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app).
379+
380+Take note of your `TenantId` if applicable for your situation. The `TenantId` can be used to override the default `common` authorization server with a tenant specific server.
381+
382+### OpenID Connect Provider
383+
384+OpenID Connect is a spec for OAUTH 2.0 + identity that is implemented by many major providers and several open source projects.
385+
386+This provider was originally built against CoreOS Dex and we will use it as an example.
387+The OpenID Connect Provider (OIDC) can also be used to connect to other Identity Providers such as Okta, an example can be found below.
388+
389+#### Dex
390+
391+To configure the OIDC provider for Dex, perform the following steps:
392+
393+1. Download Dex:
394+
395+ ```
396+ go get github.com/dexidp/dex
397+ ```
398+
399+ See the [getting started guide](https://dexidp.io/docs/getting-started/) for more details.
400+
401+2. Setup oauth2-proxy with the correct provider and using the default ports and callbacks. Add a configuration block to the `staticClients` section of `examples/config-dev.yaml`:
402+
403+ ```
404+ - id: oauth2-proxy
405+ redirectURIs:
406+ - 'http://127.0.0.1:4180/oauth2/callback'
407+ name: 'oauth2-proxy'
408+ secret: proxy
409+ ```
410+
411+3. Launch Dex: from `$GOPATH/github.com/dexidp/dex`, run:
412+
413+ ```
414+ bin/dex serve examples/config-dev.yaml
415+ ```
416+
417+4. In a second terminal, run the oauth2-proxy with the following args:
418+
419+ ```
420+ -provider oidc
421+ -provider-display-name "My OIDC Provider"
422+ -client-id oauth2-proxy
423+ -client-secret proxy
424+ -redirect-url http://127.0.0.1:4180/oauth2/callback
425+ -oidc-issuer-url http://127.0.0.1:5556/dex
426+ -cookie-secure=false
427+ -cookie-secret=secret
428+ -email-domain kilgore.trout
429+ ```
430+
431+ To serve the current working directory as a web site under the `/static` endpoint, add:
432+
433+ ```
434+ -upstream file://$PWD/#/static/
435+ ```
436+
437+5. Test the setup by visiting http://127.0.0.1:4180 or http://127.0.0.1:4180/static .
438+
439+See also [our local testing environment](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/contrib/local-environment) for a self-contained example using Docker and etcd as storage for Dex.
440+
441+#### Okta
442+
443+To configure the OIDC provider for Okta, perform the following steps:
444+
445+1. Log in to Okta using an administrative account. It is suggested you try this in preview first, `example.oktapreview.com`
446+2. (OPTIONAL) If you want to configure authorization scopes and claims to be passed on to multiple applications,
447+you may wish to configure an authorization server for each application. Otherwise, the provided `default` will work.
448+* Navigate to **Security** then select **API**
449+* Click **Add Authorization Server**, if this option is not available you may require an additional license for a custom authorization server.
450+* Fill out the **Name** with something to describe the application you are protecting. e.g. 'Example App'.
451+* For **Audience**, pick the URL of the application you wish to protect: https://example.corp.com
452+* Fill out a **Description**
453+* Add any **Access Policies** you wish to configure to limit application access.
454+* The default settings will work for other options.
455+[See Okta documentation for more information on Authorization Servers](https://developer.okta.com/docs/guides/customize-authz-server/overview/)
456+3. Navigate to **Applications** then select **Add Application**.
457+* Select **Web** for the **Platform** setting.
458+* Select **OpenID Connect** and click **Create**
459+* Pick an **Application Name** such as `Example App`.
460+* Set the **Login redirect URI** to `https://example.corp.com`.
461+* Under **General** set the **Allowed grant types** to `Authorization Code` and `Refresh Token`.
462+* Leave the rest as default, taking note of the `Client ID` and `Client Secret`.
463+* Under **Assignments** select the users or groups you wish to access your application.
464+4. Create a configuration file like the following:
465+
466+ ```
467+ provider = "oidc"
468+ redirect_url = "https://example.corp.com/oauth2/callback"
469+ oidc_issuer_url = "https://corp.okta.com/oauth2/abCd1234"
470+ upstreams = [
471+ "https://example.corp.com"
472+ ]
473+ email_domains = [
474+ "corp.com"
475+ ]
476+ client_id = "XXXXX"
477+ client_secret = "YYYYY"
478+ pass_access_token = true
479+ cookie_secret = "ZZZZZ"
480+ skip_provider_button = true
481+ ```
482+
483+The `oidc_issuer_url` is based on URL from your **Authorization Server**'s **Issuer** field in step 2, or simply https://corp.okta.com .
484+The `client_id` and `client_secret` are configured in the application settings.
485+Generate a unique `cookie_secret` to encrypt the cookie.
486+
487+Then you can start the oauth2-proxy with `./oauth2-proxy --config /etc/example.cfg`
488+
489+#### Okta - localhost
490+
491+1. Signup for developer account: https://developer.okta.com/signup/
492+2. Create New `Web` Application: https://${your-okta-domain}/dev/console/apps/new
493+3. Example Application Settings for localhost:
494+ * **Name:** My Web App
495+ * **Base URIs:** http://localhost:4180/
496+ * **Login redirect URIs:** http://localhost:4180/oauth2/callback
497+ * **Logout redirect URIs:** http://localhost:4180/
498+ * **Group assignments:** `Everyone`
499+ * **Grant type allowed:** `Authorization Code` and `Refresh Token`
500+4. Make note of the `Client ID` and `Client secret`, they are needed in a future step
501+5. Make note of the **default** Authorization Server Issuer URI from: https://${your-okta-domain}/admin/oauth2/as
502+6. Example config file `/etc/localhost.cfg`
503+ ```
504+ provider = "oidc"
505+ redirect_url = "http://localhost:4180/oauth2/callback"
506+ oidc_issuer_url = "https://${your-okta-domain}/oauth2/default"
507+ upstreams = [
508+ "http://0.0.0.0:8080"
509+ ]
510+ email_domains = [
511+ "*"
512+ ]
513+ client_id = "XXX"
514+ client_secret = "YYY"
515+ pass_access_token = true
516+ cookie_secret = "ZZZ"
517+ cookie_secure = false
518+ skip_provider_button = true
519+ # Note: use the following for testing within a container
520+ # http_address = "0.0.0.0:4180"
521+ ```
522+7. Then you can start the oauth2-proxy with `./oauth2-proxy --config /etc/localhost.cfg`
523+
524+### login.gov Provider
525+
526+login.gov is an OIDC provider for the US Government.
527+If you are a US Government agency, you can contact the login.gov team through the contact information
528+that you can find on https://login.gov/developers/ and work with them to understand how to get login.gov
529+accounts for integration/test and production access.
530+
531+A developer guide is available here: https://developers.login.gov/, though this proxy handles everything
532+but the data you need to create to register your application in the login.gov dashboard.
533+
534+As a demo, we will assume that you are running your application that you want to secure locally on
535+http://localhost:3000/, that you will be starting your proxy up on http://localhost:4180/, and that
536+you have an agency integration account for testing.
537+
538+First, register your application in the dashboard. The important bits are:
539+ * Identity protocol: make this `Openid connect`
540+ * Issuer: do what they say for OpenID Connect. We will refer to this string as `${LOGINGOV_ISSUER}`.
541+ * Public key: This is a self-signed certificate in .pem format generated from a 2048 bit RSA private key.
542+ A quick way to do this is `openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 3650 -nodes -subj '/C=US/ST=Washington/L=DC/O=GSA/OU=18F/CN=localhost'`,
543+ The contents of the `key.pem` shall be referred to as `${OAUTH2_PROXY_JWT_KEY}`.
544+ * Return to App URL: Make this be `http://localhost:4180/`
545+ * Redirect URIs: Make this be `http://localhost:4180/oauth2/callback`.
546+ * Attribute Bundle: Make sure that email is selected.
547+
548+Now start the proxy up with the following options:
549+```
550+./oauth2-proxy -provider login.gov \
551+ -client-id=${LOGINGOV_ISSUER} \
552+ -redirect-url=http://localhost:4180/oauth2/callback \
553+ -oidc-issuer-url=https://idp.int.identitysandbox.gov/ \
554+ -cookie-secure=false \
555+ -email-domain=gsa.gov \
556+ -upstream=http://localhost:3000/ \
557+ -cookie-secret=somerandomstring12341234567890AB \
558+ -cookie-domain=localhost \
559+ -skip-provider-button=true \
560+ -pubjwk-url=https://idp.int.identitysandbox.gov/api/openid_connect/certs \
561+ -profile-url=https://idp.int.identitysandbox.gov/api/openid_connect/userinfo \
562+ -jwt-key="${OAUTH2_PROXY_JWT_KEY}"
563+```
564+You can also set all these options with environment variables, for use in cloud/docker environments.
565+One tricky thing that you may encounter is that some cloud environments will pass in environment
566+variables in a docker env-file, which does not allow multiline variables like a PEM file.
567+If you encounter this, then you can create a `jwt_signing_key.pem` file in the top level
568+directory of the repo which contains the key in PEM format and then do your docker build.
569+The docker build process will copy that file into your image which you can then access by
570+setting the `OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem`
571+environment variable, or by setting `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem` on the commandline.
572+
573+Once it is running, you should be able to go to `http://localhost:4180/` in your browser,
574+get authenticated by the login.gov integration server, and then get proxied on to your
575+application running on `http://localhost:3000/`. In a real deployment, you would secure
576+your application with a firewall or something so that it was only accessible from the
577+proxy, and you would use real hostnames everywhere.
578+
579+#### Skip OIDC discovery
580+
581+Some providers do not support OIDC discovery via their issuer URL, so oauth2-proxy cannot simply grab the authorization, token and jwks URI endpoints from the provider's metadata.
582+
583+In this case, you can set the `--skip-oidc-discovery` option, and supply those required endpoints manually:
584+
585+```
586+ -provider oidc
587+ -client-id oauth2-proxy
588+ -client-secret proxy
589+ -redirect-url http://127.0.0.1:4180/oauth2/callback
590+ -oidc-issuer-url http://127.0.0.1:5556
591+ -skip-oidc-discovery
592+ -login-url http://127.0.0.1:5556/authorize
593+ -redeem-url http://127.0.0.1:5556/token
594+ -oidc-jwks-url http://127.0.0.1:5556/keys
595+ -cookie-secure=false
596+ -email-domain example.com
597+```
598+
599+### Nextcloud Provider
600+
601+The Nextcloud provider allows you to authenticate against users in your
602+Nextcloud instance.
603+
604+When you are using the Nextcloud provider, you must specify the urls via
605+configuration, environment variable, or command line argument. Depending
606+on whether your Nextcloud instance is using pretty urls your urls may be of the
607+form `/index.php/apps/oauth2/*` or `/apps/oauth2/*`.
608+
609+Refer to the [OAuth2
610+documentation](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/oauth2.html)
611+to setup the client id and client secret. Your "Redirection URI" will be
612+`https://internalapp.yourcompany.com/oauth2/callback`.
613+
614+```
615+ -provider nextcloud
616+ -client-id <from nextcloud admin>
617+ -client-secret <from nextcloud admin>
618+ -login-url="<your nextcloud url>/index.php/apps/oauth2/authorize"
619+ -redeem-url="<your nextcloud url>/index.php/apps/oauth2/api/v1/token"
620+ -validate-url="<your nextcloud url>/ocs/v2.php/cloud/user?format=json"
621+```
622+
623+Note: in *all* cases the validate-url will *not* have the `index.php`.
624+
625+### DigitalOcean Auth Provider
626+
627+1. [Create a new OAuth application](https://cloud.digitalocean.com/account/api/applications)
628+ * You can fill in the name, homepage, and description however you wish.
629+ * In the "Application callback URL" field, enter: `https://oauth-proxy/oauth2/callback`, substituting `oauth2-proxy` with the actual hostname that oauth2-proxy is running on. The URL must match oauth2-proxy's configured redirect URL.
630+2. Note the Client ID and Client Secret.
631+
632+To use the provider, pass the following options:
633+
634+```
635+ --provider=digitalocean
636+ --client-id=<Client ID>
637+ --client-secret=<Client Secret>
638+```
639+
640+ Alternatively, set the equivalent options in the config file. The redirect URL defaults to `https://<requested host header>/oauth2/callback`. If you need to change it, you can use the `--redirect-url` command-line option.
641+
642+### Bitbucket Auth Provider
643+
644+1. [Add a new OAuth consumer](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html)
645+ * In "Callback URL" use `https://<oauth2-proxy>/oauth2/callback`, substituting `<oauth2-proxy>` with the actual hostname that oauth2-proxy is running on.
646+ * In Permissions section select:
647+ * Account -> Email
648+ * Team membership -> Read
649+ * Repositories -> Read
650+2. Note the Client ID and Client Secret.
651+
652+To use the provider, pass the following options:
653+
654+```
655+ --provider=bitbucket
656+ --client-id=<Client ID>
657+ --client-secret=<Client Secret>
658+```
659+
660+The default configuration allows everyone with Bitbucket account to authenticate. To restrict the access to the team members use additional configuration option: `--bitbucket-team=<Team name>`. To restrict the access to only these users who has access to one selected repository use `--bitbucket-repository=<Repository name>`.
661+
662+
663+### Gitea Auth Provider
664+
665+1. Create a new application: `https://< your gitea host >/user/settings/applications`
666+2. Under `Redirect URI` enter the correct URL i.e. `https://<proxied host>/oauth2/callback`
667+3. Note the Client ID and Client Secret.
668+4. Pass the following options to the proxy:
669+
670+```
671+ --provider="github"
672+ --redirect-url="https://<proxied host>/oauth2/callback"
673+ --provider-display-name="Gitea"
674+ --client-id="< client_id as generated by Gitea >"
675+ --client-secret="< client_secret as generated by Gitea >"
676+ --login-url="https://< your gitea host >/login/oauth/authorize"
677+ --redeem-url="https://< your gitea host >/login/oauth/access_token"
678+ --validate-url="https://< your gitea host >/api/v1"
679+```
680+
681+
682+## Email Authentication
683+
684+To authorize by email domain use `--email-domain=yourcompany.com`. To authorize individual email addresses use `--authenticated-emails-file=/path/to/file` with one email per line. To authorize all email addresses use `--email-domain=*`.
685+
686+## Adding a new Provider
687+
688+Follow the examples in the [`providers` package](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/providers/) to define a new
689+`Provider` instance. Add a new `case` to
690+[`providers.New()`](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/providers/providers.go) to allow `oauth2-proxy` to use the
691+new `Provider`.