digipoauth

README

rclone-digiposte

This go package aims to provide oauth2 endpoint for digiposte.fr. digiposte.fr is a french service provided by La Poste (the french post office) to store and share documents. It is similar to Dropbox, Google Drive, etc.

Officially, digiposte.fr does not provide any oauth2 endpoint. This package is a workaround to connect to digiposte.fr using oauth2.

Usage

Get a token

Documentation

Index

• Constants
• Variables
• type AccessGenerator
  • func (ag *AccessGenerator) Token(ctx context.Context, generateBasic *oauth2v4.GenerateBasic, isGenRefresh bool) (string, string, error)
• type Credentials
• type InvalidOptionError
  • func (e *InvalidOptionError) Apply(interface{}) error
  • func (e *InvalidOptionError) Error() string
  • func (e *InvalidOptionError) Unwrap() error
• type LoginMethod
• type LoginMethodFunc
  • func (f LoginMethodFunc) Login(ctx context.Context, creds *Credentials) (*oauth2.Token, []*http.Cookie, error)
• type Option
• type OptionFunc
  • func (f OptionFunc) Apply(instance interface{}) error
• type RequiredFieldError
  • func (e *RequiredFieldError) Error() string
• type Server
  • func NewServer(setter digiconfig.Setter, clientID, clientSecret, redirectURL string, ...) (*Server, error)
  • func (s *Server) AuthorizeURL() string
  • func (s *Server) Close() error
  • func (s *Server) Start() error
  • func (s *Server) TokenURL() string

Constants

const (
	AuthorizePath = "/authorize"
	TokenPath     = "/token"

	ReadTimeout  = 5 * time.Second
	WriteTimeout = 5 * time.Minute
)

const RefreshTokenLength = 32

Variables

var ErrNilCredentials = errors.New("nil credentials")

Types

type AccessGenerator

type AccessGenerator struct {
	// contains filtered or unexported fields
}

func (*AccessGenerator) Token

func (ag *AccessGenerator) Token(
	ctx context.Context,
	generateBasic *oauth2v4.GenerateBasic,
	isGenRefresh bool,
) (string, string, error)

type Credentials

type Credentials struct {
	Username  string
	Password  string
	OTPSecret string
}

type InvalidOptionError

type InvalidOptionError struct {
	Name string
	Err  error
}

func (*InvalidOptionError) Apply

func (e *InvalidOptionError) Apply(interface{}) error

func (*InvalidOptionError) Error

func (e *InvalidOptionError) Error() string

func (*InvalidOptionError) Unwrap

func (e *InvalidOptionError) Unwrap() error

type LoginMethod

type LoginMethod interface {
	Login(ctx context.Context, creds *Credentials) (*oauth2.Token, []*http.Cookie, error)
}

type LoginMethodFunc

type LoginMethodFunc func(ctx context.Context, creds *Credentials) (*oauth2.Token, []*http.Cookie, error)

func (LoginMethodFunc) Login

func (f LoginMethodFunc) Login(ctx context.Context, creds *Credentials) (*oauth2.Token, []*http.Cookie, error)

type Option

type Option interface {
	Apply(instance interface{}) error
}

type OptionFunc

type OptionFunc func(instance interface{}) error

func (OptionFunc) Apply

func (f OptionFunc) Apply(instance interface{}) error

type RequiredFieldError

type RequiredFieldError struct {
	Field string
}

func (*RequiredFieldError) Error

func (e *RequiredFieldError) Error() string

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is a local web server for collecting auth.

func NewServer

func NewServer(
	setter digiconfig.Setter,
	clientID, clientSecret, redirectURL string,
	loginMethod LoginMethod,
	logger *log.Logger,
) (*Server, error)

StartServer starts a local webserver to receive the auth.

func (*Server) AuthorizeURL

func (s *Server) AuthorizeURL() string

AuthorizeURL returns the URL to the authorize endpoint.

func (*Server) Close

func (s *Server) Close() error

Close closes the server.

func (*Server) Start

func (s *Server) Start() error

Start starts the server.

func (*Server) TokenURL

func (s *Server) TokenURL() string

TokenURL returns the URL to the token endpoint.