Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: FXAS21002 FXOS8700Q
kcm_defs.h File Reference
Keys and configuration manager (KCM) definitions. More...
Go to the source code of this file.
Data Structures | |
| struct | kcm_csr_params_ |
| This struct contains CSR parameters for future generated CSR. More... | |
Typedefs | |
| typedef void * | kcm_security_desc_s |
| Security descriptor - contains different ACLs such as remote ACL, local ACL and audit. | |
| typedef struct kcm_csr_params_ | kcm_csr_params_s |
| This struct contains CSR parameters for future generated CSR. | |
Enumerations | |
| enum | kcm_item_type_e { KCM_PRIVATE_KEY_ITEM, KCM_PUBLIC_KEY_ITEM, KCM_SYMMETRIC_KEY_ITEM, KCM_CERTIFICATE_ITEM, KCM_CONFIG_ITEM, KCM_LAST_ITEM } |
KCM item types. More... | |
| enum | kcm_md_type_e { , KCM_MD_SHA256 = 0x1 } |
supported message digests More... | |
| enum | kcm_csr_key_usage_e { , KCM_CSR_KU_DIGITAL_SIGNATURE = 0x1, KCM_CSR_KU_NON_REPUDIATION = 0x2, KCM_CSR_KU_KEY_CERT_SIGN = 0x4, KCM_CSR_KU_KEY_AGREEMENT = 0x8 } |
X.509 v3 Key Usage Extension bit-mask options. More... | |
| enum | kcm_csr_ext_key_usage_e { , KCM_CSR_EXT_KU_SERVER_AUTH = (1 << 1), KCM_CSR_EXT_KU_CLIENT_AUTH = (1 << 2), KCM_CSR_EXT_KU_CODE_SIGNING = (1 << 3), KCM_CSR_EXT_KU_EMAIL_PROTECTION = (1 << 4), KCM_CSR_EXT_KU_TIME_STAMPING = (1 << 8), KCM_CSR_EXT_KU_OCSP_SIGNING = (1 << 9) } |
X.509 v3 Extended Key Usage Extension bit-mask options. More... | |
| enum | kcm_crypto_key_scheme_e { , KCM_SCHEME_EC_SECP256R1 } |
Cryptographic scheme types Currently only ECC-256 curve is supported. More... | |
Detailed Description
Keys and configuration manager (KCM) definitions.
Definition in file kcm_defs.h.
Typedef Documentation
| typedef struct kcm_csr_params_ kcm_csr_params_s |
This struct contains CSR parameters for future generated CSR.
- Parameters:
-
subject String that contains the subject (distinguished name) of the certificate in predefined format. The format should be as the following example: "C=US,ST=California,L=San Francisco,O=Wikimedia Foundation,Inc.,CN=*.wikipedia.org". md_type Message digest selected from `kcm_md_type_e`. key_usage Key usage extension bit-mask selected from `kcm_csr_key_usage_e`. If the requested CSR does not contain any key usage extension, it needs to be set to `KCM_CSR_KU_NONE`. ext_key_usage Extended key usage extensions bit-mask selected from `kcm_csr_ext_key_usage_e`. If the requested CSR does not contain any extended key usage extension, it needs to be set to `KCM_CSR_EXT_KU_NONE`.
| typedef void* kcm_security_desc_s |
Security descriptor - contains different ACLs such as remote ACL, local ACL and audit.
Currently defined to `void*.` May be changed in the future.
Definition at line 77 of file kcm_defs.h.
Enumeration Type Documentation
Cryptographic scheme types Currently only ECC-256 curve is supported.
More schemes can be added later on.
Definition at line 84 of file kcm_defs.h.
X.509 v3 Extended Key Usage Extension bit-mask options.
- Enumerator:
Definition at line 61 of file kcm_defs.h.
| enum kcm_csr_key_usage_e |
X.509 v3 Key Usage Extension bit-mask options.
- Enumerator:
Definition at line 51 of file kcm_defs.h.
| enum kcm_item_type_e |
KCM item types.
- Enumerator:
KCM_PRIVATE_KEY_ITEM KCM private key item type. KCM Supports ECC keys with curves defined in palGroupIndex_t(pal_Crypto.h)
KCM_PUBLIC_KEY_ITEM KCM public key item type. KCM Supports ECC keys with curves defined in palGroupIndex_t(pal_Crypto.h)
KCM_SYMMETRIC_KEY_ITEM KCM symmetric key item type.
KCM_CERTIFICATE_ITEM KCM certificate item type. Supported x509 certificates in der format.
KCM_CONFIG_ITEM KCM configuration parameter item type.
KCM_LAST_ITEM KCM not defined item type.
Definition at line 32 of file kcm_defs.h.
| enum kcm_md_type_e |
supported message digests
Definition at line 44 of file kcm_defs.h.
Generated on Tue Jul 12 2022 20:21:04 by
1.7.2