goidc

package module

v0.0.0-...-ac4f970 Latest Latest Go to latest Published: Sep 7, 2023 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/high-creek-software/goidc

Links

Open Source Insights

README ¶

goidc

This is a simple oidc implementation as we learn the ropes of working with OIDC providers.

Documentation ¶

Index ¶

Constants
Variables
func SetAuthResponse(ar AuthResponse, r *http.Request)
func SetClaims(c Claims, r *http.Request)
type AuthResponse
- func AuthResponseFromContext(r *http.Request) (AuthResponse, bool)
- func (ar AuthResponse) String() string
type Claims
- func ClaimsFromContext(r *http.Request) (Claims, bool)
- func (c Claims) GetRoleNames() []string
type Client
- func NewClient[C any](issuer, clientID string, endpoints Endpoints, keyRefreshDuration time.Duration) *Client[C]
- func (c *Client[C]) BuildAuthenticateRedirect(state, redirectURI string, scopes []string) (*url.URL, string, error)
- func (c *Client[C]) ParseClaims(idToken string) (*C, error)
- func (c *Client[C]) RequestAuthResponse(code, redirectURI, codeVerifier string) (*AuthResponse, error)
type Endpoints
type IntrospectionResult
type Introspector
- func NewZitadelIntrospectorFromFile(issuer, path string, endpoints Endpoints) (Introspector, error)
- func NewZitadelIntrospectorWithData(issuer string, endpoints Endpoints, data []byte) (Introspector, error)
type ZitadelEndpoints
- func (z ZitadelEndpoints) Authorize() string
- func (z ZitadelEndpoints) Introspect() string
- func (z ZitadelEndpoints) Keys() string
- func (z ZitadelEndpoints) Token() string
type ZitadelIntrospector
- func (zi *ZitadelIntrospector) Introspect(token string) (bool, error)

Constants ¶

View Source

const (
	SCOPEOPENID  = "openid"
	SCOPEPROFILE = "profile"
	SCOPEEMAIL   = "email"
)

Variables ¶

View Source

var DefaultScopes = []string{SCOPEOPENID, SCOPEPROFILE, SCOPEEMAIL}

DefaultScopes provides an easy-to-use set of scopes for basic apps.

Functions ¶

func SetAuthResponse ¶

func SetAuthResponse(ar AuthResponse, r *http.Request)

func SetClaims ¶

func SetClaims(c Claims, r *http.Request)

Types ¶

type AuthResponse ¶

type AuthResponse struct {
	AccessToken string `json:"access_token"`
	TokenType   string `json:"token_type"`
	ExpiresIn   int    `json:"expires_in"`
	IDToken     string `json:"id_token"`
	State       string `json:"state"`
}

func AuthResponseFromContext ¶

func AuthResponseFromContext(r *http.Request) (AuthResponse, bool)

func (AuthResponse) String ¶

func (ar AuthResponse) String() string

type Claims ¶

type Claims struct {
	Audience          []string                     `json:"aud"`
	AuthTime          int                          `json:"auth_time"`
	Email             string                       `json:"email"`
	EmailVerified     bool                         `json:"email_verified"`
	Exp               int64                        `json:"exp"`
	FamilyName        string                       `json:"family_name"`
	GivenName         string                       `json:"given_name"`
	Name              string                       `json:"name"`
	PreferredUsername string                       `json:"preferred_username"`
	Nickname          string                       `json:"nickname"`
	Locale            string                       `json:"locale"`
	Sub               string                       `json:"sub"`
	Picture           string                       `json:"picture"`
	Roles             map[string]map[string]string `json:"urn:zitadel:iam:org:project:roles"` // This probably isn't going to work across providers, but I'm only working with zitadel on this right now
}

func ClaimsFromContext ¶

func ClaimsFromContext(r *http.Request) (Claims, bool)

func (Claims) GetRoleNames ¶

func (c Claims) GetRoleNames() []string

type Client ¶

type Client[C any] struct {
	// contains filtered or unexported fields
}

Client as this is a simple implementation of OIDC at this point, this client is intended to only help facilitate PKCE for its OIDC implementation.

func NewClient ¶

func NewClient[C any](issuer, clientID string, endpoints Endpoints, keyRefreshDuration time.Duration) *Client[C]

func (*Client[C]) BuildAuthenticateRedirect ¶

func (c *Client[C]) BuildAuthenticateRedirect(state, redirectURI string, scopes []string) (*url.URL, string, error)

BuildAuthenticateRedirect this builds the URL to redirect to, it also returns the PKCE raw value (to be stored in session/cookie/etc.) or an error if encountered.

func (*Client[C]) ParseClaims ¶

func (c *Client[C]) ParseClaims(idToken string) (*C, error)

ParseClaims takes the id_token returned from the authentication request, parses it based upon type C associated with this struct instance.

func (*Client[C]) RequestAuthResponse ¶

func (c *Client[C]) RequestAuthResponse(code, redirectURI, codeVerifier string) (*AuthResponse, error)

RequestAuthResponse takes the code returned on the callback endpoint and turns it into the auth response, again this is working with PKCE.

type Endpoints ¶

type Endpoints interface {
	Authorize() string
	Keys() string
	Token() string
	Introspect() string
}

type IntrospectionResult ¶

type IntrospectionResult struct {
	Active bool `json:"active"`
}

type Introspector ¶

type Introspector interface {
	Introspect(token string) (bool, error)
}

func NewZitadelIntrospectorFromFile ¶

func NewZitadelIntrospectorFromFile(issuer, path string, endpoints Endpoints) (Introspector, error)

func NewZitadelIntrospectorWithData ¶

func NewZitadelIntrospectorWithData(issuer string, endpoints Endpoints, data []byte) (Introspector, error)

type ZitadelEndpoints ¶

type ZitadelEndpoints struct {
}

func (ZitadelEndpoints) Authorize ¶

func (z ZitadelEndpoints) Authorize() string

func (ZitadelEndpoints) Introspect ¶

func (z ZitadelEndpoints) Introspect() string

func (ZitadelEndpoints) Keys ¶

func (z ZitadelEndpoints) Keys() string

func (ZitadelEndpoints) Token ¶

func (z ZitadelEndpoints) Token() string

type ZitadelIntrospector ¶

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

func (*ZitadelIntrospector) Introspect ¶

func (zi *ZitadelIntrospector) Introspect(token string) (bool, error)

Source Files ¶

View all Source files

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