Credential Providers

Inji Mobile currently provides support for following credential providers:

Download VC using OpenID for VC Issuance Flow (eSignet)

National ID
Insurance

To set up a new provider that can issue VC, it can be accomplished by making a few configuration changes.

Steps:

The configuration details can be found in the mimoto-issuers-config.json property file. This file is maintained separately for each deployment environment. In this repository, each environment's configuration is stored in a dedicated branch specific to that environment.

Refer to mimoto-issuers-config.json of Collab environment.

These values will be used by Inji Mobile via Mimoto. Mimoto exposes APIs which is used by the Inji Mobile application to fetch, store the issuers and their configurations in the local storage.

API used to fetch issuers: https://api.mosip.io/v1/mimoto/residentmobileapp/issuers
API used to fetch issuer's configuration: https://api.mosip.io/v1/mimoto/residentmobileapp/issuers/${issuerId}

In mimoto-issuers-config.json, new providers can be added as per the well-known schema defined by OpenID4VCI standards.

After adding the provider in configuration, it will be displayed on the UI on Add new card screen.

If new provider supports OpenID4VCI protocol, it is recommended to use issuerMachine.ts and EsignetMosipVCItemMachine.ts for workflow to download VC.
If it doesn't support OpenID4VCI protocol, new state machine needs to be added. Please refer to issuerMachine.ts and EsignetMosipVCItemMachine.ts.

At present, Inji mobile supports verification of VCs which has RSA proof type. If VC is issued with any other proof type, verification will fail and VC will not be downloaded. To bypass this VC verification, we need to use issuer id as "Sunbird".

Refer https://github.com/mosip/mosip-config/blob/collab1/mimoto-issuers-config.json#L71 as reference. Here, credential_issuer should be "Sunbird" and then add all the configuration.

Token endpoint should also use same issuer id. Refer https://github.com/mosip/mosip-config/blob/collab1/mimoto-issuers-config.json#L143
Once the above steps are completed, mimoto should be onboarded as an OIDC client for every issuer. Please check the steps in the below sections.

Onboarding Mimoto as OIDC Client for a new Issuer:

Step 1:

Please find a zip file attached to this document called certgen.zip which will help the user in creating the p12 file as well as the public-key.jwk file. certgen.zip

Step 2:

The Userguide.md file explains the working of the script.

Step 3:

Create a client ID using the Esignet API which is mentioned below:

RequestURL : {{URL}}/v1/esignet/client-mgmt/oidc-client

Sample Request Body:



{
  "requestTime": "2024-06-19T11:56:01.925Z",
  "request": {
    "clientId": "mpartner-default-esignet-sunbird", #ClientId can be given as per user choice
    "clientName": "SUNBIRD", #ClientName can be given as per user choice and this name shows on the UI
    "publicKey":
    "publicKey": #This public key you can get from the script results
      {
    "kty": "RSA",
    "e": "AQAB",
    "use": "sig",
    "alg": "RS256",
    "n": "iYUbabC5vDW1ajzCF_MamTYuNrj_q-VuGO1Phzoi8G2DttiPpWc1WXNe2n22wD8-xVpIFT0Tm-wCNm7vbnQJ0n5RyWgn_4fOJkCeUgNOFeVm4g92IDcstoN9Hos_4G2-FUwtNNmGh0z_g-jkdUs_y2HXHJS97MBex9v8czMUknru-5EJvXzyKjEYY_z50oMl7RfpsFK76vJ84T7bpj90ZlkCqSi_ru0rYZaYc8CE7UIV1oKf33fQXuUw4vxlaxMRNxYFtdiGooeYouz8tfpav7yN88Urn6Js2vHdf8ugUYodM1_TOesosHjYEaMr80M0nT0z394OoDPFwzI5YC3koQ"
},
    "relyingPartyId": "mpartner-default-esignet-sunbird", #This value can be same as clientId
    "userClaims":  [       #Claims Section defines the different attributes of User Data taht is accessible to the OIDC client
            "birthdate",
            "address",
            "gender",
            "name",
            "phone_number",
            "picture",
            "email",
            "individual_id"
        ],
    "authContextRefs":  [ #ACR values define the various ways a user can login e.g through INJI,using Bioemtrics and Throguh OTP
            "mosip:idp:acr:linked-wallet",
            "mosip:idp:acr:biometrics",
            "mosip:idp:acr:knowledge"
        ],
    "logoUri": "{{url}}/inji/inji-home-logo.png",
    "redirectUris": [ "https:\/\/healthservices.{{url}}\/userprofile"],
    "grantTypes": [
      "authorization_code"
    ],
    "clientAuthMethods": [
      "private_key_jwt"
    ]
  }
}

Sample Response :


{
    "id": null,
    "version": null,
    "responsetime": "2024-05-21T11:56:26.752Z",
    "metadata": null,
    "response": {
        "clientId": "mpartner-default-esignet-sunbird",
        "status": "ACTIVE"
    },
    "errors": []
}

Clients can get renewed by demand, but that mean some manual changes are required. It is always recommended to create a client once per environment as it has no expiry. Also note that one public key and p12 file pair can be used only once . ( Unless removed from DB )
The install.sh script in mimoto as well as the helm charts inside mimoto repo were changed to allow for the storage and mounting of the oidckeystore.p12 file

Step 4:

The logo URL should be uploaded to file server.

For Onboarding any new issuer, Step 1 to 4 has to be followed and p12 has to be generated.

Step 5:

Once p12 file is generated, existing keystore file has to be exported from mimoto pod and newly created p12 file has to be imported and remounted in the Mimoto pod.

Step 6:

Once mimoto is added as an OIDC client, the new issuer should be added as a partner to mimoto. Please find the below section detailing the steps.

Add new partner in Mimoto:

Following is the process of adding a new partner by the name of “esignet--partner “ onto mimoto.

We already have a p12 file on the mimoto pod (as explained in above section), we are not replacing or creating a second p12 file, We are only adding another key to the key-store already present.

Download the existing p12 file from the mimoto pod using this command from the environment's terminal:

kubectl -n mimoto cp mimoto-86cc54569c-9bs65:certs/..data/oidckeystore.p12 oidckeystore.p12

Add the esignet--partner's key as alias “esignet--partner“ onto the same p12 file using a tool like keystore-explorer. The password here is “mosip123“

The below image shows how to browse and select the esignet-sunbird-partner’s oidckeystore as the second alias. in the decryption password field should have the password of the p12 file, in this case “mosip123“

The below image shows how to add an alias for the new key pair, here the value is esignet-sunbird-partner.

To take a backup of the original keystore.p12 use the following command

kubectl -n mimoto get secrets mimotooidc -o yaml | sed "s/name: mimotooidc/name: mimotooidc-backup/g" | kubectl -n mimoto create -f -

Delete the existing mimotooidc secret using the following command

kubectl delete secret -n mimoto mimotooidc

To create a new secret containing both the keypair.

kubectl -n mimoto create secret generic mimotooidc --from-file=./oidckeystore.p12

Create the required secrets in the cluster such as mimoto.oidc.mock.partner.clientid and use the client ID from the response of create oidc-client request.
Make sure to add the the mimoto.oidc.mock.partner.clientid inside the config-server deployment yaml file
Restart the Mimoto pod to take all the changes.

Last updated 28 days ago