config

Documentation

Index

• Variables
• type Choices
  • func (c Choices) Search(value string) bool
• type Config
  • func New(path string) (*Config, error)
  • func NewDefaultConfig() *Config
• type Field
  • func (f Field) Validate(name string, value interface{}) error
• type FieldType
• type JSONPath
  • func (p *JSONPath) MarshalText() ([]byte, error)
  • func (p *JSONPath) UnmarshalText(text []byte) error
• type JWTConfig
  • func (c *JWTConfig) GetDecodingKey() interface{}
  • func (c *JWTConfig) GetSigningKey() interface{}
• type LockoutPolicy
• type Regexp
  • func (r *Regexp) MarshalText() ([]byte, error)
  • func (r *Regexp) UnmarshalText(text []byte) error
• type SMSConfig
• type SMSMapping
• type SMTPConfig
• type SocialConfig
• type Template
  • func (t *Template) MarshalText() ([]byte, error)
  • func (t *Template) UnmarshalText(text []byte) error
• type TemplateConfig

Variables

var ErrAsymmetricKeyPathsNotSet = errors.New("expected jwt_private_key_path and jwt_public_key_path to be set for all supported asymmetric algorithms")

var ErrEmailNotConfigured = errors.New("expected smtp to be set if email support is enabled")

var ErrFacebookConfig = errors.New("expected facebook_client_id, facebook_client_secret to be set if facebook provider is enabled")

var ErrGithubConfig = errors.New("expected github_client_id, github_client_secret to be set if github providder is enabled")

var ErrGoogleConfig = errors.New("expected google_client_id, google_client_secret to be set if google provider is enabled")

var ErrInvalidCustomDataSchema = errors.New("invalid custom data schema")

var ErrParsingPrivateKey = errors.New("unable to parse private key")

var ErrParsingPublicKey = errors.New("unable to parse public key")

var ErrPhoneEmailDisabled = errors.New("can't disable email and phone at the same time")

var ErrSMSNotConfigured = errors.New("expected sms to be set if phone support is enabled")

var ErrSymmetricSecretNotSet = errors.New("expected jwt_secret to be set for all symmetric algorithms")

var ErrUnableToReadTemplate = errors.New("unable to read template")

var ErrUnsupportedAlgorithm = errors.New("unsupported algorithm")

Types

type Choices

type Choices []string

func (Choices) Search

func (c Choices) Search(value string) bool

type Config

type Config struct {
	AccessTokenCookieName     string           `json:"access_token_cookie_name"`
	AccessTokenCookieDomain   string           `json:"access_token_cookie_domain"`
	AdminOnlyList             bool             `json:"admin_only_list"`
	ChangeTemplate            *TemplateConfig  `json:"change_template"`
	ConfirmationTemplate      *TemplateConfig  `json:"confirmation_template"`
	DatabaseURL               string           `json:"database_url"`
	DisableEmail              bool             `json:"disable_email"`
	DisablePhone              bool             `json:"disable_phone"`
	DisableSignup             bool             `json:"disable_signup"`
	EmailRule                 Regexp           `json:"email_rule"`
	Facebook                  SocialConfig     `json:"facebook"`
	Google                    SocialConfig     `json:"google"`
	Github                    SocialConfig     `json:"github"`
	Host                      string           `json:"host"`
	InstanceURL               string           `json:"instance_url"`
	InvitationTemplate        *TemplateConfig  `json:"invitation_template"`
	JWT                       JWTConfig        `json:"jwt"`
	LockoutPolicy             LockoutPolicy    `json:"lockout_policy"`
	LoginHook                 string           `json:"login_hook"`
	LogLevel                  logrus.Level     `json:"log_level"`
	MaxConnectionPoolSize     int              `json:"max_connection_pool_size"`
	MinutesBetweenEmailChange time.Duration    `json:"minutes_between_email_change"`
	MinutesBetweenPhoneChange time.Duration    `json:"minutes_between_phone_change"`
	MinutesBetweenResend      time.Duration    `json:"minutes_between_resend"`
	PasswordHashCost          uint8            `json:"password_hash_cost"`
	PasswordRule              Regexp           `json:"password_rule"`
	PhoneRule                 Regexp           `json:"phone_rule"`
	Port                      uint16           `json:"port"`
	RecoveryTemplate          *TemplateConfig  `json:"recovery_template"`
	RefreshTokenCookieName    string           `json:"refresh_token_cookie_name"`
	RefreshTokenCookieDomain  string           `json:"refresh_token_cookie_domain"`
	SetAccessTokenCookie      bool             `json:"set_access_token_cookie"`
	SetRefreshTokenCookie     bool             `json:"set_refresh_token_cookie"`
	SiteURL                   string           `json:"site_url"`
	SMS                       *SMSConfig       `json:"sms"`
	SMTP                      *SMTPConfig      `json:"smtp"`
	SocialRedirectPage        string           `json:"social_redirect_page"`
	CustomDataSchema          map[string]Field `json:"custom_data_schema"`
	MetadataPath              *JSONPath        `json:"metadata_path"`
	AdminRoles                []string         `json:"admin_roles"`
	ReadOnlyRoles             []string         `json:"read_only_roles"`
	RolesPath                 JSONPath         `json:"roles_path"`
}

