quarterdeck

func (*Server) APIKeyCreate ¶

func (s *Server) APIKeyCreate(c *gin.Context)

TODO: document TODO: actually implement this resource endpoint HACK: this is just a quick hack to get us going: it creates an api key quickly

func (*Server) APIKeyDelete ¶

func (s *Server) APIKeyDelete(c *gin.Context)

func (*Server) APIKeyDetail ¶

func (s *Server) APIKeyDetail(c *gin.Context)

func (*Server) APIKeyList ¶

func (s *Server) APIKeyList(c *gin.Context)

TODO: document TODO: actually implement this resource endpoint TODO: implement pagination HACK: this is just a quick hack to get us going, it should filter api keys based on the authenticated user and organization instead of just returning everyting.

func (*Server) APIKeyUpdate ¶

func (s *Server) APIKeyUpdate(c *gin.Context)

func (*Server) Authenticate ¶

func (s *Server) Authenticate(c *gin.Context)

TODO: add documentation TODO: simplify the code in this handler

func (*Server) Available ¶

func (s *Server) Available() gin.HandlerFunc

Available is middleware that uses healthy boolean to return a service unavailable http status code if the server is shutting down or in maintenance mode. This middleware must be fairly early on in the chain to ensure that complex handling does not slow the shutdown of the server.

func (*Server) Healthy ¶

func (s *Server) Healthy() bool

func (*Server) JWKS ¶ added in v0.1.1

func (s *Server) JWKS(c *gin.Context)

JWKS returns the JSON web key set for the public RSA keys that are currently being used by Quarterdeck to sign JWT acccess and refresh tokens. External callers can use these keys to verify that a JWT token was in fact issued by the Quarterdeck API.

func (*Server) Login ¶

func (s *Server) Login(c *gin.Context)

TODO: add documentation TODO: simplify the code in this handler

func (*Server) OpenIDConfiguration ¶ added in v0.1.1

func (s *Server) OpenIDConfiguration(c *gin.Context)

Returns a JSON document with the OpenID configuration as defined by the OpenID Connect standard: https://connect2id.com/learn/openid-connect. This document helps clients understand how to authenticate with Quarterdeck. TODO: once OpenID endpoints have been configured add them to this JSON response

func (*Server) Refresh ¶

func (s *Server) Refresh(c *gin.Context)

func (*Server) Register ¶

func (s *Server) Register(c *gin.Context)

TODO: add documentation TODO: review and ensure the register methodology is what we want

func (*Server) SecurityTxt ¶ added in v0.1.1

func (s *Server) SecurityTxt(c *gin.Context)

Writes the security.txt file generated from https://securitytxt.org/ and digitally signed with the info@rotational.io PGP keys to alert security researchers to our security policies and allow them to contact us with any security flaws.

func (*Server) Serve ¶

func (s *Server) Serve() (err error)

Serve API requests while listening on the specified bind address.

func (*Server) SetHealth ¶

func (s *Server) SetHealth(health bool)

func (*Server) SetURL ¶

func (s *Server) SetURL(url string)

func (*Server) Shutdown ¶

func (s *Server) Shutdown() (err error)

Shutdown the server gracefully (usually called by OS signal).

func (*Server) Status ¶

func (s *Server) Status(c *gin.Context)

Status handler returns the current healthy status of the server (can't be unhealthy otherwise the Available middleware would have intercepted the request)

func (*Server) URL ¶

func (s *Server) URL() string