WebID Service#
Starting in version 2.0, 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.
Starting in version 2.0,
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. [1]
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. An RDF document is a document whose contents consists of statements that have the following form (also known as a triple):
<subject> <predicate> <object> .
The WebID profile document is a publicly accessible document. [1]
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 configuredINRUPT_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 forhttp://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.
Fetch a Profile Document#
A client can retrieve the profile associated with a WebID by issuing a
GET
request to the WebID:
Method: |
|
---|---|
Endpoint: |
|
Accept: |
|
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., .ttl
, .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: |
|
---|---|
Endpoint: |
|
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: |
|
---|---|
Endpoint: |
|
Body: |
A profile document that conform to the WebID service’s constraints. If the document does not conform to the service constraints, a
|
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: |
|
---|---|
Endpoint: |
|
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}"
}
See also Pod Provisioning service. |
Content-Type: |
application/json |
Delete a Profile Document#
Important
The operation has authentication and authorization requirements. See Authentication and Authorization Requirements.
To delete a WebID profile document, issue a DELETE
request to the
WebID:
Method: |
|
---|---|
Endpoint: |
|
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.
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 configuredINRUPT_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 theINRUPT_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 issueriss
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
andINRUPT_JWT_ISSUER_DENY_LIST
, theINRUPT_JWT_ISSUER_DENY_LIST
supersedes theINRUPT_JWT_ISSUER_ALLOW_LIST
and the issuer is not accepted.
All other issuers are rejected with a
401 Unauthorized
error.See also
INRUPT_JWT_ISSUER_DENY_LIST
.
- INRUPT_PROVISION_HTTP_BASE_URL#
The base URL of the Pod Provisioning 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:
- 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 partyazp
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
.See also
INRUPT_OPENID_ISSUER
.
- 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.Added in version 2.2.0.
- 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
andauditv1out
message channels). This service uses theauditv1out
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#
Configuration Logging#
Starting in 2.2, 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 onINRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
list).As such, if the configuration matches prefix in both
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
andINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
, theINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
takes precedence and the configuration is not logged. For example, ifinrupt.
is an allow prefix, butinrupt.kafka.
is a deny prefix, all configurations that start withinrupt.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.
), orusing the MicroProfile Config environmental variables conversion value (e.g.,
INRUPT_FOOBAR_
).
Warning
Use the same format for both
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
andINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
.For example, if you change the format of
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
, change the format ofINRUPT_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>...
, specifyfoobar.
(including the dot.
) instead of, for example,foo
orfoobar
.If using converted form, if you want to match configuration properties of the form
FOOBAR_<XXXX>...
, specifyFOOBAR_
(including the underscore_
) instead of, for example,FOO
orFOOBAR
.
Added in version 2.2.0.
- 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 onINRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
. For example:If
foobar.
is an allowed prefix, to suppressfoobar.private.<anything>
, you can specifyfoobar.private.
to the deny list.If
foobar.
is not an allowed prefix, no property starting withfoobar.
is logged. As such, you do not need to specifyfoobar.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.
), orusing the MicroProfile Config environmental variables conversion value (e.g.,
INRUPT_FOOBAR_
).
Warning
Use the same format for both
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
andINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
.For example, if you change the format of
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
, change the format ofINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
as well.Added in version 2.2.0.
Logging 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 alsoINRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT
.If the action is to
PRIORITIZE
, see alsoINRUPT_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
isPRIORITIZE
.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
isREPLACE
.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 [2] 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:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY#
A comma-separated list [2] 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:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_LOGGING_REQUEST_METADATA_ALLOW#
A comma-separated list [2] 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:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_LOGGING_REQUEST_METADATA_DENY#
A comma-separated list [2] 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:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW#
A comma-separated list [2] 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 matchx-correlation-id
header,X-CoRrElAtIoN-Id
header, etc.See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY#
A comma-separated list [2] 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:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
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 [2] 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
To return a propagated property that was added via the
INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW
configuration, ensure that the cases of these properties match.You may need to update
QUARKUS_HTTP_CORS_EXPOSED_HEADERS
to extend the list of CORS-safelisted response headers.
See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY#
A comma-separated list [2] 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:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
General#
- 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_DENY_LIST#
A comma-separated list of disallowed Solid-OIDC issuers.
If unset, the service accepts all Solid-OIDC issuers unless
INRUPT_JWT_ISSUER_ALLOW_LIST
is set, in which case, the service only accepts those in theINRUPT_JWT_ISSUER_ALLOW_LIST
.If set, the service disallows the Solid-OIDC issuers in the list. If
INRUPT_JWT_ISSUER_ALLOW_LIST
is also set, issuers not in theINRUPT_JWT_ISSUER_ALLOW_LIST
are also disallowed.
- INRUPT_WEBID_CLIENT_CONTACTS#
A comma-delimited list [2] of contacts (either email addresses or WebID URLs) for the client associated with the default Solid-OIDC Client ID. See
INRUPT_WEBID_ALLOWED_CLIENT_IDS
.
- INRUPT_WEBID_CLIENT_LOGO_URI#
Default:
https://{ESS DOMAIN}/logo.png
The application logo for the client associated with the default Solid-OIDC Client ID. See
INRUPT_WEBID_ALLOWED_CLIENT_IDS
.
- INRUPT_WEBID_CLIENT_NAME#
Default:
Inrupt WebID Manager
The name of the client associated with the default Solid-OIDC Client ID. See
INRUPT_WEBID_ALLOWED_CLIENT_IDS
.
- INRUPT_WEBID_CLIENT_TOS_URI#
The URL for a terms of service document for the client associated with the default Solid-OIDC Client ID. See
INRUPT_WEBID_ALLOWED_CLIENT_IDS
.
- QUARKUS_LOG_LEVEL#
Default:
INFO
Logging level.
Additional Information#
See also https://quarkus.io/guides/all-config.
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 "
.