UMA Service

New in version 2.0.

Starting in 2.0, ESS provides a User Managed Access Grant 2.0 (UMA) service. This service allows clients to exchange a token or credential in one format for an access token that can be used when interacting with a Pod resource. For example, a client can exchange an OpenID Connect ID token along with one or more Verifiable Credential documents for a single access token.

ESS’ UMA service is responsible for handling the UMA authorization flow.

If an agent tries to access a Pod resource on ESS, ESS directs the resource request to the UMA authorization service which checks to see if the agent has the appropriate access privileges:

• If the agent does not have the appropriate access privileges, the UMA flow allows for the user to acquire the appropriate access privilege through an iterative exchange (e.g., first with an access grant VC and then with the ID token). These access privileges are enforced with the ACP data model.

UMA Service Endpoint

By default, the ESS UMA Service runs from the following root URL:

https://uma.<ESS Domain>

To change the root UMA service URL, see INRUPT_UMA_ISSUER.

Discovery

ESS provides a metadata resource /.well-known/uma2-configuration from the root UMA service URL:

https://uma.<ESS DOMAIN>/.well-known/uma2-configuration

The endpoint returns the current deployment’s UMA service configuration.

ESS Services with UMA Flow Support

The following ESS services support the use of UMA authorization flow:

• Query (QPF) service [1],

• Pod Storage service [1], and

• (Starting in 2.1) Access Grant service (for its endpoints) [1].

For QPF Service’s UMA-related configuration, see:

• UMA Configuration

For Pod Storage Service’s UMA-related configuration, see:

• Pod Storage UMA Configuration.

For Access Grant Service’s UMA-related configuration, see:

• UMA Configuration.

[1] (1,2,3)

The services also support the use of Solid-OpenID Connect (OIDC) access tokens.

Configuration

As part of the installation process, Inrupt provides base Kustomize overlays and associated files that require deployment-specific configuration inputs.

The following configuration options are available for the service and may be set as part of updating the inputs for your deployment. The Inrupt-provided base Kustomize overlays may be using updated configuration values that differ from the default values.

Required

INRUPT_UMA_ISSUER

The URI of the UMA service.

See also:

• INRUPT_AUTHZ_AS_URI configuration for Pod Services.

• INRUPT_AUTHZ_AS_URI configuration for Query Service.

• INRUPT_AUTHZ_AS_URI configuration for Query Indexer.

• INRUPT_AUTHZ_AS_URI configuration for Access Grant Service.

INRUPT_UMA_VC_VERIFIER

The URI of the VC HTTP API verifier.

QUARKUS_GRPC_CLIENTS_AUTHZ_HOST

The gRPC host of the Authorization Server.

QUARKUS_GRPC_CLIENTS_AUTHZ_PORT

The gRPC port of the Authorization Server.

SMALLRYE_JWT_SIGN_KEY_LOCATION

The location of a signing key in JWK format.

See also:

• SMALLRYE_JWT_ENCRYPT_KEY_LOCATION configuration for Pod Services.

Kafka Configuration

Tip

See also ESS’ Kafka Configuration.

INRUPT_KAFKA_AUDITV1EVENTSENCRYPTED_CIPHER_PASSWORD

The strong cipher key to use when running auditing with encrypted messages over the auditv1eventsencrypted topic.

INRUPT_KAFKA_AUDITV1EVENTSPRODUCERENCRYPTED_CIPHER_PASSWORD

The strong cipher key to use when running auditing with encrypted messages over the auditv1eventsproducerencrypted topic.

New in version 2.2.0.

KAFKA_BOOTSTRAP_SERVERS

Default: localhost:9092

Comma-delimited list of Kafka broker servers for use by ESS services, including this service.

Setting KAFKA_BOOTSTRAP_SERVERS configures ESS to use the same Kafka instance(s) for all its Kafka message channels (e.g., solidresource and auditv1out message channels). This service uses the auditv1out message channel.

Note

Inrupt-provided overlays default to using KAFKA_BOOTSTRAP_SERVERS.

