goth: github.com/markbates/goth/providers/steam Index | Files

package steam

import "github.com/markbates/goth/providers/steam"

Package steam implements the OpenID protocol for authenticating users through Steam.

Package steam implements the OpenID protocol for authenticating users through Steam.

Index

Package Files

session.go steam.go

type Provider Uses

type Provider struct {
    APIKey      string
    CallbackURL string
    HTTPClient  *http.Client
    // contains filtered or unexported fields
}

Provider is the implementation of `goth.Provider` for accessing Steam

func New Uses

func New(apiKey string, callbackURL string) *Provider

New creates a new Steam provider, and sets up important connection details. You should always call `steam.New` to get a new Provider. Never try to create one manually.

func (*Provider) BeginAuth Uses

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

BeginAuth will return the authentication end-point for Steam.

func (*Provider) Client Uses

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

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is no-op for the Steam package.

func (*Provider) FetchUser Uses

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

FetchUser will go to Steam and access basic info about the user.

func (*Provider) Name Uses

func (p *Provider) Name() string

Name gets the name used to retrieve this provider.

func (*Provider) RefreshToken Uses

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

RefreshToken refresh token is not provided by Steam

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by Steam

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
    CallbackURL   string
    SteamID       string
    ResponseNonce string
}

Session stores data during the auth process with Steam.

func (*Session) Authorize Uses

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

Authorize the session with Steam and return the unique response_nonce by OpenID.

func (Session) GetAuthURL Uses

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

GetAuthURL will return the URL set by calling the `BeginAuth` function on the Steam 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 steam imports 11 packages (graph) and is imported by 10 packages. Updated 2017-02-07. Refresh now. Tools for package owners.