oauth2

package

v0.0.0-...-c9838ac Latest Latest Go to latest Published: Feb 6, 2016 License: MIT Imports: 11 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

This section is empty.

This section is empty.

func FinishAuthorizeRequest(serviceName, code string) (*models.User, error)

FinishAuthorizeRequest validates code value and tries to find user.

func HandleAuthorizeRequest(serviceName string) string

HandleAuthorizeRequest generates authorization URL for specified service.

func HandleService(serviceName string) error

HandleService validates that service name is valid and allowed.

func Init()

Init initializes oauth2 module.

func ValidateAuthorizeRequest(serviceName, state string) error

ValidateAuthorizeRequest validates that state value is valid.

type Config struct {
	ClientID     string
	ClientSecret string
	RedirectURL  string
	Scopes       []string

	Endpoint Endpoint
}

Config describes a typical 3-legged OAuth2 flow, with both the client application information and the server's endpoint URLs.

func NewGitHub(clientID, clientSecret, redirectURL string,
	scopes []string) *Config

NewGitHub initializes new config for GitHub service.

func (c *Config) AuthCodeURL(state string) string

AuthCodeURL constructs authorization url according to the config.

func (c *Config) Exchange(code string) (*Token, error)

Exchange exchanges authorization code to the access token.

func (c *Config) User(token *Token) (*User, error)

User returns the user's data from authorization service.

type Endpoint struct {
	AuthURL  string
	TokenURL string
	UserURL  string
}

Endpoint contains the OAuth 2.0 provider's authorization, token and user endpoint URLs.

type Token struct {
	Access string
	Type   string
	Scopes []string
}

Token represents the crendentials used to authorize the requests to access protected resources on the OAuth 2.0 provider's backend.

type User struct {
	ID    int64
	Name  string
	Email string
}

User represents the user's data from authorization service.