SHELL RUN TIME ERRORS SP_DUAL_LIBRARY_ERROR_BASE SP_SERVER_ERROR_BASE SP_SHELL_ERROR_BASE SP_SECURE_UPDATE_ERROR_BASE SP_SETUP_LIBRARY_ERROR_BASE

1 up 200 300 400 500 700

SHK Error Codes

Error Code 0 1 2 3 4 5 6 7 Description

SHK Run-time Errors

SP_ERR_OK Success. SP_ERR_NO_KEY Problem in accessing the key. Probably, the Sentinel Key is not attached. SP_ERR_LOAD_ERROR Cannot load the protected application. SP_ERR_DATE_STOP Expiration date or time reached. SP_ERR_NO_MORE_LIFE The number of executions allowed for the application have exhausted. SP_ERR_MEM_ERROR Not enough memory available to execute the protected application. SP_ERR_MEM_ACCESS Memory access error or trying access an invalid memory location. SP_ERR_LIBLOAD Error in loading your applications import library. The DLL required by your application could not be loaded. SP_ERR_BAD_IMPORT Error importing library function. The imported function is not found in the specified DLL. SP_ERR_CANT_START_CA Error opening the Secure Update Wizard. Make sure that its files are installed. SP_ERR_QUIT_CA Error in Secure update program. SP_ERR_DATE_TIME_EXPIRE Date/Time expired while application is running. SP_ERR_NO_NETWORK_KEY The hardware key is missing on the system where the Sentinel Keys Server is running. You must save your work as the application will terminate within two minutes. SP_ERR_DEBUGGER Application not allowed to run in debugger. SP_ERR_FILE_MODIFY Error in file checksum. SP_ERR_CODE_DATA_MODIFY Code/data modified (file or memory). SP_ERR_BREAK_POINT Breakpoint Detected.

8 9 10 11

12

13

14

15

16

17

SP_ERR_TIME_TAMPER Time Tamper Detected.

SHK Shell-time Errors

401 402 403 404 SP_ERR_BAD_ALGO Invalid/inactive algorithm programmed in the Sentinel Key. SP_ERR_LONG_MSG The message text is very long. You can modify the message while creating a Shell feature. SP_READ_ERROR The application could not be read. Check the path specified for your application. SP_ERR_NOT_ENOUGH_MEMORY Not enough resources to protect the application. Try closing some of the applications running on your system. SP_ERR_CANNOT_OPEN Error in opening the application. Check the path specified for your application. SP_ERR_WRITE_ERROR Could not write to the application. Make sure that application is not read-only and the correct path is specified. SP_ERR_CANNOT_OVERWRITE Could not write to the application. May be your overwrite flag is not checked. SP_ERR_INVALID_HEADER Invalid file header. Ensure that the application is in PE format. SP_ERR_TMP_CREATE_ERROR Cannot create a temporary file. SP_ERR_PATH_NOT_THERE The path for output file specified does not exist. Create a directory by specifying the destination path. SP_ERR_BAD_FILE_INFO The file is not digitally signed. SP_ERR_NOT_WIN32FILE Not a valid Win32 file. SP_ERR_INVALID_MACHINE The application is not developed on a Intel x86 platform. SP_ERR_INVALID_SECTION The section specified in the file header could not be found in the application. SP_ERR_INVALID_RELOC The relocation specified for your application could not be found, or has invalid address. SP_ERR_CRYPT_ERROR Failed to generate a random number. SP_ERR_SMARTHEAP_ERROR Import Overwrite not supported with SmartHeap SP_ERR_IMPORT_OVERWRITE_ERROR Import overwrite not supported for the application. SP_ERR_NO_PESHELL The application does not have PE (Portable Executable) format. SP_ERR_FRAMEWORK_REQUIRED .NET Framework is required to protect .NET DLLs. SP_ERR_CANNOT_HANDLE_FILE The Shell engine failed to handle this file. SP_ERR_IMPORT_DLL_ERROR The name of the imported DLL is longer than the maximum length allowed (200 bytes).

405 406

407 408 409 410 411 412 413 414 415 416 417 418 420 421 422 423

424 425 426 427 428 429 430 431 432 433 434 435

