usso

Documentation

Overview

Package usso provides types and functionality for the Ubuntu Single Sign-on Server

Index

• Constants
• Variables
• func AddJWTCookie(jwtToken string, w http.ResponseWriter)
• func JWTExtractor(r *http.Request) (string, error)
• func LoginHandler(nonce openid.NonceStore, w http.ResponseWriter, r *http.Request) (*openid.Response, *openid.Request, string, error)
• func LogoutHandler(w http.ResponseWriter, r *http.Request)
• func NewJWTToken(jwtSecret string, resp *openid.Response, role int) (string, error)
• func NewJWTTokenForClient(jwtSecret, username, fullname, email, tokenKey string, role int) (string, error)
• func VerifyJWT(jwtSecret, jwtToken string) (*jwt.Token, error)

Constants

const (
	ClaimsIdentity         = "identity"
	ClaimsUsername         = "username"
	ClaimsEmail            = "email"
	ClaimsName             = "name"
	ClaimsRole             = "role"
	ClaimsAccountFilter    = "accountFilter"
	StandardClaimExpiresAt = "exp"
)

UserClaims holds the JWT custom claims for a user

const JWTCookie = "X-Auth-Token"

JWTCookie is the name of the cookie used to store the JWT

Variables

var ClaimsKey struct{}

ClaimsKey is the context key for the JWT claims

Functions

func AddJWTCookie

func AddJWTCookie(jwtToken string, w http.ResponseWriter)

AddJWTCookie sets the JWT as a cookie

func JWTExtractor

func JWTExtractor(r *http.Request) (string, error)

JWTExtractor extracts the JWT from a request and returns the token string. The token is not verified.

func LoginHandler

func LoginHandler(nonce openid.NonceStore, w http.ResponseWriter, r *http.Request) (*openid.Response, *openid.Request, string, error)

LoginHandler processes the login for Ubuntu SSO

func LogoutHandler

func LogoutHandler(w http.ResponseWriter, r *http.Request)

LogoutHandler logs the user out by removing the cookie and the JWT authorization header

func NewJWTToken

func NewJWTToken(jwtSecret string, resp *openid.Response, role int) (string, error)

NewJWTToken creates a new JWT from the verified OpenID response

func NewJWTTokenForClient

func NewJWTTokenForClient(jwtSecret, username, fullname, email, tokenKey string, role int) (string, error)

NewJWTTokenForClient creates a new JWT from the validated OAuth token where the token_key is the id

func VerifyJWT

func VerifyJWT(jwtSecret, jwtToken string) (*jwt.Token, error)

VerifyJWT checks that we have a valid token