goth: Index | Files

package openidConnect

import ""


Package Files

openidConnect.go session.go


const (
    PreferredUsernameClaim = "preferred_username"
    EmailClaim             = "email"
    NameClaim              = "name"
    NicknameClaim          = "nickname"
    PictureClaim           = "picture"
    GivenNameClaim         = "given_name"
    FamilyNameClaim        = "family_name"
    AddressClaim           = "address"

    // Unused but available to set in Provider claims
    MiddleNameClaim          = "middle_name"
    ProfileClaim             = "profile"
    WebsiteClaim             = "website"
    EmailVerifiedClaim       = "email_verified"
    GenderClaim              = "gender"
    BirthdateClaim           = "birthdate"
    ZoneinfoClaim            = "zoneinfo"
    LocaleClaim              = "locale"
    PhoneNumberClaim         = "phone_number"
    PhoneNumberVerifiedClaim = "phone_number_verified"
    UpdatedAtClaim           = "updated_at"

type OpenIDConfig Uses

type OpenIDConfig struct {
    AuthEndpoint     string `json:"authorization_endpoint"`
    TokenEndpoint    string `json:"token_endpoint"`
    UserInfoEndpoint string `json:"userinfo_endpoint"`
    Issuer           string `json:"issuer"`

type Provider Uses

type Provider struct {
    ClientKey   string
    Secret      string
    CallbackURL string
    HTTPClient  *http.Client

    UserIdClaims    []string
    NameClaims      []string
    NickNameClaims  []string
    EmailClaims     []string
    AvatarURLClaims []string
    FirstNameClaims []string
    LastNameClaims  []string
    LocationClaims  []string

    SkipUserInfoRequest bool
    // contains filtered or unexported fields

Provider is the implementation of `goth.Provider` for accessing OpenID Connect provider

func New Uses

func New(clientKey, secret, callbackURL, openIDAutoDiscoveryURL string, scopes ...string) (*Provider, error)

New creates a new OpenID Connect provider, and sets up important connection details. You should always call `openidConnect.New` to get a new Provider. Never try to create one manually. New returns an implementation of an OpenID Connect Authorization Code Flow See ID Token decryption is not (yet) supported UserInfo decryption is not (yet) supported

func (*Provider) BeginAuth Uses

func (p *Provider) BeginAuth(state string) (goth.Session, error)

BeginAuth asks the OpenID Connect provider for an authentication end-point.

func (*Provider) Client Uses

func (p *Provider) Client() *http.Client

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is a no-op for the openidConnect package.

func (*Provider) FetchUser Uses

func (p *Provider) FetchUser(session goth.Session) (goth.User, error)

FetchUser will use the the id_token and access requested information about the user.

func (*Provider) Name Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken Uses

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetName Uses

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) UnmarshalSession Uses

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession will unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL      string
    AccessToken  string
    RefreshToken string
    ExpiresAt    time.Time
    IDToken      string

Session stores data during the auth process with the OpenID Connect provider.

func (*Session) Authorize Uses

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)

Authorize the session with the OpenID Connect provider and return the access token to be stored for future use.

func (Session) GetAuthURL Uses

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the OpenID Connect provider.

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package openidConnect imports 11 packages (graph) and is imported by 42 packages. Updated 2020-02-29. Refresh now. Tools for package owners.