UMA Service

Added 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.

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

INRUPT_JSONLD_CONTEXT_ALLOW_LIST

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

A comma-delimited list 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 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 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 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.

Added in version 2.1.

INRUPT_UMA_VC_REVOCATION_LIST_CREDENTIAL_ALLOW_LIST

Default: unset

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

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

Added in version 2.1.

INRUPT_UMA_VC_VERIFICATION_METHOD_ALLOW_LIST

Default: unset

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

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

Added 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.