• The machines with the card readers must have Idopte middleware and Smart ID Desktop App installed locally and a browser to access Smart ID Identity Manager.

• Smart ID Identity Manager version 23.04.9 or later (for 23.04 series).

  Smart ID Identity Manager versions 23.10.0 to 23.10.2 are not supported.

• Smart ID Desktop App version 1.12.2 or later. 

• Idopte Middleware  6.23.0.25 or later

• Inside Server version 1.4.3 or later with attached HSM for handling secrets

Idopte Web App Certificate authenticates Identity Manager Operator against Idopte middleware installed on the machines with the card readers.

1. Create a key pair, that is, a private key and a public key.

2. Send the public key together with a symbolic URL (for example https://smartiddesktopapp.customerdomain), to the Idopte company. You will then receive a certificate in X.509 format (previously a custom format was used).
   This certificate has a limited validity of several months and needs to be refreshed regularly.
   

You must configure the certificate together with the private key in Identity Manager Operator.

1. Configure the Idopte Web App Certificate in idm-operator/WEB-INF/classes/system.properties. 

   Example: Web App Certificate

   # |-separated list of webapp cert in custom format used by Idopte 6.22.x and earlier or in base64 X.509 format used by later versions # (if all clients support the same format, then you only need to specify that one) hermodEncodingService.idopteCert=theCertInBase64X509Format|theCertInCustomFormat

   For docker-based installations, you must configure the Idopte Web App certificate in docker/compose/identitymanager/operator/docker-compose.yml with every $ character in the cert escaped as $$.  
   

   Example

   --- version: "3.7" 
   services: smartid-idm-operator:
     extends:
       file: docker-compose-base.yml
       service: smartid-idm-operator
     environment: - 'SYSTEM_PROPERTIES={ ...etc...
                      "hermodEncodingService.idopteCert" : "4SyF8E6?J4{SVYI)psu*Xb0t#E=1oJdCH}B[Y8){oDbd%GP-L&ZI*KtJl@P?<:t$$Tvv[NPS9>6Mqkpnmg...etc..."
    ...etc...

    

2. Store the private key in an HSM or encapsulated in a password protected .p12 file (named idopteAuthentication.p12 in the example below) alongside either the actual X.509 web application certificate or a dummy certificate for the private key (for Idopte 6.22.x and older), which contains the symbolic URL as SAN URI extension.
   

3. Configure the .p12 file in idm-operator/WEB-INF/classes/engineSignEncryptConfig.xml. 
   

   Example

   An HSM can also be used.

   Example: engineSignEncryptConfig.xml

   <?xml version="1.0" encoding="UTF-8"?> 
     <engineSignEncrypt> 
       <descriptors>
       <!-- ... some other configurations ... -->
       <descriptor name="idopteAuthentication" version="1">
         <type algorithm="NONEwithRSA" key="idopteAuthentication" />
       </descriptor>
       <!-- ... some other configurations ... -->
       </descriptors>
   
       <keys>
       <!-- ... some other configurations ... -->
       <key name="idopteAuthentication"> 
         <type name="pkcs12" locationValue="classpath:idopteAuthentication.p12" pin="thePinGoesHere"/>
       </key>
       <!-- ... some other configurations ... -->
     </keys> 
   </engineSignEncrypt>

    

   For docker-based installations, place the idopteAuthentication.p12 into docker/compose/certs/ and reference it in docker/complose/identitymanager/config/signencrypt.xml.

Identity Manager Operator can now prove its identity against the Idopte Middleware when the communication starts.

Identity Manager must connect to the Inside Server to handle certain secrets used for the secure channel and authenticating to the card.

A two-way TLS handshake is needed between Identity Manager and the Inside Server. 

1. Configure the Inside Server URL in idm-operator/WEB-INF/classes/system.properties. See an example below:

   Example: Inside server URL

   # URL of Inside Server
   insideRestClient.url=https://<host_name>:<port>

   For docker-based installations you need to edit docker/compose/smartid.env. See an example below:
   

   Example: Inside server URL - Docker

   INSIDE_SERVER_URL='https://<host_name>:<port>'

   The variable must be referenced by docker/compose/identitymanager/operator/docker-compose.yml.

2. Configure the Identity Manager p12 file to use as client authentication for the Inside Server in
   idm-operator/WEB-INF/classes/engineSignEncryptConfig.xml. 
   

   Example

   An HSM can also be used.

   Example: Client auth keystore

   <?xml version="1.0" encoding="UTF-8"?>
     <engineSignEncrypt>
       <descriptors>
          <!-- ... some other configurations ... -->
          <descriptor name="insideClientAuth" version="1">
            <type algorithm="SHA256withRSA" size="" result="" key="insideClientAuth" />
          </descriptor>
       </descriptors>
       <keys>
         <!-- ... some other configurations ... -->
         <key name="insideClientAuth">
           <type name="pkcs12" locationValue="classpath:insideClientAuth.p12" pin="thePinGoesHere"/>
         </key>
         <!-- ... some other configurations ... -->
     </keys>
   </engineSignEncrypt>

3. Add the Inside Server certificate to the Identity Manager truststore (for example tomcat/conf/prime.truststore), via a suitable application like Keystore Explorer or Java's keytool command:

   keytool import example

   # note that keytool refuses to open keystores with very short passwords (less than 6 characters) - use e.g. Keystore Explorer to set a secure password in that case keytool -importcert -file insideServer.cer -keystore prime.truststore -alias "Inside Server cert"

Only the following cards are supported by IDM when used with the Idopte middleware:

• JCOP 3 (P60) cards with one specific custom profile (see JCOP 3 cards with Idopte middleware for details)
• JCOP 4.5 (P71) based on common IN Groupe profile (see JCOP 4.5 cards with Idopte middleware for details)

You can detect whether you are dealing with a JCOP 3 or JCOP 4.5 card by reading the token info JSON, as shown in Reader/card selection and information in Identity Manager .

The resulting JSON object will contain the attribute "jcopVersion", set to either "3" or "4.5".

Encoding via the Idopte middleware is supported only for Smart ID Desktop App (version 1.12.2 or higher). 
For encodings on card operation tasks you need to specify the appropriate device ID ("8711").

• Define the device ID in the encoding description. See the example below:

  Example: Device ID location

  [Encoding]
  Type=1024,Chip
  Devices=8711
  ...

  For card production tasks, you must specify "Personal Desktop App (PDA)" as production component on the respective card object.

You must specify the name "idopte" since a webservice-interface is used instead of the PKCS#11 interface to enable use of the secure channel.

• Add Idopte in the encoding description. 

  Example: Select Idopte middleware

  [Description]
  PKCS11Library=idopte
  ...

The Idopte middleware is incompatible with Alcor Micro USB Smart Card Readers, which are often integrated in Lenovo notebooks. If you try to connect to the card, the PC/SC connection is lost. This appears to be a driver/hardware issue.

The following is a non-exhaustive list of encoding parameters which are unsupported in encodings for the Idopte middleware.

Using unsupported parameters in most cases will result in encoding failure due to an "UnsupportedOperationException". The exception message can include a hint about parameters that possibly need to be removed from the encoding description.

• PUK=...

• SignPUK=...

• CardManagerKey=... (ignored, no exception thrown)

• NewCardManagerKey=...

• TokenInfoJsonField=...

• MDCardID=...

• MDCardSerialNumber=...

• CMSCardSerialNumber=...

• CardOSSkiThumbprintField=...

• OSVersionField=..

• PackageInformationField=...

• DeleteProfile=...

• UseCardManagerKey=...

• BlockCard=...

• InitialSignPUK=... (ignored, no exception thrown)

• InitialLabel=... (ignored, no exception thrown)

Card activation (InitPin=true) does not support PIN dialogs (for transport/global/signature PIN). Any PIN must be passed in from the process or entered through a PIN pad.

CSR signing with the corresponding private key on the card is not supported. PKCS#10 certificate requests are protected by the secure channel instead.

Certificate and key writing is authenticated using various symmetric keys.

If you want to additionally enforce having the card holder enter the PIN / signature PIN during renewal, you can set the IdopteExtraPinInput flag to true and specify which PIN(s) to enter, like in the following examples:

[Description]
IdopteExtraPinInput=true
PIN=!FROM_USER_DIALOG_1_FIELD_AUTO

[Description]
IdopteExtraPinInput=true
SignPIN=!FROM_USER_DIALOG_1_FIELD

[Description]
IdopteExtraPinInput=true
PIN=!FROM_PROTECTED_AUTHENTICATION_PATH
SignPIN=!FROM_PROTECTED_AUTHENTICATION_PATH

This will force the card holder to authenticate with the required PIN(s) before any certificate requests can be processed.

This error can occur when using outdated PIN pad reader drivers that are not able to recognize the PIN pad reader. If an older Idopte middleware version is already installed, the installer will only unpack the drivers but not reconfigure the device to use them.

Solution:

• To use the new drivers, open the device manager and select the smart card reader. If the PIN pad reader is not visible, click update driver and select the appropriate PIN pad reader.

• To verify, open the Idopte middleware and select general information, where you can see the reader name and PIN pad authentication information. PIN pad authentication must be true when any PIN pad reader is connected.