Auth Bearer Service Configuration

Introduction

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

Default Values

  • Users listens on port 9148 by default.

The auth Service Family

Infinite Scale uses several authentication services for different use cases. All services that start with auth- are part of the authentication service family. Each member authenticates requests with different scopes.


As of now, these auth services exist

auth-app

Handles 3rd party app authentication.

auth-basic

Handles basic authentication.

auth-bearer

Handles OIDC authentication.

auth-machine

Handles interservice authentication when a user is impersonated.

auth-service

Handles interservice authentication when using service accounts.

Built in OpenID Connect Identity Provider

A default Infinite Scale deployment will start a built-in OpenID Connect identity provider but can be configured to use an external one as well.

Scalability

There is no persistance or caching. The proxy caches verified auth bearer tokens. Requests will be forwarded to the identity provider. Therefore, multiple instances of the auth-bearer service can be started without further configuration. Currently, the auth registry used by the gateway service can only use a single instance of the service. To use more than one auth provider per deployment, you need to scale the gateway. This will change over time and be documented when available.

Configuration

Environment Variables

The auth-bearer service is configured via the following environment variables. Read the Environment Variable Types documentation for important details. Column IV shows with which release the environment variable has been introduced.

  • master + Rolling 6.6.1

Environment variables for the auth-bearer service
Name IV Type Default Value Description

OCIS_TRACING_ENABLED
AUTH_BEARER_TRACING_ENABLED

pre5.0

bool

false

Activates tracing.

OCIS_TRACING_TYPE
AUTH_BEARER_TRACING_TYPE

pre5.0

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

pre5.0

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
AUTH_BEARER_TRACING_COLLECTOR

pre5.0

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

pre5.0

string

The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.

OCIS_LOG_PRETTY
AUTH_BEARER_LOG_PRETTY

pre5.0

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
AUTH_BEARER_LOG_COLOR

pre5.0

bool

false

Activates colorized log output.

OCIS_LOG_FILE
AUTH_BEARER_LOG_FILE

pre5.0

string

The path to the log file. Activates logging to this file if set.

AUTH_BEARER_DEBUG_ADDR

pre5.0

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

pre5.0

string

Token to secure the metrics endpoint.

AUTH_BEARER_DEBUG_PPROF

pre5.0

bool

false

Enables pprof, which can be used for profiling.

AUTH_BEARER_DEBUG_ZPAGES

pre5.0

bool

false

Enables zpages, which can be used for collecting and viewing in-memory traces.

AUTH_BEARER_GRPC_ADDR

pre5.0

string

127.0.0.1:9148

The bind address of the GRPC service.

OCIS_GRPC_PROTOCOL
AUTH_BEARER_GRPC_PROTOCOL

pre5.0

string

tcp

The transport protocol of the GRPC service.

OCIS_JWT_SECRET
AUTH_BEARER_JWT_SECRET

pre5.0

string

The secret to mint and validate jwt tokens.

OCIS_REVA_GATEWAY

pre5.0

string

com.owncloud.api.gateway

The CS3 gateway endpoint.

OCIS_GRPC_CLIENT_TLS_MODE

pre5.0

string

TLS mode for grpc connection to the go-micro based grpc services. Possible values are 'off', 'insecure' and 'on'. 'off': disables transport security for the clients. 'insecure' allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server certificate verification.

OCIS_GRPC_CLIENT_TLS_CACERT

pre5.0

string

Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.

AUTH_BEARER_SKIP_USER_GROUPS_IN_TOKEN

pre5.0

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

pre5.0

string

https://localhost:9200

URL of the OIDC issuer. It defaults to URL of the builtin IDP.

OCIS_INSECURE
AUTH_BEARER_OIDC_INSECURE

pre5.0

bool

false

Allow insecure connections to the OIDC issuer.

AUTH_BEARER_OIDC_ID_CLAIM

pre5.0

string

preferred_username

Name of the claim, which holds the user identifier.

AUTH_BEARER_OIDC_UID_CLAIM

pre5.0

string

Name of the claim, which holds the UID.

AUTH_BEARER_OIDC_GID_CLAIM

pre5.0

string

Name of the claim, which holds the GID.

YAML Example

  • master + Rolling 6.6.1

# 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
  tls: null
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: com.owncloud.api.gateway
  tls:
    mode: ""
    cacert: ""
skip_user_groups_in_token: false
oidc:
  issuer: https://localhost:9200
  insecure: false
  id_claim: preferred_username
  uid_claim: ""
  gid_claim: ""