2019-04-14 16:42:11 +08:00
---
date: "2019-04-19:44:00+01:00"
title: "OAuth2 provider"
slug: "oauth2-provider"
weight: 41
2020-12-09 14:47:06 +08:00
toc: false
2019-04-14 16:42:11 +08:00
draft: false
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00
aliases:
- /en-us/oauth2-provider
2019-04-14 16:42:11 +08:00
menu:
sidebar:
2023-03-23 23:18:24 +08:00
parent: "development"
2019-04-14 16:42:11 +08:00
name: "OAuth2 Provider"
weight: 41
identifier: "oauth2-provider"
---
# OAuth2 provider
2020-12-09 14:47:06 +08:00
**Table of Contents**
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
{{< toc > }}
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
Gitea supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent. This feature is available since release 1.8.0.
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
## Endpoints
2019-04-14 16:42:11 +08:00
2021-06-18 05:56:46 +08:00
| Endpoint | URL |
| ------------------------ | ----------------------------------- |
| OpenID Connect Discovery | `/.well-known/openid-configuration` |
| Authorization Endpoint | `/login/oauth/authorize` |
| Access Token Endpoint | `/login/oauth/access_token` |
| OpenID Connect UserInfo | `/login/oauth/userinfo` |
| JSON Web Key Set | `/login/oauth/keys` |
2019-04-14 16:42:11 +08:00
## Supported OAuth2 Grants
2021-01-02 00:33:27 +08:00
At the moment Gitea only supports the [**Authorization Code Grant** ](https://tools.ietf.org/html/rfc6749#section-1.3.1 ) standard with additional support of the following extensions:
2022-07-28 09:22:47 +08:00
2021-01-02 00:33:27 +08:00
- [Proof Key for Code Exchange (PKCE) ](https://tools.ietf.org/html/rfc7636 )
- [OpenID Connect (OIDC) ](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth )
2020-11-28 14:12:22 +08:00
2019-04-14 16:42:11 +08:00
To use the Authorization Code Grant as a third party application it is required to register a new application via the "Settings" (`/user/settings/applications`) section of the settings.
## Scopes
2023-01-18 05:46:03 +08:00
Gitea supports the following scopes for tokens:
| Name | Description |
| ---- | ----------- |
| ** (no scope)** | Grants read-only access to public user profile and public repositories. |
| **repo** | Full control over all repositories. |
| **repo:status** | Grants read/write access to commit status in all repositories. |
| **public_repo** | Grants read/write access to public repositories only. |
| **admin:repo_hook** | Grants access to repository hooks of all repositories. This is included in the `repo` scope. |
| **write:repo_hook** | Grants read/write access to repository hooks |
| **read:repo_hook** | Grants read-only access to repository hooks |
| **admin:org** | Grants full access to organization settings |
| **write:org** | Grants read/write access to organization settings |
| **read:org** | Grants read-only access to organization settings |
| **admin:public_key** | Grants full access for managing public keys |
| **write:public_key** | Grant read/write access to public keys |
| **read:public_key** | Grant read-only access to public keys |
| **admin:org_hook** | Grants full access to organizational-level hooks |
2023-03-10 22:28:32 +08:00
| **admin:user_hook** | Grants full access to user-level hooks |
2023-01-18 05:46:03 +08:00
| **notification** | Grants full access to notifications |
| **user** | Grants full access to user profile info |
| **read:user** | Grants read access to user's profile |
| **user:email** | Grants read access to user's email addresses |
| **user:follow** | Grants access to follow/un-follow a user |
| **delete_repo** | Grants access to delete repositories as an admin |
| **package** | Grants full access to hosted packages |
| **write:package** | Grants read/write access to packages |
| **read:package** | Grants read access to packages |
| **delete:package** | Grants delete access to packages |
| **admin:gpg_key** | Grants full access for managing GPG keys |
| **write:gpg_key** | Grants read/write access to GPG keys |
| **read:gpg_key** | Grants read-only access to GPG keys |
| **admin:application** | Grants full access to manage applications |
| **write:application** | Grants read/write access for managing applications |
| **read:application** | Grants read access for managing applications |
| **sudo** | Allows to perform actions as the site admin. |
2019-04-14 16:42:11 +08:00
2022-10-24 15:59:24 +08:00
## Client types
Gitea supports both confidential and public client types, [as defined by RFC 6749 ](https://datatracker.ietf.org/doc/html/rfc6749#section-2.1 ).
For public clients, a redirect URI of a loopback IP address such as `http://127.0.0.1/` allows any port. Avoid using `localhost` , [as recommended by RFC 8252 ](https://datatracker.ietf.org/doc/html/rfc8252#section-8.3 ).
2019-04-14 16:42:11 +08:00
## Example
**Note:** This example does not use PKCE.
2022-06-26 06:50:12 +08:00
1. Redirect to user to the authorization endpoint in order to get their consent for accessing the resources:
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
```curl
2023-05-27 02:16:48 +08:00
https://[YOUR-GITEA-URL]/login/oauth/authorize?client_id=CLIENT_ID& redirect_uri=REDIRECT_URI& response_type=code& state=STATE
2020-12-09 14:47:06 +08:00
```
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
The `CLIENT_ID` can be obtained by registering an application in the settings. The `STATE` is a random string that will be send back to your application after the user authorizes. The `state` parameter is optional but should be used to prevent CSRF attacks.
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
![Authorization Page ](/authorize.png )
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
The user will now be asked to authorize your application. If they authorize it, the user will be redirected to the `REDIRECT_URL` , for example:
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
```curl
https://[REDIRECT_URI]?code=RETURNED_CODE& state=STATE
```
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
2. Using the provided `code` from the redirect, you can request a new application and refresh token. The access token endpoints accepts POST requests with `application/json` and `application/x-www-form-urlencoded` body, for example:
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
```curl
POST https://[YOUR-GITEA-URL]/login/oauth/access_token
```
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
```json
{
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"code": "RETURNED_CODE",
"grant_type": "authorization_code",
"redirect_uri": "REDIRECT_URI"
}
```
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
Response:
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
```json
{
"access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJnbnQiOjIsInR0IjowLCJleHAiOjE1NTUxNzk5MTIsImlhdCI6MTU1NTE3NjMxMn0.0-iFsAwBtxuckA0sNZ6QpBQmywVPz129u75vOM7wPJecw5wqGyBkmstfJHAjEOqrAf_V5Z-1QYeCh_Cz4RiKug",
"token_type": "bearer",
"expires_in": 3600,
"refresh_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJnbnQiOjIsInR0IjoxLCJjbnQiOjEsImV4cCI6MTU1NzgwNDMxMiwiaWF0IjoxNTU1MTc2MzEyfQ.S_HZQBy4q9r5SEzNGNIoFClT43HPNDbUdHH-GYNYYdkRfft6XptJBkUQscZsGxOW975Yk6RbgtGvq1nkEcklOw"
}
```
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
The `CLIENT_SECRET` is the unique secret code generated for this application. Please note that the secret will only be visible after you created/registered the application with Gitea and cannot be recovered. If you lose the secret you must regenerate the secret via the application's settings.
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
The `REDIRECT_URI` in the `access_token` request must match the `REDIRECT_URI` in the `authorize` request.
2019-04-14 16:42:11 +08:00
2020-12-09 14:47:06 +08:00
3. Use the `access_token` to make [API requests ](https://docs.gitea.io/en-us/api-usage#oauth2 ) to access the user's resources.