auth

package

v0.5.1 Latest Latest Go to latest Published: Jul 13, 2025 License: Apache-2.0 Imports: 8 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 GetClaims(c *gin.Context) (*jwtprovider.Claims, bool)
func GetJWTToken(c *gin.Context) (string, bool)
type Provider

Constants ¶

View Source

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

	AuthFlag      = "Authenticated"
	AuthTimestamp = "AuthTimestamp"
	AuthNonce     = "AuthNonce"
)

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

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

GetClaims 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

Types ¶

type Provider ¶

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

func HMACAuth ¶ added in v0.5.1

func HMACAuth(provider *hmacprovider.HMACProvider) Provider

func NewAuthJWT ¶ added in v0.5.0

func NewAuthJWT(p jwtprovider.JWTParser) Provider

func NewAuthToken ¶ added in v0.3.1

func NewAuthToken(headerName string, key string) Provider

Source Files ¶

View all Source files

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