Mistake on this page? Email us
kcm_status.h File Reference

Key and configuration manager (KCM) status/error codes. This list may grow as needed. More...

Go to the source code of this file.

Macros

#define KCM_STATUS_ESFS_ERROR   KCM_STATUS_STORAGE_ERROR
 

Enumerations

enum  kcm_status_e {
  KCM_STATUS_SUCCESS, KCM_STATUS_ERROR, KCM_STATUS_INVALID_PARAMETER, KCM_STATUS_INSUFFICIENT_BUFFER,
  KCM_STATUS_OUT_OF_MEMORY, KCM_STATUS_ITEM_NOT_FOUND, KCM_STATUS_META_DATA_NOT_FOUND, KCM_STATUS_META_DATA_SIZE_ERROR,
  KCM_STATUS_FILE_EXIST, KCM_STATUS_KEY_EXIST, KCM_STATUS_NOT_PERMITTED, KCM_STATUS_STORAGE_ERROR,
  KCM_STATUS_ITEM_IS_EMPTY, KCM_STATUS_INVALID_FILE_VERSION, KCM_STATUS_FILE_CORRUPTED, KCM_STATUS_FILE_NAME_CORRUPTED,
  KCM_STATUS_INVALID_FILE_ACCESS_MODE, KCM_STATUS_UNKNOWN_STORAGE_ERROR, KCM_STATUS_NOT_INITIALIZED, KCM_STATUS_CLOSE_INCOMPLETE_CHAIN,
  KCM_STATUS_CORRUPTED_CHAIN_FILE, KCM_STATUS_INVALID_NUM_OF_CERT_IN_CHAIN, KCM_STATUS_CERTIFICATE_CHAIN_VERIFICATION_FAILED, KCM_STATUS_FILE_NAME_TOO_LONG,
  KCM_STATUS_INVALID_EXPECTED_LOCATION, KCM_CRYPTO_STATUS_UNSUPPORTED_HASH_MODE, KCM_CRYPTO_STATUS_PARSING_DER_PRIVATE_KEY, KCM_CRYPTO_STATUS_PARSING_DER_PUBLIC_KEY,
  KCM_CRYPTO_STATUS_PK_KEY_INVALID_FORMAT, KCM_CRYPTO_STATUS_INVALID_PK_PUBKEY, KCM_CRYPTO_STATUS_ECP_INVALID_KEY, KCM_CRYPTO_STATUS_PK_KEY_INVALID_VERSION,
  KCM_CRYPTO_STATUS_PK_PASSWORD_REQUIRED, KCM_CRYPTO_STATUS_PRIVATE_KEY_VERIFICATION_FAILED, KCM_CRYPTO_STATUS_PUBLIC_KEY_VERIFICATION_FAILED, KCM_CRYPTO_STATUS_PK_UNKNOWN_PK_ALG,
  KCM_CRYPTO_STATUS_UNSUPPORTED_CURVE, KCM_CRYPTO_STATUS_PARSING_DER_CERT, KCM_CRYPTO_STATUS_CERT_EXPIRED, KCM_CRYPTO_STATUS_CERT_FUTURE,
  KCM_CRYPTO_STATUS_CERT_MD_ALG, KCM_CRYPTO_STATUS_CERT_PUB_KEY_TYPE, KCM_CRYPTO_STATUS_CERT_PUB_KEY, KCM_CRYPTO_STATUS_CERT_NOT_TRUSTED,
  KCM_CRYPTO_STATUS_INVALID_X509_ATTR, KCM_CRYPTO_STATUS_VERIFY_SIGNATURE_FAILED, KCM_CRYPTO_STATUS_INVALID_MD_TYPE, KCM_CRYPTO_STATUS_FAILED_TO_WRITE_SIGNATURE,
  KCM_CRYPTO_STATUS_FAILED_TO_WRITE_PRIVATE_KEY, KCM_CRYPTO_STATUS_FAILED_TO_WRITE_PUBLIC_KEY, KCM_CRYPTO_STATUS_FAILED_TO_WRITE_CSR, KCM_CRYPTO_STATUS_INVALID_OID,
  KCM_CRYPTO_STATUS_INVALID_NAME_FORMAT, KCM_CRYPTO_STATUS_ENTROPY_MISSING, KCM_STATUS_SELF_GENERATED_CERTIFICATE_VERIFICATION_ERROR, KCM_CRYPTO_STATUS_SET_EXTENSION_FAILED,
  KCM_STATUS_RBP_ERROR, KCM_STATUS_FILE_NAME_INVALID, KCM_CRYPTO_STATUS_INVALID_PK_PRIVKEY, KCM_MAX_STATUS
}
 

Detailed Description

Key and configuration manager (KCM) status/error codes. This list may grow as needed.

Enumeration Type Documentation

Enumerator
KCM_STATUS_SUCCESS 

Operation completed successfully.

KCM_STATUS_ERROR 

Operation ended with an unspecified error.

KCM_STATUS_INVALID_PARAMETER 

A parameter provided to the function was invalid.

KCM_STATUS_INSUFFICIENT_BUFFER 

The provided buffer size was insufficient for the required output.

KCM_STATUS_OUT_OF_MEMORY 

An out-of-memory condition occurred.

KCM_STATUS_ITEM_NOT_FOUND 

The item was not found in storage.

KCM_STATUS_META_DATA_NOT_FOUND 

The metadata was not found in the file.

KCM_STATUS_META_DATA_SIZE_ERROR 

Metadata found, but size is different than expected.

KCM_STATUS_FILE_EXIST 

Trying to store an item that is already in the storage.

KCM_STATUS_KEY_EXIST 

Trying to generate a key for a CSR, but the requested output key name already exists in storage.

