Skip to content

Commit faf4db6

Browse files
Deployed 1cd7e83 to main with MkDocs 1.6.1 and mike 2.1.2
1 parent 36eb921 commit faf4db6

3 files changed

Lines changed: 13 additions & 8 deletions

File tree

main/oid4vc/index.html

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1446,7 +1446,12 @@
14461446

14471447

14481448
<h1 id="openid4vci-plugin-for-aca-py">OpenID4VCI Plugin for ACA-Py<a class="headerlink" href="#openid4vci-plugin-for-aca-py" title="Permanent link">&para;</a></h1>
1449-
<p>This plugin implements <a href="https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-11.html">OpenID4VCI (Draft 11)</a>. The OpenID4VCI specification is in active development, as is this plugin. Consider this plugin experimental; endpoints and records may change to reflect upstream changes in the specification.</p>
1449+
<p>This plugin implements <a href="https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html">OpenID4VCI v1.0</a>.</p>
1450+
<blockquote>
1451+
<p>[!WARNING]
1452+
This plugin is under active development.
1453+
Treat it as experimental; endpoints and records may change as implementation details evolve.</p>
1454+
</blockquote>
14501455
<h2 id="openid4vci-plugin-demo-with-sphereon-wallet">OpenID4VCI Plugin Demo with Sphereon Wallet<a class="headerlink" href="#openid4vci-plugin-demo-with-sphereon-wallet" title="Permanent link">&para;</a></h2>
14511456
<h3 id="demo-overview">Demo Overview<a class="headerlink" href="#demo-overview" title="Permanent link">&para;</a></h3>
14521457
<p>This repository showcases a simplified demonstration of the OID4VCI (OpenID for Verifiable Credential Issuers) integration with the <a href="https://github.com/Sphereon-Opensource/ssi-mobile-wallet">Sphereon Wallet app</a>. Follow the steps below to run the demo successfully.</p>
@@ -1515,7 +1520,7 @@ <h3 id="integrating-the-status-list-plugin">Integrating the Status List Plugin<a
15151520
<p>Example Configuration:
15161521
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a> OID4VCI_STATUS_HANDLER: status_list.v1_0.status_handler
15171522
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a> STATUS_LIST_SIZE: 131072
1518-
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a> STATUS_LIST_SHARD_SIZE: 1024
1523+
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a> STATUS_LIST_SHARD_SIZE: 131072
15191524
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a> STATUS_LIST_PUBLIC_URI: https://localhost:8082/tenant/{tenant_id}/status/{list_number}
15201525
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a> STATUS_LIST_FILE_PATH: /tmp/bitstring/{tenant_id}/{list_number}
15211526
</code></pre></div>
@@ -1525,8 +1530,8 @@ <h3 id="integrating-the-status-list-plugin">Integrating the Status List Plugin<a
15251530
<p>Example JSON Body (list_type can be either "w3c" or "ietf"):
15261531
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a> {
15271532
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> &quot;issuer_did&quot;: &quot;did....&quot;,
1528-
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> &quot;list_type&quot;: &quot;w3c&quot;,
1529-
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> &quot;list_size&quot;: 131072,
1533+
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> &quot;list_size&quot;: 131072,
1534+
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> &quot;list_type&quot;: &quot;ietf&quot;,
15301535
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a> &quot;shard_size&quot;: 1024,
15311536
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a> &quot;status_message&quot;: [
15321537
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a> {
@@ -1538,7 +1543,7 @@ <h3 id="integrating-the-status-list-plugin">Integrating the Status List Plugin<a
15381543
<a id="__codelineno-3-13" name="__codelineno-3-13" href="#__codelineno-3-13"></a> &quot;message&quot;: &quot;revoked&quot;
15391544
<a id="__codelineno-3-14" name="__codelineno-3-14" href="#__codelineno-3-14"></a> },
15401545
<a id="__codelineno-3-15" name="__codelineno-3-15" href="#__codelineno-3-15"></a> ],
1541-
<a id="__codelineno-3-16" name="__codelineno-3-16" href="#__codelineno-3-16"></a> &quot;status_purpose&quot;: &quot;message&quot;,
1546+
<a id="__codelineno-3-16" name="__codelineno-3-16" href="#__codelineno-3-16"></a> &quot;status_purpose&quot;: &quot;revocation&quot;,
15421547
<a id="__codelineno-3-17" name="__codelineno-3-17" href="#__codelineno-3-17"></a> &quot;status_size&quot;: 1,
15431548
<a id="__codelineno-3-18" name="__codelineno-3-18" href="#__codelineno-3-18"></a> &quot;supported_cred_id&quot;: &quot;string&quot;,
15441549
<a id="__codelineno-3-19" name="__codelineno-3-19" href="#__codelineno-3-19"></a> &quot;verification_method&quot;: &quot;did....&quot;
@@ -1552,7 +1557,7 @@ <h2 id="architecture">Architecture<a class="headerlink" href="#architecture" tit
15521557
<p><img alt="oid4vci-component" src="https://raw.githubusercontent.com/openwallet-foundation/acapy-plugins/main/oid4vc/docs/images/oid4vci-component.png" /></p>
15531558
<h3 id="public-routes">Public Routes<a class="headerlink" href="#public-routes" title="Permanent link">&para;</a></h3>
15541559
<p>ACA-Py provides a pluggable mechanism for registering routes for consumption by the controller, the Admin API. This Admin Server makes it trivial to extend the controller from plugins. ACA-Py does not, however, provide a similar mechanism for publicly accessible HTTP Endpoints. Generally speaking, the only public endpoint ACA-Py provides is the DIDComm Messaging endpoint. The OpenID4VCI protocol requires endpoints that are publicly accessible to present and exchange tokens for credentials. This Plugin accomplishes this by starting a separate <a href="https://docs.aiohttp.org/en/stable/index.html">aiohttp server</a> (similar to how the Admin server is separate from the DIDComm messaging server) and publishes the OpenID4VCI endpoints through this separate server.</p>
1555-
<p>Details of the endpoints can be found at <code>/api/docs</code> or in the <a href="https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-11.html">OpenId4VCI Specification</a>.</p>
1560+
<p>Details of the endpoints can be found at <code>/api/docs</code> or in the <a href="https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html">OpenId4VCI Specification</a>.</p>
15561561
<h3 id="admin-routes">Admin Routes<a class="headerlink" href="#admin-routes" title="Permanent link">&para;</a></h3>
15571562
<p>The plugin exposes Admin API routes for consumption by the Controller to facilitate Credential Issuance over OpenID4VCI. The Admin API Routes can be found under <code>/api/docs</code> of the Admin Server in the <code>oid4vci</code> section.</p>
15581563
<h3 id="records">Records<a class="headerlink" href="#records" title="Permanent link">&para;</a></h3>
@@ -1710,7 +1715,7 @@ <h3 id="creating-supported-credential-records">Creating Supported Credential Rec
17101715
<a id="__codelineno-4-48" name="__codelineno-4-48" href="#__codelineno-4-48"></a><span class="w"> </span><span class="p">]</span>
17111716
<a id="__codelineno-4-49" name="__codelineno-4-49" href="#__codelineno-4-49"></a><span class="p">}</span>
17121717
</code></pre></div>
1713-
<p>For the <code>id</code>, <code>format</code>, <code>cryptographic_binding_supported</code>, <code>cryptographic_suites_supported</code>, and <code>display</code> attributes, see the <a href="https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-11.html">OpenID4VCI Specification, Section 10.2.3</a>.</p>
1718+
<p>For the <code>id</code>, <code>format</code>, <code>cryptographic_binding_supported</code>, <code>cryptographic_suites_supported</code>, and <code>display</code> attributes, see the <a href="https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html">OpenID4VCI Specification, Section 10.2.3</a>.</p>
17141719
<ul>
17151720
<li><code>type</code> is a required attribute for JWT-VC (recorded as <code>types</code> in the <code>SupportedCredential.format_data</code> dictionary), and <code>credentialSubject</code> represents display characteristics of the credential only and is not an exhaustive list of the credential attributes. These values are reported in the credential issuer metadata.</li>
17161721
<li>The <code>@context</code> of credential to be issued, as well as the <code>type</code> are stored in the <code>SupportedCredential.vc_additional_data</code> dictionary. These values are NOT reported in the credential issuer metadata.</li>

main/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

main/sitemap.xml.gz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)