go-micro/auth/options.go

package auth

import (
	"time"

	"github.com/micro/go-micro/v2/auth/provider"
	"github.com/micro/go-micro/v2/store"
)

type Options struct {
	// ID is the services auth ID
	ID string
	// RefreshToken is used to generate new tokens
	RefreshToken string
	// Token is the services token used to authenticate itself
	Token *Token
	// Public key base64 encoded
	PublicKey string
	// Private key base64 encoded
	PrivateKey string
	// Provider is an auth provider
	Provider provider.Provider
	// LoginURL is the relative url path where a user can login
	LoginURL string
	// Store to back auth
	Store store.Store
}

type Option func(o *Options)

// Store to back auth
func Store(s store.Store) Option {
	return func(o *Options) {
		o.Store = s
	}
}

// PublicKey is the JWT public key
func PublicKey(key string) Option {
	return func(o *Options) {
		o.PublicKey = key
	}
}

// PrivateKey is the JWT private key
func PrivateKey(key string) Option {
	return func(o *Options) {
		o.PrivateKey = key
	}
}

// Credentials sets the auth credentials
func Credentials(id, refresh string) Option {
	return func(o *Options) {
		o.ID = id
		o.RefreshToken = refresh
	}
}

// Provider set the auth provider
func Provider(p provider.Provider) Option {
	return func(o *Options) {
		o.Provider = p
	}
}

// LoginURL sets the auth LoginURL
func LoginURL(url string) Option {
	return func(o *Options) {
		o.LoginURL = url
	}
}

type GenerateOptions struct {
	// Metadata associated with the account
	Metadata map[string]string
	// Roles/scopes associated with the account
	Roles []string
	// Namespace the account belongs too
	Namespace string
	// Secret to use with the account
	Secret string
	// Provider of the account, e.g. oauth
	Provider string
	// Type of the account, e.g. user
	Type string
}

type GenerateOption func(o *GenerateOptions)

// WithType for the generated account
func WithType(t string) GenerateOption {
	return func(o *GenerateOptions) {
		o.Type = t
	}
}

// WithMetadata for the generated account
func WithMetadata(md map[string]string) GenerateOption {
	return func(o *GenerateOptions) {
		o.Metadata = md
	}
}

// WithRoles for the generated account
func WithRoles(rs ...string) GenerateOption {
	return func(o *GenerateOptions) {
		o.Roles = rs
	}
}

// WithNamespace for the generated account
func WithNamespace(n string) GenerateOption {
	return func(o *GenerateOptions) {
		o.Namespace = n
	}
}

// WithSecret for the generated account
func WithSecret(s string) GenerateOption {
	return func(o *GenerateOptions) {
		o.Secret = s
	}
}

// WithProvider for the generated account
func WithProvider(p string) GenerateOption {
	return func(o *GenerateOptions) {
		o.Provider = p
	}
}

// NewGenerateOptions from a slice of options
func NewGenerateOptions(opts ...GenerateOption) GenerateOptions {
	var options GenerateOptions
	for _, o := range opts {
		o(&options)
	}
	return options
}

type LoginOptions struct {
	// Secret to use for rlogin
	Secret string
}

type LoginOption func(o *LoginOptions)

// WithLoginSecret for the generated account
func WithLoginSecret(s string) LoginOption {
	return func(o *LoginOptions) {
		o.Secret = s
	}
}

// NewLoginOptions from a slice of options
func NewLoginOptions(opts ...LoginOption) LoginOptions {
	var options LoginOptions
	for _, o := range opts {
		o(&options)
	}
	return options
}

type TokenOptions struct {
	// TokenExpiry is the time the token should live for
	TokenExpiry time.Duration
}

type TokenOption func(o *TokenOptions)

// WithTokenExpiry for the token
func WithTokenExpiry(ex time.Duration) TokenOption {
	return func(o *TokenOptions) {
		o.TokenExpiry = ex
	}
}

// NewTokenOptions from a slice of options
func NewTokenOptions(opts ...TokenOption) TokenOptions {
	var options TokenOptions
	for _, o := range opts {
		o(&options)
	}

	// set defualt expiry of token
	if options.TokenExpiry == 0 {
		options.TokenExpiry = time.Minute
	}

	return options
}