acme_client_certificate.h File Reference

Certificate management. More...

#include "acme/acme_client.h"

Go to the source code of this file.

Functions

error_t acmeClientSendDownloadCertRequest (AcmeClientContext *context, char_t *buffer, size_t size, size_t *length)
 Send HTTP request (certificate URL) More...
 
error_t acmeClientFormatDownloadCertRequest (AcmeClientContext *context)
 Format HTTP request body (certificate URL) More...
 
error_t acmeClientParseDownloadCertResponse (AcmeClientContext *context, char_t *buffer, size_t size, size_t *length)
 Parse HTTP response (certificate URL) More...
 
error_t acmeClientSendRevokeCertRequest (AcmeClientContext *context, const char_t *cert, size_t certLen, AcmeReasonCode reason)
 Send HTTP request (revokeCert URL) More...
 
error_t acmeClientFormatRevokeCertRequest (AcmeClientContext *context, const char_t *cert, size_t certLen, AcmeReasonCode reason)
 Format HTTP request body (revokeCert URL) More...
 
error_t acmeClientParseRevokeCertResponse (AcmeClientContext *context)
 Parse HTTP response (certificate URL) More...
 

Detailed Description

Certificate management.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneACME Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.4.0

Definition in file acme_client_certificate.h.

Function Documentation

◆ acmeClientFormatDownloadCertRequest()

error_t acmeClientFormatDownloadCertRequest ( AcmeClientContext context)

Format HTTP request body (certificate URL)

Parameters
[in]contextPointer to the ACME client context
Returns
Error code

Definition at line 147 of file acme_client_certificate.c.

◆ acmeClientFormatRevokeCertRequest()

error_t acmeClientFormatRevokeCertRequest ( AcmeClientContext context,
const char_t cert,
size_t  certLen,
AcmeReasonCode  reason 
)

Format HTTP request body (revokeCert URL)

Parameters
[in]contextPointer to the ACME client context
[in]certCertificate to be revoked (PEM format)
[in]certLenLength of the certificate, in bytes
[in]reasonRevocation reason code
Returns
Error code

Definition at line 336 of file acme_client_certificate.c.

◆ acmeClientParseDownloadCertResponse()

error_t acmeClientParseDownloadCertResponse ( AcmeClientContext context,
char_t buffer,
size_t  size,
size_t *  length 
)

Parse HTTP response (certificate URL)

Parameters
[in]contextPointer to the ACME client context
[out]bufferPointer to the buffer where to store the certificate chain
[in]sizeSize of the buffer, in bytes
[out]lengthActual length of the certificate chain, in bytes
Returns
Error code

Definition at line 188 of file acme_client_certificate.c.

◆ acmeClientParseRevokeCertResponse()

error_t acmeClientParseRevokeCertResponse ( AcmeClientContext context)

Parse HTTP response (certificate URL)

Parameters
[in]contextPointer to the ACME client context
Returns
Error code

Definition at line 422 of file acme_client_certificate.c.

◆ acmeClientSendDownloadCertRequest()

error_t acmeClientSendDownloadCertRequest ( AcmeClientContext context,
char_t buffer,
size_t  size,
size_t *  length 
)

Send HTTP request (certificate URL)

Parameters
[in]contextPointer to the ACME client context
[out]bufferPointer to the buffer where to store the certificate chain
[in]sizeSize of the buffer, in bytes
[out]lengthActual length of the certificate chain, in bytes
Returns
Error code

Definition at line 58 of file acme_client_certificate.c.

◆ acmeClientSendRevokeCertRequest()

error_t acmeClientSendRevokeCertRequest ( AcmeClientContext context,
const char_t cert,
size_t  certLen,
AcmeReasonCode  reason 
)

Send HTTP request (revokeCert URL)

Parameters
[in]contextPointer to the ACME client context
[in]certCertificate to be revoked (PEM format)
[in]certLenLength of the certificate, in bytes
[in]reasonRevocation reason code
Returns
Error code

Definition at line 245 of file acme_client_certificate.c.