WebID Service

ESS introduces a separate service to host and manage WebIDs and the corresponding Profile Documents.

WebID and Profile Document

According to the WebID draft specification, a WebID is a URL that identifies an agent.

ESS’ WebID service creates WebIDs of the form:
```
https://id.{ESS DOMAIN}/{username}
```
The WebID profile document is no longer hosted in the user’s Pod.
ESS creates an extended profile resource, separate from the public WebID profile. The extended profile resource, unlike the WebID profile, is hosted in the agent’s Pod, and by default, is private. The agents can grant or deny access to their extended profile like any other resource in their Pod. For more information, see extended profile in the Pod Provisioning Service.

Prior to version 2.0, ESS issued WebIDs of the form https://{ESS Domain}/{username}/profile/card#me , which were hosted in the user’s Pod.

WebID Profile Document

The WebID URL dereferences to the agent’s WebID profile, where the profile is a document that describes the agent.

The ESS WebID Service ensures that the WebID Profile document is a valid RDF document.

WebID Profile Document Constraints

ESS enforces the following constraints on the RDF data model in the WebID Profile:

The document must contain the following solid:oidcIssuer triple :
```
<WebID URL> solid:oidcIssuer <defaultIssuer URL> .
```
where
- <WebID URL> is the agent’s WebID
- <defaultIssuer URL> is the configured INRUPT_WEBID_ISSUER value.
For all solid:oidcIssuer triples,
- The subject must be the agent’s WebID URL.
- The object must be a valid HTTP(S) URL.
If an rdf:type triple is present in the WebID Profile Document, its value must be one of:
- foaf:Agent
- foaf:Group
- foaf:Person
- foaf:Organization
  where foaf: is the namespace prefix for http://xmlns.com/foaf/0.1/ . For example,
  <WebID URL> a foaf:Agent.
For any foaf:isPrimaryTopicOf triples, the object must be an HTTP(S) URL.
For any pim:storage triples, the object must be an HTTP(S) URL.

ESS allows any other RDF triples, without constraints, in the WebID profile.

WebID Profile Document Endpoints

The WebID service provides various endpoints for managing (get, create, replace, add storage info, delete) the WebID profile document.

Authentication and Authorization Requirements

The operations to create and modify the WebID profile ( create, replace, update with storage info, delete) have authentication and authorization requirements:

Agents must be authenticated.
The agent’s ID token must be issued by an approved issuer. See INRUPT_JWT_ISSUER_ALLOW_LIST for details.
Agents can only use approved applications to create and modify their WebID profile. See INRUPT_WEBID_ALLOWED_CLIENT_IDS for details.
Agents can only create and modify their own WebID. Specifically, the WebID service checks that the webid claim in the agent’s ID token matches the specified https://id.{ESS DOMAIN}/{username} endpoint.

Fetch a Profile Document

A client can retrieve the profile associated with a WebID by issuing a GET request to the WebID:

Method:

GET

Endpoint:

https://id.{ESS DOMAIN}/{username}

Accept:

text/turtle

Body:

N/A

Content-Type:

N/A

Tip Per the WebID draft specification , an HTTP request on the WebID can return a redirect status ( 303 ) along with the profile document URL in the Location header.

As such, a client may need to handle the HTTP redirection according to its needs (e.g., follow the redirect automatically or error ).

Alternatively, if the profile document URL is the WebID with a file extension (e.g., .Turtle , .jsonld ), you can issue a GET request directly to the profile document URL.

Upon successful fetch, the response includes a status of 200 OK (including when the client automatically follows the redirect) and the profile document in its body.

Create a Profile Document

Important The operation has authentication and authorization requirements. See Authentication and Authorization Requirements.

To create a WebID profile document if one does not already exist for the WebID, issue a POST request to the WebID:

Method:

POST

Endpoint:

https://id.{ESS DOMAIN}/{username}

Body:

N/A

Content-Type:

N/A

Note If the WebID profile document already exists, the POST request returns a 400 Bad Request error.

Upon successful creation of a WebID profile document, the response includes a status of 201 Created . The newly created WebID profile document has the following content:

@prefix foaf: <http://xmlns.com/foaf/0.1/>.
@prefix solid: <http://www.w3.org/ns/solid/terms#>.
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
<https://id.{ESS DOMAIN}/{username}> a foaf:Agent;
    solid:oidcIssuer <{WEBID_ISSUER}/>.

Where the {WEBID_ISSUER} is the configured INRUPT_WEBID_ISSUER value.

Replace a Profile Document

Important The operation has authentication and authorization requirements. See Authentication and Authorization Requirements.

