auth

Documentation

Index

• Constants
• Variables
• func IsClientToken(tok string) bool
• func Save(w io.Writer, p Provider) error
• func WithContext(pctx context.Context, p Provider) context.Context
• type BrowserAuth
  • func NewBrowserAuth(ctx context.Context, opts ...Option) (BrowserAuth, error)
  • func (c BrowserAuth) Cookies() []*http.Cookie
  • func (s BrowserAuth) HTTPClient() (*http.Client, error)
  • func (c BrowserAuth) SlackToken() string
  • func (s BrowserAuth) Test(ctx context.Context) error
  • func (BrowserAuth) Type() Type
  • func (c BrowserAuth) Validate() error
• type BrowserAuthUI
• type CookieFileAuth
  • func NewCookieFileAuth(token string, cookieFile string) (CookieFileAuth, error)
  • func (c CookieFileAuth) Cookies() []*http.Cookie
  • func (s CookieFileAuth) HTTPClient() (*http.Client, error)
  • func (c CookieFileAuth) SlackToken() string
  • func (s CookieFileAuth) Test(ctx context.Context) error
  • func (CookieFileAuth) Type() Type
  • func (c CookieFileAuth) Validate() error
• type Error
  • func (ae *Error) Error() string
  • func (ae *Error) Is(target error) bool
  • func (ae *Error) Unwrap() error
• type Option
  • func BrowserWithAuthFlow(flow BrowserAuthUI) Option
  • func BrowserWithBrowser(b browser.Browser) Option
  • func BrowserWithTimeout(d time.Duration) Option
  • func BrowserWithWorkspace(name string) Option
• type Provider
  • func FromContext(ctx context.Context) (Provider, error)
• type Type
  • func (i Type) String() string
• type ValueAuth
  • func Load(r io.Reader) (ValueAuth, error)
  • func NewValueAuth(token string, cookie string) (ValueAuth, error)
  • func (c ValueAuth) Cookies() []*http.Cookie
  • func (s ValueAuth) HTTPClient() (*http.Client, error)
  • func (c ValueAuth) SlackToken() string
  • func (s ValueAuth) Test(ctx context.Context) error
  • func (ValueAuth) Type() Type
  • func (c ValueAuth) Validate() error

Constants

const SlackURL = "https://slack.com"

Variables

var (
	ErrNoToken      = errors.New("no token")
	ErrNoCookies    = errors.New("no cookies")
	ErrNotSupported = errors.New("not supported")
)

var ErrNoProvider = errors.New("internal error:  no provider in context")

Functions

func IsClientToken

func IsClientToken(tok string) bool

IsClientToken returns true if the tok is a web-client token.

func Save

func Save(w io.Writer, p Provider) error

Save serialises authentication information to writer. It will return ErrNoToken or ErrNoCookie if provider fails validation.

func WithContext

func WithContext(pctx context.Context, p Provider) context.Context

WithContext returns context with auth provider.

Types

type BrowserAuth

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

func NewBrowserAuth

func NewBrowserAuth(ctx context.Context, opts ...Option) (BrowserAuth, error)

func (BrowserAuth) Cookies

func (c BrowserAuth) Cookies() []*http.Cookie

func (BrowserAuth) HTTPClient

func (s BrowserAuth) HTTPClient() (*http.Client, error)

func (BrowserAuth) SlackToken

func (c BrowserAuth) SlackToken() string

func (BrowserAuth) Test

func (s BrowserAuth) Test(ctx context.Context) error

TestAuth attempts to authenticate with the given provider. It will return AuthError if failed.

func (BrowserAuth) Type

func (BrowserAuth) Type() Type

func (BrowserAuth) Validate

func (c BrowserAuth) Validate() error

type BrowserAuthUI

type BrowserAuthUI interface {
	RequestWorkspace(w io.Writer) (string, error)
	Stop()
}

type CookieFileAuth

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

func NewCookieFileAuth

func NewCookieFileAuth(token string, cookieFile string) (CookieFileAuth, error)

NewCookieFileAuth creates new auth provider from token and Mozilla cookie file.

func (CookieFileAuth) Cookies

func (c CookieFileAuth) Cookies() []*http.Cookie

func (CookieFileAuth) HTTPClient

func (s CookieFileAuth) HTTPClient() (*http.Client, error)

func (CookieFileAuth) SlackToken

func (c CookieFileAuth) SlackToken() string

func (CookieFileAuth) Test

func (s CookieFileAuth) Test(ctx context.Context) error

TestAuth attempts to authenticate with the given provider. It will return AuthError if failed.

func (CookieFileAuth) Type

func (CookieFileAuth) Type() Type

func (CookieFileAuth) Validate

func (c CookieFileAuth) Validate() error

type Error

type Error struct {
	Err error
	Msg string
}

Error is the error returned by New, the underlying Err contains an API error returned by slack.AuthTest call.

func (*Error) Error

func (ae *Error) Error() string

func (*Error) Is

func (ae *Error) Is(target error) bool

func (*Error) Unwrap

func (ae *Error) Unwrap() error

type Option

type Option func(*options)

func BrowserWithAuthFlow

func BrowserWithAuthFlow(flow BrowserAuthUI) Option

func BrowserWithBrowser

func BrowserWithBrowser(b browser.Browser) Option

func BrowserWithTimeout

func BrowserWithTimeout(d time.Duration) Option

func BrowserWithWorkspace

func BrowserWithWorkspace(name string) Option

type Provider

type Provider interface {
	// SlackToken should return the Slack Token value.
	SlackToken() string
	// Cookies should return a set of Slack Session cookies.
	Cookies() []*http.Cookie
	// Type returns the auth type.
	Type() Type
	// Validate should return error, in case the token or cookies cannot be
	// retrieved.
	Validate() error
	// Test tests if credentials are valid.
	Test(ctx context.Context) error
	// Client returns an authenticated HTTP client
	HTTPClient() (*http.Client, error)
}

Provider is the Slack Authentication provider.

func FromContext

func FromContext(ctx context.Context) (Provider, error)

FromContext returns the auth provider from the context.

type Type

type Type uint8

Type is the auth type.

const (
	TypeInvalid    Type = iota // Invalid
	TypeValue                  // Value
	TypeCookieFile             // Cookie File
	TypeBrowser                // EZ-Login 3000
)

All supported auth types.

func (Type) String

func (i Type) String() string

type ValueAuth

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

ValueAuth stores Slack credentials.

func Load

func Load(r io.Reader) (ValueAuth, error)

Load deserialises JSON data from reader and returns a ValueAuth, that can be used to authenticate Slackdump. It will return ErrNoToken or ErrNoCookie if the authentication information is missing.

func NewValueAuth

func NewValueAuth(token string, cookie string) (ValueAuth, error)

func (ValueAuth) Cookies

func (c ValueAuth) Cookies() []*http.Cookie

func (ValueAuth) HTTPClient

func (s ValueAuth) HTTPClient() (*http.Client, error)

func (ValueAuth) SlackToken

func (c ValueAuth) SlackToken() string

func (ValueAuth) Test

func (s ValueAuth) Test(ctx context.Context) error

TestAuth attempts to authenticate with the given provider. It will return AuthError if failed.

func (ValueAuth) Type

func (ValueAuth) Type() Type

func (ValueAuth) Validate

func (c ValueAuth) Validate() error