Java API
HSM Dinamo
Loading...
Looking for...
No entries found
Library Return Codes
Code Value Description Details
D_SOCKET_FAILED
-10
Failed to create socket. Socket creation failed. Possible causes: system error. See 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. Opening a session with the HSM failed. Possible cases for this error are: network/HSM unavailable; network subsystem failure. Other less likely causes are: connection rejected by the HSM; internal socket error. See logs for more details.
D_SEND_FAILED
-13
Failed to send data. The Client was unable to send data successfully. The most likely causes for this error are: session rimeout (client or server side); network/HSM unavailable; network subsystem failure. Other less likely causes are: internal socket error. See logs for more details.
D_RECV_FAILED
-14
Failed to receive data. The Client was unable to successfully receive the data. The most likely causes of this error are: session timeout (client or server side); network/HSM unavailable; network subsystem failure. Other less likely causes are: internal socket error. See logs for more details.
D_INVALID_PACKAGE_SIZE
-15
Invalid package size. The size of the data packet received is different than expected. See logs for more details.
D_SETSOCKOPT_FAILED
-16
Failed to set socket options. The setting of socket options has failed. The probable causes are: invalid parameter; network subsystem failure; connection timeout; internal socket failure. See logs for more details.
D_GETSOCKOPT_FAILED
-17
Failed to retrieve socket options. The setting of socket options has failed. The probable causes are: invalid parameter buffer size; network subsystem failure; internal socket failure. See logs for more details.
D_ALL_LOAD_BALANCE_HSM_FAILED
-18
All the HSMs on 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_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 start 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 fault in the internal cryptography library. The internal encryption library has failed. One of the causes may be insufficient resources (memory) on the local machine. See logs for more details.
D_CRL_GENERAL_ERROR
101
Generic fault in the internal connection encryption library. The internal connection encryption library has failed. One of the causes may be insufficient resources (memory) on the local machine. See logs for more details. Related to communication between the local machine and the target server.
D_CRL_SSL_CACERT_BADFILE
102
The server's certificate chain could not be loaded. The CA chain/certificate was not found or is in the wrong format. Related to communication between the local machine and the destination server.
D_CRL_COULDNT_RESOLVE_HOST
103
The server name could not be resolved. The server name cannot be resolved or is incorrectly formed. Check the server name. Related to communication between the local machine and the destination server.
D_CRL_COULDNT_CONNECT
104
It was not possible to connect to the server. Failed to connect to the server. Check the server name. Related to communication between the local machine and the destination server.
D_CRL_OPERATION_TIMEDOUT
105
Timeout failure. The operation has exceeded the timeout limit. Related to communication between the local machine and the target server.
D_CRL_PEER_FAILED_VERIFICATION
106
Server certificate/fingerprint verification failed. The server's certificate/fingerprint could not be verified. Related to communication between the local machine and the destination server.
D_CRL_SSL_CONNECT_ERROR
107
TLS handshake failed. A problem has occurred in the SSL/TLS handshake. It could be certificates (format, paths, permissions), passwords and others. Related to communication between the local machine and the destination server.
D_CRL_SEND_ERROR
108
Failed to send data. There was a problem sending data. Check the network connection. Related to communication between the local machine and the destination server.
D_CRL_RECV_ERROR
109
Failed to receive data. There was a problem receiving data. Check the network connection. Related to communication between the local machine and the target server.
D_CRL_SSL_CERTPROBLEM
110
Failed to use the local certificate. A problem occurred when using the local certificate. Related to communication between the local machine and the destination server.
D_CRL_SSL_ISSUER_ERROR
111
Failed to verify the certificate issuer. There was a problem verifying the issuer of the certificate. Related to communication between the local machine and the destination server.
D_CRL_AUTH_ERROR
112
Authentication failed. There was a problem with the authentication function. Related to communication between the local machine and the destination server.
D_CRL_GOT_NOTHING
113
Nothing was returned by the HTTP server. Nothing has been returned by the server and in this case it is an error. Related to communication between the local machine and the destination server.
D_CRL_UNSUPPORTED_PROTOCOL
114
Protocol not supported. The protocol passed in the URL is not supported. Related to communication between the local machine and the destination server.
D_CRL_URL_MALFORMAT
115
Poorly formatted URL. The URL is not formatted correctly. Related to communication between the local machine and the destination server.
D_CRL_WEIRD_SERVER_REPLY
116
Server response not recognized. The server sent a response that could not be understood. Related to communication between the local machine and the destination server.
D_CRL_REMOTE_ACCESS_DENIED
117
Access to remote resource denied. Access has been 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, see the logs for more details. Related to communication between the local machine and the target server.
D_CRL_WRITE_ERROR
119
Internal failure of the write callback. This error can have several causes, see the logs for more details. Related to communication between the local machine and the target server.
D_CRL_READ_ERROR
120
Internal failure of the read callback. This error can have several causes, see the logs for more details. Related to communication between the local machine and the target server.
D_CRL_HTTP_POST_ERROR
121
HTTP POST failure. This error can have several causes, see the logs for more details. Related to communication between the local machine and the target server.
D_CRL_ABORTED_BY_CALLBACK
122
Operation aborted by internal callback. This error can have several causes, see the logs for more details. Related to communication between the local machine and the target server.
D_CRL_TOO_MANY_REDIRECTS
123
Too many redirections. The maximum number of supported redirections has been reached. Related to communication between the local machine and the destination server.
D_CRL_SSL_CIPHER
124
Failure to use the specified encryption algorithm. The specified cryptographic algorithm could not be used. Related to communication between the local machine and the destination server.
D_CRL_BAD_CONTENT_ENCODING
125
Content encoding not recognized. The content encoding could not be recognized. Related to communication between the local machine and the destination server.
D_CRL_LOGIN_DENIED
126
Login denied. The remote server denied login. Related to communication between the local machine and the destination server.
D_CRL_INSTALL_SIGN_CALL_FAILED
127
Failure to install subscription calls. The installation of the signature calls failed. These calls are related to the signature used in the TLS tunnel between the local machine and the destination server. Please generate the debug logs and contact technical support.
D_CRL_CERT_LOAD_FAILED
128
Failed to load TLS certificate. Failed to load the TLS certificate stored in the HSM. Check 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. Check 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 the TLS private key. Failed to load the TLS private key stored in the HSM. Check 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. The requested memory could not be allocated. Check the memory available 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 parameters passed (e.g. passing an invalid flag parameter, not passing a key handle when creating an HMAC in DCreateHash, etc.). See logs for more details.
D_INVALID_TYPE
1002
Invalid type of parameter passed to the API. The type of parameter passed to the API is invalid. This error is generic. It can be related to data types, keys, blobs passed in API parameters in certain situations (e.g. using a symmetric key in a symmetric operation, unsupported output data type, etc.). See logs for more details.
D_INVALID_STATE
1003
The handle status is invalid. The handle used has an invalid status. This error can occur when the handle is used without being properly initialized or in a different use (e.g. a session cannot perform other operations when in remote logging). See logs for more details.
D_LOGGING_NOT_STARTED
1004
Log not initialized. Currently not in use.
D_MORE_DATA
1005
More data is needed. The buffer passed as a parameter in the API is not big enough to receive the output data. Check the documentation of the API called in the manual and that the API has returned the required size for the output buffer. See logs for more details.
D_INVALID_RESPONSE
1006
HSM's answer invalid. 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. Check that the context is valid, not NULL and initialized appropriately.
D_KEY_GEN_ERROR
1008
Key generation failed. Currently not in use.
D_KEY_DEL_ERROR
1009
Key removal failed. Currently not in use.
D_KEY_NOT_EXISTS
1010
The key doesn't exist. Currently not in use.
D_INVALID_DATA_LENGTH
1011
Invalid input data size. The size of the input data/buffer is invalid. Check the API documentation 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: using a symmetric key for asymmetric operations (vice versa), etc. Check the type of key passed, the documentation of the API called and cryptography fundamentals for the correct use of keys. See logs for more details.
D_INVALID_PADDING
1013
Invalid padding. The padding type requested by the API is invalid/not recognized. Check the padding type passed and the documentation for the padding types accepted by the API. See logs for more details.
D_INVALID_KEY
1014
Invalid key. The key passed to the API is not valid or is not appropriate for this use. Check that: the key context is not NULL, the key context is initialized correctly, the algorithm matches the operation. See the API documentation for the types of keys accepted. See logs for more details.
D_BAD_DATA
1015
Invalid input data. The input data is invalid or corrupted. See API call documentation 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: 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 can be valid but invalid for a given operation. See the API documentation for the types of algorithms accepted. See the 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 start hash operation. The hash initialization operation failed (rare). See logs for more details. Contact support.
D_INVALID_HASH_STATE
1020
Invalid hash status. The hash has an invalid state. The hash works on operations defined as start/middle/end. Operations outside this sequence may fail due to this error (e.g. finalizing a hash that has not been initialized or has already been finalized, etc.). See documentation for correct use of the API call. See logs for more details.
D_END_HASH_FAILED
1021
Failed to finalize hash operation. The hash operation failed to complete. Possible causes: internal or server error. See client library and HSM logs for more details.
D_GET_INFO_ERROR
1022
Failed to retrieve information from the HSM. The client failed when trying to retrieve information from the server. Possible causes: server error. See HSM logs for more details.
D_INVALID_PIN_LEN
1023
Invalid PIN size. The PIN has an invalid size (e.g. backup PIN size larger or smaller than allowed). See documentation of the API call for more format details. See logs for more details.
D_OPEN_FILE_FAILED
1025
Failed to open file on local machine. The name/path of the file passed as a parameter could not be opened/created. Possible causes: access permissions, path, etc. See logs for more details.
D_BACKUP_FAILED
1026
HSM backup failed. HSM backup operation failed. Possible causes: HSM failure. See HSM and client library logs for more details.
D_RESTORE_FAILED
1027
HSM restore failed. Currently not in use.
D_INVALID_CALLBACK
1028
Invalid callback function. The callback function is invalid. See the documentation of the API called. Check that it is not NULL. See logs for more details.
D_NOT_IMPLEMENTED
1029
Functionality not implemented. The requested functionality is not implemented. Check that the latest client library is installed. See the documentation of the API called.
D_AUTH_FAILED
1030
Authentication failure. Authentication on this operation failed. Check user/password/OTP, or any password or credendial passed to this function call. See the HSM and client library logs for more details.
D_INVALID_CLEAR_OP
1031
Invalid open session operation. 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's password change operation failed. Possible causes: password not compatible with HSM policy, etc. See HSM logs for more details.
D_PWD_SIZE_ERROR
1033
Invalid password length. The password entered has an invalid length. See documentation on the allowed password length. See logs for more details.
D_IMPORT_KEY_ERROR
1034
Failed to import key. Currently not in use.
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: old version of the client library that doesn't support the flag, invalid flag, etc. See the documentation of the API called for details of the flags. See logs for more details.
D_INVALID_SIGNATURE
1037
Invalid signature. Signature verification failed. The public key was found and used but the verification of the signature content did not match what was expected. See logs for more details.
D_INVALID_PUB_KEY
1038
Invalid public key. Currently not in use.
D_INVALID_KEY_STATE
1039
Invalid key status. The state of the key is invalid for the requested operation. See logs for more details.
D_CREATE_USER_ERROR
1040
User creation failed. Currently not in use.
D_NO_MORE_OBJECT
1041
There are no more objects to be received by HSM. Internal error. Please contact support.
D_PUT_ENV_VAR_FAILED
1042
Failed to set environment variable. The creation of the environment variable failed. See logs for more details.
D_INVALID_FILE_SIZE
1043
File size is invalid. The size of the file passed is invalid for the operation. E.g.: When passing a file larger than that allowed for writing to the HSM, this error will be returned. See logs for more details.
D_INVALID_TEXT_SIZE
1044
Invalid text size. Currently not in use.
D_FILE_ACCESS_ERROR
1045
File access failed. Access to the file failed. Check access permissions. See logs for more details.
D_INVALID_COUNTER
1046
Invalid counter. Currently not in use.
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 not in use.
D_INVALID_IP_ADDRESS
1049
Invalid IP address. Currently not in use.
D_GET_PEER_IP_ERROR
1050
Failed to retrieve the peer's IP address. Currently not in use.
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
Part 1 of the key is invalid. The first part of the key is invalid. The KCV (Key Check Value) of the first component of the ZCMK (Zone Control Master Key) Visa key is invalid. Check key entry or KCV.
D_INVALID_KEY_PART_2
1053
Part 2 of the key is invalid. The second part of the key is invalid. The KCV (Key Check Value) of the second component of the ZCMK (Zone Control Master Key) Visa key is invalid. Check key entry or KCV.
D_INVALID_KEY_PART_3
1054
Part 3 of the key is invalid. The third part of the key is invalid. The KCV (Key Check Value) check of the third component of the ZCMK (Zone Control Master Key) Visa key is invalid. Check key entry or KCV.
D_VERIFY_DAC_FAILED
1055
Failed to check 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 feature has been discontinued. The requested functionality is no longer supported.
D_NO_MATCHING_KEY_FOUND
1057
No matching key was found. Currently not in use.
D_CALLBACK_ERROR
1058
Failure of the callback function. Currently not in use.
D_INTERNAL_ERROR
1059
Internal failure. This failure can occur for various internal reasons. See logs for more details.
D_KEY_NOT_EXPORTABLE_ERROR
1060
The key is not exportable. The requested operation is trying to export a non-exportable key.
INVALID_SPB_ID
1062
The SPB ID is invalid. The SPB ID passed is invalid. Please check the appropriate format in the API documentation.
JSON_PARSE_ERROR
1063
The JSON parse failed. JSON parse failed. See logs for more details.
JSON_PARSE_WRONG_TYPE_ERROR
1064
The JSON parse failed because of a request of an invalid type. JSON parse failed. The data type is different from the type expected by the requested operation. E.g.: Requesting a string of an integer data type. See logs for more details.
JSON_SET_VALUE_ERROR
1065
JSON failed when trying to set a new value to an object. Failed to set a value to the JSON object. See logs for more details.
JSON_UNSET_VALUE_ERROR
1066
JSON failed when trying to remove a value from an object. Failed to remove a value from the JSON object. See logs for more details.
JSON_VALUE_NOT_FOUND
1067
JSON didn't find the value inside the requested object. Failed to find the value inside the JSON object. See logs for more details.
JSON_OBJ_CREATE_ERROR
1068
JSON was able to create the requested object. Failed to create JSON object. See logs for more details.
SLP_PARSE_ERROR
1069
Failed to parse the server's SLP response. The SLP response from the server cannot be parsed as expected. See logs for more details.
SLP_INTERNAL_ERROR
1070
Failed to perform SLP operation. The SLP operation was not performed successfully. See logs for more details.
SLP_TOO_MANY_SERVERS_ERROR
1071
Failure due to excessive responses from HSM servers. The number of SLP responses from HSM servers has exceeded the limits. See logs for more details.
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.
GENERATE_PKCS12_ERROR
1073
Failed to generate PKCS#12 file. The generation of the PKCS#12 package failed. See logs for more details.
SET_LOAD_BALANCE_LIST_ERROR
1074
Failed to define the load balance list. Balancing list definition failed. See logs for more details.
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.
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
HTTP status code not expected. The HTTP status code is not as expected. See logs for more details.
D_BASE64_ERROR
1078
Base error64. 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_KEEP_ALIVE_ERROR
3001
Keep alive failure. Currently not in use.
D_RECEIVE_LOG_ERROR
3002
Failed to receive logs. Receipt of remote monitoring logs failed. Possible cause: HSM error. See HSM logs for more details.
D_ERROR_NOTIFY
3003
Server failure notification. This error is generic. See the logs for more details.