package
10.0.96+incompatible
Repository: https://github.com/libopenstorage/openstorage.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

ContextSaveUserInfo saves user information in the context for other functions to consume.
Enabled returns whether or not auth is enabled.
No description provided by the author
IsJwtToken returns true if the provided string is a valid jwt token.
NewGuestUser creates UserInfo for the system guest user.
New returns a JwtAuthenticator.
NewOIDC returns a new OIDC authenticator.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewUserInfoFromContext returns user information in the context if available.
NoAuth returns the default no auth implementation.
ParseToDuration takes in a "human" type duration and changes it to time.Duration.
Token returns a signed JWT containing the claims provided.
TokenClaims returns the claims for the raw JWT token.
TokenIssuer returns the issuer for the raw JWT token.

# Constants

Day is the duration of hours in a day.
DayDef is the abbrevation for days.
HourDef is the abbrevation for hours.
Key to store in the token claims in gRPC context.
MinuteDef is the abbrevation for minutes.
SecondDef is the abbrevation for seconds.
default type is sub.
UsernameClaimTypeEmail requests to use "name" as the claims for the ID of the user.
UsernameClaimTypeName requests to use "name" as the claims for the ID of the user.
UsernameClaimTypeSubject requests to use "sub" as the claims for the ID of the user.
Year is the duration of days in a year.
YearDef is the abbrevation for years.

# Variables

DayRegex is a regular expression for finding days as a duration.
HourRegex is a regular expression for finding hours as a duration.
Inst returns the instance of system token manager.
MinuteRegex is a regular expression for finding minutes as a duration.
SecondRegex is a regular expression for finding seconds as a duration.
SystemTokenManagerInst returns the systemTokenManager instance.
YearRegex is a regular expression for finding years as a duration.

# Structs

Claims provides information about the claims in the token See https://openid.net/specs/openid-connect-core-1_0.html#IDToken for more information.
JwtAuthConfig provides JwtAuthenticator the keys to validate the token.
JwtAuthenticator definition.
OIDCAuthConfig configures an OIDC connection.
OIDCAuthenticator is used to validate tokens with an OIDC.
Options provide any options to apply to the token.
Signature describes the signature type using definitions from the jwt package.
UserInfo contains information about the user taken from the token.

# Interfaces

Authenticator interface validates and extracts the claims from a raw token.
TokenGenerator allows for the creation of tokens.

# Type aliases

Keys to store data in gRPC context.
UsernameClaimType holds the claims type to be use as the unique id for the user.