goth: Index | Files

package nextcloud

import ""

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.


Package Files

nextcloud.go session.go


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.

type Provider Uses

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 Uses

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

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 Uses

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.

func NewCustomisedURL Uses

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) BeginAuth Uses

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

BeginAuth asks Nextcloud for an authentication end-point.

func (*Provider) Client Uses

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

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is a no-op for the nextcloud package.

func (*Provider) FetchUser Uses

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

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

func (*Provider) Name Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken Uses

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

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetName Uses

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 Uses

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession wil unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL      string
    AccessToken  string
    RefreshToken string
    ExpiresAt    time.Time

Session stores data during the auth process with Nextcloud.

func (*Session) Authorize Uses

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

Authorize the session with Nextcloud and return the access token to be stored for future use.

func (Session) GetAuthURL Uses

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

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

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package nextcloud imports 11 packages (graph) and is imported by 2 packages. Updated 2019-01-16. Refresh now. Tools for package owners.