wechat

README

goth-wechat

This package implements the WeChat OAuth2 provider for Goth, an authentication library for Go web applications.

Installation

go get github.com/chenmingbiao/goth-wechat

Usage

To use this provider with Goth, you need to set it up in your application:

package main

import (
    "github.com/markbates/goth"
    "github.com/chenmingbiao/goth-wechat"
)

func init() {
    goth.UseProviders(
        wechat.New(os.Getenv("WECHAT_KEY"), os.Getenv("WECHAT_SECRET"), "http://localhost:3000/auth/wechat/callback"),
    )
}

Make sure to set the WECHAT_KEY and WECHAT_SECRET environment variables with your WeChat application credentials.

Authentication

The WeChat authentication flow follows these steps:

1. Redirect the user to the WeChat authorization page
2. WeChat redirects back to your site with a code
3. Your site exchanges the code for an access token
4. Fetch the user information using the access token

For detailed implementation, please refer to the Goth documentation and examples.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Thanks to the Goth project for providing the authentication framework.
• This provider is based on the WeChat OAuth 2.0 documentation.

Documentation

Index

• type Provider
  • func New(clientKey, secret, callbackURL string, scopes ...string) *Provider
  • func (p *Provider) BeginAuth(state string) (goth.Session, error)
  • func (p *Provider) Client() *http.Client
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
  • func (p *Provider) Name() string
  • func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) RefreshTokenAvailable() bool
  • func (p *Provider) SetName(name string)
  • func (p *Provider) UnmarshalSession(data string) (goth.Session, error)
• type Session
  • func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)
  • func (s Session) GetAuthURL() (string, error)
  • func (s Session) Marshal() string
  • func (s Session) String() string

Types

type Provider

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

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

func New

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

New creates a new WeChat provider, and sets up important connection details.

func (*Provider) BeginAuth

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

BeginAuth asks WeChat 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 wechat package.

func (*Provider) FetchUser

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

FetchUser will go to WeChat 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 get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

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 the same 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
	OpenID       string
}

Session stores data during the auth process with WeChat.

func (*Session) Authorize

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

Authorize the session with WeChat 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 WeChat provider.

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string