To use a different Kafka instance for the auditv1out channel, use specific message channel configuration.

See also ESS’ Kafka Configuration.

Optional

Configuration Logging

Starting in 2.2, ESS services log their startup configuration.

INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW

Default: inrupt,smallrye.jwt.expiration.grace,mp.jwt.verify.clock.skew,smallrye.jwt.always-check-authorization,smallrye.jwt.token.decryption.kid,smallrye.jwt.token.schemes,smallrye.jwt.require.named-principal,smallrye.jwt.time-to-live,smallrye.jwt.jwks.refresh-interval,smallrye.jwt.jwks.forced-refresh-interval,smallrye.jwt.required.claims,mp.jwt.verify.audiences

A comma-separated list of configuration property prefixes (case-sensitive) that determine which configurations are logged:

• If the list is empty, NO configuration property is logged.

• If a configuration property starts with a listed prefix (case-sensitive), the configuration property and its value are logged unless the configuration also matches a prefix in INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY (which acts as a filter on INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW list).

  As such, if the configuration matches prefix in both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY, the INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY takes precedence and the configuration is not logged. For example, if inrupt. is an allow prefix, but inrupt.kafka. is a deny prefix, all configurations that start with inrupt.kafka. are excluded from the logs.

When specifying the prefixes, you can specify the prefixes using one of two formats:

• using dot notation (e.g., inrupt.foobar.), or

• using the MicroProfile Config environmental variables conversion value (e.g., INRUPT_FOOBAR_).

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

Tip

To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example:

• If using dot-notation, if you want to match configuration properties of the form foobar.<xxxx>..., specify foobar. (including the dot .) instead of, for example, foo or foobar.

• If using converted form, if you want to match configuration properties of the form FOOBAR_<XXXX>..., specify FOOBAR_ (including the underscore _) instead of, for example, FOO or FOOBAR.

New in version 2.2.0.

INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY

Default: inrupt.kafka

A comma-separated list of configuration name prefixes (case-sensitive) that determines which configurations (that would otherwise match the INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW) are not logged. That is, INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY acts as a filter on INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW. For example:

• If foobar. is an allowed prefix, to suppress foobar.private.<anything>, you can specify foobar.private. to the deny list.

• If foobar. is not an allowed prefix, no property starting with foobar. is logged. As such, you do not need to specify foobar.private to the deny list.

When specifying the prefixes, you can specify the prefixes using one of two formats:

• using dot notation (e.g., inrupt.foobar.), or

• using the MicroProfile Config environmental variables conversion value (e.g., INRUPT_FOOBAR_).

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

New in version 2.2.0.

Logging Redaction

INRUPT_LOGGING_REDACTION_NAME_ACTION

Default: REPLACE

Type of the redaction to perform. Supported values are:

Action	Description
REPLACE	Default. Replaces the matching text with a specified replacement.
PLAIN	Leaves the matching field unprocessed. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD).
DROP	Suppresses the matching field. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD).
PRIORITIZE	Changes the log level of the matching message.
SHA256	Replaces the matching text with its hash.

• If the action is REPLACE (default), see also INRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT.

• If the action is to PRIORITIZE, see also INRUPT_LOGGING_REDACTION_{NAME}_LEVEL.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_EXCEPTION

Fully qualified name of the exception class to match in the log messages (includes inner exception). Configure to target an exception message class.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_FIELD

Exact name of the field to match in the log messages. Configure to target a specific log message field for redaction.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_LEVEL

A new log level to use for the log message if the INRUPT_LOGGING_REDACTION_{NAME}_ACTION is PRIORITIZE.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_PATTERN

A regex (see Java regex pattern) to match in the log messages. Configure to target log message text that matches a specified pattern.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_REPLACEMENT

Replacement text to use if the INRUPT_LOGGING_REDACTION_{NAME}_ACTION is REPLACE.

If unspecified, defaults to [REDACTED].

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

Application-Defined Metadata Propagation

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW

