Mistake on this page? Email us
Go to the documentation of this file.
1 /*
2  * ----------------------------------------------------------------------------
3  * Copyright 2019 ARM Ltd.
4  *
5  * SPDX-License-Identifier: Apache-2.0
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ----------------------------------------------------------------------------
19  */
21 #ifndef PT_API_VERSION
22 #define PT_API_VERSION 2
23 #endif
24 #if PT_API_VERSION != 2
25 #error "Including mixed versions of Protocol API"
26 #endif
31 #include <stddef.h>
32 #include <stdbool.h>
40 #define CE_STATUS_RANGE_BASE 0x0500
41 #define CE_STATUS_RANGE_END 0x0600
43 typedef enum {
85 struct pt_certificate_list;
86 typedef struct pt_certificate_list pt_certificate_list_t;
95  uint16_t cert_length;
96  uint8_t *cert;
97  struct cert_context_s *next;
98 };
106  uint8_t chain_length;
107  struct cert_context_s *certs;
108 };
123 typedef void (*pt_certificate_renewal_notification_handler)(const connection_id_t connection_id,
124  const char *name,
125  int32_t initiator,
126  int32_t status,
127  const char *description,
128  void *userdata);
144 typedef void (*pt_device_certificate_renew_response_handler)(const connection_id_t connection_id,
145  const char *device_id,
146  const char *name,
147  int32_t status,
148  struct cert_chain_context_s *cert_chain,
149  void *userdata);
164 typedef pt_status_t (*pt_device_certificate_renew_request_handler)(const connection_id_t connection_id,
165  const char *device_id,
166  const char *name,
167  void *userdata);
174 typedef void (*pt_certificates_set_response_handler)(const connection_id_t connection_id, void *userdata);
179 typedef void (*pt_certificate_renew_response_handler)(const connection_id_t connection_id, void *userdata);
185 pt_certificate_list_t *pt_certificate_list_create();
191 void pt_certificate_list_destroy(pt_certificate_list_t *list);
200 pt_status_t pt_certificate_list_add(pt_certificate_list_t *list, const char *name);
212 pt_status_t pt_certificate_renewal_list_set(const connection_id_t connection_id,
213  pt_certificate_list_t *list,
214  pt_certificates_set_response_handler success_handler,
215  pt_certificates_set_response_handler failure_handler,
216  void *userdata);
228 pt_status_t pt_certificate_renew(const connection_id_t connection_id,
229  const char *name,
232  void *userdata);
248 pt_status_t pt_device_certificate_renew(const connection_id_t connection_id,
249  const char *device_id,
250  const char *name,
251  const char *csr,
252  const size_t csr_length,
255  void *userdata);
266 pt_status_t pt_device_certificate_renew_request_finish(const connection_id_t connection_id,
267  const char *device_id,
268  const pt_ce_status_e status);
281 #endif /* PT_CERTIFICATE_API_H_ */
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)
Finish device certificate renewal request.
An out-of-memory condition occurred.
Definition: pt_certificate_api.h:48
The storage operation ended with an error.
Definition: pt_certificate_api.h:53
Definition: pt_certificate_api.h:94
Operation failed to restore backup items.
Definition: pt_certificate_api.h:57
Definition: pt_certificate_api.h:43
The item was found in the storage but its length is zero.
Definition: pt_certificate_api.h:60
The device is processing too many certificate renewals.
Definition: pt_certificate_api.h:50
void(* pt_certificates_set_response_handler)(const connection_id_t connection_id, void *userdata)
Type definition for pt_certificate_renewal_list_set response success and failure handlers.
Definition: pt_certificate_api.h:174
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)
Type definition for certificate renewal notification. This callback will be called to notify the stat...
Definition: pt_certificate_api.h:123
Operation ended with an unspecified error.
Definition: pt_certificate_api.h:45
Initialization of the Certificate Enrollment module has failed. This error may be passed into MbedClo...
Definition: pt_certificate_api.h:62
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)
Requests the renewal of the certificate specified by the name parameter using the certificate signing...
Operation failed to create/read/validate backup items.
Definition: pt_certificate_api.h:55
Operation will be complete asynchronously.
Definition: pt_certificate_api.h:63
The item was not found in the storage.
Definition: pt_certificate_api.h:49
Contains common structures and definitions for the protocol translator client.
An error during enrollment over secure transport (EST) occurred.
Definition: pt_certificate_api.h:52
Called CertificateEnrollmentClient API before the initialization of the module.
Definition: pt_certificate_api.h:61
The server sent a TLV that is either unsupported or malformed.
Definition: pt_certificate_api.h:51
The provided buffer size was insufficient for the required output.
Definition: pt_certificate_api.h:47
Definition: pt_certificate_api.h:105
pt_status_t(* pt_device_certificate_renew_request_handler)(const connection_id_t connection_id, const char *device_id, const char *name, void *userdata)
Type definition for certificate renewal request handler for device certificate. This callback will be...
Definition: pt_certificate_api.h:164
void pt_free_certificate_chain_context(struct cert_chain_context_s *context)
Free a cert_chain_context_s structure passed to the certificate renewal notification callback...
The server asked for a forbidden operation (for example: the server is not allowed to renew the devic...
Definition: pt_certificate_api.h:59
Operation completed successfully.
Definition: pt_certificate_api.h:44
void(* pt_certificate_renew_response_handler)(const connection_id_t connection_id, void *userdata)
Type definition for pt_certificate_renew response success and failure handlers.
Definition: pt_certificate_api.h:179
pt_status_t pt_certificate_list_add(pt_certificate_list_t *list, const char *name)
Adds a certificate to certificate list.
Operation failed to validate renewal items.
Definition: pt_certificate_api.h:54
pt_certificate_list_t * pt_certificate_list_create()
Creates a certificate list.
Operation failed to create/read/validate original items.
Definition: pt_certificate_api.h:56
Enumeration containing the possible return status codes for Protocol API functions.
Definition: pt_common_api.h:51
void pt_certificate_list_destroy(pt_certificate_list_t *list)
Destroys the certificate list. Frees all the certificates added to the list.
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)
Requests the renewal of the certificate specified by the name parameter.
A parameter provided to the function was invalid.
Definition: pt_certificate_api.h:46
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)
Type definition for certificate renewal notification for device certificate. This callback will be ca...
Definition: pt_certificate_api.h:144
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)
Sends the certificate list to Edge, triggering renewal subscriptions of the certificates in the list...
Operation failed to create/validate/delete the renewal status file.
Definition: pt_certificate_api.h:58