config

Documentation

Index

• type Config
• type Debug
• type Drivers
• type GRPCConfig
• type JSONDriver
• type LDAPDriver
• type LDAPGroupSchema
• type LDAPUserSchema
• type Log
• type OwnCloudSQLDriver
• type RESTProvider
• type Service
• type TokenManager
• type Tracing

Types

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 `` /* 155-byte string literal not displayed */

	Driver  string  `` /* 142-byte string literal not displayed */
	Drivers Drivers `yaml:"drivers"`

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

type Debug

type Debug struct {
	Addr   string `` /* 143-byte string literal not displayed */
	Token  string `yaml:"token" env:"GROUPS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint."`
	Pprof  bool   `yaml:"pprof" env:"GROUPS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling."`
	Zpages bool   `yaml:"zpages" env:"GROUPS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing in-memory traces."`
}

type Drivers

type Drivers struct {
	LDAP        LDAPDriver        `yaml:"ldap"`
	OwnCloudSQL OwnCloudSQLDriver `yaml:"owncloudsql"`

	JSON JSONDriver   `yaml:"json,omitempty"` // not supported by the oCIS product, therefore not part of docs
	REST RESTProvider `yaml:"rest,omitempty"` // not supported by the oCIS product, therefore not part of docs
}

type GRPCConfig

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

type JSONDriver

type JSONDriver struct {
	File string
}

type LDAPDriver

type LDAPDriver struct {
	URI                      string          `` /* 137-byte string literal not displayed */
	CACert                   string          `` /* 191-byte string literal not displayed */
	Insecure                 bool            `` /* 168-byte string literal not displayed */
	BindDN                   string          `` /* 135-byte string literal not displayed */
	BindPassword             string          `` /* 128-byte string literal not displayed */
	UserBaseDN               string          `yaml:"user_base_dn" env:"LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN" desc:"Search base DN for looking up LDAP users."`
	GroupBaseDN              string          `yaml:"group_base_dn" env:"LDAP_GROUP_BASE_DN;GROUPS_LDAP_GROUP_BASE_DN" desc:"Search base DN for looking up LDAP groups."`
	UserScope                string          `` /* 163-byte string literal not displayed */
	GroupScope               string          `` /* 167-byte string literal not displayed */
	GroupSubstringFilterType string          `` /* 334-byte string literal not displayed */
	UserFilter               string          `` /* 161-byte string literal not displayed */
	GroupFilter              string          `` /* 137-byte string literal not displayed */
	UserObjectClass          string          `` /* 175-byte string literal not displayed */
	GroupObjectClass         string          `` /* 179-byte string literal not displayed */
	IDP                      string          `` /* 185-byte string literal not displayed */
	UserSchema               LDAPUserSchema  `yaml:"user_schema"`
	GroupSchema              LDAPGroupSchema `yaml:"group_schema"`
}

type LDAPGroupSchema

type LDAPGroupSchema struct {
	ID              string `` /* 178-byte string literal not displayed */
	IDIsOctetString bool   `` /* 307-byte string literal not displayed */
	Mail            string `` /* 147-byte string literal not displayed */
	DisplayName     string `` /* 192-byte string literal not displayed */
	Groupname       string `` /* 139-byte string literal not displayed */
	Member          string `` /* 130-byte string literal not displayed */
}

type LDAPUserSchema

type LDAPUserSchema struct {
	ID              string `` /* 175-byte string literal not displayed */
	IDIsOctetString bool   `` /* 303-byte string literal not displayed */
	Mail            string `` /* 129-byte string literal not displayed */
	DisplayName     string `` /* 149-byte string literal not displayed */
	Username        string `` /* 133-byte string literal not displayed */
}

type Log

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

type OwnCloudSQLDriver

type OwnCloudSQLDriver struct {
	DBUsername         string `` /* 130-byte string literal not displayed */
	DBPassword         string `yaml:"db_password" env:"GROUPS_OWNCLOUDSQL_DB_PASSWORD" desc:"Password for the database user."`
	DBHost             string `yaml:"db_host" env:"GROUPS_OWNCLOUDSQL_DB_HOST" desc:"Hostname of the database server."`
	DBPort             int    `yaml:"db_port" env:"GROUPS_OWNCLOUDSQL_DB_PORT" desc:"Network port to use for the database connection."`
	DBName             string `yaml:"db_name" env:"GROUPS_OWNCLOUDSQL_DB_NAME" desc:"Name of the owncloud database."`
	IDP                string `` /* 162-byte string literal not displayed */
	Nobody             int64  `yaml:"nobody" env:"GROUPS_OWNCLOUDSQL_NOBODY" desc:"Fallback number if no numeric UID and GID properties are provided."`
	JoinUsername       bool   `yaml:"join_username" env:"GROUPS_OWNCLOUDSQL_JOIN_USERNAME" desc:"Join the user properties table to read usernames."`
	JoinOwnCloudUUID   bool   `yaml:"join_owncloud_uuid" env:"GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID" desc:"Join the user properties table to read user IDs."`
	EnableMedialSearch bool   `` /* 220-byte string literal not displayed */
}

type RESTProvider

type RESTProvider struct {
	ClientID          string
	ClientSecret      string
	RedisAddr         string
	RedisUsername     string
	RedisPassword     string
	IDProvider        string
	APIBaseURL        string
	OIDCTokenEndpoint string
	TargetAPI         string
}

type Service

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

type TokenManager

type TokenManager struct {
	JWTSecret string `yaml:"jwt_secret" env:"OCIS_JWT_SECRET;GROUPS_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;GROUPS_TRACING_ENABLED" desc:"Activates tracing."`
	Type      string `` /* 191-byte string literal not displayed */
	Endpoint  string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT;GROUPS_TRACING_ENDPOINT" desc:"The endpoint of the tracing agent."`
	Collector string `` /* 229-byte string literal not displayed */
}