A comma-separated list [2] of application-defined properties that can be included in the associated audit events (unless specified in the corresponding INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY).

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To include a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY

A comma-separated list [2] of application-defined properties to exclude from the associated audit messages. This setting takes precedence over INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

INRUPT_LOGGING_REQUEST_METADATA_ALLOW

A comma-separated list [2] of application-defined properties that can be included in the associated log messages (unless specified in the corresponding INRUPT_LOGGING_REQUEST_METADATA_DENY).

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To include a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

INRUPT_LOGGING_REQUEST_METADATA_DENY

A comma-separated list [2] of application-defined properties to exclude from the associated log messages. This setting takes precedence over INRUPT_LOGGING_REQUEST_METADATA_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW

A comma-separated list [2] of non-baggage request headers to add to the baggage (unless specified in the corresponding INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY); i.e., include these non-baggage request headers as application-defined properties.

The configuration is case-insensitive; i.e., the listed headers do not need to match the case of the client request headers. For example, a list that includes x-correlation-id can match x-correlation-id header, X-CoRrElAtIoN-Id header, etc.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY

A comma-separated list [2] of non-baggage request headers to exclude from being added to the baggage; i.e., excludes these headers as application-defined properties. This setting takes precedence over INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW.

The configuration is case-insensitive; i.e., the listed headers do not need to match the case of the client request headers. For example, a list that includes x-correlation-id can match (and exclude) x-correlation-id header, X-CoRrElAtIoN-Id header, etc.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_OVERRIDES

A flag that determines ESS behavior when metadata property is defined both as a header and as a baggage entry:

• If true, ESS updates/overrides the baggage entry with the header value.

• If false (the default), ESS keeps the baggage entry.

For details, Duplicate Property Definition.

New in version 2.2.0.

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW

A comma-separated list [2] of application-defined properties that can return as response headers (unless specified in the corresponding INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY).

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

• To return a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

• You may need to update QUARKUS_HTTP_CORS_EXPOSED_HEADERS to extend the list of CORS-safelisted response headers.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY

A comma-separated list [2] of application-defined properties to exclude from returning as response headers. This setting takes precedence over INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

• Manage Application-Defined Metadata Propagation to configure.

• Application-Defined Metadata for more information.

New in version 2.2.0.

General

INRUPT_JSONLD_CONTEXT_ALLOW_LIST

Default: https://vc.{ESS DOMAIN}/credentials/v1

A comma-delimited list [2] of trusted JSON-LD context URIs allowed to be dereferenced. The list is in addition to the following contexts (i.e., you do not need to include the following contexts):

• https://www.w3.org/2018/credentials/v1

• https://schema.inrupt.com/credentials/v1.jsonld

• https://schema.inrupt.com/credentials/v2.jsonld

• https://w3id.org/security/data-integrity/v1

• https://w3id.org/vc-revocation-list-2020/v1

• https://w3id.org/vc/status-list/2021/v1

• https://w3id.org/security/suites/ed25519-2020/v1

• http://www.w3.org/ns/odrl.jsonld

Recommended

If possible, set this configuration value to that of the Access Grant Service. Mismatched values may result in the failure to parse access request/grant VCs.

Warning

Do not set to an empty list (i.e., do not unset this configuration). If empty, any context URI (with the exception of those URIs in INRUPT_JSONLD_CONTEXT_DENY_LIST) is allowed, including untrusted and malicious contexts.

INRUPT_JSONLD_CONTEXT_DENY_LIST

A deny-list of JSON-LD context URIs. URIs listed in this configuration are prevented from being dereferenced.

See also: INRUPT_JSONLD_CONTEXT_ALLOW_LIST.

INRUPT_JWT_ALLOWED_SIGNATURE_ALGORITHMS

Default: ES256, RS256

A comma-separated list that specifies the allowed encryption algorithms used to sign ID tokens.

INRUPT_JWT_ISSUER_ALLOW_LIST

A comma-separated list [2] of trusted issuers of Solid-OIDC tokens.

