auth

Documentation

Index

• Constants
• func AuthAPIKey(secret string) gin.HandlerFunc
• func AuthAppEngineCron() gin.HandlerFunc
• func AuthInternalOnly() gin.HandlerFunc
• func AuthJWT(client *fbauth.Client) gin.HandlerFunc
• func ElevateToAdmin(ctx context.Context, client *fbauth.Client, uid string) error
• func InitAuth() (*fbauth.Client, error)
• func RevokeAdmin(ctx context.Context, client *fbauth.Client, uid string) error
• func VerifyAdmin(ctx context.Context, client *fbauth.Client, uid string) error
• func VerifyToken(c *gin.Context, client *fbauth.Client) (int, string, error)
• type APIKey
• type RefreshResponse
  • func RefreshFirebaseToken(token RefreshToken, secret APIKey) (RefreshResponse, error)
• type RefreshToken

Constants

const (
	FirebaseContextVal = "FIREBASE_ID_TOKEN"
)

Functions

func AuthAPIKey

func AuthAPIKey(secret string) gin.HandlerFunc

func AuthAppEngineCron

func AuthAppEngineCron() gin.HandlerFunc

AppEngine cron authentication

func AuthInternalOnly

func AuthInternalOnly() gin.HandlerFunc

only allow internal ip ranges

func AuthJWT

func AuthJWT(client *fbauth.Client) gin.HandlerFunc

Gin middleware for JWT auth

func ElevateToAdmin

func ElevateToAdmin(ctx context.Context, client *fbauth.Client, uid string) error

add 'admin' claim to users JWT so they can perform admin actions (they still need to be authenticated with JWT)

func InitAuth

func InitAuth() (*fbauth.Client, error)

load firebase configuration and create the auth client expecting env variable FIREBASE_CONFIG_FILE

func RevokeAdmin

func RevokeAdmin(ctx context.Context, client *fbauth.Client, uid string) error

remove admin claim from users JWT so they can no longer perform admin actions

func VerifyAdmin

func VerifyAdmin(ctx context.Context, client *fbauth.Client, uid string) error

use user id to very if user is admin or not

func VerifyToken

func VerifyToken(c *gin.Context, client *fbauth.Client) (int, string, error)

use id_token provided in Authorization: Bearer [ID_TOKEN]

Types

type APIKey

type APIKey string

type RefreshResponse

type RefreshResponse struct {
	ExpiresIn    string `json:"expires_in"`
	TokenType    string `json:"token_type"`
	RefreshToken string `json:"refresh_token"`
	IDToken      string `json:"id_token"`
	UserID       string `json:"user_id"`
	ProjectID    string `json:"project_id"`
}

func RefreshFirebaseToken

func RefreshFirebaseToken(token RefreshToken, secret APIKey) (RefreshResponse, error)

https://firebase.google.com/docs/reference/rest/auth

type RefreshToken

type RefreshToken string