SP_ERR_IMPORT_FUNCTION_ERROR The name of the imported function in the DLL is longer than the maximum length allowed (400 bytes). SP_ERR_X64_SHELL_ENGINE Failed to initialize the shell engine for x64 applications. SP_ERR_STRONG_NAME .NET applications signed with strong names can't be protected. SP_ERR_FRAMEWORK_10 .NET Framework 1.0 is required to protect .NET 1.0 applications. SP_ERR_FRAMEWORK_SDK_10 .NET Framework SDK 1.0 is required to protect .NET 1.0 applications. SP_ERR_FRAMEWORK_11 .NET Framework 1.1 is required to protect .NET 1.1 applications. SP_ERR_FRAMEWORK_SDK_11 .NET Framework SDK 1.1 is required to protect .NET 1.1 applications. SP_ERR_FRAMEWORK_20 .NET Framework 2.0 is required to protect .NET 2.0 or 3.0 applications. SP_ERR_FRAMEWORK_SDK_20 .NET Framework SDK 2.0 is required to protect .NET 2.0 or 3.0 applications. SP_ERR_APP_NOT_SUPPORTED This version of .NET application is not supported. SP_ERR_FILE_COPY Failed to copy the appropriate DLLs into the destination directory. SP_ERR_HEADER_SIZE_EXCEED Shelling failed due to file Header Size exceeded the limit.

SHK Command-Line Shell Errors

450 451 452 454 SP_ERR_PARAMETER_MISSING Missing argument for /F , /L1, /L2, /G or /U. No arguments supplied to the cmdshell. SP_ERR_PARAMETER_IDENTIFIER_MISSING Missing /F. SP_ERR_PARAMETER_INVALID Parameters are too long. SP_ERR_REGISTRY Failed to get the registry entry for the java runtime environment or the version of the JRE installed on the system does not meets the minimum requirements. SP_ERR_VERIFY_SIGN The CommandLineShell jar file is invalid. SP_ERR_LICENSE_TEMPLATE_FILE Failed to load the license template file. SP_ERR_NO_DEVELOPER_KEY The Developer Key not found. SP_ERR_NO_ENDUSER_KEY The end user Sentinel Key not found. SP_ERR_NO_POINT_KEYS Failed to locate the developer/user key pair, that has the developer ID, as that of the key pair, used to build the license using the ltm file. SP_ERR_NO_SHELL_FEATURE There is no shell feature in the specified License Template File. SP_ERR_SHELL_OPTION_FILE_MISSING The command shell utility could not locate the shell options file.

455 457 458 459 460

461 462

463 464 465 466 467

SP_ERR_SHELL_OPTION_FILE_FORMAT The shell option file is not in the proper format. SP_ERR_SHELL_OPTION_FILE_INVALID The shell option file contains some incorrect/invalid value for some tag. SP_ERR_DELETE_LICENSE Failed to delete the license from the token. SP_ERR_FILE_CREATE_FAILED Failed to create the Shell option XML file. SP_ERR_SHELL_FILES_LIMIT The number of source files to be shelled, specified in the shell option XML file exceeded the maximum number of files that can be shelled. SP_ERR_SINGLE_INSTANCE_ERROR Either the Toolkit, or the command line shell is already running on the same machine. SP_ERR_NO_EXE_FILE Returns this error when the user is specifying the use of shell option file and the source file does not contain even a single .exe, or .dll file.

468 469

API Error Codes

This section provides information about status/error code specific to the Sentinel Keys client library and the Sentinel Keys Server:

Value 0 201 202 SP_SUCCESS

Code

Description Sentinel Keys Client Library-specific Error Codes The function executed successfully. One or more input parameters are wrong. Please verify the values specified. Any or all of the following: o The software key format is wrong. You can find the appropriate software key in the header file for your template. o The software key is for some other Sentinel Key. o Unable to find a license for the license ID specified. You can find the license ID in the header file for your template. Invalid license handle. The license timed-out.

SP_ERR_INVALID_PARAMETER SP_ERR_SOFTWARE_KEY

203

SP_ERR_INVALID_LICENSE

o o 204 205 206 207 SP_ERR_INVALID_FEATURE SP_ERR_INVALID_TOKEN SP_ERR_NO_LICENSE SP_ERR_INSUFFICIENT_BUFFER

