Documentation
¶
Index ¶
- Constants
- func AuthMiddleware(auth Provider) gin.HandlerFunc
- func GetHMACDetails(c *gin.Context) (string, string, string, bool)
- func GetHMACIdentity(c *gin.Context) (string, bool)
- func GetJWTClaims(c *gin.Context) (*jwtprovider.Claims, bool)
- func GetJWTToken(c *gin.Context) (string, bool)
- func GetSessionIdentity(c *gin.Context) (any, bool)
- type BasicAuthProvider
- type BasicAuthProviderOption
- type Provider
- func NewAuthJWT(p jwtprovider.JWTParser) Provider
- func NewAuthSession(gobIdentityTypes ...any) Provider
- func NewAuthToken(headerName string, key string) Provider
- func NewAuthTokenList(headerName string, keyList []string) Provider
- func NewBasicAuthProvider(b backend.Authenticator, opts ...BasicAuthProviderOption) (Provider, error)
- func NewHMACAuthProvider(provider *hmacprovider.HMACProvider) Provider
Constants ¶
const ( HeaderHMACHash = "X-HMAC-Hash" HeaderHMACTimestamp = "X-HMAC-Timestamp" HeaderHMACNonce = "X-HMAC-Nonce" HMACKeyId = "HMACKeyId" HMACTimestamp = "HMACTimestamp" HMACNonce = "HMACNonce" DefaultKeyId = "authenticated" )
const (
ContextJwtClaims = "jwtClaims"
)
const (
DefaultRealm = "restricted"
)
const (
DefaultTokenAuthHeader = "X-API-Key"
)
Variables ¶
This section is empty.
Functions ¶
func AuthMiddleware ¶
func AuthMiddleware(auth Provider) gin.HandlerFunc
func GetHMACDetails ¶
GetHMACDetails fetch hmac details returns keyId, timestamp, nonce, true if success
func GetHMACIdentity ¶
GetHMACIdentity fetch hmac keyId
func GetJWTClaims ¶
func GetJWTClaims(c *gin.Context) (*jwtprovider.Claims, bool)
GetJWTClaims helper to get claims from gin context
func GetJWTToken ¶
GetJWTToken helper to get JWT token from gin context
Types ¶
type BasicAuthProvider ¶ added in v0.8.4
type BasicAuthProvider struct {
// contains filtered or unexported fields
}
type BasicAuthProviderOption ¶ added in v0.8.4
type BasicAuthProviderOption func(*BasicAuthProvider)
func WithRealm ¶ added in v0.8.4
func WithRealm(realm string) BasicAuthProviderOption
type Provider ¶
func NewAuthJWT ¶
func NewAuthJWT(p jwtprovider.JWTParser) Provider
func NewAuthSession ¶
NewAuthSession creates a new auth session gobIdentityTypes are optional identity types for user identity that need to be registered with gob() for correct serialization/deserialization
func NewAuthToken ¶
NewAuthToken create simple auth token provider checks a predefined header for a specific token Security Note: while this approach may be somewhat fine for backend, machine-to-machine authentication in a highly secured and controlled environment, it is inherently as insecure as it can get. DO NOT use it as a means of authentication on web environments!!
func NewAuthTokenList ¶
NewAuthTokenList create simple auth token provider checks if a predefined header has a specific token from a token list Security Note: while this approach may be somewhat fine for backend, machine-to-machine authentication in a highly secured and controlled environment, it is inherently as insecure as it can get. DO NOT use it as a means of authentication on web environments!!
func NewBasicAuthProvider ¶ added in v0.8.4
func NewBasicAuthProvider(b backend.Authenticator, opts ...BasicAuthProviderOption) (Provider, error)
func NewHMACAuthProvider ¶
func NewHMACAuthProvider(provider *hmacprovider.HMACProvider) Provider
Source Files
Directories