auth

package

v0.7.0 Latest Latest Go to latest Published: Sep 11, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/oddbit-project/blueprint

Links

Open Source Insights

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 Provider

Constants ¶

View Source

const (
	HeaderHMACHash      = "X-HMAC-Hash"
	HeaderHMACTimestamp = "X-HMAC-Timestamp"
	HeaderHMACNonce     = "X-HMAC-Nonce"

	HMACKeyId     = "HMACKeyId"
	HMACTimestamp = "HMACTimestamp"
	HMACNonce     = "HMACNonce"
	DefaultKeyId  = "authenticated"
)

View Source

const (
	ContextJwtClaims = "jwtClaims"
)

View Source

const (
	DefaultTokenAuthHeader = "X-API-Key"
)

Variables ¶

This section is empty.

Functions ¶

func AuthMiddleware ¶

func AuthMiddleware(auth Provider) gin.HandlerFunc

func GetHMACDetails ¶ added in v0.6.0

func GetHMACDetails(c *gin.Context) (string, string, string, bool)

GetHMACDetails fetch hmac details returns keyId, timestamp, nonce, true if success

func GetHMACIdentity ¶ added in v0.6.0

func GetHMACIdentity(c *gin.Context) (string, bool)

GetHMACIdentity fetch hmac keyId

func GetJWTClaims ¶ added in v0.6.0

func GetJWTClaims(c *gin.Context) (*jwtprovider.Claims, bool)

GetJWTClaims helper to get claims from gin context

func GetJWTToken ¶ added in v0.5.0

func GetJWTToken(c *gin.Context) (string, bool)

GetJWTToken helper to get JWT token from gin context

func GetSessionIdentity ¶ added in v0.6.0

func GetSessionIdentity(c *gin.Context) (any, bool)

Types ¶

type Provider ¶

type Provider interface {
	CanAccess(c *gin.Context) bool
}

func NewAuthJWT ¶ added in v0.5.0

func NewAuthJWT(p jwtprovider.JWTParser) Provider

func NewAuthSession ¶ added in v0.6.0

func NewAuthSession(gobIdentityTypes ...any) Provider

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 ¶ added in v0.3.1

func NewAuthToken(headerName string, key string) Provider

NewAuthToken create simple auth token provider checks a predefined header for a specific token

func NewAuthTokenList ¶ added in v0.6.0

func NewAuthTokenList(headerName string, keyList []string) Provider

NewAuthTokenList create simple auth token provider checks if a predefined header has a specific token from a token list

func NewHMACAuthProvider ¶ added in v0.5.2

func NewHMACAuthProvider(provider *hmacprovider.HMACProvider) Provider

Source Files ¶

View all Source files

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