kcm_defs.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2016-2017 ARM Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------

#ifndef __KCM_DEFS_H__
#define __KCM_DEFS_H__

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

    typedef enum {
        KCM_PRIVATE_KEY_ITEM,          
        KCM_PUBLIC_KEY_ITEM,           
        KCM_SYMMETRIC_KEY_ITEM,        
        KCM_CERTIFICATE_ITEM,          
        KCM_CONFIG_ITEM,               
        KCM_LAST_ITEM                  
    } kcm_item_type_e;

    typedef enum {
        KCM_MD_NONE = 0x0,
        KCM_MD_SHA256 = 0x1               
    } kcm_md_type_e;

    typedef enum {
        KCM_CSR_KU_NONE = 0x0,
        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      
    } kcm_csr_key_usage_e;

    typedef enum {
        KCM_CSR_EXT_KU_NONE =             0,
        KCM_CSR_EXT_KU_ANY =              (1 << 0),
        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)  
    } kcm_csr_ext_key_usage_e;

    typedef enum {
        KCM_SCHEME_NONE,
        KCM_SCHEME_EC_SECP256R1,       
    } kcm_crypto_key_scheme_e;

    /*
    * Certificate chain handle
    */
    typedef void* kcm_cert_chain_handle;

    typedef uintptr_t kcm_key_handle_t;

    typedef void* kcm_security_desc_s;

    typedef struct kcm_csr_params_ {
        char *subject;
        kcm_md_type_e md_type;
        uint32_t key_usage;
        uint32_t ext_key_usage;
    } kcm_csr_params_s;


#ifdef MBED_CONF_MBED_CLOUD_CLIENT_SECURE_ELEMENT_SUPPORT

    typedef enum {
        KCM_LOCATION_PSA = 1,             
        KCM_LOCATION_SECURE_ELEMENT = 2,  
    } kcm_item_location_e;

    typedef struct kcm_item_extra_info {
        kcm_item_location_e priv_key_location;
        kcm_item_location_e pub_key_location;
    } kcm_item_extra_info_s;

#endif // #ifdef MBED_CONF_MBED_CLOUD_CLIENT_SECURE_ELEMENT_SUPPORT

    #define KCM_MAX_FILENAME_SIZE  100

    #define KCM_MAX_NUMBER_OF_CERTITICATES_IN_CHAIN 5

    #define KCM_SHA256_SIZE                         32

    #define KCM_EC_SECP256R1_SIGNATURE_RAW_SIZE     64

    #define KCM_EC_SECP256R1_SHARED_SECRET_SIZE     32

#ifdef __cplusplus
}
#endif

#endif //__KCM_DEFS_H__