acme_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file acme_client_misc.h
3  * @brief Helper functions for ACME client
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_MISC_H
32 #define _ACME_CLIENT_MISC_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
43 error_t acmeClientLoadKeyPair(AcmeKeyPair *keyPair, const char_t *publicKey,
44  size_t publicKeyLen, const char_t *privateKey, size_t privateKeyLen);
45 
47 
49 
51  const char_t *method, const char_t *url);
52 
54  const char_t *kid, const char_t *nonce, const char_t *url,
55  char_t *buffer, size_t *written);
56 
57 error_t acmeClientFormatJwk(const AcmeKeyPair *keyPair, char_t *buffer,
58  size_t *written, bool_t sort);
59 
60 error_t acmeClientGenerateCsr(AcmeClientContext *context, uint8_t *buffer,
61  size_t *written);
62 
65 
66 const char_t *acmeClientGetPath(const char_t *url);
67 
68 //C++ guard
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif
ACME client (Automatic Certificate Management Environment)
#define AcmeClientContext
Definition: acme_client.h:248
error_t acmeClientSendRequest(AcmeClientContext *context)
Send HTTP request.
error_t acmeClientGenerateCsr(AcmeClientContext *context, uint8_t *buffer, size_t *written)
Generate CSR (Certificate Signing Request)
void acmeClientUnloadKeyPair(AcmeKeyPair *keyPair)
Unload public/private key pair.
error_t acmeClientFormatJwsProtectedHeader(const AcmeKeyPair *keyPair, const char_t *kid, const char_t *nonce, const char_t *url, char_t *buffer, size_t *written)
Format JWS protected header.
error_t acmeClientFormatJwk(const AcmeKeyPair *keyPair, char_t *buffer, size_t *written, bool_t sort)
Export a public key to JWK format.
error_t acmeClientFormatRequestHeader(AcmeClientContext *context, const char_t *method, const char_t *url)
Format HTTP request header.
error_t acmeClientParseResponseHeader(AcmeClientContext *context)
Parse HTTP response header.
error_t acmeClientLoadKeyPair(AcmeKeyPair *keyPair, const char_t *publicKey, size_t publicKeyLen, const char_t *privateKey, size_t privateKeyLen)
Load public/private key pair.
const char_t * acmeClientGetPath(const char_t *url)
Extract the path name from a given URL.
error_t acmeClientParseProblemDetails(AcmeClientContext *context)
Parse error response.
char char_t
Definition: compiler_port.h:48
int bool_t
Definition: compiler_port.h:53
error_t
Error codes.
Definition: error.h:43
Public/private key pair.
Definition: acme_client.h:413