dynamo

README

DynamoDB Storage for OAuth 2.0

Based on the https://github.com/go-oauth2/mongo

Install

$ go get -u github.com/ajpetersons/go-oauth2-dynamodb

Usage (specifying credentials)

package main

import (
	"github.com/ajpetersons/go-oauth2-dynamodb"
	"github.com/go-oauth2/oauth2/v4.manage"
)

func main() {
	manager := manage.NewDefaultManager()
	manager.MustTokenStorage(
		dynamo.NewTokenStore(dynamo.NewConfig(
			"us-east-1", // AWS Region
			"http://localhost:8000", // AWS DynamoDB Endpoint
			"AKIA*********", // AWS Access Key
			"*************", // AWS Secret
                        "oauth2_basic", // Oauth2 basic table name
			"oauth2_access", // Oauth2 access table name
			"oauth2_refresh", // Oauth2 refresh table name
		)),
	)
	// ...
}

Usage (with IAM Role configured for ec2 or Lambda)

package main

import (
	"github.com/ajpetersons/go-oauth2-dynamodb"
	"github.com/go-oauth2/oauth2/v4.manage"
)

func main() {
	manager := manage.NewDefaultManager()
	manager.MustTokenStorage(
		dynamo.NewTokenStore(dynamo.NewConfig(
			"us-east-1", // AWS Region
			"", // Emtpy
			"", // Emtpy
			"", // Emtpy
			"oauth2_basic", // Oauth2 basic table name
                        "oauth2_access", // Oauth2 access table name
                        "oauth2_refresh", // Oauth2 refresh table name

		)),
	)
	// ...
}

Run tests

Start dynamodb local

java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb 

Export env variables

export AWS_REGION=us-east-1
export DYNAMODB_ENDPOINT='http://localhost:8000'
export AWS_ACCESS_KEY=AKIA******
export AWS_SECRET=**************

Run tests

go test

MIT License

Copyright (c) 2021 Artūrs Jānis Pētersons

Documentation

Index

• func CreateWithAccessToken(tokenStorage *TokenStore, info oauth2.TokenInfo, id string) (err error)
• func CreateWithAuthorizationCode(tokenStorage *TokenStore, info oauth2.TokenInfo, id string) (err error)
• func CreateWithRefreshToken(tokenStorage *TokenStore, info oauth2.TokenInfo) (err error)
• func NewTokenStore(config *Config) (store oauth2.TokenStore)
• type Config
  • func NewConfig(...) (config *Config, err error)
• type TableConfig
• type TokenStore
  • func (tokenStorage *TokenStore) Create(ctx context.Context, info oauth2.TokenInfo) (err error)
  • func (tokenStorage *TokenStore) GetByAccess(ctx context.Context, access string) (to oauth2.TokenInfo, err error)
  • func (tokenStorage *TokenStore) GetByCode(ctx context.Context, code string) (to oauth2.TokenInfo, err error)
  • func (tokenStorage *TokenStore) GetByRefresh(ctx context.Context, refresh string) (to oauth2.TokenInfo, err error)
  • func (tokenStorage *TokenStore) RemoveByAccess(ctx context.Context, access string) (err error)
  • func (tokenStorage *TokenStore) RemoveByCode(ctx context.Context, code string) (err error)
  • func (tokenStorage *TokenStore) RemoveByRefresh(ctx context.Context, refresh string) (err error)

Functions

func CreateWithAccessToken

func CreateWithAccessToken(
	tokenStorage *TokenStore, info oauth2.TokenInfo, id string,
) (err error)

func CreateWithAuthorizationCode

func CreateWithAuthorizationCode(
	tokenStorage *TokenStore, info oauth2.TokenInfo, id string,
) (err error)

func CreateWithRefreshToken

func CreateWithRefreshToken(
	tokenStorage *TokenStore, info oauth2.TokenInfo,
) (err error)

func NewTokenStore

func NewTokenStore(config *Config) (store oauth2.TokenStore)

Types

type Config

type Config struct {
	AWSCONFIG        *aws.Config
	TABLE            *TableConfig
	ENDPOINT         string
	CONSISTENT_READS bool
}

Config dynamodb configuration parameters

func NewConfig

func NewConfig(region, endpoint, accessKey, secret, basicTableName, accessTableName, refreshTableName string) (config *Config, err error)

NewConfig create dynamodb configuration

type TableConfig

type TableConfig struct {
	BasicCname   string
	AccessCName  string
	RefreshCName string
}

type TokenStore

type TokenStore struct {
	// contains filtered or unexported fields
}

func (*TokenStore) Create

func (tokenStorage *TokenStore) Create(
	ctx context.Context, info oauth2.TokenInfo,
) (err error)

Create and store the new token information

func (*TokenStore) GetByAccess

func (tokenStorage *TokenStore) GetByAccess(
	ctx context.Context, access string,
) (to oauth2.TokenInfo, err error)

GetByAccess use the access token for token information data

func (*TokenStore) GetByCode

func (tokenStorage *TokenStore) GetByCode(
	ctx context.Context, code string,
) (to oauth2.TokenInfo, err error)

GetByCode use the authorization code for token information data

func (*TokenStore) GetByRefresh

func (tokenStorage *TokenStore) GetByRefresh(
	ctx context.Context, refresh string,
) (to oauth2.TokenInfo, err error)

GetByRefresh use the refresh token for token information data

func (*TokenStore) RemoveByAccess

func (tokenStorage *TokenStore) RemoveByAccess(
	ctx context.Context, access string,
) (err error)

RemoveByAccess use the access token to delete the token information

func (*TokenStore) RemoveByCode

func (tokenStorage *TokenStore) RemoveByCode(
	ctx context.Context, code string,
) (err error)

RemoveByCode use the authorization code to delete the token information

func (*TokenStore) RemoveByRefresh

func (tokenStorage *TokenStore) RemoveByRefresh(
	ctx context.Context, refresh string,
) (err error)

RemoveByRefresh use the refresh token to delete the token information