auth

package

v0.0.0-...-ccca5b4 Latest Latest Go to latest Published: Aug 6, 2020 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kubism/smorgasbord

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Callback(h *Handler) gin.HandlerFunc
func Login(h *Handler) gin.HandlerFunc
func Register(r *gin.Engine, h *Handler)
type Client
- func NewClient(baseURL string) *Client
type ExtraClaims
type Handler
- func NewHandler(config *HandlerConfig) (*Handler, error)
type HandlerConfig
type State

Constants ¶

View Source

const QueryTokenKey = "token"

Variables ¶

This section is empty.

Functions ¶

func Callback ¶

func Callback(h *Handler) gin.HandlerFunc

func Login(h *Handler) gin.HandlerFunc

func Register ¶

func Register(r *gin.Engine, h *Handler)

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(baseURL string) *Client

func (*Client) Close ¶

func (c *Client) Close() error

Close will clean all listeners and channels required by the Client.

func (*Client) GetAuthCodeURL ¶

func (c *Client) GetAuthCodeURL() (string, error)

GetAuthCodeURL will connect to the server and retrieve the URL, which the client will be redirected to as part of the OIDC flow. Make sure to start the callback server via StartCallbackServer first or this function will return an error.

func (*Client) GetToken ¶

func (c *Client) GetToken() string

GetToken return the current value of the token. If the token has not been retrieved, the value will be an empty string.

func (*Client) StartCallbackServer ¶

func (c *Client) StartCallbackServer() error

func (*Client) StopCallbackServer ¶

func (c *Client) StopCallbackServer() error

StopCallbackServer will shutdown the server, which receives the token by being the final redirect as part of the OIDC flow.

func (*Client) WaitUntilTokenReceived ¶

func (c *Client) WaitUntilTokenReceived(ctx context.Context) error

WaitUntilTokenReceived will block until either the token was received or the context is done. The token can only be received if the callback server is running and the user is finishing the OIDC flow with his browser.

type ExtraClaims ¶

type ExtraClaims struct {
	Email         string `json:"email"`
	EmailVerified bool   `json:"email_verified"`
}

type Handler ¶

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

func NewHandler ¶

func NewHandler(config *HandlerConfig) (*Handler, error)

func (*Handler) Exchange ¶

func (h *Handler) Exchange(ctx context.Context, code string) (*oauth2.Token, error)

func (*Handler) GetAuthCodeURL ¶

func (h *Handler) GetAuthCodeURL(state *State) (string, error)

func (*Handler) Refresh ¶

func (h *Handler) Refresh(ctx context.Context, refreshToken string) (*oauth2.Token, error)

func (*Handler) Verify ¶

func (h *Handler) Verify(ctx context.Context, token *oauth2.Token) (*oidc.IDToken, error)

func (*Handler) VerifyStateAndClaims ¶

func (h *Handler) VerifyStateAndClaims(ctx context.Context, token *oauth2.Token, encoded string) (*State, *ExtraClaims, error)

type HandlerConfig ¶

type HandlerConfig struct {
	IssuerURL          string
	OfflineAsScope     bool
	ClientID           string
	ClientSecret       string
	RedirectURL        string
	Nonce              string
	AuthCodeURLMutator func(string) string
}

type State ¶

type State struct {
	Callback string `form:"callback" json:"callback,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL