Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
This article includes updates for Smart ID Desktop App 1.12.1.

...

API commands 

Expand
titleSign

Additionally to JWS signatures, Smart ID Desktop App also supports PKCS7, XML based signature XMLDSIG and raw RSA signatures. Not all the message properties that are described in the API documentation are supported by Smart ID Desktop App. Contact Nexus if you need more information regarding this.


Expand
titleAuthenticate

Since Authenticate is a specific application of the Sign command. Therefore, the same applies as for the Sign command.

...

Expand
titleStartpinreset

This command is only used with Smart ID Desktop App.

If "driver", or "smartcardid", or both parameters are specified, a profile-less operation will be performed, for example, adminkey change, PIN reset, PUK change, or PIN change for a selected token not associated with an existing Smart ID Desktop App profile. However, if only the parameters "profileid" and "operation" are specified, the chosen operation is executed on a token associated with an existing profile within the app.

Parameters

ParameterDescription

"driver"

Identifies the token in case of profile PIN reset.

The value is json with two fields:

  • Name
    Accepted values: "yubi", "cardos", "any", "c2300", "gemalto", "vsc"

  • Type
    Accepted values: "minidriver" or "pkcs11" 

"operation"

If not specified, PIN reset is performed.

Accepted values:

  • "pinreset", "adminkeychange", "pinchange","pukchange"

“smartcardid”

Unique minidriver-based token identifier. This parameter is used to identify the token in case of a profile-less operation. (To identify the token, it is enough to specify one of the fields “smartcardid” or “driver”).

"profileid"

Identifies the profile within the Smart Id Desktop App, on which the operation is executed. (If the values for "smartcardid" and "profileid" identified with the profile are different, the value for "smartcardid" should be used.)

Response Parameters

ParameterDescription

“nonce”

This value is generated by Smart ID Desktop App and sent to the server to be encrypted by adminkey, and returned using the Epin command as proof of adminkey possession. 

"transportedkey"

Onetime RSA key used for encoding of the new adminkey, which allows for its secure transmission.



Expand
titleEndpinreset

This command is only used with Smart ID Desktop App.

Parameters

ParameterDescription

"encryptedpayload"

Only used in case of adminkey change operation. The expected valued is the new adminkey in hex format, JWT encoded with RSA_OAEP and A128CBC_HS256.

“encryptednonce”

Encrypted nonce that was sent in Spin command to Hermod.

“smartcardid”

Defines which profile in Smart ID Desktop App that is targeted.

“newadminkey”

Optional.

If present, instead of initiating a PIN reset, it actually changes previous adminkey to the current one.

Hexencoded adminkey, which means 48 lowercase ASCI characters encoding 24 bytes of the new key.


...