influxdb/auth.go

120 lines
3.3 KiB
Go

package platform
import (
"context"
"fmt"
)
// Authorization is a authorization. 🎉
type Authorization struct {
ID ID `json:"id"`
Token string `json:"token"`
User string `json:"user,omitempty"`
UserID ID `json:"userID,omitempty"`
Permissions []Permission `json:"permissions"`
}
// AuthorizationService represents a service for managing authorization data.
type AuthorizationService interface {
// Returns a single authorization by ID.
FindAuthorizationByID(ctx context.Context, id ID) (*Authorization, error)
// Returns a single authorization by Token.
FindAuthorizationByToken(ctx context.Context, t string) (*Authorization, error)
// Returns a list of authorizations that match filter and the total count of matching authorizations.
// Additional options provide pagination & sorting.
FindAuthorizations(ctx context.Context, filter AuthorizationFilter, opt ...FindOptions) ([]*Authorization, int, error)
// Creates a new authorization and sets a.Token and a.UserID with the new identifier.
CreateAuthorization(ctx context.Context, a *Authorization) error
// Removes a authorization by token.
DeleteAuthorization(ctx context.Context, id ID) error
}
// AuthorizationFilter represents a set of filter that restrict the returned results.
type AuthorizationFilter struct {
Token *string
ID *ID
UserID *ID
User *string
}
type action string
const (
// ReadAction is the action for reading.
ReadAction action = "read"
// WriteAction is the action for writing.
WriteAction action = "write"
// CreateAction is the action for creating new resources.
CreateAction action = "create"
// DeleteAction is the action for deleting an existing resource.
DeleteAction action = "delete"
)
type resource string
const (
// UserResource represents the user resource actions can apply to.
UserResource = resource("user")
// OrganizationResource represents the org resource actions can apply to.
OrganizationResource = resource("org")
)
// BucketResource constructs a bucket resource.
func BucketResource(id ID) resource {
return resource(fmt.Sprintf("bucket/%s", id))
}
// Permission defines an action and a resource.
type Permission struct {
Action action `json:"action"`
Resource resource `json:"resource"`
}
func (p Permission) String() string {
return fmt.Sprintf("%s:%s", p.Action, p.Resource)
}
var (
// CreateUser is a permission for creating users.
CreateUserPermission = Permission{
Action: CreateAction,
Resource: UserResource,
}
// DeleteUser is a permission for deleting users.
DeleteUserPermission = Permission{
Action: DeleteAction,
Resource: UserResource,
}
)
// ReadBucket constructs a permission for reading a bucket.
func ReadBucketPermission(id ID) Permission {
return Permission{
Action: ReadAction,
Resource: BucketResource(id),
}
}
// WriteBucket constructs a permission for writing to a bucket.
func WriteBucketPermission(id ID) Permission {
return Permission{
Action: WriteAction,
Resource: BucketResource(id),
}
}
// Allowed returns true if the permission exists in a list of permissions.
func Allowed(req Permission, ps []Permission) bool {
for _, p := range ps {
if p.Action == req.Action && p.Resource == req.Resource {
return true
}
}
return false
}