provider

package

v0.0.0-...-1f4ee57 Latest Latest Go to latest Published: Jun 25, 2021 License: MIT Imports: 34 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/liov/tiga

Documentation ¶

Index ¶

Variables
type Provider
- func New(clientKey, secret, callbackURL string, scopes ...string) *Provider
- func NewCustomisedURL(clientKey, secret, callbackURL, authURL, tokenURL, profileURL string, ...) *Provider
type ProviderIndex
- func NewAuth() *ProviderIndex
type Session

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	AuthURL    = "http://localhost:8070/oauth/authorize"
	TokenURL   = "http://localhost:8070/oauth/access_token"
	ProfileURL = "http://localhost:8070/api/v1/auth"
)

Functions ¶

This section is empty.

Types ¶

type Provider ¶

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

func New ¶

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

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

func NewCustomisedURL ¶

func NewCustomisedURL(clientKey, secret, callbackURL, authURL, tokenURL, profileURL string, scopes ...string) *Provider

NewCustomisedURL is similar to New(...) but can be used to set custom URLs to connect to

func (*Provider) BeginAuth ¶

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

BeginAuth asks Github for an authentication end-point.

func (*Provider) Client ¶

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

func (*Provider) Debug ¶

func (p *Provider) Debug(debug bool)

func (*Provider) FetchUser ¶

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

func (*Provider) Name ¶

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken ¶

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

func (*Provider) RefreshTokenAvailable ¶

func (p *Provider) RefreshTokenAvailable() bool

func (*Provider) SetName ¶

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 ¶

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

UnmarshalSession will unmarshal a JSON string into a session.

type ProviderIndex ¶

type ProviderIndex struct {
	Providers    []string
	ProvidersMap map[string]string
}

func NewAuth ¶

func NewAuth() *ProviderIndex

type Session ¶

type Session struct {
	AuthURL     string
	AccessToken string
}

func (*Session) Authorize ¶

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

Authorize the session with Github and return the access token to be stored for future use.

func (Session) GetAuthURL ¶

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

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

func (Session) Marshal ¶

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String ¶

func (s Session) String() string

Source Files ¶

View all Source files

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