From bc11262da5aacd329f16b6e1f9ad8c73d630d93f Mon Sep 17 00:00:00 2001 From: Manu Sporny Date: Wed, 27 Dec 2023 16:36:54 -0500 Subject: [PATCH] Replace CODE markup with ReSpec backticks. --- index.html | 148 ++++++++++++++++++++++++++--------------------------- 1 file changed, 74 insertions(+), 74 deletions(-) diff --git a/index.html b/index.html index 1d4ebcf..f350bdf 100644 --- a/index.html +++ b/index.html @@ -275,7 +275,7 @@

BitstringStatusListEntry

When an issuer desires to enable status information for a -verifiable credential, they MAY add a credentialStatus +verifiable credential, they MAY add a `credentialStatus` property that uses the data model described in this specification.

@@ -291,7 +291,7 @@

BitstringStatusListEntry

id An optional identifier for the status list entry. The constraints on the -id property are listed in the Verifiable Credentials Data Model +`id` property are listed in the Verifiable Credentials Data Model specification [[VC-DATA-MODEL]]. If present, the value is expected to be a URL that identifies the status information associated with the verifiable credential. It MUST NOT be the URL for the status list. The value is @@ -304,7 +304,7 @@

BitstringStatusListEntry

type -The type property MUST be BitstringStatusListEntry. +The `type` property MUST be `BitstringStatusListEntry`. @@ -322,14 +322,14 @@

BitstringStatusListEntry

- revocation + `revocation` Used to cancel the validity of a verifiable credential. This status is not reversible. - suspension + `suspension` Used to temporarily prevent the acceptance of a verifiable credential. This status is reversible. @@ -342,7 +342,7 @@

BitstringStatusListEntry

statusListIndex -The statusListIndex property MUST be an arbitrary size integer +The `statusListIndex` property MUST be an arbitrary size integer greater than or equal to 0, expressed as a string. The value identifies the position of the status of the verifiable credential. @@ -350,10 +350,10 @@

BitstringStatusListEntry

statusListCredential -The statusListCredential property MUST be a URL to a +The `statusListCredential` property MUST be a URL to a verifiable credential. When the URL is dereferenced, the resulting -verifiable credential MUST have type property that -includes the BitstringStatusListCredential value. +verifiable credential MUST have `type` property that +includes the `BitstringStatusListCredential` value. @@ -414,17 +414,17 @@

BitstringStatusListCredential

id The verifiable credential that contains the status list MAY -express an id property that matches the value specified in -statusListCredential for the corresponding -BitstringStatusListEntry (see ). +express an `id` property that matches the value specified in +`statusListCredential` for the corresponding +`BitstringStatusListEntry` (see ). type The verifiable credential that contains the status list MUST -express a type property that includes the -BitstringStatusListCredential value. +express a `type` property that includes the +`BitstringStatusListCredential` value. @@ -448,8 +448,8 @@

BitstringStatusListCredential

credentialSubject.type -The type of the credential subject, which is the -status list, MUST be BitstringStatusList. +The `type` of the credential subject, which is the +status list, MUST be `BitstringStatusList`. @@ -467,25 +467,25 @@

BitstringStatusListCredential

- revocation + `revocation` Used to cancel the validity of a verifiable credential. This status is not reversible. - suspension + `suspension` Used to temporarily prevent the acceptance of a verifiable credential. This status is reversible. - status + `status` Used to indicate a status message associated with a verifiable credential. -The status message descriptions MUST be defined in credentialSubject.statusMessages. -credentialSubject.size MUST be defined with this statusPurpose. +The status message descriptions MUST be defined in `credentialSubject.statusMessages`. +`credentialSubject.size` MUST be defined with this `statusPurpose`. @@ -495,14 +495,14 @@

BitstringStatusListCredential

credentialSubject.encodedList -The encodedList property of the credential subject MUST be +The `encodedList` property of the credential subject MUST be the GZIP-compressed [[RFC1952]], base-64 encoded [[RFC4648]] bitstring values for the associated range of verifiable credential status values. The uncompressed bitstring MUST be at least 16KB in size. The bitstring MUST be encoded such that the first index, with a value of zero -(0), is located at the left-most bit in the bitstring and the +(`0`), is located at the left-most bit in the bitstring and the last index, with a value of one less than the length of the bitstring -(bitstring_length - 1), is located at the right-most bit in the +(`bitstring_length - 1`), is located at the right-most bit in the bitstring. Further information on bitstring encoding can be found in Section . @@ -512,11 +512,11 @@

BitstringStatusListCredential

credentialSubject.ttl - The ttl indicates the "time to live" in milliseconds. + The `ttl` indicates the "time to live" in milliseconds. This property MAY be present. If not present, implementers MUST - use a value of 300000 for this property. A verifier - MUST NOT use a cached BitstringStatusListCredential that was - cached for more than the ttl duration prior to the + use a value of `300000` for this property. A verifier + MUST NOT use a cached `BitstringStatusListCredential` that was + cached for more than the `ttl` duration prior to the start of verification operation on a verifiable credential. Implementations that publish the status list SHOULD align any protocol-specific caching information, such as the @@ -528,12 +528,12 @@

BitstringStatusListCredential

credentialSubject.size - The size indicates the size of the status entry in bits. - size MAY be provided. If size is not present - as a property of the credentialStatus, then size - MUST be processed as `1`. size MUST be an integer greater than zero. - If size is provided and is greater than `1`, then the property - credentialStatus.statusMessages MUST be present, and the number of + The `size` indicates the size of the status entry in bits. + `size` MAY be provided. If `size` is not present + as a property of the `credentialStatus`, then `size` + MUST be processed as `1`. `size` MUST be an integer greater than zero. + If `size` is provided and is greater than `1`, then the property + `credentialStatus.statusMessages` MUST be present, and the number of status messages must equal the number of possible values. @@ -542,22 +542,22 @@

