Smart ID Messaging - Standard service tasks in Identity Manager
This article includes updates for Identity Manager 6.1.
Mobile App: Create Key
Description
Use this task to either provision a new profile or update an existing one overwriting existing keys. The task will create the keys needed for the "Mobile App: Install certificates" task. The keys will be created on the mobile device. Additionally, PKCS#10 requests will be generated with these keys.
The following PKCS#10 requests will be generated:
Signature Certificate (optional)
Authentication Certificate (optional)
Device Encryption (used to secure the communication with Smart ID Mobile App)
Key size
By default, RSA keys with a length of 2048 bits will be generated. The size can be configured in the certificate template using the certificate attribute KEY_SIZE. For more information, see also Set up certificate template in Identity Manager
The requests will be sent to a message catching intermediate event identified by the parameter 'messageName'. Identity Manager will put the PKCS#10 requests into the process map under the keys "SIG_P10_VAR", "AUTH_P10_VAR" and "DEVICE_ENC_P10_VAR". If a new profile was created, Identity Manager will also put the new profileId into the process map under the key "profileId". In order to save the profile id you will need to copy it into a data pool field.
After this task is executed, you need to get certificates from a CA using the requests stored in the process variables "SIG_P10_VAR" and "AUTH_P10_VAR" before proceeding to the "Mobile App: Install certificates" task. Store the certificates into the process map.
Smart ID Mobile App will sign the request data and Identity Manager will verify the mobile client's data signature using the attestation key. The attestation key is configured in the task's attestationKeySet parameter and in the Sign and encrypt engine in Identity Manager.
If the verification fails, the task will not accept the data but set two process variables instead:
The errorTypeField (see the parameters below) will be set to "HERMOD_ERROR_JWT_SIGNATURE". Use this in your process design to react to validation errors.
The errorMessageField (see the parameters below) will contain a more descriptive message
Configuration
To use this task, configure the following delegate expression in your service task:
${hermodKeyCreationTask}The following parameters can be configured in Identity Manager Admin:
Parameter | Mandatory | Value | Description |
|---|---|---|---|
messagingServer | Example value:
| The name of the Smart ID Messaging configuration as defined in Identity Manager Admin. This configuration provides data (url, authentication token, lifespan and timeout) needed for the Smart ID Messaging connection. | |
messageName | Example value:
| The name of the intermediate message catching event that will be triggered by Smart ID Messaging. | |
userid | Example value:
| ID representing the user on the messaging server. This will be displayed in the profile on the mobile app to verify the correct data is provided. A common approach is to use the user's email address. | |
errorMessageField | Example value:
| Process variable to put the error message in case of failure. | |
errorTypeField | Example value:
| Process variable to put the error type in case of failure. | |
signCertificateTemplate | - |
| Signature certificate template. |
authCertificateTemplate | - |
| Authentication certificate template. |
profileName | If new profile | Leave empty (when updating a profile) | Profile name for Smart ID Messaging. Will be displayed in the Smart ID Mobile App. Leave empty if you want to update an existing profile. |
serverName | If new profile | Example value:
| Name of the server that issued the provisioning request. This is for the user to understand where the profile comes from. |
attestationKeySet | - (If not set will default to "ATTESTATION") | Example value:
| The name of the attestation key that will be used for signing (by the client) and validating (by Identity Manager) the mobile client's data. The available values are the names of the descriptors in the sign and encrypt engine that start with "att_", without this prefix. An attestation key with the same name must be defined in Smart ID Mobile App/MDM device. Default value is "ATTESTATION" when no descriptor value is provided. |
qrResultField | If new profile | Example value:
| Process variable to put the resulting url. This url may be converted to a QR-Code for the Smart ID Mobile App by using GenerateQRCodeParametrizedAction. |
profileId | If update profile | Leave empty (for new profile) | Id of the Smart ID Mobile App profile that will be updated with new keys. Leave empty if you want to provision a new profile. |
storagePriority | Valid values:
| Storage priority of certificates. MDM is replaced by EXT, however MDM is still supported. | |
visualIdLayout | If using visual ID | Example value:
| The layout to be used for creating the visual ID. If there is a juel expression configured for the front or backside image, this will take precedence over the statically configured image. If there is no image found for the juel expression, and there is no statically configured image, the task will fail. |
cardDatapool | If using visual ID | Example value:
| The datapool used for saving the mobile ID profile. |