mailru

package

v1.79.0 Latest Latest Go to latest Published: Feb 20, 2024 License: MIT Imports: 9 Imported by: 7

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/markbates/goth

Links

Open Source Insights

Documentation ¶

Overview ¶

Package mailru implements the OAuth2 protocol for authenticating users through mailru.com. This package can be used as a reference implementation of an OAuth2 provider for Goth.

Index ¶

type Provider
- func New(clientID, clientSecret, redirectURL string, scopes ...string) *Provider
type Session

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Provider ¶

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

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

func New ¶

func New(clientID, clientSecret, redirectURL string, scopes ...string) *Provider

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

func (*Provider) BeginAuth ¶

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

BeginAuth asks MAILRU for an authentication end-point.

func (*Provider) Client ¶

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

func (*Provider) Debug ¶

func (p *Provider) Debug(debug bool)

Debug is a no-op for the mailru package.

func (*Provider) FetchUser ¶

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

FetchUser will go to MAILRU and access basic information about the user.

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)

RefreshToken refresh token is not provided by mailru.

func (*Provider) RefreshTokenAvailable ¶

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by mailru

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 Session ¶

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

Session stores data during the auth process with MAILRU.

func (*Session) Authorize ¶

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

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

func (*Session) GetAuthURL ¶

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

GetAuthURL returns the URL for the authentication end-point for the provider.

func (*Session) Marshal ¶

func (s *Session) Marshal() string

Marshal the session into a string

Source Files ¶

View all Source files

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