Verifiable Credentials Service#

Starting in version 2.0, ESS supports an authorization mechanism based on access requests and grants. In 2.0, the access requests and grants are serialized as a Verifiable Credentials (VCs).

To support access requests and grants, ESS provides various Verifiable Credential (VC) related endpoints that follow the draft VC API. [1]

Verifiable Credential (VC) Service#

The ESS Verifiable Credential (VC) Service consists of the following endpoints:

Endpoint

Description

/issue

Issues VCs for access requests and grants.

/verify

Verifies VCs.

/status

Updates the status of VCs (e.g., update the status to revoked).

/derive

Query for VCs and derive a Verifiable Presentation from the matching VCs.

ESS VC Service Endpoints#

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

https://vc.<ESS Domain>

To change the root VC URL, see INRUPT_VC_ISSUER.

ESS provides a VC 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 Verifiable Credential-related 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"
}

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

QUARKUS_MONGODB_CONNECTION_STRING#

Required if using MongoDB for persistence

The connection string for the MongoDB database

See also INRUPT_VC_MONGODB_DATABASE.

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

Kafka Configuration#

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

INRUPT_KAFKA_AUDITV1EVENTSENCRYPTED_CIPHER_PASSWORD#

The strong cipher key to use when running auditing with encrypted messages.

Optional Configuration#

QUARKUS_LOG_LEVEL#

Default: INFO

Logging level.

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#

An allow-list of JSON-LD context URIs. Any URI listed in this configuration will be allowed to be dereferenced. If this configuration is empty, any context URI is allowed, unless it is also present in the INRUPT_JSONLD_CONTEXT_DENY_LIST.

See also:

INRUPT_JSONLD_CONTEXT_DENY_LIST#

A deny-list of JSON-LD context URIs. Any URI listed in this configuration will be 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_NAME#

A display name for the VC issuer.

INRUPT_VC_ISSUER_DESCRIPTION#

A description of the VC issuer displayed to users.

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.

INRUPT_JWT_ISSUER_ALLOW_LIST#

A comma-separated list of trusted Solid-OIDC issuers (i.e., identity providers).

See also INRUPT_JWT_ISSUER_DENY_LIST.

INRUPT_JWT_ISSUER_DENY_LIST#

A comma-separated list of disallowed Solid-OIDC issuers.

INRUPT_JWT_ALLOWED_SIGNATURE_ALGORITHMS#

Default: ES256, RS256

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

/issue Endpoint Configuration#

INRUPT_VC_MAX_DURATION#

A maximum duration (i.e., expiration time) for the issued Verifiable Credentials. This value should be expressed as an ISO_8601 duration format, such as PT2H (2 hours) or P180D (180 days).

If the value is set, the VC Issuer service calculates an expiration date using this value. Then,

  • If the credential payload sent to the VC Issuer service also specifies an expiration date, the VC Issuer service uses the earlier of the two dates.

  • If the credential payload sent to the VC Issuer service does not specify an expiration date, the VC Issuer service uses the calculated date as the expiration date.

If the value is unset, then:

  • If the credential payload sent to the VC Issuer service specifies an expiration date, the VC Issuer service uses the specified expiration date.

  • If the credential payload sent to the VC Issuer service does not specify an expiration date, the VC Issuer service does not set an expiration date for the issued VC.

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