google

Documentation

Index

• Constants
• func GetOAuthURLIdentifierKey(state string) string
• type OAuth
  • func New(opts ...Option) *OAuth
  • func (auth *OAuth) BuildAuthPageURL() (string, error)
  • func (auth *OAuth) HandleOAuth2ByAPPAuthToken(token string) (*plugin.OAuthUser, error)
  • func (auth *OAuth) HandleOAuth2ByAuthCode(code *plugin.VerifyCode) (*plugin.OAuthUser, error)
  • func (auth *OAuth) Provide(ctx context.Context) any
• type Option
  • func WithClientID(clientID string) Option
  • func WithClientSecret(clientSecret string) Option
  • func WithRedirectURL(redirectURL string) Option
  • func WithScope(scope []string) Option
• type Options

Constants

const (
	// ScopeProfile Google 获取用户信息的权限
	ScopeProfile = "https://www.googleapis.com/auth/userinfo.profile" // 获取用户信息
	// ScopeEmail Google 获取用户邮箱的权限
	ScopeEmail = "https://www.googleapis.com/auth/userinfo.email" // 获取用户邮箱
)

const (
	// EndpointUserInfo 获取用户信息的请求地址
	EndpointUserInfo = "https://www.googleapis.com/oauth2/v3/userinfo"
)

const (
	LockKey = "google.oauth.lock"
)

const (
	OAuthUrlIdentifierKey = "google.oauth2.url.identifier.%s"
)

Functions

func GetOAuthURLIdentifierKey

func GetOAuthURLIdentifierKey(state string) string

Types

type OAuth

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

func New

func New(opts ...Option) *OAuth

func (*OAuth) BuildAuthPageURL

func (auth *OAuth) BuildAuthPageURL() (string, error)

BuildAuthPageURL 构建授权页面 URL

func (*OAuth) HandleOAuth2ByAPPAuthToken

func (auth *OAuth) HandleOAuth2ByAPPAuthToken(token string) (*plugin.OAuthUser, error)

HandleOAuth2ByAPPAuthToken 处理 APP 授权登录

func (*OAuth) HandleOAuth2ByAuthCode

func (auth *OAuth) HandleOAuth2ByAuthCode(code *plugin.VerifyCode) (*plugin.OAuthUser, error)

HandleOAuth2ByAuthCode 处理授权码登录授权

func (*OAuth) Provide

func (auth *OAuth) Provide(ctx context.Context) any

type Option

type Option func(o *Options)

func WithClientID

func WithClientID(clientID string) Option

func WithClientSecret

func WithClientSecret(clientSecret string) Option

func WithRedirectURL

func WithRedirectURL(redirectURL string) Option

func WithScope

func WithScope(scope []string) Option

type Options

type Options struct {
	ClientID     string
	ClientSecret string
	RedirectURL  string
	Scope        []string
	TTL          time.Duration
}