pt_certificate_api.h

Go to the documentation of this file.

/*
 * ----------------------------------------------------------------------------
 * Copyright 2019 ARM Ltd.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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 PT_API_VERSION
#define PT_API_VERSION 2
#endif
#if PT_API_VERSION != 2
#error "Including mixed versions of Protocol API"
#endif

#ifndef PT_CERTIFICATE_API_H_
#define PT_CERTIFICATE_API_H_

#include <stddef.h>
#include <stdbool.h>
#include "pt-client-2/pt_common_api.h"

#define CE_STATUS_RANGE_BASE 0x0500
#define CE_STATUS_RANGE_END 0x0600

typedef enum {
    CE_STATUS_SUCCESS = 0,                    
    CE_STATUS_ERROR = CE_STATUS_RANGE_BASE,   
    CE_STATUS_INVALID_PARAMETER,              
    CE_STATUS_INSUFFICIENT_BUFFER,            
    CE_STATUS_OUT_OF_MEMORY,                  
    CE_STATUS_ITEM_NOT_FOUND,                 
    CE_STATUS_DEVICE_BUSY,                    
    CE_STATUS_BAD_INPUT_FROM_SERVER,          
    CE_STATUS_EST_ERROR,                      
    CE_STATUS_STORAGE_ERROR,                  
    CE_STATUS_RENEWAL_ITEM_VALIDATION_ERROR,  
    CE_STATUS_BACKUP_ITEM_ERROR,              
    CE_STATUS_ORIGINAL_ITEM_ERROR,            
    CE_STATUS_RESTORE_BACKUP_ERROR,           
    CE_STATUS_RENEWAL_STATUS_ERROR,           
    CE_STATUS_FORBIDDEN_REQUEST,              
    CE_STATUS_ITEM_IS_EMPTY,                  
    CE_STATUS_NOT_INITIALIZED,                
    CE_STATUS_INIT_FAILED,                    
    CE_STATUS_PENDING = 0x5ff,                
    CE_MAX_STATUS = CE_STATUS_RANGE_END
} pt_ce_status_e;

struct pt_certificate_list;
typedef struct pt_certificate_list pt_certificate_list_t;

struct cert_context_s {
    uint16_t cert_length;
    uint8_t *cert;
    struct cert_context_s *next;
};

struct cert_chain_context_s {
    uint8_t chain_length;
    struct cert_context_s *certs;
};

typedef void (*pt_certificate_renewal_notification_handler)(const connection_id_t connection_id,
                                                            const char *name,
                                                            int32_t initiator,
                                                            int32_t status,
                                                            const char *description,
                                                            void *userdata);

typedef void (*pt_device_certificate_renew_response_handler)(const connection_id_t connection_id,
                                                             const char *device_id,
                                                             const char *name,
                                                             int32_t status,
                                                             struct cert_chain_context_s *cert_chain,
                                                             void *userdata);

typedef pt_status_t (*pt_device_certificate_renew_request_handler)(const connection_id_t connection_id,
                                                                   const char *device_id,
                                                                   const char *name,
                                                                   void *userdata);

typedef void (*pt_certificates_set_response_handler)(const connection_id_t connection_id, void *userdata);

typedef void (*pt_certificate_renew_response_handler)(const connection_id_t connection_id, void *userdata);

pt_certificate_list_t *pt_certificate_list_create();

void pt_certificate_list_destroy(pt_certificate_list_t *list);

pt_status_t pt_certificate_list_add(pt_certificate_list_t *list, const char *name);

pt_status_t pt_certificate_renewal_list_set(const connection_id_t connection_id,
                                            pt_certificate_list_t *list,
                                            pt_certificates_set_response_handler success_handler,
                                            pt_certificates_set_response_handler failure_handler,
                                            void *userdata);

pt_status_t pt_certificate_renew(const connection_id_t connection_id,
                                 const char *name,
                                 pt_certificate_renew_response_handler success_handler,
                                 pt_certificate_renew_response_handler failure_handler,
                                 void *userdata);

pt_status_t pt_device_certificate_renew(const connection_id_t connection_id,
                                        const char *device_id,
                                        const char *name,
                                        const char *csr,
                                        const size_t csr_length,
                                        pt_device_certificate_renew_response_handler success_handler,
                                        pt_device_certificate_renew_response_handler failure_handler,
                                        void *userdata);

pt_status_t pt_device_certificate_renew_request_finish(const connection_id_t connection_id,
                                                       const char *device_id,
                                                       const pt_ce_status_e status);

void pt_free_certificate_chain_context(struct cert_chain_context_s *context);

#endif /* PT_CERTIFICATE_API_H_ */