Skip to main content

Configure your Identity Provider

Overview​

The OpenID4VCI and OIDC Bridge issuance workflows augment your existing identity management infrastructure. You can leverage an existing Identity Provider (IdP) to authenticate users and retrieve information required to generate verifiable credentials and make them available to an end-user's digital wallet.

tip

If you are unfamiliar with OpenID Connect, the identity protocol underpinning the OpenID provisioning capability, there are many excellent guides available online such as this guide from Google, or this guide from Mozilla.

Prerequisites​

You can use any OpenID Provider as long as it supports the following capabilities specified by OpenID Connect Core and OpenID Connect Discovery:

  • Must publish the OpenID Provider configuration at /.well-known/openid-configuration

  • Must support Authorization Code flow

  • Must support the state parameter

These are required to allow the OpenID4VCI issuance workflow to engage with your IdP and accept an ID Token containing the end-users claims.

Identity Provider configuration​

Perform the following steps to ensure your IdP is properly configured and ready to be used to issue verifiable credentials:

Step 1: Create your Identity Provider​

If you don't have an existing IdP, we offer a number of tutorials on how to set up an IdP with the following providers (remember you can use any IdP provider as long as it meets the outlined requirements):

step 2: Update the OpenID configuration file​

Browse to https://<your-host-domain>/.well-known/openid-configuration (it should be publicly available) and verify the following values exist (other options may validly sit alongside):


{
    "authorization_endpoint": "https://your-auth-endpoint/auth",
    "token_endpoint": "https://your-token-endpoint/token",
    "jwks_uri": "https://your-jwks-endpoint/jwks",
    "response_types_supported": [
        "code"
    ],
    "grant_types_supported": [
        "authorization_code"
    ],
    "token_endpoint_auth_methods_supported": [
        "client_secret_basic"
    ],
}

Step 3: Setup an application client on your Identity Provider​

Setup an application client on your IdP:

Step 4: Run a manual test to request an ID token​

  1. In a new browser window, make a request of the following structure:

https://auth0-tenant.au.auth0.com/authorize
?scope=openid%20profile
&response_type=code
&client_id=<your_client_id>
&state=xqw2Lcafhx0NIoX0
&nonce=kjfhuo34hPxksklj
&prompt=login
&redirect_uri=https://example.com/callback

  • Use the authorization endpoint defined in your IdP /.well-known/openid-configuration file. This example uses an Auth0 IdP.

  • response_type: Use code to indicate the expected response type.

  • client_id: Use the client_id for the client application you created on your IdP.

  • state: Use any random string.

  • nonce: Use any random string.

  • prompt: Use login to prompt your IdP to display the login screen.

  • redirect_uri: Use the example URI you used for the client application you created on your IdP.

  1. Authenticate with the IdP using a user that you have set up on it.

Example Auth0 login page

image

  1. The redirect will terminate, but you can still retrieve the code from the query parameter:

https://example.com/callback?code=oLxCRk2oPgfR8QU3&state=xqw2Lcafhx0NIoX0https://example.com/callback?code=oLxCRk2oPgfR8QU3&state=xqw2Lcafhx0NIoX0

  1. Construct a request of the following structure to the /token endpoint of your IdP tenant:

curl --request POST \
  --url https://auth0-tenant.au.auth0.com/oauth/token \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic dkowU0NLY2hyNFhqQzB4SE5FOERrSDZQbWxnMmxrQ046UU53ZmE0WWk0SW05enkxdV8xNW43U3pXS3QtOUc1Y2RIMHIxYk9OUnBVUGZOLVVJUmFhWHZfOTB6OFY2LU9qSA==' \
  --data-raw '{
    "grant_type": "authorization_code",
    "code": "oLxCRk2oPgfR8QU3",
    "redirect_uri" : "https://example.com/callback"
}'

  • url: We are using an example from Auth0. Replace with the correct URL for your IdP.

  • header:

    • Use Content-Type: application/json.

    • Use your client_id and client_secret to create the Authorization: Basic header encoded with Base64 using a tool similar to base64url.com. The string should be formatted as client_id:client_secret prior to being encoded.

  • data-raw:

    • grant_type: Use authorization_code

    • code: Use the value captured from the above redirect. This is time sensitive, you have about 5 mins!

    • redirect_uri: Use the same value as the request.

  1. The response should include the id_token.

{
    "access_token": "-vtm3ahlh9k_V2uDjnZ5r2MPbKRaHpA1",
    "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJUVXdOVEpCTXpJNFJUTTNNVGt4TURnNU5EVTJRamRETlRVNVJrWTNNamMyTTBWRU1FVkJPUSJ9.eyJodHRwczovL215dGVuYW50Lm1hdHRyLmdsb2JhbC90cmFpbmluZ0NlcnQiOiJQYXNzZWQgQSsiLCJuaWNrbmFtZSI6Im1lIiwibmFtZSI6Im1lQGVtYWlsLmNvbSIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci84ZjlkYzA0ZTZhYmRjYzlmZWE1M2U4MTk0NWM3Mjk0Yj9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRm1lLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDIwLTA0LTMwVDA3OjUxOjA4Ljk0MloiLCJpc3MiOiJodHRwczovL2Rldi1yb2w0d29hby5hdS5hdXRoMC5jb20vIiwic3ViIjoiYXV0aDB8NWU2NmVjZjZlNWNjZjUwY2QwMDNmZjIwIiwiYXVkIjoidkowU0NLY2hyNFhqQzB4SE5FOERrSDZQbWxnMmxrQ04iLCJpYXQiOjE1ODgyMzQwNzEsImV4cCI6MTU4ODI3MDA3MX0.KLrMUoqz5mrvNQQ3K09eFijVg3qkmT17R_zOUvVhtfC8LvUWaBYpszQ7j3x3zCZ1TsS4ATS68kcxLfSbq7A71atYVzwjKvGwGce9IjH7cRKyIO8Z1RAcSCw7ncXBOzT_O20sH3BV_ZgPHEJA2PreKQERKjcKSCHJeRaPyqVbh2v2lSHYCm6e8HdB8v_Zq0looLvxS5afQ8PMn3k36COo13F4zvLuUn9is--B-SRUqUjSX6-KOvULa1HXbQVnO6RUNiijQSbN-ZLA_6TRQC8BKoT3-8v1cLSb49sZOXGSBHkkNHGBhMXeJuw4iD8IjYQWpcXlVRQHuCQwFgSHxdez9w",
    "scope": "openid profile",
    "expires_in": 86400,
    "token_type": "Bearer"
}

  1. Copy the id_token value and paste it into a tool like jwt.io to inspect the payload of the ID token:

{
    "https://YOUR_TENANT_SUBDOMAIN.vii.mattr.global/educationalCredentialAwarded": "Certificate Name",
    "updated_at": "2020-04-30T07:51:08.942Z",
    "iss": "https://dev-rol4woao.au.auth0.com/",
    "sub": "auth0|5e66ecf6e5ccf50cd003ff20",
    "aud": "vJ0SCKchr4XjC0xHNE8DkH6Pmlg2lkCN",
    "iat": 1588234071,
    "exp": 1588270071,
    "auth_time": 1606723358,
    "nonce": "kjfhuo34hPxksklj"
}

  • sub: This is the unqiue identifier of the authenticated user in your IdP.

  • nonce: The value provided in the original request.

What's next?​

You can now proceed to create an authentication provider configuration.