OAuth2 multi-user token client

This package provides a multi-user token client for OAuth2. Based on golang.org/x/oauth2.

• OAuth2 multi-user token client
  • Install
  • Motivation / Why not golang.org/x/oauth2
    • Multi User
    • Store Refresh Token
  • How to use
    • Create TokenStore
    • Create tokenhttp.Client
    • Use tokenhttp.Client
  • Zoom helper

Install

go get github.com/araj-dev/muoauth@latest

Motivation / Why not golang.org/x/oauth2

Multi User

golang.org/x/oauth2 provides a token client for a single user.

config := &oauth2.Config{
	ClientID: "clientid",
	//...
}
tokenSource := config.TokenSource(ctx, &oauth2.token{RefreshToken: "xxxxxx"})
client := oauth2.NewClient(ctx, tokenSource)

client.Do(...)

that client refresh token automatically when it is expired. but it has a single oauth user in one client. we don't want to create a client for each user.

So this package add id argument in http.Client functions to identify a user.

db, err := sql.Open("mysql", os.Getenv("DSN"))
if err != nil {
panic(err)
}
defer db.Close()

oc := &oauth2.Config{
    ClientID: "clientid",
    //...
}
// Need oauth2 config and db connection.
// Database connection is used as persistent store.
s := store.NewTokenStore(oc, db)

// Pass store to tokenhttp.NewClient
// tokenhttp.NewClient will refresh token automatically.
// and it save token to database.
c := tokenhttp.NewClient(s)

req := http.NewRequest(...)

// pass client to identify a user
// identity can be any string, it is used to identify a which token re-use or re-load from persistent.
c.Do("identity", req)

Store Refresh Token

This package automatically refresh token when it is expired and save it to persistent store.

store/persistent.go provides MySQL persistent implementation.

If you want to use other type persistent, you can implement store.TokenStore interface.

How to use

Create TokenStore

db, err := sql.Open("mysql", os.Getenv("DSN"))
if err != nil {
panic(err)
}
defer db.Close()
oc := &oauth2.Config{
    ClientID: "clientid",
    //...
	endpoint: oauth2.Endpoint{
        TokenURL: "https://example.com/token",
    },// or use pre-defined endpoints in golang.org/x/oauth2 (e.g: google.Endpoint, endpoints.Zoom,...)
}
// Need oauth2 config and db connection.
// Database connection is used as persistent store.
s := store.NewTokenStore(oc, db)

Create tokenhttp.Client

c := tokenhttp.NewClient(s)

Use tokenhttp.Client

// use http package to create request
req := http.NewRequest(...)
// pass client to identify a user
// identity can be any string, it is used to identify a which token re-use or re-load from persistent.
c.Do("identity", req)

Zoom helper

If you want to use Zoom API, you can use zoom.NewClient to create a client. zoomapi package contains a generated go file from OpenAPI schema provided from Zoom API. Open API Schema file is in oas/oas.yaml Actually it is not a complete implementation of Zoom API, but it is enough for my use case. If you want to add mode API, you can add implementation in zoom package. zoom/zoom.go

See example/main.go for more detail.

// create zoom client
db, err := sql.Open("mysql", os.Getenv("DSN"))
if err != nil {
  panic(err)
}
defer db.Close()
oc := oauth2.Config{
  ClientID: "clientid",
  ClientSecret: "secret"
  Endpoint: endpoints.Zoom,
}
s := store.NewTokenStore(oc, db)

c := zoom.NewClient(s)

// self info endpoint
// and response is typed by generated golang struct.
res := c.Me("token-id")

TODO:

[] Add more test [] Add more API for Zoom [] Add more example [] Add MySQL table definition for persistent store [] Add more persistent store implementation (e.g: Redis, Postgres,...) [] Improve Store Interface (around Crypto) [] Improve golang map race condition.