1
0
mirror of https://github.com/go-micro/go-micro.git synced 2024-11-30 08:06:40 +02:00
go-micro/auth/auth.go

53 lines
1.2 KiB
Go
Raw Normal View History

2019-11-25 11:30:26 +02:00
// Package auth provides authentication and authorization capability
package auth
2019-11-25 11:33:30 +02:00
import (
"time"
)
2019-11-25 11:30:26 +02:00
// Auth providers authentication and authorization
type Auth interface {
// String to identify the package
String() string
// Init the auth package
Init(opts ...Option) error
// Options returns the options set
Options() Options
// Generate a new auth Account
Generate(id string, opts ...GenerateOption) (*Account, error)
// Revoke an authorization Account
Revoke(token string) error
// Validate an account token
Validate(token string) (*Account, error)
2019-12-17 23:27:05 +02:00
}
// Resource is an entity such as a user or
type Resource struct {
2019-12-17 23:27:05 +02:00
// Name of the resource
Name string
// Type of resource, e.g.
Type string
2019-11-25 11:30:26 +02:00
}
// Role an account has
type Role struct {
Name string
Resource *Resource
}
// Account provided by an auth provider
type Account struct {
// ID of the account (UUID or email)
2019-11-25 11:30:26 +02:00
Id string `json: "id"`
// Token used to authenticate
Token string `json: "token"`
// Time of Account creation
2019-11-25 11:30:26 +02:00
Created time.Time `json:"created"`
// Time of Account expiry
2019-11-25 11:30:26 +02:00
Expiry time.Time `json:"expiry"`
// Roles associated with the Account
Roles []*Role `json:"roles"`
2019-11-25 11:30:26 +02:00
// Any other associated metadata
Metadata map[string]string `json:"metadata"`
}