KCM_STATUS_NOT_PERMITTED 

Trying to access an item without proper permissions, or trying to perform an action that is not allowed on an item.

KCM_STATUS_STORAGE_ERROR 

File error occurred.

KCM_STATUS_ITEM_IS_EMPTY 

The data of the current item is empty.

KCM_STATUS_INVALID_FILE_VERSION 

Invalid file version. Cannot read file.

KCM_STATUS_FILE_CORRUPTED 

File data corrupted. Cannot read file.

KCM_STATUS_FILE_NAME_CORRUPTED 

File name corrupted. Cannot read file.

KCM_STATUS_INVALID_FILE_ACCESS_MODE 

Invalid file access mode.

KCM_STATUS_UNKNOWN_STORAGE_ERROR 

KCM cannot translate current storage error.

KCM_STATUS_NOT_INITIALIZED 

KCM did not initialized.

KCM_STATUS_CLOSE_INCOMPLETE_CHAIN 

Closing KCM chain with fewer certificates than declared in create.

KCM_STATUS_CORRUPTED_CHAIN_FILE 

KCM attempted to open an invalid chain file.

KCM_STATUS_INVALID_NUM_OF_CERT_IN_CHAIN 

Operation failed because of an invalid number of certificates.

KCM_STATUS_CERTIFICATE_CHAIN_VERIFICATION_FAILED 

At least one of the certificates fails to verify its predecessor.

KCM_STATUS_FILE_NAME_TOO_LONG 

Provided file name is longer than permitted.

KCM_STATUS_INVALID_EXPECTED_LOCATION 

Location of the item is not as expected.

KCM_CRYPTO_STATUS_UNSUPPORTED_HASH_MODE 

Operation was called with unsupported hash mode.

KCM_CRYPTO_STATUS_PARSING_DER_PRIVATE_KEY 

Operation failed to parse DER-format private key.

KCM_CRYPTO_STATUS_PARSING_DER_PUBLIC_KEY 

Operation failed to parse DER-format public key.

KCM_CRYPTO_STATUS_PK_KEY_INVALID_FORMAT 

Operation failed due to invalid PK key format.

KCM_CRYPTO_STATUS_INVALID_PK_PUBKEY 

Operation failed due to invalid PK public key.

KCM_CRYPTO_STATUS_ECP_INVALID_KEY 

Operation failed due to invalid ECP key.

KCM_CRYPTO_STATUS_PK_KEY_INVALID_VERSION 

Operation failed due to invalid PK version of key.

KCM_CRYPTO_STATUS_PK_PASSWORD_REQUIRED 

Operation failed due to missing password.

KCM_CRYPTO_STATUS_PRIVATE_KEY_VERIFICATION_FAILED 

Operation failed to verify private key.

KCM_CRYPTO_STATUS_PUBLIC_KEY_VERIFICATION_FAILED 

Operation failed to verify public key.

KCM_CRYPTO_STATUS_PK_UNKNOWN_PK_ALG 

Operation failed due to unknown pk algorithm.

KCM_CRYPTO_STATUS_UNSUPPORTED_CURVE 

Unsupported curve.

KCM_CRYPTO_STATUS_PARSING_DER_CERT 

Operation failed to parse DER-format certificate.

KCM_CRYPTO_STATUS_CERT_EXPIRED 

Certificate expired.

KCM_CRYPTO_STATUS_CERT_FUTURE 

Certificate validity starts in the future.

KCM_CRYPTO_STATUS_CERT_MD_ALG 

Certificate with bad MD algorithm.

KCM_CRYPTO_STATUS_CERT_PUB_KEY_TYPE 

Certificate with unsupported public key PK type.

KCM_CRYPTO_STATUS_CERT_PUB_KEY 

Certificate with bad public key data (size or curve).

KCM_CRYPTO_STATUS_CERT_NOT_TRUSTED 

Certificate is not trusted.

KCM_CRYPTO_STATUS_INVALID_X509_ATTR 

Certificate with bad x509 attribute.

KCM_CRYPTO_STATUS_VERIFY_SIGNATURE_FAILED 

Operation failed to check the signature.

KCM_CRYPTO_STATUS_INVALID_MD_TYPE 

Operation failed in check of ecc md type.

KCM_CRYPTO_STATUS_FAILED_TO_WRITE_SIGNATURE 

Operation failed to calculate signature.

KCM_CRYPTO_STATUS_FAILED_TO_WRITE_PRIVATE_KEY 

Operation failed to write private key to DER buffer.

KCM_CRYPTO_STATUS_FAILED_TO_WRITE_PUBLIC_KEY 

Operation failed to write public key to DER buffer.

KCM_CRYPTO_STATUS_FAILED_TO_WRITE_CSR 

Operation failed to write CSR to DER buffer.

KCM_CRYPTO_STATUS_INVALID_OID 

Operation failed due to invalid OID.

KCM_CRYPTO_STATUS_INVALID_NAME_FORMAT 

Operation failed because of invalid name format.

KCM_CRYPTO_STATUS_ENTROPY_MISSING 

Operation failed because entropy missing.

KCM_STATUS_SELF_GENERATED_CERTIFICATE_VERIFICATION_ERROR 

Verification of self-generated certificate against stored private key failed.

KCM_CRYPTO_STATUS_SET_EXTENSION_FAILED 

Failed to copy an extension from the certificate to the CSR.

KCM_STATUS_RBP_ERROR 

Rollback-protected data operation failed.

KCM_STATUS_FILE_NAME_INVALID 

File name contains an invalid character (must only include the characters '0-9', 'A'-'Z', 'a'-'z', '.', '-', '_').

KCM_CRYPTO_STATUS_INVALID_PK_PRIVKEY 

Operation failed because of an invalid PK private key.