nextcloud

README

Nextcloud OAuth2

For this backend, you need to have an OAuth2 enabled Nextcloud Instance, e.g. on your own private server.

Setting up Nextcloud Test Environment

To test, you only need a working Docker image of Nextcloud running on a public URL, e.g. through traefik

version: '2'

networks:
  traefik-web:
    external: true

services:
  app:
    image: nextcloud
    restart: always
    networks:
      - traefik-web
    labels:
      - traefik.enable=true
      - traefik.frontend.rule=Host:${NEXTCLOUD_DNS}
      - traefik.docker.network=traefik-web
    environment:
      SQLITE_DATABASE: "database.sqlite3"
      NEXTCLOUD_ADMIN_USER: admin
      NEXTCLOUD_ADMIN_PASSWORD: admin
      NEXTCLOUD_TRUSTED_DOMAINS: ${NEXTCLOUD_DNS}

and start it up via

NEXTCLOUD_DNS=goth.my.server.name docker-compose up -d

afterwards, you will have a running Nextcloud instance with credentials

admin / admin

Then add a new OAuth 2.0 Client by going to

Settings -> Security -> OAuth 2.0 client

and add a new client with the name goth and redirection uri http://localhost:3000/auth/nextcloud/callback. The imporant part here the two cryptic entries Client Identifier and Secret, which needs to be used in your application.

Running Login Example

If you want to run the default example in <goth>/examples, you have to retrieve the keys described in the previous section and run the example as follows:

NEXTCLOUD_URL=https://goth.my.server.name \
NEXTCLOUD_KEY=<your-key> \
NEXTCLOUD_SECRET=<your-secret> \
SESSION_SECRET=1 \
./examples

Afterwards, you should be able to login via Nextcloud in the examples app.

Running the Provider Test

The test has the same arguments as the login example test, but starts the test itself

NEXTCLOUD_URL=https://goth.my.server.name \
NEXTCLOUD_KEY=<your-key> \
NEXTCLOUD_SECRET=<your-secret> \
SESSION_SECRET=1 \
go test -v

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 New(clientKey, secret, callbackURL string, scopes ...string) *Provider
  • func NewCustomisedDNS(clientKey, secret, callbackURL, nextcloudURL string, scopes ...string) *Provider
  • func NewCustomisedURL(clientKey, secret, callbackURL, authURL, tokenURL, profileURL 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

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.

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

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

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

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

BeginAuth asks Nextcloud 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 nextcloud package.

func (*Provider) FetchUser

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

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 1 type)

func (*Provider) UnmarshalSession

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

UnmarshalSession wil unmarshal a JSON string into a session.

type Session

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

Session stores data during the auth process with Nextcloud.

func (*Session) Authorize

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

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

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

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string