acme_client_order.h
Go to the documentation of this file.
1 /**
2  * @file acme_client_order.h
3  * @brief Order object management
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneACME Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.0
29  **/
30 
31 #ifndef _ACME_CLIENT_ORDER_H
32 #define _ACME_CLIENT_ORDER_H
33 
34 //Dependencies
35 #include "acme/acme_client.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //ACME client related functions
44 
46  const AcmeOrderParams *params);
47 
49  const AcmeOrderParams *params);
50 
52  const AcmeOrderParams *params);
53 
55 
59 
63 
65 
66 //C++ guard
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif
ACME client (Automatic Certificate Management Environment)
#define AcmeClientContext
Definition: acme_client.h:248
AcmeOrderStatus
Order status.
Definition: acme_client.h:320
error_t acmeClientSendOrderStatusRequest(AcmeClientContext *context)
Send HTTP request (order URL)
error_t acmeClientSendFinalizeOrderRequest(AcmeClientContext *context)
Send HTTP request (order's finalize URL)
error_t acmeClientFormatOrderStatusRequest(AcmeClientContext *context)
Format HTTP request body (order URL)
error_t acmeClientSendNewOrderRequest(AcmeClientContext *context, const AcmeOrderParams *params)
Send HTTP request (newOrder URL)
error_t acmeClientCheckOrderParams(const AcmeOrderParams *params)
Check certificate order information.
error_t acmeClientParseNewOrderResponse(AcmeClientContext *context)
Parse HTTP response (newOrder URL)
AcmeOrderStatus acmeClientParseOrderStatus(const char_t *label)
Parse order status field.
error_t acmeClientFormatNewOrderRequest(AcmeClientContext *context, const AcmeOrderParams *params)
Format HTTP request body (newOrder URL)
error_t acmeClientInitOrder(AcmeClientContext *context, const AcmeOrderParams *params)
Initialize order object.
error_t acmeClientFormatFinalizeOrderRequest(AcmeClientContext *context)
Format HTTP request body (order's finalize URL)
error_t acmeClientParseOrderStatusResponse(AcmeClientContext *context)
Parse HTTP response (order URL)
error_t acmeClientParseFinalizeOrderResponse(AcmeClientContext *context)
Parse HTTP response (order's finalize URL)
char char_t
Definition: compiler_port.h:48
error_t
Error codes.
Definition: error.h:43
Certificate order parameters.
Definition: acme_client.h:469