Learn how to set up a VICAL
Introduction
The purpose of a Verified Issuer Certificate Authority List (VICAL) is to enable different participants in a digital ecosystem to rely on a single trusted framework.
This guide will walk you through using the Portal to set up a VICAL and publish a policy that defines trusted participants and credential types.
Prerequisites
- Make sure you understand the concepts of a VICAL and how it relates to a Digital Trust Service (DTS).
- You need access to an existing MATTR VII tenant with either the
DTS ProviderorAdminrole. Refer to the Getting started with the Portal tutorial to learn how to create a tenant and assign roles.
Guide overview
Publishing a VICAL comprises the following steps:
- Create an Ecosystem: This is the overarching entity that holds participants and credential types together. Only required if you don't already have an ecosystem on your tenant.
- Create participants: These are the issuers that will be part of the VICAL. Each participant includes an IACA certificate and the credential types they are allowed to issue.
- Manually publish a VICAL: Create a DTS root CA as the trust anchor, then generate and publish a VICAL that includes your participants and their credential types.
- Configure VICAL auto-generation and publishing (optional): Set the VICAL to automatically generate and publish on a daily or weekly schedule.
- View previously published VICALs (optional): Review the history of previously published VICALs and download their policy files.
Create an Ecosystem
This step is only required if you don't have an existing ecosystem on your tenant. If you already have an ecosystem, you will not see the option to create a new one and should skip directly to the next step.
Perform the following steps to create an Ecosystem:
- Log in to the Portal.
- Navigate to the Ecosystem page under the Digital Trust Service section.
- Enter a name for your Ecosystem, such as "My Digital Trust Service".
- Select the Create button.
Create participants
Participants are entities that represent issuers that will be included in the VICAL. For each participant, you will need to upload an IACA certificate that will be used as the trust anchor when signing mDocs, and define what credential types they are allowed to issue.
Perform the following steps to create a participant:
- Select the Participants page under the Digital Trust Service section (this page is only visible if you have an existing ecosystem. If you don't have an ecosystem, you will need to return to step 1 above and create it first).
- Select the Create new button.
The Create participant form appears, starting from Step 1 (Details). - Insert a meaningful Name for the participant (e.g. "Montcliff DMV").
- Use the Country dropdown list to select the Participant’s country (optional). Note that when selected, this value must match the Country value in the IACA certificate associated with this participant.
- If you select a country, a State or Province dropdown list is displayed. You can use it to select the Participant’s state or province (optional). Note that when selected, this value must match the StateOrProvinceName value in the IACA certificate associated with this participant.
- Insert the participant’s Address (optional).
- Insert the participant’s Phone number (optional).
- Use the Status radio button to set the participant as Active.
- Click the Next button.
You are directed to Step 2 (Certificates). - Select the Add new button.
- Upload the PEM file you want to use as this participant’s identifier for issuing mDocs (this must be a
valid IACA certificate and match any values set for Country and State or Province above).
You should now see the certificate summary and details. - Use the Credential types valid for text box to insert the credential types that this participant will be allowed to issue.
- You can insert as many credential types as you want.
- You can use the pre-populated options (
org.iso.18013.5.1.mDLand/ororg.iso.23220.photoid.1) or insert custom credential types that are relevant to your ecosystem. - The credential type is just a string value and does not need to match any values in the certificate. It is only used to link the participant to the credential types they are allowed to issue.
- Scroll down and use the Certificate status dropdown list to set the certificate as Active.
- Click the Add button.
- Click Create.
Repeat the above steps for each participant you want to include in your VICAL.
Manually Publish a VICAL
After you have created your participants, you can publish a VICAL that includes these participants and their associated credential types. When you publish the VICAL, the MATTR VII platform will sign a VICAL that includes the information you provided for each participant, along with the PEM-encoded IACA certificate.
Perform the following steps to publish your DTS policy as a VICAL:
Create a DTS root CA
Each VICAL must be linked to a trusted root CA via a chain of trust. This is what will be used by consuming relying parties as the trust anchor to validate the authenticity and integrity of the VICAL.
Perform the following steps to create a DTS root CA:
If you already have an existing DTS root CA that you want to use as the trust anchor for your VICAL, you can skip this step.
- Navigate to the Certificates page under the Platform Management section.
- Select the Create new button.
The New certificate form appears. - Use the Type dropdown list to select DTS CA.
- Use the Management method radio button to select MATTR managed.
- Enter a meaningful name in the Organisation field to identify the organization that will be signing the policy.
- Use the Country dropdown list to select the country where the organization is located.
- Select the Create button.
- Scroll down and use the Status radio button to select Active.
- Select the Update button.
Your new DTS root CA is now ready and can be used to establish trust in your VICAL.
Publish a VICAL
- Navigate to the Trust lists page under the Digital Trust Service section.
- Select the VICAL (Trusted issuers) tab.
- Enter a meaningful Provider name to identify the provider of the VICAL. This will be included in the VICAL metadata and used by relying parties to identify the source of the VICAL.
- Select the Create button.
- Review the preview area where you can see all participants and credential types included in the VICAL.
- Select Generate & Publish when you are ready.
The VICAL is now generated and published, and a modal is displayed where you can:- Use the Download button to download the VICAL policy file.
- Use the Copy button to copy a link to the public endpoint where relying parties can access the policy.
Configure VICAL auto-generation and publishing (optional)
You can optionally set up auto-generation of your VICAL by performing the following steps:
- Return to the Trust lists page under the Digital Trust Service section.
- Select the VICAL (Trusted issuers) tab.
- Expand the VICAL configuration panel.
- Use the Generation method radio button to select Auto generate.
- Use the Auto generate frequency dropdown list to select how often you want the VICAL to be automatically generated and published (daily/weekly).
- Select the Update button.
- Review the preview area where you can see all participants and credential types included in the VICAL.
Note that the VICAL is not generated and published yet. It will only be generated and published automatically based on the frequency you selected in step 5 above. If you want to generate and publish the VICAL immediately, you can select the Generate & Publish button.
View Previously Published VICALs (optional)
- Return to the Trust lists page under the Digital Trust Service section.
- Select the VICAL (Trusted issuers) tab.
- Scroll down and select the View Previously Published button to see all previously published VICALs.
You can use the Download button to download the policy file for any previously published VICAL displayed.
Next steps
Now that you have published your VICAL, you can share the public endpoint with relying parties so they can consume the VICAL and establish trust in the issuers and credential types included in it. You can also refer to the VICAL consumption guide to learn how relying parties can consume, validate and use a VICAL.
How would you rate this page?
Last updated on