apis

Documentation

Index

• type PasswordAuthenticator
• type PasswordAuthenticatorFactory
• type TokenInfo
• type TokenInfoFactory
• type TokenProvider
• type TokenProviderFactory
• type TokenRequest
• type TokenResponse
• type VerifyRequest
• type VerifyResponse

Types

type PasswordAuthenticator

type PasswordAuthenticator interface {
	Authenticate(username, password string) (bool, int32, error)
}

type PasswordAuthenticatorFactory

type PasswordAuthenticatorFactory interface {
	New(params []string) (PasswordAuthenticator, error)
}

type TokenInfo

type TokenInfo interface {
	// VerifyToken verifies the providing token and performs authorization. The returned error is only used by the underlying rpc protocol
	VerifyToken(ctx context.Context, request VerifyRequest) (VerifyResponse, error)
}

type TokenInfoFactory

type TokenInfoFactory interface {
	New(params []string) (TokenInfo, error)
}

type TokenProvider

type TokenProvider interface {
	// GetToken retrieves the auth token . The returned error is only used by the underlying rpc protocol
	GetToken(ctx context.Context, request TokenRequest) (TokenResponse, error)
}

type TokenProviderFactory

type TokenProviderFactory interface {
	New(params []string) (TokenProvider, error)
}

type TokenRequest

type TokenRequest struct {
	Params []string
}

type TokenResponse

type TokenResponse struct {
	Success bool
	Status  int32
	Token   string
}

type VerifyRequest

type VerifyRequest struct {
	Token  string
	Params []string
}

type VerifyResponse

type VerifyResponse struct {
	Success bool
	Status  int32
}