1
0
mirror of https://github.com/go-micro/go-micro.git synced 2024-12-18 08:26:38 +02:00
go-micro/auth/options.go

240 lines
4.6 KiB
Go
Raw Normal View History

package auth
import (
"time"
"github.com/micro/go-micro/v2/auth/provider"
2020-05-11 18:57:39 +02:00
"github.com/micro/go-micro/v2/client"
"github.com/micro/go-micro/v2/store"
)
2020-04-14 10:14:07 +02:00
func NewOptions(opts ...Option) Options {
var options Options
for _, o := range opts {
o(&options)
}
2020-05-11 18:57:39 +02:00
if options.Client == nil {
options.Client = client.DefaultClient
}
2020-04-14 10:14:07 +02:00
return options
}
type Options struct {
2020-04-07 13:46:44 +02:00
// Namespace the service belongs to
Namespace string
2020-03-31 13:44:34 +02:00
// ID is the services auth ID
ID string
2020-04-01 15:25:00 +02:00
// Secret is used to authenticate the service
Secret string
2020-03-31 13:44:34 +02:00
// Token is the services token used to authenticate itself
Token *Token
2020-04-01 15:25:00 +02:00
// PublicKey for decoding JWTs
PublicKey string
2020-04-01 18:17:40 +02:00
// PrivateKey for encoding JWTs
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
2020-05-11 18:57:39 +02:00
// Client to use for RPC
Client client.Client
2020-05-13 18:54:47 +02:00
// Addrs sets the addresses of auth
Addrs []string
}
type Option func(o *Options)
2020-05-13 18:54:47 +02:00
// Addrs is the auth addresses to use
func Addrs(addrs ...string) Option {
return func(o *Options) {
o.Addrs = addrs
}
}
2020-04-07 13:46:44 +02:00
// Namespace the service belongs to
func Namespace(n string) Option {
return func(o *Options) {
o.Namespace = n
}
}
// 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
}
}
2020-04-01 18:17:40 +02:00
// PrivateKey is the JWT private key
func PrivateKey(key string) Option {
return func(o *Options) {
o.PrivateKey = key
}
}
2020-03-31 13:44:34 +02:00
// Credentials sets the auth credentials
2020-04-01 15:25:00 +02:00
func Credentials(id, secret string) Option {
return func(o *Options) {
2020-03-31 13:44:34 +02:00
o.ID = id
2020-04-01 15:25:00 +02:00
o.Secret = secret
}
}
2020-04-29 16:11:06 +02:00
// ClientToken sets the auth token to use when making requests
func ClientToken(token *Token) Option {
return func(o *Options) {
o.Token = token
}
}
// 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
}
}
2020-05-11 18:57:39 +02:00
// WithClient sets the client to use when making requests
func WithClient(c client.Client) Option {
return func(o *Options) {
o.Client = c
}
}
type GenerateOptions struct {
// Metadata associated with the account
Metadata map[string]string
2020-05-20 17:49:52 +02:00
// Scopes the account has access too
Scopes []string
// Provider of the account, e.g. oauth
Provider string
// Type of the account, e.g. user
Type string
2020-04-01 18:20:02 +02:00
// Secret used to authenticate the account
Secret string
}
type GenerateOption func(o *GenerateOptions)
2020-04-01 18:20:02 +02:00
// WithSecret for the generated account
func WithSecret(s string) GenerateOption {
return func(o *GenerateOptions) {
o.Secret = s
}
}
// 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
}
}
// WithScopes for the generated account
func WithScopes(s ...string) GenerateOption {
return func(o *GenerateOptions) {
o.Scopes = 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 TokenOptions struct {
2020-04-01 15:25:00 +02:00
// ID for the account
ID string
// Secret for the account
Secret string
// RefreshToken is used to refesh a token
RefreshToken string
// Expiry is the time the token should live for
Expiry time.Duration
}
type TokenOption func(o *TokenOptions)
2020-04-01 15:25:00 +02:00
// WithExpiry for the token
func WithExpiry(ex time.Duration) TokenOption {
return func(o *TokenOptions) {
o.Expiry = ex
}
}
func WithCredentials(id, secret string) TokenOption {
return func(o *TokenOptions) {
o.ID = id
o.Secret = secret
}
}
func WithToken(rt string) TokenOption {
return func(o *TokenOptions) {
2020-04-01 15:25:00 +02:00
o.RefreshToken = rt
}
}
// 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
2020-04-01 15:25:00 +02:00
if options.Expiry == 0 {
options.Expiry = time.Minute
}
return options
}
2020-05-20 17:49:52 +02:00
type VerifyOptions struct {
Scope string
}
type VerifyOption func(o *VerifyOptions)
// WithScope to require when verifying
func WithScope(s string) VerifyOption {
return func(o *VerifyOptions) {
o.Scope = s
}
}