kcm_status.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_STATUS_H__
#define __KCM_STATUS_H__

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    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,
} kcm_status_e;

//Macro defined for backward compatibility. Will be deprecated.
#define KCM_STATUS_ESFS_ERROR KCM_STATUS_STORAGE_ERROR

#ifdef __cplusplus
}
#endif

#endif //__KCM_STATUS_H__