BitstringStatusListCredential

credentialSubject.statusMessages - The statusMessages property MUST be an array. If present, + The `statusMessages` property MUST be an array. If present, the length of the array must equal the number of possible status states - indicated by size. statusMessages MAY be present if - size is `1`. statusMessages MUST be present if - size is greater than `1`. If not present, the message value - associated with the bit value of 0 is "unset" and the bit - value of 1 is "set". - If present, elements in the statusMessages array MUST contain at + indicated by `size`. `statusMessages` MAY be present if + `size` is `1`. `statusMessages` MUST be present if + `size` is greater than `1`. If not present, the message value + associated with the bit value of `0` is "unset" and the bit + value of `1` is "set". + If present, elements in the `statusMessages` array MUST contain at minimum two properties: - Implementers MAY add additional values to objects in the statusMessages + Implementers MAY add additional values to objects in the `statusMessages` array. - Implementers MAY use the string value of undefined in the value + Implementers MAY use the string value of `undefined` in the value to indicate that a corresponding status is not defined for the associated status value, but that it may be defined in the future. Rules for how to handle various status messages are outside the scope of @@ -570,13 +570,13 @@

BitstringStatusListCredential

credentialSubject.reference - The reference property provides a point for implementers to + The `reference` property provides a point for implementers to include a [[URL]] to material related to the status. An implementer MAY include - the reference property, and if they do, the value MUST be a + the `reference` property, and if they do, the value MUST be a [[URL]] or an array of URLs. Implementers using a `statusPurpose` of `status` - are strongly encouraged to provide a reference. + are strongly encouraged to provide a `reference`.

- reference is especially important when interpertation of the + `reference` is especially important when interpertation of the status for a credential may involve some understanding of the business case involved.

@@ -661,7 +661,7 @@

Generate Algorithm

  • Let |RLC| be an unsigned BitstringStatusListCredential -without the encodedList property set. +without the `encodedList` property set.
  • Generate a |compressed bitstring| by passing @@ -669,7 +669,7 @@

    Generate Algorithm

    Bitstring Generation Algorithm.
  • -Set the encodedList to |compressed bitstring|. +Set the `encodedList` to |compressed bitstring|.
  • Generate a proof for the |RLC| and publish it to the @@ -690,31 +690,31 @@

    Validate Algorithm

    1. Let |credentialToValidate| be a verifiable credential -containing a credentialStatus entry that is a +containing a `credentialStatus` entry that is a BitstringStatusListEntry.
    2. -Let |status purpose| be the value of statusPurpose -in the credentialStatus entry in the +Let |status purpose| be the value of `statusPurpose` +in the `credentialStatus` entry in the |credentialToValidate|.
    3. -Dereference the statusListCredential URL, and ensure that all +Dereference the `statusListCredential` URL, and ensure that all proofs verify successfully. If the dereference fails, or if any of the proof verifications fail, return a validation error.
    4. Verify that the |status purpose| matches the -statusPurpose value in the |statusListCredential|. +`statusPurpose` value in the |statusListCredential|.
    5. Let |compressed bitstring| be the value of the -encodedList property of the +`encodedList` property of the BitstringStatusListCredential.
    6. Let |credentialIndex| be the value of the -statusListIndex property of the +`statusListIndex` property of the BitstringStatusListEntry.
    7. @@ -727,11 +727,11 @@

      Validate Algorithm

      |credentialIndex| times the |size| in the |bitstring|.
    8. -For statusPurpose of revocation or suspension, -return true if status is `1`, and return false -if status has any other value. For other statusPurpose, -return the corresponding value of the status -as indicated in the statusMessages array. +For `statusPurpose` of `revocation` or `suspension`, +return `true` if `status` is `1`, and return `false` +if `status` has any other value. For other `statusPurpose`, +return the corresponding `value` of the `status` +as indicated in the `statusMessages` array.
    @@ -751,11 +751,11 @@

    Bitstring Generation Algorithm

    where each bit is initialized to 0 (zero).
  • -For each value in bitstring, if there is a -corresponding statusListIndex value in -a credential in issuedCredentials, set the value to the -appropriate status. The position of the value is computed as statusListIndex -times the size. +For each value in `bitstring`, if there is a +corresponding `statusListIndex` value in +a credential in `issuedCredentials`, set the value to the +appropriate status. The position of the value is computed as `statusListIndex` +times the `size`.
  • Generate a |compressed bitstring| by using the GZIP @@ -800,27 +800,27 @@

    Bitstring Expansion Algorithm

    Media Types

    - When dereferencing statusListCredential, - the content type of the statusListCredential might + When dereferencing `statusListCredential`, + the content type of the `statusListCredential` might be any media type registered for the purpose of expressing a verifiable credential with one or more proofs.

    For example, a verifiable credential secured with - Data Integrity Proofs might have content type application/vc+ld+json, + Data Integrity Proofs might have content type `application/vc+ld+json`, whereas a verifiable credential secured with - SD-JWT might have content-type application/sd-jwt. + SD-JWT might have content-type `application/sd-jwt`.

    Some implementations might choose to support less specific media types such as - application/ld+json or application/json. + `application/ld+json` or `application/json`.

    When dereferencing over HTTP, the use of the accept and content-type headers, might allow some implementations to negotiate for the proof format - used to secure the statusListCredential. + used to secure the `statusListCredential`.

    Some implementations might use the 415 Unsupported Media Type