• If unset, the service accepts Solid-OIDC tokens from all issuers with the exception of those in the INRUPT_JWT_ISSUER_DENY_LIST.

• If set, the service accepts only the Solid-OIDC tokens from the issuers in the list with the following exception:

  • If an issuer is in both INRUPT_JWT_ISSUER_ALLOW_LIST and INRUPT_JWT_ISSUER_DENY_LIST, the INRUPT_JWT_ISSUER_DENY_LIST supersedes the INRUPT_JWT_ISSUER_ALLOW_LIST and the issuer is not accepted by ESS.

See also INRUPT_JWT_ISSUER_DENY_LIST.

Tip

Ensure that the UMA service’s INRUPT_JWT_ISSUER_ALLOW_LIST is consistent with the INRUPT_JWT_ISSUER_ALLOW_LIST value set in ESS Services with UMA Flow Support:

• INRUPT_JWT_ISSUER_ALLOW_LIST configuration for Pod Services.

• INRUPT_JWT_ISSUER_ALLOW_LIST configuration for Query Service.

• INRUPT_JWT_ISSUER_ALLOW_LIST configuration for Access Grant Service.

INRUPT_JWT_ISSUER_DENY_LIST

A comma-separated list [2] of disallowed issuers of Solid-OIDC tokens.

• If unset, the service accepts Solid-OIDC tokens from all issuers unless INRUPT_JWT_ISSUER_ALLOW_LIST is set, in which case, the service only accepts tokens from those in the INRUPT_JWT_ISSUER_ALLOW_LIST.

• If set, the service disallows the Solid-OIDC tokens from the issuers in the list. If INRUPT_JWT_ISSUER_ALLOW_LIST is also set, issuers not in the INRUPT_JWT_ISSUER_ALLOW_LIST are also disallowed.

INRUPT_UMA_DPOP_ALGORITHMS

Default: ES256, RS256

The permitted DPoP proof algorithms.

INRUPT_UMA_VC_ISSUER_ALLOW_LIST

Default: https://vc.{ESS_DOMAIN}

A comma-delimited list [2] of VC issuers accepted by the UMA service. The UMA service uses this value to determine whether to exchange a VC for an UMA access token.

For example, ESS’ Access Grant service (https://vc.{ESS_DOMAIN}) issues access requests and access grants as VCs. To have UMA exchange the access requests and access grants for UMA tokens, INRUPT_UMA_VC_ISSUER_ALLOW_LIST has as its default value the ESS’ Access Grant service’s base URL.

Warning

Issuers in this list are fully trusted to issue any type of VC.

• For security reasons, do not unset the configuration property. If unset, the UMA service accepts all VC issuers; i.e., UMA service will issue an UMA access token in exchange for VCs from any issuer.

• List only trusted issuers. Otherwise, a malicious issuer could issue a VC on behalf of any user without their knowledge or consent, and exchange it for a UMA token.

New in version 2.1.

INRUPT_UMA_VC_REVOCATION_LIST_CREDENTIAL_ALLOW_LIST

Default: unset

A comma-delimited list [2] of permitted domains for VC revocation list credentials.

If unset, the service accepts all domains. (Default)

New in version 2.1.

INRUPT_UMA_VC_VERIFICATION_METHOD_ALLOW_LIST

Default: unset

A comma-delimited list [2] of permitted domains for VC verification methods and corresponding public keys.

If unset, the service accepts all domains. (Default)

New in version 2.1.

INRUPT_VC_ISSUER

The discoverable issuer of verifiable credentials.

QUARKUS_LOG_LEVEL

Default: INFO

Logging level.

SMALLRYE_JWT_NEW_TOKEN_LIFESPAN

Default: 300

The number of seconds that tokens will live.

Additional Information

See also https://quarkus.io/guides/all-config.

[2] (1,2,3,4,5,6,7,8,9,10,11,12,13,14)

Whitespaces are preserved when parsing comma-delimited lists (i.e., the parsed string values are not trimmed). For example, when parsed, "value1, value2,value3 " results in "value1", " value2", "value3 ".