The feature ID specified is wrong. Unable to find the desired Sentinel Key. Make sure you are sending the correct developer ID. The Sentinel Key is emptydoes not contain the requested license. The size of the buffer is not sufficient to hold the expected data. Please allocate sufficient memory or limit the data to match the buffer size. Any or all of the following: o The public key used for verification is incorrect. o The signed content is tampered.

208

SP_ERR_VERIFY_FAILED

209

SP_ERR_CANNOT_OPEN_DRIVER

Unable to communicate with the key probably because the Sentinel System Driver is not installed properly or not loaded.

210

SP_ERR_ACCESS_DENIED

211

SP_ERR_INVALID_DEVICE_RESPONSE

212

SP_ERR_COMMUNICATIONS_ERROR

You attempted to perform an illegal action on a feature. For example, you may have tried to read an AES or ECC feature or write a read-only feature. Unable to communicate with the key. Please verify if the key is attached properly. You may even plug-in the key again, after plugging-out. Unable to communicate with the Sentinel Key. Make sure of the following: o The Sentinel System Driver is installed and running. o The client and the Sentinel Keys Server use the same protocol. o The Sentinel Key is attached properly. o There is no network-related problem (for example, network congestion or break-down). You tried to decrement a counter that is already zero. The Sentinel Key memory is corrupt. You tried using some functionality that the feature does not support. See the topic Feature Attributes to understand the functionality for various features. The Sentinel System Driver is currently busy. Try the operation again. The client library has an older version. It needs to be updated. The operation timed out. Please try it again. The digital signature or content of the encrypted packet are not valid. The feature has not been activated. The feature cannot use the API function. Probably, the corresponding feature attribute was not selected when creating the feature. For example, SFNTEncrypt is called when Encrypt attribute was not selected while adding the AES feature. The Sentinel Key has been plugged-out. Please re-attach it and call the function again. For non-RTC keys The system clock has been tampered or the cheat counter has reached zero. For RTC key, the RTC time has been tampered. An invalid command is specified in the API function. Unable to complete the request. Insufficient resources (such as memory) are available. The specified Sentinel Key is not found. The number of executions allowed for the application/feature has finished. The query sent exceeds 112 bytes. Please send a shorter query. User Authentication required. The License ID you specified, already exists The decryption process failed. The checksum value not matching. The license image is corrupt. Insufficient memory in key to load a license.

213 214 215

SP_ERR_COUNTER_LIMIT SP_ERR_MEM_CORRUPT SP_ERR_INVALID_FEATURE_TYPE

216 217 218 219 220 221

SP_ERR_DEVICE_IN_USE SP_ERR_INVALID_API_VERSION SP_ERR_TIME_OUT_ERROR SP_ERR_INVALID_PACKET SP_ERR_KEY_NOT_ACTIVE SP_ERR_FUNCTION_NOT_ENABLED

222 223

SP_ERR_DEVICE_RESET SP_ERR_TIME_CHEAT

224 225 226 227 228 229 230 231 232 233 234

SP_ERR_INVALID_COMMAND SP_ERR_RESOURCE SP_ERR_UNIT_NOT_FOUND SP_ERR_DEMO_EXPIRED SP_ERR_QUERY_TOO_LONG SP_ERR_USER_AUTH_REQUIRED SP_ERR_DUPLICATE_LIC_ID SP_ERR_DECRYPTION_FAILED SP_ERR_BAD_CHKSUM SP_ERR_BAD_LICENSE_IMAGE SP_ERR_INSUFFICIENT_MEMORY

Sentinel Keys Server-specific Status Codes

301

SP_ERR_SERVER_PROBABLY_NOT_UP

302

SP_ERR_UNKNOWN_HOST

303 304 305 306 307 308 309 310

SP_ERR_BAD_SERVER_MESSAGE SP_ERR_NO_LICENSE_AVAILABLE SP_ERR_INVALID_OPERATION SP_ERR_INTERNAL_ERROR SP_ERR_PROTOCOL_NOT_INSTALLED SP_ERR_BAD_CLIENT_MESSAGE SP_ERR_SOCKET_OPERATION SP_ERR_NO_SERVER_RESPONSE

