Access Grant Service#

Starting in version 2.0, ESS supports an authorization mechanism based on access requests and grants. With access requests and grants:

  1. An agent sends an access request to the resource owner. This request includes the specific access mode(s) (e.g. Read, Write, Append), the resource(s) to access, etc.

  2. The resource owner decides to deny or grant the access request:

    • For an approved request, ESS creates an access grant with an approved status.

    • For a denied request, ESS creates an access grant with a denied status.

  3. If the requesting agent has an approved access grant, the requesting agent can exchange the access grant for an access token in order to access the resource.

Important

Starting in version 2.1:

  • An access request for a Container, by default, also applies to the Container’s descendants, unless explicitly specified otherwise in the request (See inherit: false).

  • An access grant for a Container, by default, also applies to the Container’s descendants, unless explicitly specified otherwise in the grant (See inherit: false).

In the previous version, access request/grant applied only to the explicitly stated resource or resources in the access request/grant, regardless of whether the resource is a Container, an Resource Description Framework (RDF) Resource, or a Non-RDF Resource.

See also Enable Access Grant Usage (ACP).

Access Grant Service#

ESS provides an Access Grant service that serializes access requests and grants as Verifiable Credentials (VCs) and provides various Access Grants endpoints that follow the draft VC API. [2]

ESS Access Grant Service Endpoints#

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

https://vc.<ESS Domain>

To change the root URL, see INRUPT_VC_ISSUER.

The ESS Access Grant Service consists of the following endpoints:

Endpoint

Description

/issue

Issues access requests and grants that are serialized as VCs.

/verify

Verifies access requests and grants that are serialized as VCs.

/status

Updates the status of access grants (i.e., update the status to revoked).

/derive

Query for access requests and grants VCs and derive a Verifiable Presentation that contains the matching access requests and grants VCs.

Endpoint Access Control#

Access Tokens#

ESS Access Grant Service endpoints (/issue, /status, and /derive) require the user to be authenticated. To identify the user, the endpoints support the use of the following tokens:

See also:

Client Allow Lists#

Note

Starting in 2.2.1, the Access Grant Service replaces the INRUPT_VC_CLIENT_ID_ALLOW_LIST configuration with required configurations that specify allow lists by the specific Access Credential Type. These configuration must be set for the Access Grant Service to start.

To restrict client access to the /issue and /status endpoints, see:

To set these configurations, use the ESS-provided overlay inputs/ file ess-verifiable-credentials-client-type-allow-list.env. If keeping default values for these configurations, you only need to set INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSGRANT in the ess-verifiable-credentials-client-type-allow-list.env file.

Access Grant Service Discovery#

ESS provides a Access Grant service metadata resource at the following /.well-known/vc-configuration URI:

https://vc.<ESS Domain>/.well-known/vc-configuration

The endpoint returns a JSON-LD document that includes the locations for the Access Grant Service endpoints:

{
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    "https://vc.<ESS Domain>/credentials/v1"
  ],
  "derivationService": "https://vc.<ESS Domain>/derive",
  "issuerService": "https://vc.<ESS Domain>/issue",
  "statusService": "https://vc.<ESS Domain>/status",
  "supportedSignatureTypes": [
    "Ed25519Signature2020"
  ],
  "verifierService": "https://vc.<ESS Domain>/verify"
}

Access Grant Service 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_VC_ISSUER#

Default: https://vc.<ESS DOMAIN>

Specifies the root URL of the Access Grant service.

QUARKUS_DATASOURCE_JDBC_URL#

Required if using a PostgreSQL database for persistence

The JDBC connection string for the PostgreSQL database.

See also: QUARKUS_DATASOURCE_USERNAME and QUARKUS_DATASOURCE_PASSWORD.

QUARKUS_DATASOURCE_PASSWORD#

Required if using a PostgreSQL database for persistence

The password for the JDBC connector

See also: QUARKUS_DATASOURCE_JDBC_URL and QUARKUS_DATASOURCE_USERNAME.

QUARKUS_DATASOURCE_USERNAME#

Required if using a PostgreSQL database for persistence

The username for the JDBC connector

See also: QUARKUS_DATASOURCE_JDBC_URL and QUARKUS_DATASOURCE_PASSWORD.

QUARKUS_MONGODB_CONNECTION_STRING#

Required if using MongoDB for persistence

The connection string for the MongoDB database

See also INRUPT_VC_MONGODB_DATABASE.

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.

Added in version 2.1.5.

INRUPT_KAFKA_AUDITV1EVENTSPRODUCERENCRYPTED_CIPHER_PASSWORD#

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

Added 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). The Access Grant 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.

UMA Configuration#

INRUPT_AUTHZ_AS_URI#

The URI of the UMA Authorization Server.

The value must match:

Added in version 2.1.

INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER#

The URI of the UMA token issuer.

The value must match INRUPT_AUTHZ_AS_URI.

Added in version 2.1.

INRUPT_JWT_AUTHORIZATION_SERVER_JWKS#

The JWKS endpoint of the INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER.

Added in version 2.1.

OIDC Configuration#

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 [1] of trusted issuers of Solid-OIDC tokens.

See also INRUPT_JWT_ISSUER_DENY_LIST.

Tip

Ensure that ESS UMA service’ INRUPT_JWT_ISSUER_ALLOW_LIST is consistent with the INRUPT_JWT_ISSUER_ALLOW_LIST value set for this service.

INRUPT_JWT_ISSUER_DENY_LIST#

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

Tip

Ensure that ESS’ UMA service’s INRUPT_JWT_ISSUER_DENY_LIST is consistent with the INRUPT_JWT_ISSUER_DENY_LIST value set for this service.

Allow List Configuration#

INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSGRANT#

