ce_status.h

00001 // ----------------------------------------------------------------------------
00002 // Copyright 2018 ARM Ltd.
00003 //  
00004 // Licensed under the Apache License, Version 2.0 (the "License");
00005 // you may not use this file except in compliance with the License.
00006 // You may obtain a copy of the License at
00007 //  
00008 //     http://www.apache.org/licenses/LICENSE-2.0
00009 //  
00010 // Unless required by applicable law or agreed to in writing, software
00011 // distributed under the License is distributed on an "AS IS" BASIS,
00012 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013 // See the License for the specific language governing permissions and
00014 // limitations under the License.
00015 // ----------------------------------------------------------------------------
00016 
00017 #ifndef __CE_STATUS_H__
00018 #define __CE_STATUS_H__
00019 
00020 #ifdef __cplusplus
00021 extern "C" {
00022 #endif
00023 
00024     /**
00025     * @file ce_status.h
00026     *  \brief Certificate Enrollment (CE) status and error codes.
00027     * This list may grow as needed.
00028     */
00029 
00030 #define CE_STATUS_RANGE_BASE 0x0500
00031 #define CE_STATUS_RANGE_END 0x05ff
00032 
00033 typedef enum {
00034     CE_STATUS_SUCCESS = 0,                    //!< Operation completed successfully.
00035     CE_STATUS_ERROR = CE_STATUS_RANGE_BASE,   //!< Operation ended with an unspecified error.
00036     CE_STATUS_INVALID_PARAMETER,              //!< A parameter provided to the function was invalid.
00037     CE_STATUS_INSUFFICIENT_BUFFER,            //!< The provided buffer size was insufficient for the required output.
00038     CE_STATUS_OUT_OF_MEMORY,                  //!< An out-of-memory condition occurred.
00039     CE_STATUS_ITEM_NOT_FOUND,                 //!< The item was not found in the storage.
00040     CE_STATUS_DEVICE_BUSY,                    //!< The device is processing too many certificate renewals.
00041     CE_STATUS_BAD_INPUT_FROM_SERVER,          //!< The server sent a TLV that is either unsupported or malformed
00042     CE_STATUS_EST_ERROR,                      //!< An error during enrollment over secure transport (EST) occurred.
00043     CE_STATUS_STORAGE_ERROR,                  //!< The storage operation ended with an error.
00044     CE_STATUS_RENEWAL_ITEM_VALIDATION_ERROR,  //!< Operation failed to validate renewal items.
00045     CE_STATUS_BACKUP_ITEM_ERROR,              //!< Operation failed to create/read/validate backup items.
00046     CE_STATUS_ORIGINAL_ITEM_ERROR,            //!< Operation failed to create/read/validate original items.
00047     CE_STATUS_RESTORE_BACKUP_ERROR,           //!< Operation failed to restore backup items.
00048     CE_STATUS_RENEWAL_STATUS_ERROR,           //!< Operation failed to create/validate/delete the renewal status file.
00049     CE_STATUS_FORBIDDEN_REQUEST,              //!< The server asked for a forbidden operation (for example: the server is not allowed to renew the device's bootstrap certificate).
00050     CE_STATUS_ITEM_IS_EMPTY,                  //!< The item was found in the storage but its length is zero.
00051     CE_STATUS_NOT_INITIALIZED,                //!< Called CertificateEnrollmentClient API before the initialization of the module.
00052     CE_STATUS_INIT_FAILED,                    //!< Initialization of the Certificate Enrollment module has failed. This error may be passed into MbedCloudClient::error callback.
00053     CE_MAX_STATUS = CE_STATUS_RANGE_END
00054 } ce_status_e ;
00055 
00056 #ifdef __cplusplus
00057 }
00058 #endif
00059 
00060 #endif  //__CE_STATUS_H__