The Sentinel Keys Server that the application is trying to contact is not running. The name specified for Sentinel Keys Server does not exist. If you are using IP/IPX protocol, try using the IP/IPX address instead of the host name of the system. The client is unable to parse the message received from the Sentinel Keys Server. The hard limit or user limit has been exhausted. An unsupported API function is called. Encountered an internal error. The protocol set is not installed. The Sentinel Keys Server is not able to parse the message received from client. Encountered an error in socket operations (such as, the socket initialization failed). No Sentinel Keys Server in the subnet responded. This error code is returned by the SFNTEnumServer API function.

700 Error Codes

701 702 703 704 705 706 707 708 709 710 711 712 SP_ERR_BAD_XML SP_ERR_BAD_PACKET SP_ERR_BAD_FEATURE SP_ERR_BAD_HEADER SP_ERR_ISV_MISSING SP_ERR_DEVID_MISMATCH SP_ERR_LM_TOKEN_ERROR SP_ERR_LM_MISSING SP_ERR_INVALID_SIZE SP_ERR_FEATURE_NOT_FOUND SP_ERR_LICENSE_NOT_FOUND SP_ERR_BEYOND_RANGE License contents are not valid. The information packets embedded in the content are invalid. The feature info is invalid. The header information of the contents is invalid. Developer key not found. Please check the developer ID of the created information. Decryption failed (for .DIR file)using the Distributor token. The Distributor token not found. Update packet size is invalid. The feature to be updated could not be located. The license to be updated could not be located. Range defined in the constants has exceeded.

Secure Update Error Codes Summary

T
Error Code (Decimal) 0 501 502 SP_SUCCESS Success. SP_ERR_KEY_NOT_FOUND The Valid hardware key not found. The Update Code is not meant for this key. SP_ERR_ILLEGAL_UPDATE One or more commands could not be performed. Description

503

SP_ERR_DLL_LOAD_ERROR The Secure Update library not found, which is: SecureUpdate.DLL for Windows libSecureUpdate32.so for Linux libSecureUpdate32.dylib for Macintosh SP_ERR_NO_CONFIG_FILE Update wizard not able to locate the configuration file. SP_ERR_INVALID_CONFIG_FILE Not a valid Configuration file. SP_ERR_UPDATE_WIZARD_NOT_FOUND Could not find UpdateWizard.exe. SP_ERR_UPDATE_WIZARD_SPAWN_ERROR There was an error in spawning the Update Wizard. SP_ERR_EXCEPTION_ERROR An exception error occurred within the Update Wizard. SP_ERR_INVALID_CLIENT_LIB Not a valid Secure Update DLL. SP_ERR_CABINET_DLLThe CABINET.DLL is not found on target system. SP_ERR_INSUFFICIENT_REQ_CODE_BUFFER The size of the request buffer is not sufficient to hold the request code. SP_ERR_UPDATE_WIZARD_USER_CANCELLED The application was canceled when the try/buy option is shown. Applicable only to applications that use Sentinel Update Wizard and are protected using Shell. SP_ERR_INVALID_DLL_VERSION The Secure Update DLL version is invalid. SP_ERR_INVALID_FILE_TYPE The type of the file is invalid. File types can be .upw or .nlf. SP_ERR_COMMUNICATIONS_ERROR Unable to communicate with the Sentinel Key. Make sure of the following: The Sentinel System Driver is installed and running. The client and the Sentinel Keys Server use the same protocol. The Sentinel Key is attached properly. There is no network-related problem (for example, network congestion or break-down). SP_ERR_UNIT_NOT_FOUND The specified Sentinel Key is not found. /* Common error codes for Secure Update and Key Programming Library*/

504 505 506 507 508 509 510 511 512

513 514 212

226

230 231 232 233 234

SP_ERR_DUPLICATE_LIC_ID The License ID you specified, already exists. SP_ERR_DECRYPTION_FAILED The decryption process failed. SP_ERR_BAD_CHKSUM The checksum value not matching. SP_ERR_BAD_LICENSE_IMAGE The license image is corrupt. SP_ERR_INSUFFICIENT_MEMORY Insufficient memory in key to load a license.