Documentation ¶
Overview ¶
Package nextcloud implements the OAuth2 protocol for authenticating users through nextcloud. This package can be used as a reference implementation of an OAuth2 provider for Goth.
Index ¶
- Variables
- type 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
Constants ¶
This section is empty.
Variables ¶
var ( AuthURL = "https://<own-server>/apps/oauth2/authorize" TokenURL = "https://<own-server>/apps/oauth2/api/v1/token" ProfileURL = "https://<own-server>/ocs/v2.php/cloud/user?format=json" )
These vars define the Authentication, Token, and Profile URLS for Nextcloud. You have to set these values to something useful, because nextcloud is always hosted somewhere.
Functions ¶
This section is empty.
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 Nextcloud.
func New ¶
New is only here to fulfill the interface requirements and does not work properly without setting your own Nextcloud connect parameters, more precisely AuthURL, TokenURL and ProfileURL. Please use NewCustomisedDNS with the beginning of your URL or NewCustomiseURL.
func NewCustomisedDNS ¶
func NewCustomisedDNS(clientKey, secret, callbackURL, nextcloudURL string, scopes ...string) *Provider
NewCustomisedDNS is the simplest method to create a provider based only on your key/secret and the beginning of the URL to your server, e.g. https://my.server.name/
func NewCustomisedURL ¶
func NewCustomisedURL(clientKey, secret, callbackURL, authURL, tokenURL, profileURL string, scopes ...string) *Provider
NewCustomisedURL create a working connection to your Nextcloud server given by the values authURL, tokenURL and profileURL. If you want to use a simpler method, please have a look at NewCustomisedDNS, which gets only on parameter instead of three.
func (*Provider) FetchUser ¶
FetchUser will go to Nextcloud and access basic information about the user.
func (*Provider) RefreshToken ¶
RefreshToken get new access token based on the refresh token
func (*Provider) RefreshTokenAvailable ¶
RefreshTokenAvailable refresh token is provided by auth provider or not
type Session ¶
Session stores data during the auth process with Nextcloud.
func (*Session) Authorize ¶
Authorize the session with Nextcloud and return the access token to be stored for future use.
func (Session) GetAuthURL ¶
GetAuthURL will return the URL set by calling the `BeginAuth` function on the Nextcloud provider.