access

Documentation

Index

• Constants
• Variables
• func EnableTestMode()
• func GetToken(zones []string) (t *token.Token, err error)
• func GetTokenAmount(zones []string) (regular, fallback int)
• func SaveNewAuthToken(deviceID string, resp *http.Response) error
• func TokenIssuerIsFailing() bool
• func UpdateAccount(_ context.Context, task *modules.Task) error
• func VerifyRawToken(data []byte) (granted terminal.Permission, err error)
• func VerifyToken(t *token.Token) (granted terminal.Permission, err error)
• type AuthTokenRecord
  • func GetAuthToken() (*AuthTokenRecord, error)
  • func (authToken *AuthTokenRecord) GetToken() *account.AuthToken
  • func (authToken *AuthTokenRecord) Save() error
  • func (authToken *AuthTokenRecord) Update(resp *http.Response) error
• type AuthorizeOp
  • func AuthorizeToTerminal(t terminal.OpTerminal) (*AuthorizeOp, *terminal.Error)
  • func (op *AuthorizeOp) Type() string
• type UserRecord
  • func GetUser() (*UserRecord, error)
  • func (user *UserRecord) IsLoggedIn() bool
  • func (user *UserRecord) MayUseTheSPN() bool
  • func (user *UserRecord) Save() error

Constants

const (
	AccountServer         = "https://api.account.safing.io"
	LoginPath             = "/api/v1/authenticate"
	UserProfilePath       = "/api/v1/user/profile"
	TokenRequestSetupPath = "/api/v1/token/request/setup" //nolint:gosec
	TokenRequestIssuePath = "/api/v1/token/request/issue" //nolint:gosec
	HealthCheckPath       = "/api/v1/health"
)

Client URLs.

const OpTypeAccessCodeAuth = "auth"

OpTypeAccessCodeAuth is the type ID of the auth operation.

Variables

var (
	ErrDeviceIsLocked       = errors.New("device is locked")
	ErrDeviceLimitReached   = errors.New("device limit reached")
	ErrFallbackNotAvailable = errors.New("fallback tokens not available, token issuer is online")
	ErrInvalidCredentials   = errors.New("invalid credentials")
	ErrMayNotUseSPN         = errors.New("may not use SPN")
	ErrNotLoggedIn          = errors.New("not logged in")
)

Errors.

var (
	// ExpandAndConnectZones are the zones that grant access to the expand and
	// connect operations.
	ExpandAndConnectZones = []string{"pblind1", "alpha2", "fallback1"}
)

Functions

func EnableTestMode

func EnableTestMode()

EnableTestMode enables the test mode, leading the access module to only register a test zone. This should not be used to test the access module itself.

func GetToken

func GetToken(zones []string) (t *token.Token, err error)

GetToken returns a token of one of the given zones.

func GetTokenAmount

func GetTokenAmount(zones []string) (regular, fallback int)

GetTokenAmount returns the amount of tokens for the given zone.

func SaveNewAuthToken

func SaveNewAuthToken(deviceID string, resp *http.Response) error

SaveNewAuthToken saves a new auth token to the database.

func TokenIssuerIsFailing

func TokenIssuerIsFailing() bool

TokenIssuerIsFailing returns whether token issuing is currently failing.

func UpdateAccount

func UpdateAccount(_ context.Context, task *modules.Task) error

UpdateAccount updates the user account and fetches new tokens, if needed.

func VerifyRawToken

func VerifyRawToken(data []byte) (granted terminal.Permission, err error)

VerifyRawToken verifies a raw token.

func VerifyToken

func VerifyToken(t *token.Token) (granted terminal.Permission, err error)

VerifyToken verifies a token.

Types

type AuthTokenRecord

type AuthTokenRecord struct {
	record.Base
	sync.Mutex

	Token *account.AuthToken
}

AuthTokenRecord holds an authentication token.

func GetAuthToken

func GetAuthToken() (*AuthTokenRecord, error)

GetAuthToken returns the current auth token.

func (*AuthTokenRecord) GetToken

func (authToken *AuthTokenRecord) GetToken() *account.AuthToken

GetToken returns the token from the record.

func (*AuthTokenRecord) Save

func (authToken *AuthTokenRecord) Save() error

Save saves the auth token to the database.

func (*AuthTokenRecord) Update

func (authToken *AuthTokenRecord) Update(resp *http.Response) error

Update updates an existing auth token with the next token from a response.

type AuthorizeOp

type AuthorizeOp struct {
	terminal.OpBaseRequest
}

AuthorizeOp is used to authorize a session.

func AuthorizeToTerminal

func AuthorizeToTerminal(t terminal.OpTerminal) (*AuthorizeOp, *terminal.Error)

AuthorizeToTerminal starts an authorization operation.

func (*AuthorizeOp) Type

func (op *AuthorizeOp) Type() string

Type returns the type ID.

type UserRecord

type UserRecord struct {
	record.Base
	sync.Mutex

	*account.User

	MayUseSPN  bool
	LoggedInAt *time.Time
}

UserRecord holds a SPN user account.

func GetUser

func GetUser() (*UserRecord, error)

GetUser returns the current user account.

func (*UserRecord) IsLoggedIn

func (user *UserRecord) IsLoggedIn() bool

IsLoggedIn returns whether a User is currently logged in.

func (*UserRecord) MayUseTheSPN

func (user *UserRecord) MayUseTheSPN() bool

MayUseTheSPN returns whether the currently logged in User may use the SPN.

func (*UserRecord) Save

func (user *UserRecord) Save() error

Save saves the User.