acme_client_challenge.h
Go to the documentation of this file.
1 /**
2  * @file acme_client_challenge.h
3  * @brief Challenge 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_CHALLENGE_H
32 #define _ACME_CLIENT_CHALLENGE_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  AcmeChallenge *challenge);
45 
47  AcmeChallenge *challenge);
48 
50 
53 
55  const char_t *identifier, bool_t wildcard);
56 
58  AcmeChallenge *challenge);
59 
61  AcmeChallenge *challenge);
62 
64  AcmeChallenge *challenge);
65 
66 //C++ guard
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif
ACME client (Automatic Certificate Management Environment)
AcmeChallengeStatus
Challenge status.
Definition: acme_client.h:351
AcmeChallengeType
Challenge types.
Definition: acme_client.h:365
#define AcmeClientContext
Definition: acme_client.h:248
AcmeChallengeStatus acmeClientParseChallengeStatus(const char_t *label)
Parse challenge status field.
error_t acmeClientSendChallengeReadyRequest(AcmeClientContext *context, AcmeChallenge *challenge)
Send HTTP request (challenge URL)
error_t acmeClientGenerateTlsAlpnCert(AcmeClientContext *context, AcmeChallenge *challenge)
Generate a self-signed certificate (TLS-ALPN challenge only)
AcmeChallengeType acmeClientParseChallengeType(const char_t *label)
Parse challenge type field.
error_t acmeClientParseChallengeReadyResponse(AcmeClientContext *context)
Parse HTTP response (challenge URL)
error_t acmeClientGenerateKeyAuthorization(AcmeClientContext *context, AcmeChallenge *challenge)
Generate key authorization.
error_t acmeClientDigestKeyAuthorization(AcmeClientContext *context, AcmeChallenge *challenge)
Digest the key authorization (for DNS challenge only)
error_t acmeClientFormatChallengeReadyRequest(AcmeClientContext *context, AcmeChallenge *challenge)
Format HTTP request body (challenge URL)
AcmeChallengeType acmeClientGetChallengeType(AcmeClientContext *context, const char_t *identifier, bool_t wildcard)
Retrieve the challenge type used for a given domain name.
char char_t
Definition: compiler_port.h:48
int bool_t
Definition: compiler_port.h:53
uint8_t identifier[]
error_t
Error codes.
Definition: error.h:43
Challenge object.
Definition: acme_client.h:547