auth

package

v0.2.1 Latest Latest Go to latest Published: Dec 8, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func CreateOAuthTokenSource(source oauth2.TokenSource) *oAuthTokenSource

CreateOAuthTokenSource creates an oAuthTokenSource from a ITokenSource from the oauth2 library

type ITokenSource interface {
	Token() (*Token, error)
}

ITokenSource interface for creating new auth tokens

func ApiKeyTokenSource(secret string) (ITokenSource, error)

ApiKeyTokenSource creates a new apiKeyTokenSource for API key authentication

func BasicAuthTokenSource(clientId string, secret string) (ITokenSource, error)

BasicAuthTokenSource creates a new basicAuthTokenSource for basic authentication

func CreateTokenFromOAuthFlow(l logger.Logger, grantType string, clientId string, secret string, flow discovery.OAuthFlow) (ITokenSource, error)

CreateTokenFromOAuthFlow creates a ITokenSource for a OAuthFlow

func CreateTokenSource(l logger.Logger, schema discovery.SecuritySchema, clientId string, secret string) (ITokenSource, error)

CreateTokenSource creates a new ITokenSource Uses the schema type (BasicSecSchemaType) to create a ITokenSource for the proper auth source

func CreateTokenSourceFromSchemas(l logger.Logger, schemas []discovery.SecuritySchema, clientId string, secret string) (ITokenSource, error)

CreateTokenSourceFromSchemas creates a new ITokenSource from the first schema in the slice

type Token struct {
	AccessToken  string
	TokenType    string
	RefreshToken string
	Expiry       time.Time
}

Token object holding token information

func (t *Token) CreateAuthHeader(l logger.Logger) http.Header

CreateAuthHeader returns a http Header holding the Authorization header from this token

func (t *Token) CreateAuthHeaderValue(l logger.Logger) string

CreateAuthHeaderValue creates the value for the Authorization header from this token

func (t *Token) SetAuthHeader(l logger.Logger, r *http.Request)

SetAuthHeader set the authorization header in a http Request using this token

func (t *Token) Type(l logger.Logger) string

Type returns the type of this token formats the TokenType to a value that can be used in the Authorization http header

func (t *Token) Valid() bool

Valid checks if this token is still valid checks if this token holds a value and isn't expired yet