oauth

Documentation

Index

• func Authorize(c *gin.Context)
• func Initialise(handler RequestHandler) error
• func Token(c *gin.Context)
• type Client
• type RequestHandler

Functions

func Authorize

func Authorize(c *gin.Context)

Authorize handles a request for user authorization

func Initialise

func Initialise(handler RequestHandler) error

Initialise initialises the oauth router.

func Token

func Token(c *gin.Context)

Token handles a request from a client to obtain an access token.

Types

type Client

type Client struct {
	ID             string
	Name           string
	CreatorID      int
	Avatar         string
	Authorizations []string
}

Client is the data passed to the template of the authorization page.

type RequestHandler

type RequestHandler interface {
	// Checks whether the user is logged in. If they are, it returns true. Otherwise, it redirects
	// the user to the login page.
	CheckLoggedInOrRedirect(c *gin.Context) bool
	// DisplayAuthorizePage renders the page where the user can validate the request for authorization
	DisplayAuthorizePage(client Client, c *gin.Context)
	// CheckCSRF is a function that checks the POSTed parameter `csrf` is valid.
	CheckCSRF(c *gin.Context, s string) bool
	// GetDB retrieves MySQL's DB.
	GetDB() *sql.DB
	// GetUserID retrieves the ID of the currently logged in user.
	GetUserID(c *gin.Context) int
}

RequestHandler contains the functions to which Oauth will delegate.