To replace an existing WebID profile document, issue a PUT request with a valid replacement profile document to the WebID:

Method:

PUT

Endpoint:

https://id.{ESS DOMAIN}/{username}

Body:

A profile document that conform to the WebID service’s constraints.

If the document does not conform to the service constraints, a 400 Bad Request error is returned.

Content-Type:

text/turtle

Upon successful update, the response includes a status of 204 No Content .

Add Pod Location to Profile Document

Important The operation has authentication and authorization requirements. See Authentication and Authorization Requirements.

To add a Pod Location to a WebID profile document, issue a POST request to the {WebID}/provision endpoint:

Method:

POST

Endpoint:

https://id.{ESS DOMAIN}/{username}/provision

Body:

A JSON document:

{
   "@context": {
      "id":"@id",
      "storage":{
         "@type":"@id",
         "@id":"http://www.w3.org/ns/pim/space#storage"
      },
      "profile":{
         "@type":"@id",
         "@id":"http://xmlns.com/foaf/0.1/isPrimaryTopicOf"
      }
   },
   "id":"{WebID}",
   "profile":"{extended Profile Resource stored on the Pod}",
   "storage":"{HTTP(S) Pod URL}"
}

Delete a Profile Document

Important The operation has authentication and authorization requirements.

To delete a WebID profile document, issue a DELETE request to the WebID:

Method:

DELETE

Endpoint:

https://id.{ESS DOMAIN}/{username}

Body:

N/A

Content-Type:

N/A

Upon successful delete, the response includes a status of 204 No Content .

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

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

Required

These WebID service configuration options are set as part of updating the inputs for your deployment.

INRUPT_JWT_ISSUER_ALLOW_LIST

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

Tip

Ensure that INRUPT_JWT_ISSUER_ALLOW_LIST includes the configured INRUPT_WEBID_ISSUER value.
If your application, such as a start app, provisions the Pod and updates the WebID with the provisioned Pod information, ensure that the WebID service’s INRUPT_JWT_ISSUER_ALLOW_LIST overlaps with the INRUPT_JWT_ISSUER_ALLOW_LIST value set for the Pod Provision Service.

Important

For the WebID service, you must set INRUPT_JWT_ISSUER_ALLOW_LIST to a non-empty list. If the list is empty, the WebID service throws an error.

The WebID service uses the INRUPT_JWT_ISSUER_ALLOW_LIST to check the issuer iss claim (from the agent’s ID token), accepting only 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.

All other issuers are rejected with a 401 Unauthorized error.

INRUPT_PROVISION_HTTP_BASE_URL

The base URL of the Pod Provision Service. This is used by the WebID Service to link to the Pod Provisioning Service.

Important

The value requires a trailing slash / ; e.g., https://provision.{ESS_DOMAIN}/ .

INRUPT_START_CLIENT_ID

Default : https://start.{ESS_DOMAIN}/app/id

The Solid-OIDC Client ID of the start application. The default start app can handle:

User sign up/log in, and
Provisioning of the user’s WebID and Pod.

INRUPT_WEBID_ALLOWED_CLIENT_IDS

Default : INRUPT_START_CLIENT_ID, INRUPT_WEBID_CLIENT_ID

Comma-delimited list of Solid-OIDC Client IDs. The list determines which clients are authorized to modify the WebID profile documents.

Specifically, the WebID service uses INRUPT_WEBID_ALLOWED_CLIENT_IDS to check the authorized party azp claim from the agent’s ID token.

INRUPT_WEBID_CLIENT_ID

Default : https://id.{ESS_DOMAIN}/app/id

The URL of the WebID editor application.

INRUPT_WEBID_ISSUER

Default : https://openid.{ESS DOMAIN}

The required issuer that must appear in the WebID profile documents. See WebID Profile Document Constraints .

Tip

Ensure this issuer is in the INRUPT_JWT_ISSUER_ALLOW_LIST.

QUARKUS_DATASOURCE_JDBC_URL

The JDBC connection string for the persistence datasource. For example, jdbc:postgresql://HOSTNAME/DATABASE-NAME .

QUARKUS_DATASOURCE_PASSWORD

The password for connecting to the persistence datasource.

QUARKUS_DATASOURCE_USERNAME

The username for connecting to the persistence datasource.

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.

KAFKA_BOOTSTRAP_SERVERS

Default : localhost:9092

Comma-delimited list of Kafka broker servers for use by ESS services, iincluding 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.

Optional

Configuration Logging

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 .

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.

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 PRIORITIZE, see also INRUPT_LOGGING_REDACTION_{NAME}_LEVEL.