auth

Documentation

Overview

Package auth implements helpers for securing routes

Package auth implements helpers for securing routes

Index

• func CredentialsPath() string
• type RequireAdmin
  • func (ra RequireAdmin) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Status
  • func VerifyAuthToken(r *http.Request) (Status, bool)

Functions

func CredentialsPath

func CredentialsPath() string

CredentialsPath returns a canonical path to the credentials.json file

Types

type RequireAdmin

type RequireAdmin struct {
	H http.Handler
}

RequireAdmin is an http.Handler which wraps another handler, requiring users to be admins before accessing this handler.

func (RequireAdmin) ServeHTTP

func (ra RequireAdmin) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Status

type Status struct {
	User    github.User
	Valid   bool
	Onboard bool
}

Status consists of the fields that will be returned on successful authentication

func VerifyAuthToken

func VerifyAuthToken(r *http.Request) (Status, bool)

VerifyAuthToken checks if the request contains a valid Firebase Auth token