API C/C++
HSM Dinamo
Loading...
Searching...
No entry found
Library Return Codes
Code Value Description Details
D_SOCKET_FAILED
-10
Failed to create socket. Socket creation failed. Possible causes: system error. Refer to logs for more details.
D_GETHOSTNAME_FAILED
-11
Failed to resolve HSM address. The HSM address could not be resolved. Check the HSM address entered. If using load balancing, check the addresses in the configuration file. If the address is correct, see logs for more details.
D_CONNECT_FAILED
-12
Failed to connect to the HSM. Session establishment with the HSM failed. Possible causes for this error include: network/HSM unavailability; network subsystem failure. Other less probable causes are: connection rejected by the HSM; internal socket error. Refer to logs for more details.
D_SEND_FAILED
-13
Failed to send data. The Client failed to send data successfully. Most probable causes for this error include: session timeout (client-side or server-side); network/HSM unavailability; network subsystem failure. Other less probable causes are: internal socket error. Refer to logs for more details.
D_RECV_FAILED
-14
Failed to receive data. The client failed to receive data successfully. The most probable causes for this error are: session timeout (client-side or server-side); unavailable network/HSM; network subsystem failure. Less probable causes include: internal socket error. Refer to logs for more details.
D_INVALID_PACKAGE_SIZE
-15
Invalid package size. The size of the received data package differs from the expected size. Refer to logs for more details.
D_SETSOCKOPT_FAILED
-16
Failed to set socket options. Setting socket options failed. Probable causes include: invalid parameter; network subsystem failure; connection timeout; internal socket error. Refer to logs for more details.
D_GETSOCKOPT_FAILED
-17
Failed to retrieve socket options. Setting socket options failed. Probable causes include: invalid parameter buffer size; network subsystem failure; internal socket failure. See logs for more details.
D_ALL_LOAD_BALANCE_HSM_FAILED
-18
All HSMs in the load balancing list are unavailable. The HSMs in the load balancing list are all unavailable. After unsuccessfully trying to access all the HSMs listed, this error is returned. In this specific case, after this error is returned, all the addresses registered in the list become available for new access attempts without going through the suspension time. Possible causes: network failure on the client machine; failure to access the HSM network; failure of all HSMs.
D_RESET_BY_PEER_ERROR
-19
Connection closed by the remote host. The connection was forcibly closed by the remote host.
D_CONNECTION_REFUSED_ERROR
-20
Connection refused. The connection was not made because the remote host actively refused it.
D_CONNECTION_TIMEDOUT_ERROR
-21
Connection timeout. The connection attempt failed because the remote host did not respond after a period of time, or an established connection failed because the remote host failed to respond.
D_NETWORK_DOWN_ERROR
-22
No network. The socket operation found a malfunctioning network.
D_SSL_ZERO_RETURN_ERROR
-23
Zero return. The remote TLS/SSL host has closed the connection for writing by sending a close_notify alert. No data can be read.
D_SSL_ERROR
-24
SSL error. A fatal, non-recoverable error has occurred in the SSL library, usually a protocol error. See the logs for more details.
D_SSL_CTX_NEW_FAILED
1
Failed to create SSL context. SSL context creation failed. Possible causes: system or internal failures. See logs for more details.
D_SSL_NEW_FAILED
2
Failed to create TLS structure. The creation of the TLS connection structure failed. Possible causes: system or internal failures. See logs for more details.
D_SSL_CONNECT_FAILED
3
Failed to initiate TLS handshake with HSM. The TLS handshake with the HSM failed. At this point the socket connection to the HSM has already been established and the TLS handshake has failed. Possible causes: TLS handshake failure, use of old HSM (very old versions) with new client library (or vice versa), failure at protocol level, Connection failure. See logs for more details.
D_SSL_GENERAL_ERROR
4
Generic failure in the internal cryptography library. The internal cryptography library failed. One possible cause may be insufficient resources (memory) on the local machine. See logs for more details.
D_CRL_GENERAL_ERROR
101
Generic failure in the internal connection cryptography library. The internal connection encryption library failed. One possible cause is insufficient local machine resources (memory). See logs for more details. This error is related to communication between the local machine and the target server.
D_CRL_SSL_CACERT_BADFILE
102
Could not load the server's certificate chain. The CA chain/certificate was not found or is in an incorrect format. This error is related to communication between the local machine and the target server.
D_CRL_COULDNT_RESOLVE_HOST
103
Could not resolve the server name. The server name cannot be resolved or is malformed. Verify the server name. This error is related to communication between the local machine and the target server.
D_CRL_COULDNT_CONNECT
104
Could not connect to the server. Failed to connect to the server. Verify the server name. This relates to communication between the local machine and the target server.
D_CRL_OPERATION_TIMEDOUT
105
Timeout failure. The operation exceeded the timeout limit. This relates to communication between the local machine and the target server.
D_CRL_PEER_FAILED_VERIFICATION
106
Failed to verify server certificate/fingerprint. The server's certificate/fingerprint could not be verified. This relates to communication between the local machine and the target server.
D_CRL_SSL_CONNECT_ERROR
107
TLS handshake failed. An issue occurred during the SSL/TLS handshake. This could be due to certificates (format, paths, permissions), passwords, or other factors. This is related to communication between the local machine and the target server.
D_CRL_SEND_ERROR
108
Failed to send data. An issue occurred while sending data. Check the network connection. This is related to communication between the local machine and the target server.
D_CRL_RECV_ERROR
109
Failed to receive data. An issue occurred while receiving data. Check the network connection. This is related to communication between the local machine and the target server.
D_CRL_SSL_CERTPROBLEM
110
Failed to use the local certificate. An issue occurred when utilizing the local certificate, related to communication between the local machine and the target server.
D_CRL_SSL_ISSUER_ERROR
111
Failed to verify the certificate issuer. An issue occurred during certificate issuer verification, related to communication between the local machine and the target server.
D_CRL_AUTH_ERROR
112
Failed to authenticate. An issue occurred within the authentication function, related to communication between the local machine and the target server.
D_CRL_GOT_NOTHING
113
Nothing was returned by the HTTP server. Nothing was returned by the server, which indicates an error. This is related to communication between the local machine and the target server.
D_CRL_UNSUPPORTED_PROTOCOL
114
Unsupported protocol. The protocol specified in the URL is not supported. This relates to communication between the local machine and the target server.
D_CRL_URL_MALFORMAT
115
Malformed URL. The URL is not correctly formatted. This relates to communication between the local machine and the target server.
D_CRL_WEIRD_SERVER_REPLY
116
Unrecognized server response. The server sent an uninterpretable response. Related to communication between the local machine and the target server.
D_CRL_REMOTE_ACCESS_DENIED
117
Access denied to the remote resource. Access was denied to the target URL resource. Related to communication between the local machine and the target server.
D_CRL_HTTP2
118
HTTP2 windowing layer failure. This error can have several causes; refer to the logs for more details. It is related to communication between the local machine and the target server.
D_CRL_WRITE_ERROR
119
Internal write callback failure. This error can have several causes; refer to the logs for more details. It is related to communication between the local machine and the target server.
D_CRL_READ_ERROR
120
Internal read callback failure. This error can have several causes; refer to the logs for more details. It is related to communication between the local machine and the target server.
D_CRL_HTTP_POST_ERROR
121
HTTP POST failed. This error can have several causes; refer to the logs for more details. It is related to communication between the local machine and the target server.
D_CRL_ABORTED_BY_CALLBACK
122
Operation aborted by the internal callback. This error can have several causes; refer to the logs for more details. It is related to communication between the local machine and the target server.
D_CRL_TOO_MANY_REDIRECTS
123
Too many redirects. The maximum number of supported redirects has been reached. This is related to communication between the local machine and the target server.
D_CRL_SSL_CIPHER
124
Failed to use the specified cryptographic algorithm. The specified cryptographic algorithm could not be used. This is related to communication between the local machine and the target server.
D_CRL_BAD_CONTENT_ENCODING
125
Unrecognized content encoding. The content encoding could not be recognized. This is related to the communication between the local machine and the target server.
D_CRL_LOGIN_DENIED
126
Login denied. The remote server denied the login. This is related to the communication between the local machine and the target server.
D_CRL_INSTALL_SIGN_CALL_FAILED
127
Signature call installation failed. Signature call installation failed. These calls are related to the signature used in the TLS tunnel between the local machine and the target server. Please generate debug logs and contact technical support.
D_CRL_CERT_LOAD_FAILED
128
Failed to load the TLS certificate. Failed to load the TLS certificate stored in the HSM. Verify that the certificate exists in the HSM and that its name and type (x.509) are correct.
D_CRL_CHAIN_LOAD_FAILED
129
Failed to load the TLS certificate chain. Failed to load the TLS certificate chain stored in the HSM. Verify that the certificate chain exists in the HSM and that its name and type (X.509 or PKCS#7) are correct.
D_CRL_PRIVATE_KEY_LOAD_FAILED
130
Failed to load TLS private key. Failed to load the TLS private key stored in the HSM. Verify that the private key exists in the HSM and that its name is correct.
D_WSASTARTUP
2001
Invalid Winsock (Windows Socket) DLL version. The Winsock library version is not supported by the HSM client library. Check minimum installation requirements on Windows machines. This error only applies to Windows platforms.
D_MEMORY_ALLOC
2002
Memory allocation failure. Could not allocate the requested memory. Check the available memory for the process and the machine.
D_INVALID_PARAM
1001
Invalid parameter passed to the API. The parameter passed to the API is invalid. Check the parameters passed (e.g., passing an invalid flag parameter, not passing a key handle when creating an HMAC in DCreateHash, etc.). Refer to logs for more details.
D_INVALID_TYPE
1002
Invalid parameter type passed to the API. The type of parameter passed to the API is invalid. This is a generic error that may be related to data types, keys, or blobs passed as API parameters in certain situations (e.g., using a symmetric key in a symmetric operation, unsupported output data type, etc.). Refer to logs for more details.
D_INVALID_STATE
1003
The handle state is invalid. The handle in use is in an invalid state. This error may occur when the handle is used without being properly initialized or is used for a different purpose (e.g., a session cannot perform other operations when in remote log mode). Refer to logs for more details.
D_LOGGING_NOT_STARTED
1004
Log not initialized. Currently unused.
D_MORE_DATA
1005
More data is required. The buffer passed as a parameter in the API is not large enough to receive the output data. Check the documentation for the called API in the manual and verify if the API returned the required size for the output buffer. See logs for more details.
D_INVALID_RESPONSE
1006
Invalid HSM response. The response to the request sent to the HSM is not recognized. One possible cause is that the version of the client library is out of date with the HSM. In this case, download the latest version of the client library. Another possibility is a fault in the HSM (rare). In this case, please contact support.
D_INVALID_CONTEXT
1007
Invalid context. The context (session handle, key handle, etc.) passed to the API is invalid. In most cases, it is the session context. Verify that the context is valid, not NULL, and appropriately initialized.
D_KEY_GEN_ERROR
1008
Key generation failed. Currently unused.
D_KEY_DEL_ERROR
1009
Failed to remove key. Currently unused.
D_KEY_NOT_EXISTS
1010
The key does not exist. Currently unused.
D_INVALID_DATA_LENGTH
1011
Invalid input data length. The input data/buffer size is invalid. Refer to the documentation of the called API for the required size. See logs for more details.
D_INVALID_KEY_ALG
1012
Invalid key algorithm. The algorithm of the key used is invalid for this operation. Possible causes include using a symmetric key for asymmetric operations (and vice versa). Verify the type of key provided, the documentation for the called API, and cryptographic fundamentals for correct key usage. See logs for more details.
D_INVALID_PADDING
1013
Invalid padding. The padding type requested for the API is invalid/unrecognized. Verify the padding type provided and consult the documentation for accepted padding types by the API. See logs for more details.
D_INVALID_KEY
1014
Invalid key. The key passed to the API is either invalid or not appropriate for this use. Verify that: the key context is not NULL, the key context is correctly initialized, and the algorithm matches the operation. Refer to the documentation of the called API for accepted key types. Check logs for more details.
D_BAD_DATA
1015
Invalid input data. Input data is invalid or corrupted. Refer to the documentation of the called API for accepted input data. See logs for more details.
D_INVALID_PUBKEY
1016
Invalid public key. The public key used in this operation is invalid or could not be used. Possible causes include: invalid key format, unavailable public key, inconsistent/corrupted key, etc. See logs for more details.
D_INVALID_ALG_ID
1017
Invalid algorithm. The algorithm used is invalid for this operation. The algorithm can be any object accepted by the HSM. The algorithm may be valid but invalid for a specific operation. Refer to the called API documentation for accepted algorithm types. See logs for more details.
D_INVALID_HASH
1018
Invalid hash. The hash handle passed to the API is invalid. Possible causes: NULL hash handle, uninitialized hash, etc.
D_INIT_HASH_FAILED
1019
Failed to initiate hash operation. Hash initialization operation failed (rare). See logs for more details. Contact support.
D_INVALID_HASH_STATE
1020
Invalid hash state. The hash is in an invalid state. Hashing operations are defined in a start/middle/end sequence. Operations deviating from this sequence may fail with this error (e.g., finalizing a hash that was not initialized or has already been finalized). Refer to the documentation for correct API usage. See logs for more details.
D_END_HASH_FAILED
1021
Failed to finalize hash operation. The hash operation failed during finalization. Possible causes include an internal error or a server error. Refer to the client library and HSM logs for more details.
D_GET_INFO_ERROR
1022
Failed to retrieve HSM information. The client failed to retrieve information from the server. Possible causes include a server error. Refer to HSM logs for more details.
D_INVALID_PIN_LEN
1023
Invalid PIN size. The PIN has an invalid size (e.g., the backup PIN size is either greater or smaller than permitted). Refer to the documentation of the invoked API for more format details. Consult the logs for further information.
D_OPEN_FILE_FAILED
1025
Failed to open file on the local machine. The file name/path provided as a parameter could not be opened or created. Possible causes include access permissions, incorrect path, etc. Refer to the logs for further details.
D_BACKUP_FAILED
1026
Failed to back up the HSM. The HSM backup operation failed. Possible causes: HSM failure. Refer to HSM and client library logs for more details.
D_RESTORE_FAILED
1027
Failed to restore HSM. Currently unused.
D_INVALID_CALLBACK
1028
Invalid callback function. The callback function is invalid. Refer to the documentation for the called API. Verify that it is not NULL. Check logs for more details.
D_NOT_IMPLEMENTED
1029
Functionality not implemented. The requested functionality is not implemented. Verify that the latest client library is installed. Refer to the documentation for the called API.
D_AUTH_FAILED
1030
Authentication failed. Authentication for this operation failed. Verify the username/password/OTP, or any password or credential passed to this function call. See HSM and client library logs for more details.
D_INVALID_CLEAR_OP
1031
Invalid operation in an open session. This operation cannot be performed in an open (insecure) session. Restart this operation using an encrypted (secure) session.
D_CHANGE_PWD_ERROR
1032
Failed to change user password. The user password change operation failed. Possible causes include: password not compliant with HSM policy, etc. Refer to HSM logs for more details.
D_PWD_SIZE_ERROR
1033
Invalid password length. The provided password has an invalid length. Refer to the documentation for allowed password length. See logs for more details.
D_IMPORT_KEY_ERROR
1034
Failed to import key. Currently unused.
D_INVALID_KEY_ID
1035
Invalid key name. The key name passed in is invalid. Key names must follow the standard described in the HSM manual.
D_INVALID_FLAG
1036
Invalid flag passed to the API. The flag passed to the API is invalid. Possible causes include an outdated client library version that does not support the flag, an invalid flag, etc. Refer to the called API's documentation for flag details. Check logs for more information.
D_INVALID_SIGNATURE
1037
Invalid signature. Signature verification failed. The public key was found and used, but the signature content verification did not match what was expected. See logs for more details.
D_INVALID_PUB_KEY
1038
Invalid public key. Currently not used.
D_INVALID_KEY_STATE
1039
Invalid key state. The key state is invalid for the requested operation. See logs for more details.
D_CREATE_USER_ERROR
1040
User creation failed. Currently unused.
D_NO_MORE_OBJECT
1041
There are no more objects to be received by the HSM. Internal error. Please contact support.
D_PUT_ENV_VAR_FAILED
1042
Failed to set environment variable. Environment variable creation failed. See logs for more details.
D_INVALID_FILE_SIZE
1043
File size is invalid. The provided file size is invalid for the operation. For example, if a file larger than allowed for writing to the HSM is provided, this error will be returned. See logs for more details.
D_INVALID_TEXT_SIZE
1044
Invalid text size. Currently unused.
D_FILE_ACCESS_ERROR
1045
File access failed. File access failed. Check access permissions. See logs for more details.
D_INVALID_COUNTER
1046
Invalid counter. Currently unused.
D_INVALID_MODE
1047
Invalid encryption mode. The encryption mode used is invalid for this operation. Check that the encryption mode is consistent with the operation used. See the API documentation for accepted modes. See logs for more details.
D_INVALID_STRUCT_ID
1048
Invalid structure ID. Currently unused.
D_INVALID_IP_ADDRESS
1049
Invalid IP address. Currently unused.
D_GET_PEER_IP_ERROR
1050
Failed to retrieve peer IP address. Currently unused.
D_CERTIFICATE_PARSE_FAILED
1051
Failed to decode certificate. The decoding of the certificate has failed. This failure can occur at the X.509 decryption level or in specific expected data (e.g. SPB certificate where specific fields are required). Check the documentation of the API called to find out which types are accepted. Check logs for more details.
D_INVALID_KEY_PART_1
1052
Key part 1 is invalid. The first part of the key is invalid. The KCV (Key Check Value) verification of the first component of the ZCMK (Zone Control Master Key) Visa is invalid. Check key entry or KCV.
D_INVALID_KEY_PART_2
1053
Key part 2 is invalid. The second part of the key is invalid. The KCV (Key Check Value) verification of the second component of the ZCMK (Zone Control Master Key) Visa is invalid. Check key entry or KCV.
D_INVALID_KEY_PART_3
1054
Key part 3 is invalid. The third part of the key is invalid. The KCV (Key Check Value) verification of the third component of the Visa ZCMK (Zone Control Master Key) is invalid. Check key entry or KCV.
D_VERIFY_DAC_FAILED
1055
Failed to verify DAC. Failed to verify DAC (Data Authentication Code). The DAC passed is not the one expected. See the API documentation for more details.
D_DEPRECATED
1056
This functionality is deprecated. The requested functionality is no longer supported.
D_NO_MATCHING_KEY_FOUND
1057
No matching key was found. Currently not used.
D_CALLBACK_ERROR
1058
Callback function failed. Currently not used.
D_INTERNAL_ERROR
1059
Internal error. This error can occur for various internal reasons. Refer to logs for more details.
D_KEY_NOT_EXPORTABLE_ERROR
1060
The key is not exportable. The requested operation is attempting to export a non-exportable key.
D_INVALID_SPB_ID
1062
The SPB ID is invalid. The provided SPB ID is invalid. Please check the appropriate format in the API documentation.
D_JSON_PARSE_ERROR
1063
JSON parsing failed. Failed to parse JSON. See logs for more details.
D_JSON_PARSE_WRONG_TYPE_ERROR
1064
JSON parsing failed due to an invalid type request. Failed to parse JSON. The data type differs from the type expected by the requested operation. E.g., requesting a string from an integer data type. See logs for more details.
D_JSON_SET_VALUE_ERROR
1065
JSON failed to set a new value for an object. Failed to set a value for the JSON object. See logs for more details.
D_JSON_UNSET_VALUE_ERROR
1066
JSON failed to remove a value from an object. Failed to remove a value from the JSON object. See logs for more details.
D_JSON_VALUE_NOT_FOUND
1067
The JSON did not find the requested value within the object. Failed to find the value within the JSON object. See logs for more details.
D_JSON_OBJ_CREATE_ERROR
1068
The JSON was able to create the requested object. Failed to create the JSON object. See logs for more details.
D_SLP_PARSE_ERROR
1069
Failed to parse the SLP response from the server. The SLP response from the server could not be parsed as expected. See logs for more details.
D_SLP_INTERNAL_ERROR
1070
Failed to execute SLP operation. The SLP operation was not executed successfully. See logs for more details.
D_SLP_TOO_MANY_SERVERS_ERROR
1071
Failure due to excessive responses from HSM servers. The number of SLP responses from HSM servers exceeded the limits. See logs for more details.
D_INVALID_SERVER_VERSION
1072
The server version is not compatible with the operation. This operation failed because the server does not have a compatible firmware version. See logs for more details.
D_GENERATE_PKCS12_ERROR
1073
Failed to generate the PKCS#12 file. PKCS#12 package generation failed. See logs for more details.
D_SET_LOAD_BALANCE_LIST_ERROR
1074
Failed to set the load balance list. Setting the balancing list failed. See logs for more details.
D_OATH_BLOB_UPDATE
1075
The blob OATH must be updated. The blob OATH must be updated. See the flag OATH_CHECK_UPDATE_BLOB in the API documentation. See the API documentation for more details.
D_GZIP_DEFLATE_ERROR
1076
Failed to compress data. Failed to compress data using gzip. See logs for more details.
D_HTTP_UNEXPECTED_STATUS_CODE
1077
Unexpected HTTP status code. The HTTP status code is not as expected. See logs for more details.
D_BASE64_ERROR
1078
Base64 error. The Base64 operation failed. This error is related to encoding and decoding operations. See logs for more details.
D_SC_READER_NOT_READY
1079
Smart card reader not ready. Check that the smart card reader is connected and ready for use and that the smart card is inserted.
D_SC_NOT_FORMATTED
1080
The smart card is not formatted. Please format the card before use.
D_SC_INVALID_PIN
1081
The smart-card PIN is invalid. Check that the PIN is correct and try again.
D_SC_READ_FAILED
1082
Failure in the smart-card reading operation. Check that the smart card is compatible. Please contact support.
D_SC_UNEXPECTED_SVMK_STATUS
1083
SVMK status of the smart-card not expected. Check that the smart-card has been written with a valid SVMK m of n.
D_SC_FAILED_USB_LIB_LOAD
1084
Failed to load USB library. Check that the USB library is installed and that the user has permission to access it.
D_SC_INVALID_ATR_LEN
1085
Invalid ATR size. Invalid ATR (Answer To Reset) size. Check that the smart card is compatible.
D_SC_PIN_LOCKED
1086
PIN blocked. The PIN cannot be changed.
D_SC_KATS_NEGOTIATION_FAILED
1087
Failure to negotiate KATS. KATS negotiation failed. Check that the smart card is compatible.
D_SC_CHANGE_PIN_FAILED
1088
PIN change failed. PIN change failed. Check that the PIN is 8 digits and that the smart card is compatible.
D_INVALID_DATA_FORMAT
1089
Data format is invalid. Data format is invalid. Check that the data is compatible with the API documentation.
D_SC_FREEZE_FAILED
1090
Failed freezing operation. The smart-card PIN freezing operation failed. Check that the smart card is compatible or try again.
D_SC_LEGACY_CARD_NOT_SUPPORTED
1091
Legacy card is not supported. Legacy card is not supported. Check that the smart card is compatible.
D_SC_WOULD_OVERWRITE_SVMK
1092
This operation would overwrite the card's SVMK. This operation would overwrite the smart card's SVMK. If you wish to proceed, use the overwrite flag.
D_SC_INVALID_SVMK_TYPE
1093
This operation would overwrite the card's SVMK. This operation would overwrite the smart card's SVMK. If you wish to proceed, use the overwrite flag.
D_SC_WRITE_FAILED
1094
Failed to write on the card. Failed to write to the smart-card. Check that the smart card is compatible or try again.
D_SC_ERASE_FAILED
1095
Failed to delete the card. Failed to delete data from smart-card. Check that the smart card is compatible or try again.
D_SC_SELECT_FAILED
1096
Select operation fails. The select operation on the smart-card failed. Check that the smart card is compatible or try again.
D_INVALID_HSM_OP_MODE
1097
HSM operating mode is invalid. This functionality is not supported in this HSM operating mode. See the API documentation for more details.
D_KEEP_ALIVE_ERROR
3001
Keep-alive failure. Currently unused.
D_RECEIVE_LOG_ERROR
3002
Failed to receive logs. Remote monitoring logs failed to be received. Possible causes: HSM error. Refer to HSM logs for more details.
D_ERROR_NOTIFY
3003
Server failure notification. This error is generic. Refer to logs for more details.