tiktok

Documentation

Overview

Package tiktok implements the OAuth2 protocol for authenticating users through TikTok. This package can be used as a reference implementation of an OAuth2 provider for goth.

Index

• Constants
• type Provider
  • func New(clientKey, secret, callbackURL string, scopes ...string) *Provider
  • func (p *Provider) BeginAuth(state string) (goth.Session, error)
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
  • func (p *Provider) GetClient() *http.Client
  • 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

Constants

const (
	ScopeUserInfoBasic    = "user.info.basic"
	ScopeVideoList        = "video.list"
	ScopeVideoUpload      = "video.upload"
	ScopeShareSoundCreate = "share.sound.create"
)

Types

type Provider

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

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

func New

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

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

func (*Provider) BeginAuth

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

BeginAuth asks TikTok for an authentication end-point. Note that we create our own URL string instead of calling oauth2.AuthCodeURL() due to TikTok param name requirements.

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug TODO

func (*Provider) FetchUser

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

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

func (*Provider) GetClient

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

func (*Provider) Name

func (p *Provider) Name() string

Name is the name used to retrieve this provider.

func (*Provider) RefreshToken

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

RefreshToken will refresh a TikTok access token.

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token

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
	ExpiresAt        time.Time
	OpenID           string
	RefreshToken     string
	RefreshExpiresAt time.Time
}

Session stores data during the auth process with TikTok

func (*Session) Authorize

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

Authorize the session with TikTok and return the access token to be stored for future use. Note that we call the endpoints directly vs calling *oauth2.Config.Exchange() due to inconsistent TikTok param names.

func (Session) GetAuthURL

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

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

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string