config

Documentation

Index

• type AuthProviders
• type Config
• type Debug
• type GRPCConfig
• type JSONProvider
• type LDAPGroupSchema
• type LDAPProvider
• type LDAPUserSchema
• type Log
• type OwnCloudSQLProvider
• type Service
• type TokenManager
• type Tracing

Types

type AuthProviders

type AuthProviders struct {
	LDAP        LDAPProvider        `yaml:"ldap"`
	OwnCloudSQL OwnCloudSQLProvider `yaml:"owncloudsql"`
	JSON        JSONProvider        `yaml:"json,omitempty"` // not supported by the oCIS product, therefore not part of docs
}

type Config

type Config struct {
	Commons *shared.Commons `yaml:"-"` // don't use this directly as configuration for a service
	Service Service         `yaml:"-"`
	Tracing *Tracing        `yaml:"tracing"`
	Log     *Log            `yaml:"log"`
	Debug   Debug           `yaml:"debug"`

	GRPC GRPCConfig `yaml:"grpc"`

	TokenManager *TokenManager `yaml:"token_manager"`
	Reva         *shared.Reva  `yaml:"reva"`

	SkipUserGroupsInToken bool          `` /* 254-byte string literal not displayed */
	AuthProvider          string        `` /* 146-byte string literal not displayed */
	AuthProviders         AuthProviders `yaml:"auth_providers"`

	Supervised bool            `yaml:"-"`
	Context    context.Context `yaml:"-"`
}

type Debug

type Debug struct {
	Addr   string `` /* 147-byte string literal not displayed */
	Token  string `yaml:"token" env:"AUTH_BASIC_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint."`
	Pprof  bool   `yaml:"pprof" env:"AUTH_BASIC_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling."`
	Zpages bool   `` /* 130-byte string literal not displayed */
}

type GRPCConfig

type GRPCConfig struct {
	Addr      string                 `yaml:"addr" env:"AUTH_BASIC_GRPC_ADDR" desc:"The bind address of the GRPC service."`
	TLS       *shared.GRPCServiceTLS `yaml:"tls"`
	Namespace string                 `yaml:"-"`
	Protocol  string                 `yaml:"protocol" env:"AUTH_BASIC_GRPC_PROTOCOL" desc:"The transport protocol of the GRPC service."`
}

type JSONProvider

type JSONProvider struct {
	File string `yaml:"file,omitempty"`
}

type LDAPGroupSchema

type LDAPGroupSchema struct {
	ID              string `` /* 184-byte string literal not displayed */
	IDIsOctetString bool   `` /* 310-byte string literal not displayed */
	Mail            string `` /* 151-byte string literal not displayed */
	DisplayName     string `` /* 196-byte string literal not displayed */
	Groupname       string `` /* 143-byte string literal not displayed */
	Member          string `` /* 134-byte string literal not displayed */
}

type LDAPProvider

type LDAPProvider struct {
	URI              string          `` /* 141-byte string literal not displayed */
	CACert           string          `` /* 183-byte string literal not displayed */
	Insecure         bool            `` /* 172-byte string literal not displayed */
	BindDN           string          `` /* 139-byte string literal not displayed */
	BindPassword     string          `` /* 132-byte string literal not displayed */
	UserBaseDN       string          `yaml:"user_base_dn" env:"LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN" desc:"Search base DN for looking up LDAP users."`
	GroupBaseDN      string          `yaml:"group_base_dn" env:"LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN" desc:"Search base DN for looking up LDAP groups."`
	UserScope        string          `` /* 167-byte string literal not displayed */
	GroupScope       string          `` /* 171-byte string literal not displayed */
	UserFilter       string          `` /* 165-byte string literal not displayed */
	GroupFilter      string          `` /* 141-byte string literal not displayed */
	UserObjectClass  string          `` /* 179-byte string literal not displayed */
	GroupObjectClass string          `` /* 184-byte string literal not displayed */
	LoginAttributes  []string        `` /* 147-byte string literal not displayed */
	IDP              string          `` /* 184-byte string literal not displayed */
	UserSchema       LDAPUserSchema  `yaml:"user_schema"`
	GroupSchema      LDAPGroupSchema `yaml:"group_schema"`
}

type LDAPUserSchema

type LDAPUserSchema struct {
	ID              string `` /* 179-byte string literal not displayed */
	IDIsOctetString bool   `` /* 306-byte string literal not displayed */
	Mail            string `` /* 133-byte string literal not displayed */
	DisplayName     string `` /* 153-byte string literal not displayed */
	Username        string `` /* 137-byte string literal not displayed */
}

type Log

type Log struct {
	Level  string `` /* 169-byte string literal not displayed */
	Pretty bool   `yaml:"pretty" env:"OCIS_LOG_PRETTY;AUTH_BASIC_LOG_PRETTY" desc:"Activates pretty log output."`
	Color  bool   `yaml:"color" env:"OCIS_LOG_COLOR;AUTH_BASIC_LOG_COLOR" desc:"Activates colorized log output."`
	File   string `yaml:"file" env:"OCIS_LOG_FILE;AUTH_BASIC_LOG_FILE" desc:"The path to the log file. Activates logging to this file if set."`
}

type OwnCloudSQLProvider

type OwnCloudSQLProvider struct {
	DBUsername       string `` /* 134-byte string literal not displayed */
	DBPassword       string `yaml:"db_password" env:"AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD" desc:"Password for the database user."`
	DBHost           string `yaml:"db_host" env:"AUTH_BASIC_OWNCLOUDSQL_DB_HOST" desc:"Hostname of the database server."`
	DBPort           int    `yaml:"db_port" env:"AUTH_BASIC_OWNCLOUDSQL_DB_PORT" desc:"Network port to use for the database connection."`
	DBName           string `yaml:"db_name" env:"AUTH_BASIC_OWNCLOUDSQL_DB_NAME" desc:"Name of the owncloud database."`
	IDP              string `` /* 166-byte string literal not displayed */
	Nobody           int64  `yaml:"nobody" env:"AUTH_BASIC_OWNCLOUDSQL_NOBODY" desc:"Fallback number if no numeric UID and GID properties are provided."`
	JoinUsername     bool   `yaml:"join_username" env:"AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME" desc:"Join the user properties table to read usernames"`
	JoinOwnCloudUUID bool   `` /* 130-byte string literal not displayed */
}

type Service

type Service struct {
	Name string `yaml:"-"`
}

type TokenManager

type TokenManager struct {
	JWTSecret string `yaml:"jwt_secret" env:"OCIS_JWT_SECRET;AUTH_BASIC_JWT_SECRET" desc:"The secret to mint and validate jwt tokens."`
}

TokenManager is the config for using the reva token manager

type Tracing

type Tracing struct {
	Enabled   bool   `yaml:"enabled" env:"OCIS_TRACING_ENABLED;AUTH_BASIC_TRACING_ENABLED" desc:"Activates tracing."`
	Type      string `` /* 195-byte string literal not displayed */
	Endpoint  string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT;AUTH_BASIC_TRACING_ENDPOINT" desc:"The endpoint of the tracing agent."`
	Collector string `` /* 233-byte string literal not displayed */
}