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. [1]

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 (e.g., 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 List#

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

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.

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

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

A comma-delimited list of Client IDs that determine which applications can access the /issue Endpoint and /status Endpoint.

If unset, users can use any application to access the endpoints.

See Set Access Grants Client Allow List.

Added in version 2.0.4.

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#

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 issuer endpoint also specifies an expiration date, the issuer 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 uses the calculated date as the expiration date.

If the value is unset, then:

  • If the credential payload sent to the issuer endpoint specifies an expiration date, the Access Grant service uses the specified expiration date.

  • If the credential payload sent to the issuer endpoint does not specify an expiration date, the Access Grant service does not set an expiration date for the issued access request/grant.

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

Additional Information#

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

On this page