func New

func New(path string) (*Config, error)

func NewDefaultConfig

func NewDefaultConfig() *Config

type Field

type Field struct {
	Type     FieldType `json:"type"`
	Required bool      `json:"required"`
	Max      *float64  `json:"maximum"`
	Min      *float64  `json:"minimum"`
	Format   *Regexp   `json:"format"`
	Choices  *Choices  `json:"choices"`
}

func (Field) Validate

func (f Field) Validate(name string, value interface{}) error

type FieldType

type FieldType string

const (
	String  FieldType = "string"
	Integer FieldType = "integer"
	Boolean FieldType = "boolean"
	Float   FieldType = "float"
)

type JSONPath

type JSONPath struct {
	jp.Expr
}

func (*JSONPath) MarshalText

func (p *JSONPath) MarshalText() ([]byte, error)

func (*JSONPath) UnmarshalText

func (p *JSONPath) UnmarshalText(text []byte) error

type JWTConfig

type JWTConfig struct {
	Aud            string        `json:"audience"`
	Alg            string        `json:"algorithm"`
	Exp            time.Duration `json:"expiry"`
	Iss            string        `json:"issuer"`
	PrivateKeyPath string        `json:"private_key_path"`
	PublicKeyPath  string        `json:"public_key_path"`
	Secret         string        `json:"secret"`
	Type           string        `json:"-"`
	// contains filtered or unexported fields
}

func (*JWTConfig) GetDecodingKey

func (c *JWTConfig) GetDecodingKey() interface{}

func (*JWTConfig) GetSigningKey

func (c *JWTConfig) GetSigningKey() interface{}

type LockoutPolicy

type LockoutPolicy struct {
	Attempts uint8         `json:"attempts"`
	For      time.Duration `json:"for"`
}

type Regexp

type Regexp struct {
	regexp.Regexp
}

func (*Regexp) MarshalText

func (r *Regexp) MarshalText() ([]byte, error)

func (*Regexp) UnmarshalText

func (r *Regexp) UnmarshalText(text []byte) error

type SMSConfig

type SMSConfig struct {
	URL     string            `json:"url"`
	Method  string            `json:"method"`
	Source  string            `json:"source"`
	Mapping *SMSMapping       `json:"mapping"`
	Headers map[string]string `json:"headers"`
	Extra   map[string]string `json:"extra"`
}

type SMSMapping

type SMSMapping struct {
	Source      string `json:"source"`
	Destination string `json:"destination"`
	Message     string `json:"message"`
}

type SMTPConfig

type SMTPConfig struct {
	Email    string `json:"email"`
	Host     string `json:"host"`
	Password string `json:"password"`
	Port     uint16 `json:"port"`
	Username string `json:"username"`
}

type SocialConfig

type SocialConfig struct {
	Enabled bool   `json:"enabled"`
	ID      string `json:"id"`
	Secret  string `json:"secret"`
}

type Template

type Template struct {
	*mustache.Template
}

func (*Template) MarshalText

func (t *Template) MarshalText() ([]byte, error)

func (*Template) UnmarshalText

func (t *Template) UnmarshalText(text []byte) error

type TemplateConfig

type TemplateConfig struct {
	Path    string    `json:"path"`
	Subject string    `json:"subject"`
	Email   *Template `json:"-"`
	SMS     *Template `json:"sms"`
}