Determines which applications can access the /issue Endpoint and the /status Endpoint for access grants; i.e., can be used to issue and revoke access requests.

The value can be either:

  • A comma-delimited list [1] of the applications (specifically, their Client IDs) that are allowed access.

  • One of the following reserved keywords (case-insensitive):

    • Any to allow all applications.

    • None to disallow all applications.

See Client Allow Lists.

Added in version 2.2.1.

INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSREQUEST#

Default: Any

Determines which applications can access the /issue Endpoint and the /status Endpoint for access requests; i.e., can be used to issue and revoke access requests.

The value can be either:

  • A comma-delimited list [1] of the applications (specifically, their Client IDs) that are allowed access.

  • One of the following reserved keywords (case-insensitive):

    • Any to allow all applications.

    • None to disallow all applications.

See Client Allow Lists.

Added in version 2.2.1.

Optional Configuration#

INRUPT_JSONLD_CACHE_HOURS#

Default: 6

The number of hours to cache remote JSON-LD context documents.

See also:

INRUPT_JSONLD_CACHE_SIZE#

Default: 100

The maximum number of entries in the internal cache of remote JSON-LD context documents.

See also:

INRUPT_JSONLD_CONTEXT_ALLOW_LIST#

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

A comma-delimited list [1] 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 UMA 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.

See also:

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_HTTP_MAX_REDIRECTS#

Default: 10

The maximum number of redirects allowed when fetching JSON-LD context documents.

See also:

INRUPT_JSONLD_HTTP_TIMEOUT#

Default: 10

The timeout in seconds for fetching a remote JSON-LD context document.

See also:

INRUPT_VC_ISSUER_DESCRIPTION#

A description of the access request/grant issuer.

INRUPT_VC_ISSUER_NAME#

A display name for the access request/grant issuer.

INRUPT_VC_ISSUER_TOS#

A URL for a Terms of Service (TOS) document.

INRUPT_VC_MONGODB_DATABASE#

Default: vc

The name of the MongoDB database.

See also QUARKUS_MONGODB_CONNECTION_STRING.

QUARKUS_LOG_LEVEL#

Default: INFO

Logging level.

/issue Endpoint Configuration#

INRUPT_VC_MAX_DURATION#

Default: P365D (Starting in 2.2)

A maximum duration (i.e., expiration time) for the issued access requests/grants. Specify the value in a format supported by Java Duration.parse() method, such as PT2H (2 hours) or P180D (180 days).

If the value is set, the Access Grant service calculates an expiration date using this value. Then,

  • If the credential payload sent to the /issue endpoint also specifies an expiration date, the issuer uses the earlier of the two dates.

  • If the credential payload sent to the /issue endpoint does not specify an expiration date, the Access Grant service uses the calculated date as the expiration date.

If the value is unset, the Access Grant service, starting in 2.2, uses P365D (365 days) to calculate the expiration date.

  • If the credential payload sent to the /issue endpoint specifies an expiration date, the Access Grant service uses the earlier of the two dates.

  • If the credential payload sent to the issuer endpoint does not specify an expiration date, the Access Grant service, starting in 2.2, uses the calculated date as the expiration date.

Tip

This value should be set in accordance with your specific business, industry, or regulatory policies that govern data access durations. For example, the default value of P365D is typical of a business process that requires data access to be revalidated on an annual basis.

/status Endpoint Configuration#

INRUPT_VC_STATUS_LIST_ID_LENGTH#

Default: 4

This sets the size of the status list identifiers. A higher value adds a greater level of entropy to the status list allocations. For example, a value of 4 supports about 1.7 trillion entries.

This value can be changed at any time without adverse effects.

/derive Endpoint Configuration#

INRUPT_VC_QUERY_AGENT_PATHS#

Default: /credentialSubject/providedConsent/isProvidedTo,/credentialSubject/providedConsent/isProvidedToPerson,/credentialSubject/providedConsent/isProvidedToController

A comma-separated list of paths that can be considered during query execution. The query runs against access requests and grants that have the agent’s WebID in any of the listed paths.

Available paths are:

  • /credentialSubject/providedConsent/isProvidedTo

  • /credentialSubject/providedConsent/isProvidedToPerson

  • /credentialSubject/providedConsent/isProvidedToController

INRUPT_VC_QUERY_PROPERTY_LIMIT#

Default: 16

The maximum number of properties in a /derive query.

Service Configuration Logging#

Starting in 2.2, ESS services log their startup configuration.

INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW#

Default: inrupt,smallrye.jwt.encrypt.key.id,smallrye.jwt.encrypt.key.location

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

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

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.

Added in version 2.2.0.

INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY#

Default: inrupt.vc.sign.key-seed,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:

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.

Added in version 2.2.0.

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

Added in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_ENABLED#

Default: true

A boolean that determines whether the redaction configurations with the specified INRUPT_LOGGING_REDACTION_{NAME}_ prefix is enabled.

For more information on log redaction, see Logging Redaction.

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

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

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

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

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

Added in version 2.2.0.

Application-Defined Metadata Propagation#

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW#

A comma-separated list [1] 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:

Added in version 2.2.0.

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY#

A comma-separated list [1] 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:

Added in version 2.2.0.

INRUPT_LOGGING_REQUEST_METADATA_ALLOW#

A comma-separated list [1] 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:

Added in version 2.2.0.

INRUPT_LOGGING_REQUEST_METADATA_DENY#

A comma-separated list [1] 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:

Added in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW#

A comma-separated list [1] 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:

Added in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY#

A comma-separated list [1] 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:

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

Added in version 2.2.0.

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW#

A comma-separated list [1] 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

See:

Added in version 2.2.0.

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY#

A comma-separated list [1] 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:

Added in version 2.2.0.

Additional Information#

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

On this page