corner

README

corner

• OAUTH2 GRPC Interceptor
• OAUTH2 Gin-Gonic Middleware

publish

➜ git tag <version>
➜ git push origin --tags
➜ GOPROXY=proxy.golang.org go list -m github.com/bb-labs/corner@<version>

Documentation

Index

• Constants
• type AuthHeaders
  • func GetAuthHeaders(headers Headers) AuthHeaders
• type AuthInterceptor
  • func New(providers ...*Provider) *AuthInterceptor
  • func (cb *AuthInterceptor) GinAuthenticator(ctx *gin.Context)
  • func (cb *AuthInterceptor) UnaryServerInterceptor(ctx context.Context, req any, info *grpc.UnaryServerInfo, ...) (any, error)
• type Config
• type Headers
• type Provide
• type Provider
  • func NewAppleProvider(ctx context.Context, config Config) (*Provider, error)
  • func (p *Provider) Redeem(ctx context.Context, headers AuthHeaders) (*oauth2.Token, error)
  • func (p *Provider) Refresh(ctx context.Context, headers AuthHeaders) (*oauth2.Token, error)
  • func (p *Provider) Verify(ctx context.Context, headers AuthHeaders) (*oidc.IDToken, error)

Constants

const (
	AuthCodeHeader          = "x-auth-code"
	AuthTokenHeader         = "authorization"
	AuthTokenHeaderInternal = "id_token"
	AuthRefreshHeader       = "x-auth-refresh"
)

const (
	AppleProviderURL = "https://appleid.apple.com"
)

OIDC specific provider URLs

Types

type AuthHeaders

type AuthHeaders struct {
	AuthCode    string
	AuthToken   string
	AuthRefresh string
}

func GetAuthHeaders

func GetAuthHeaders(headers Headers) AuthHeaders

type AuthInterceptor

type AuthInterceptor struct {
	Providers []*Provider
}

AuthInterceptor provides various middleware that authenticate requests using the given providers.

func New

func New(providers ...*Provider) *AuthInterceptor

New returns a new AuthInterceptor that uses the given providers to authenticate requests.

func (*AuthInterceptor) GinAuthenticator

func (cb *AuthInterceptor) GinAuthenticator(ctx *gin.Context)

AuthMiddleware returns a new middleware that performs per-request auth.

func (*AuthInterceptor) UnaryServerInterceptor

func (cb *AuthInterceptor) UnaryServerInterceptor(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (any, error)

UnaryServerInterceptor returns a new grpc unary server interceptor that authenticates requests using the given providers.

type Config

type Config struct {

	// Client credentials
	ClientID     string
	ClientSecret string

	// Skip various checks
	SkipChecks bool
	// contains filtered or unexported fields
}

Config represents the configuration for an OpenID Connect provider.

type Headers

type Headers map[string][]string

type Provide

type Provide interface {
	Verify(ctx context.Context) (bool, error)
	Redeem(ctx context.Context, code string) (context.Context, error)
	Refresh(ctx context.Context) (context.Context, error)
}

Provide implements various steps of the OpenID Connect flow.

type Provider

type Provider struct {
	*oidc.Provider
	*oidc.IDTokenVerifier
	*oauth2.Config
	// contains filtered or unexported fields
}

Provider represents an OpenID Connect provider, with client credentials.

func NewAppleProvider

func NewAppleProvider(ctx context.Context, config Config) (*Provider, error)

NewAppleProvider returns a new Apple Provider.

func (*Provider) Redeem

func (p *Provider) Redeem(ctx context.Context, headers AuthHeaders) (*oauth2.Token, error)

Redeem exchanges the OAuth2 authentication token for an ID token

func (*Provider) Refresh

func (p *Provider) Refresh(ctx context.Context, headers AuthHeaders) (*oauth2.Token, error)

Refresh exchanges the OAuth2 refresh token for an ID token

func (*Provider) Verify

func (p *Provider) Verify(ctx context.Context, headers AuthHeaders) (*oidc.IDToken, error)