Auth Bearer Service Configuration

Table of Contents

Introduction
Configuration
- Environment Variables
- YAML Example

Introduction

The Infinite Scale Auth Bearer service authenticates OpenID Connect bearer tokens.

Services are under development because of the

stage of Infinite Scale. Their service, environment variables and configuration may change. Forgive us if there are mistakes or information is missing. Feel free to report issues and we’ll take care of them as soon as possible on github. You want to fix them yourself? We’d appreciate that even more.

Configuration

Environment Variables

The auth-bearer extension is configured via the following environment variables:

Environment variables for the auth-bearer extension
Name	Type	Default Value	Description
`OCIS_TRACING_ENABLED` `AUTH_BEARER_TRACING_ENABLED`	bool	false	Activates tracing.
`OCIS_TRACING_TYPE` `AUTH_BEARER_TRACING_TYPE`	string		The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.
`OCIS_TRACING_ENDPOINT` `AUTH_BEARER_TRACING_ENDPOINT`	string		The endpoint of the tracing agent.
`OCIS_TRACING_COLLECTOR` `AUTH_BEARER_TRACING_COLLECTOR`	string		The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.
`OCIS_LOG_LEVEL` `AUTH_BEARER_LOG_LEVEL`	string		The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".
`OCIS_LOG_PRETTY` `AUTH_BEARER_LOG_PRETTY`	bool	false	Activates pretty log output.
`OCIS_LOG_COLOR` `AUTH_BEARER_LOG_COLOR`	bool	false	Activates colorized log output.
`OCIS_LOG_FILE` `AUTH_BEARER_LOG_FILE`	string		The path to the log file. Activates logging to this file if set.
`AUTH_BEARER_DEBUG_ADDR`	string	127.0.0.1:9149	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
`AUTH_BEARER_DEBUG_TOKEN`	string		Token to secure the metrics endpoint
`AUTH_BEARER_DEBUG_PPROF`	bool	false	Enables pprof, which can be used for profiling
`AUTH_BEARER_DEBUG_ZPAGES`	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
`AUTH_BEARER_GRPC_ADDR`	string	127.0.0.1:9148	The bind address of the GRPC service.
`AUTH_BEARER_GRPC_PROTOCOL`	string	tcp	The transport protocol of the grpc service.
`OCIS_JWT_SECRET` `AUTH_BEARER_JWT_SECRET`	string		The secret to mint and validate jwt tokens.
`REVA_GATEWAY`	string	127.0.0.1:9142	The CS3 gateway endpoint.
`AUTH_BEARER_SKIP_USER_GROUPS_IN_TOKEN`	bool	false	Disables the encoding of the user’s group memberships in the reva access token. This reduces the token size, especially when users are members of a large number of groups.
`OCIS_URL` `OCIS_OIDC_ISSUER` `AUTH_BEARER_OIDC_ISSUER`	string	https://localhost:9200	URL of the OIDC issuer. It defaults to URL of the builtin IDP.
`OCIS_INSECURE` `AUTH_BEARER_OIDC_INSECURE`	bool	false	Allow insecure connections to the OIDC issuer.
`AUTH_BEARER_OIDC_ID_CLAIM`	string	preferred_username	Name of the claim, which holds the user identifier.
`AUTH_BEARER_OIDC_UID_CLAIM`	string		Name of the claim, which holds the UID.
`AUTH_BEARER_OIDC_GID_CLAIM`	string		Name of the claim, which holds the GID.

Since Version: + added, - deprecated

YAML Example

# Autogenerated
# Filename: auth-bearer-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9149
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9148
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
skip_user_groups_in_token: false
oidc:
  issuer: https://localhost:9200
  insecure: false
  id_claim: preferred_username
  uid_claim: ""
  gid_claim: ""