grant

Documentation

Index

• Variables
• type Form
• type FormRenderer
• type Grant
  • func NewGrant(csrf csrf.CSRF, auth authenticator.Request, render FormRenderer, ...) *Grant
  • func (l *Grant) Install(mux oauthserver.Mux, paths ...string)
  • func (l *Grant) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type GrantFormFields
• type Scope

Variables

var DefaultFormRenderer = grantTemplateRenderer{}

DefaultFormRenderer displays a page prompting the user to approve an OAuth grant. The requesting client id, requested scopes, and redirect URI are displayed to the user.

Types

type Form

type Form struct {
	Action string
	Error  string

	ServiceAccountName      string
	ServiceAccountNamespace string

	GrantedScopes interface{}

	Names  GrantFormFields
	Values GrantFormFields
}

type FormRenderer

type FormRenderer interface {
	Render(form Form, w http.ResponseWriter, req *http.Request)
}

FormRenderer is responsible for rendering a Form to prompt the user to approve or reject a requested OAuth scope grant.

type Grant

type Grant struct {
	// contains filtered or unexported fields
}

func NewGrant

func NewGrant(csrf csrf.CSRF, auth authenticator.Request, render FormRenderer, clientregistry api.OAuthClientGetter, authregistry oauthclient.OAuthClientAuthorizationInterface) *Grant

func (*Grant) Install

func (l *Grant) Install(mux oauthserver.Mux, paths ...string)

Install registers the grant handler into a mux. It is expected that the provided prefix will serve all operations. Path MUST NOT end in a slash.

func (*Grant) ServeHTTP

func (l *Grant) ServeHTTP(w http.ResponseWriter, req *http.Request)

type GrantFormFields

type GrantFormFields struct {
	Then        string
	CSRF        string
	ClientID    string
	UserName    string
	Scopes      interface{}
	RedirectURI string
	Approve     string
	Deny        string
}

type Scope

type Scope struct {
	// Name is the string included in the OAuth scope parameter
	Name string
	// Description is a human-readable description of the scope. May be empty.
	Description string
	// Warning is a human-readable warning about the scope. Typically used to scare the user about escalating permissions. May be empty.
	Warning string
	// Error is a human-readable error, typically around the validity of the scope. May be empty.
	Error string
	// Granted indicates whether the user has already granted this scope.
	Granted bool
}