bearer

package

v0.0.0-...-7578c0e Latest Latest Go to latest Published: Sep 29, 2023 License: MIT 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

Repository

github.com/IOTech17/neo-rport

Documentation ¶

Index ¶

Constants
Variables
func CreateAuthToken(ctx context.Context, sessionUpdater APISessionUpdater, JWTSecret string, ...) (string, error)
func GetBearerToken(req *http.Request) (string, bool)
func IncreaseSessionLifetime(ctx context.Context, sessionUpdater APISessionUpdater, s session.APISession) error
func ValidateBearerToken(ctx context.Context, tokCtx *TokenContext, uri, method string, ...) (valid bool, sessionInfo session.APISession, err error)
type APISessionGetter
type APISessionUpdater
type AppTokenClaims
type Scope
type TokenContext
- func ParseToken(tokenStr string, JWTSecret string) (tokCtx *TokenContext, err error)

Constants ¶

View Source

const (
	DefaultMaxTokenLifetime = 90 * 24 * time.Hour
	DefaultTokenLifetime    = 10 * time.Minute
)

Variables ¶

View Source

var Scopes2FaCheckOnly = []Scope{
	{
		URI:    routes.AllRoutesPrefix + routes.Verify2FaRoute,
		Method: http.MethodPost,
	},
}

View Source

var ScopesAllExcluding2FaCheck = []Scope{
	{
		URI:    "*",
		Method: "*",
	},
	{
		URI:     routes.AllRoutesPrefix + routes.Verify2FaRoute,
		Method:  "*",
		Exclude: true,
	},
}

View Source

var ScopesTotPCreateOnly = []Scope{
	{
		URI:    routes.AllRoutesPrefix + routes.TotPRoutes,
		Method: http.MethodPost,
	},
}

Functions ¶

func CreateAuthToken ¶

func CreateAuthToken(
	ctx context.Context,
	sessionUpdater APISessionUpdater,
	JWTSecret string,
	lifetime time.Duration,
	username string,
	scopes []Scope,
	userAgent string,
	remoteAddress string,
) (string, error)

func GetBearerToken ¶

func GetBearerToken(req *http.Request) (string, bool)

func IncreaseSessionLifetime ¶

func IncreaseSessionLifetime(
	ctx context.Context,
	sessionUpdater APISessionUpdater,
	s session.APISession) error

func ValidateBearerToken ¶

func ValidateBearerToken(
	ctx context.Context,
	tokCtx *TokenContext,
	uri, method string,
	apiSessionGetter APISessionGetter,
	l *logger.Logger) (valid bool, sessionInfo session.APISession, err error)

Types ¶

type APISessionGetter ¶

type APISessionGetter interface {
	Get(ctx context.Context, sessionID int64) (found bool, sessionInfo session.APISession, err error)
}

type APISessionUpdater ¶

type APISessionUpdater interface {
	Save(ctx context.Context, session session.APISession) (sessionID int64, err error)
}

type AppTokenClaims ¶

type AppTokenClaims struct {
	Username  string  `json:"username,omitempty"`
	SessionID int64   `json:"sessionID,omitempty"`
	Scopes    []Scope `json:"scopes,omitempty"`
	jwt.StandardClaims
}

type Scope ¶

type Scope struct {
	URI     string `json:"uri,omitempty"`
	Method  string `json:"method,omitempty"`
	Exclude bool   `json:"exclude,omitempty"`
}

type TokenContext ¶

type TokenContext struct {
	AppClaims *AppTokenClaims
	RawToken  string
	JwtToken  *jwt.Token
}

func ParseToken ¶

func ParseToken(tokenStr string, JWTSecret string) (tokCtx *TokenContext, err error)

Source Files ¶

View all Source files

bearer_auth.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL