This service implements OAuth 2.0 specification. Excerpts from the specification are included in this README file to describe different grant types. Please read the full spec for more detailed information.
- OAuth 2.0
- Plugins
- Session Storage
- Dependencies
- Setup
- Compile & Run Data
- Testing
- Docker
- Docker Compose
- Supporting the project
http://tools.ietf.org/html/rfc6749#section-3.2.1
Clients must authenticate with client credentials (client ID and secret) when issuing requests to /v1/oauth/tokens endpoint. Basic HTTP authentication should be used.
http://tools.ietf.org/html/rfc6749#section-4.1
The authorization code grant type is used to obtain both access tokens and refresh tokens and is optimized for confidential clients. Since this is a redirection-based flow, the client must be capable of interacting with the resource owner's user-agent (typically a web browser) and capable of receiving incoming requests (via redirection) from the authorization server.
+----------+
| Resource |
| Owner |
| |
+----------+
^
|
(B)
+----|-----+ Client Identifier +---------------+
| -+----(A)-- & Redirection URI ---->| |
| User- | | Authorization |
| Agent -+----(B)-- User authenticates --->| Server |
| | | |
| -+----(C)-- Authorization Code ---<| |
+-|----|---+ +---------------+
| | ^ v
(A) (C) | |
| | | |
^ v | |
+---------+ | |
| |>---(D)-- Authorization Code ---------' |
| Client | & Redirection URI |
| | |
| |<---(E)----- Access Token -------------------'
+---------+ (w/ Optional Refresh Token)
The client initiates the flow by directing the resource owner's user-agent to the authorization endpoint. The client includes its client identifier, requested scope, local state, and a redirection URI to which the authorization server will send the user-agent back once access is granted (or denied).
http://localhost:8080/web/authorize?client_id=test_client_1&redirect_uri=https%3A%2F%2Fwww.example.com&response_type=code&state=somestate&scope=read_write
The authorization server authenticates the resource owner (via the user-agent).
The authorization server then establishes whether the resource owner grants or denies the client's access request.
If the request fails due to a missing, invalid, or mismatching redirection URI, or if the client identifier is missing or invalid, the authorization server SHOULD inform the resource owner of the error and MUST NOT automatically redirect the user-agent to the invalid redirection URI.
If the resource owner denies the access request or if the request fails for reasons other than a missing or invalid redirection URI, the authorization server informs the client by adding the error parameter to the query component of the redirection URI.
https://www.example.com/?error=access_denied&state=somestate
Assuming the resource owner grants access, the authorization server redirects the user-agent back to the client using the redirection URI provided earlier (in the request or during client registration). The redirection URI includes an authorization code and any local state provided by the client earlier.
https://www.example.com/?code=7afb1c55-76e4-4c76-adb7-9d657cb47a27&state=somestate
The client requests an access token from the authorization server's token endpoint by including the authorization code received in the previous step. When making the request, the client authenticates with the authorization server. The client includes the redirection URI used to obtain the authorization code for verification.
curl --compressed -v localhost:8080/v1/oauth/tokens \
-u test_client_1:test_secret \
-d "grant_type=authorization_code" \
-d "code=7afb1c55-76e4-4c76-adb7-9d657cb47a27" \
-d "redirect_uri=https://www.example.com"The authorization server authenticates the client, validates the authorization code, and ensures that the redirection URI received matches the URI used to redirect the client before. If valid, the authorization server responds back with an access token and, optionally, a refresh token.
{
"user_id": "1",
"access_token": "00ccd40e-72ca-4e79-a4b6-67c95e2e3f1c",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "read_write",
"refresh_token": "6fd8d272-375a-4d8a-8d0f-43367dc8b791"
}http://tools.ietf.org/html/rfc6749#section-4.2
The implicit grant type is used to obtain access tokens (it does not support the issuance of refresh tokens) and is optimized for public clients known to operate a particular redirection URI. These clients are typically implemented in a browser using a scripting language such as JavaScript.
Since this is a redirection-based flow, the client must be capable of interacting with the resource owner's user-agent (typically a web browser) and capable of receiving incoming requests (via redirection) from the authorization server.
Unlike the authorization code grant type, in which the client makes separate requests for authorization and for an access token, the client receives the access token as the result of the authorization request.
The implicit grant type does not include client authentication, and relies on the presence of the resource owner and the registration of the redirection URI. Because the access token is encoded into the redirection URI, it may be exposed to the resource owner and other applications residing on the same device.
+----------+
| Resource |
| Owner |
| |
+----------+
^
|
(B)
+----|-----+ Client Identifier +---------------+
| -+----(A)-- & Redirection URI --->| |
| User- | | Authorization |
| Agent -|----(B)-- User authenticates -->| Server |
| | | |
| |<---(C)--- Redirection URI ----<| |
| | with Access Token +---------------+
| | in Fragment
| | +---------------+
| |----(D)--- Redirection URI ---->| Web-Hosted |
| | without Fragment | Client |
| | | Resource |
| (F) |<---(E)------- Script ---------<| |
| | +---------------+
+-|--------+
| |
(A) (G) Access Token
| |
^ v
+---------+
| |
| Client |
| |
+---------+
The client initiates the flow by directing the resource owner's user-agent to the authorization endpoint. The client includes its client identifier, requested scope, local state, and a redirection URI to which the authorization server will send the user-agent back once access is granted (or denied).
http://localhost:8080/web/authorize?client_id=test_client_1&redirect_uri=https%3A%2F%2Fwww.example.com&response_type=token&state=somestate&scope=read_write
The authorization server authenticates the resource owner (via the user-agent).
The authorization server then establishes whether the resource owner grants or denies the client's access request.
If the request fails due to a missing, invalid, or mismatching redirection URI, or if the client identifier is missing or invalid, the authorization server SHOULD inform the resource owner of the error and MUST NOT automatically redirect the user-agent to the invalid redirection URI.
If the resource owner denies the access request or if the request fails for reasons other than a missing or invalid redirection URI, the authorization server informs the client by adding the following parameters to the fragment component of the redirection URI.
https://www.example.com/#error=access_denied&state=somestate
Assuming the resource owner grants access, the authorization server redirects the user-agent back to the client using the redirection URI provided earlier. The redirection URI includes he access token in the URI fragment.
https://www.example.com/#access_token=087902d5-29e7-417b-a339-b57a60d6742a&expires_in=3600&scope=read_write&state=somestate&token_type=Bearer
The user-agent follows the redirection instructions by making a request to the web-hosted client resource (which does not include the fragment per [RFC2616]). The user-agent retains the fragment information locally.
The web-hosted client resource returns a web page (typically an HTML document with an embedded script) capable of accessing the full redirection URI including the fragment retained by the user-agent, and extracting the access token (and other parameters) contained in the fragment.
The user-agent executes the script provided by the web-hosted client resource locally, which extracts the access token.
The user-agent passes the access token to the client.
http://tools.ietf.org/html/rfc6749#section-4.3
The resource owner password credentials grant type is suitable in cases where the resource owner has a trust relationship with the client, such as the device operating system or a highly privileged application. The authorization server should take special care when enabling this grant type and only allow it when other flows are not viable.
This grant type is suitable for clients capable of obtaining the resource owner's credentials (username and password, typically using an interactive form). It is also used to migrate existing clients using direct authentication schemes such as HTTP Basic or Digest authentication to OAuth by converting the stored credentials to an access token.
+----------+
| Resource |
| Owner |
| |
+----------+
v
| Resource Owner
(A) Password Credentials
|
v
+---------+ +---------------+
| |>--(B)---- Resource Owner ------->| |
| | Password Credentials | Authorization |
| Client | | Server |
| |<--(C)---- Access Token ---------<| |
| | (w/ Optional Refresh Token) | |
+---------+ +---------------+
The resource owner provides the client with its username and password.
The client requests an access token from the authorization server's token endpoint by including the credentials received from the resource owner. When making the request, the client authenticates with the authorization server.
curl --compressed -v localhost:8080/v1/oauth/tokens \
-u test_client_1:test_secret \
-d "grant_type=password" \
-d "username=test@user" \
-d "password=test_password" \
-d "scope=read_write"The authorization server authenticates the client and validates the resource owner credentials, and if valid, issues an access token.
{
"user_id": "1",
"access_token": "00ccd40e-72ca-4e79-a4b6-67c95e2e3f1c",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "read_write",
"refresh_token": "6fd8d272-375a-4d8a-8d0f-43367dc8b791"
}http://tools.ietf.org/html/rfc6749#section-4.4
The client can request an access token using only its client credentials (or other supported means of authentication) when the client is requesting access to the protected resources under its control, or those of another resource owner that have been previously arranged with the authorization server (the method of which is beyond the scope of this specification).
The client credentials grant type MUST only be used by confidential clients.
+---------+ +---------------+
| | | |
| |>--(A)- Client Authentication --->| Authorization |
| Client | | Server |
| |<--(B)---- Access Token ---------<| |
| | | |
+---------+ +---------------+
The client authenticates with the authorization server and requests an access token from the token endpoint.
curl --compressed -v localhost:8080/v1/oauth/tokens \
-u test_client_1:test_secret \
-d "grant_type=client_credentials" \
-d "scope=read_write"The authorization server authenticates the client, and if valid, issues an access token.
{
"access_token": "00ccd40e-72ca-4e79-a4b6-67c95e2e3f1c",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "read_write",
"refresh_token": "6fd8d272-375a-4d8a-8d0f-43367dc8b791"
}http://tools.ietf.org/html/rfc6749#section-6
If the authorization server issued a refresh token to the client, the client can make a refresh request to the token endpoint in order to refresh the access token.
curl --compressed -v localhost:8080/v1/oauth/tokens \
-u test_client_1:test_secret \
-d "grant_type=refresh_token" \
-d "refresh_token=6fd8d272-375a-4d8a-8d0f-43367dc8b791"The authorization server MUST:
-
require client authentication for confidential clients or for any client that was issued client credentials (or with other authentication requirements),
-
authenticate the client if client authentication is included and ensure that the refresh token was issued to the authenticated client, and
-
validate the refresh token.
If valid and authorized, the authorization server issues an access token.
{
"user_id": "1",
"access_token": "1f962bd5-7890-435d-b619-584b6aa32e6c",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "read_write",
"refresh_token": "3a6b45b8-9d29-4cba-8a1b-0093e8a2b933"
}The authorization server MAY issue a new refresh token, in which case the client MUST discard the old refresh token and replace it with the new refresh token. The authorization server MAY revoke the old refresh token after issuing a new refresh token to the client. If a new refresh token is issued, the refresh token scope MUST be identical to that of the refresh token included by the client in the request.
https://tools.ietf.org/html/rfc7662
If the authorization server issued a access token or refresh token to the client, the client can make a request to the introspect endpoint in order to learn meta-information about a token.
curl --compressed -v localhost:8080/v1/oauth/introspect \
-u test_client_1:test_secret \
-d "token=00ccd40e-72ca-4e79-a4b6-67c95e2e3f1c" \
-d "token_type_hint=access_token"The authorization server responds meta-information about a token.
{
"active": true,
"scope": "read_write",
"client_id": "test_client_1",
"username": "test@username",
"token_type": "Bearer",
"exp": 1454868090
}This server is easily extended or modified through the use of plugins. Four services, health, oauth, session and web are available for modification.
In order to implement a plugin:
- Create your own interface that implements all of methods of the service you are replacing.
- Modify
cmd/run_server.goto use your service by calling thesession.Use[service-you-are-replaceing]Service(yourCustomService.NewService())before the services are initialized viaservices.Init(cnf, db).
For example, to implement an available redis session storage plugin:
// $ go get https://github.com/adam-hanna/redis-sessions
//
// cmd/run_server.go
import (
...
"github.com/adam-hanna/redis-sessions/redis"
...
)
// RunServer runs the app
func RunServer(configBackend string) error {
...
// configure redis for session store
sessionSecrets := make([][]byte, 1)
sessionSecrets[0] = []byte(cnf.Session.Secret)
redisConfig := redis.ConfigType{
Size: 10,
Network: "tcp",
Address: ":6379",
Password: "",
SessionSecrets: sessionSecrets,
}
// start the services
services.UseSessionService(redis.NewService(cnf, redisConfig))
if err := services.InitServices(cnf, db); err != nil {
return err
}
defer services.CloseServices()
...
}By default, this server implements in-memory, cookie sessions via gorilla sessions.
However, because the session service can be replaced via a plugin, any of the available gorilla sessions store implementations can be wrapped by session.ServiceInterface.
Since Go 1.11, a new recommended dependency management system is via modules.
This is one of slight weaknesses of Go as dependency management is not a solved problem. Previously Go was officially recommending to use the dep tool but that has been abandoned now in favor of modules.
For distributed config storage you can use either etcd or consul (etcd being the default)
If you are developing on OSX, install etcd or consul, Postgres and nats-streaming-server:
brew install etcdLoad a development configuration into etcd:
ETCDCTL_API=3 etcdctl put /config/go_oauth2_server.json '{
"Database": {
"Type": "postgres",
"Host": "localhost",
"Port": 5432,
"User": "go_oauth2_server",
"Password": "",
"DatabaseName": "go_oauth2_server",
"MaxIdleConns": 5,
"MaxOpenConns": 5
},
"Oauth": {
"AccessTokenLifetime": 3600,
"RefreshTokenLifetime": 1209600,
"AuthCodeLifetime": 3600
},
"Session": {
"Secret": "test_secret",
"Path": "/",
"MaxAge": 604800,
"HTTPOnly": true
},
"IsDevelopment": true
}'If you are using etcd API version 3, use etcdctl put instead of etcdctl set.
Check the config was loaded properly:
ETCDCTL_API=3 etcdctl get /config/go_oauth2_server.jsonbrew install consulLoad a development configuration into consul:
consul kv put /config/go_oauth2_server.json '{
"Database": {
"Type": "postgres",
"Host": "localhost",
"Port": 5432,
"User": "go_oauth2_server",
"Password": "",
"DatabaseName": "go_oauth2_server",
"MaxIdleConns": 5,
"MaxOpenConns": 5
},
"Oauth": {
"AccessTokenLifetime": 3600,
"RefreshTokenLifetime": 1209600,
"AuthCodeLifetime": 3600
},
"Session": {
"Secret": "test_secret",
"Path": "/",
"MaxAge": 604800,
"HTTPOnly": true
},
"IsDevelopment": true
}'Check the config was loaded properly:
consul kv get /config/go_oauth2_server.jsonbrew install postgresYou might want to create a Postgres database:
createuser --createdb go_oauth2_server
createdb -U go_oauth2_server go_oauth2_serverCompile the app:
go install .The binary accepts an optional flag of --configBackend which can be set to etcd | consul, defaults to etcd
Run migrations:
go-oauth2-server migrateAnd finally, run the app:
go-oauth2-server runserverWhen deploying, you can set etcd related environment variables:
ETCD_ENDPOINTSETCD_CERT_FILEETCD_KEY_FILEETCD_CA_FILEETCD_CONFIG_PATH
You can also set consul related variables
CONSUL_ENDPOINTCONSUL_CERT_FILECONSUL_KEY_FILECONSUL_CA_FILECONSUL_CONFIG_PATH
and the equivalent above commands would be
go-oauth2-server --configBackend consul migratego-oauth2-server --configBackend consul runserverI have used a mix of unit and functional tests so you need to have sqlite installed in order for the tests to run successfully as the suite creates an in-memory database.
To run tests:
make testBuild a Docker image and run the app in a container:
docker build -t go-oauth2-server:latest .
docker run -e ETCD_ENDPOINTS=localhost:2379 -p 8080:8080 --name go-oauth2-server go-oauth2-server:latestYou can load fixtures with docker exec command:
docker exec <container_id> /go/bin/go-oauth2-server loaddata \
oauth/fixtures/scopes.yml \
oauth/fixtures/roles.yml \
oauth/fixtures/test_clients.ymlYou can use docker-compose to start the app, postgres, etcd in separate linked containers:
docker-compose upDuring docker-compose up process all configuration and fixtures will be loaded. After successful up you can check, that app is running using for example the health check request:
curl --compressed -v localhost:8080/v1/healthDonate BTC to my wallet if you find this project useful: 12iFVjQ5n3Qdmiai4Mp9EG93NSvDipyRKV
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent