Helper functions for ACME client. More...

#include "acme/acme_client.h"

Functions
error_t	acmeClientLoadKeyPair (AcmeKeyPair keyPair, const char_t publicKey, size_t publicKeyLen, const char_t privateKey, size_t privateKeyLen, const char_t password)
	Load public/private key pair. More...

error_t	acmeClientLoadCertKeyPair (AcmeKeyPair keyPair, const char_t cert, size_t certLen, const char_t privateKey, size_t privateKeyLen, const char_t password)
	Load certificate/private key pair. More...

void	acmeClientUnloadKeyPair (AcmeKeyPair *keyPair)
	Unload public/private key pair. More...

error_t	acmeClientSendRequest (AcmeClientContext *context)
	Send HTTP request. More...

error_t	acmeClientFormatRequestHeader (AcmeClientContext context, const char_t method, const char_t *url)
	Format HTTP request header. More...

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. More...

error_t	acmeClientFormatJwk (const AcmeKeyPair keyPair, char_t buffer, size_t *written, bool_t sort)
	Export a public key to JWK format. More...

error_t	acmeClientGenerateCsr (AcmeClientContext context, uint8_t buffer, size_t *written)
	Generate CSR (Certificate Signing Request) More...

error_t	acmeClientParseResponseHeader (AcmeClientContext *context)
	Parse HTTP response header. More...

error_t	acmeClientParseProblemDetails (AcmeClientContext *context)
	Parse error response. More...

error_t	acmeClientInitTlsContext (HttpClientContext httpClientContext, TlsContext tlsContext, void *param)
	TLS initialization. More...

const char_t *	acmeClientGetPath (const char_t *url)
	Extract the path name from a given URL. More...

Detailed Description

Helper functions for ACME client.

License

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

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.5.4

Definition in file acme_client_misc.h.

Function Documentation

◆ acmeClientFormatJwk()

error_t acmeClientFormatJwk	(	const AcmeKeyPair *	keyPair,
		char_t *	buffer,
		size_t *	written,
		bool_t	sort
	)

Export a public key to JWK format.

Parameters

[in]	keyPair	Pointer to the key pair
[out]	buffer	Output buffer where to store the JSON representation
[out]	written	Length of the resulting JSON representation
[in]	sort	Sort members of the JWK representation in lexicographic order

Returns: Error code

Definition at line 993 of file acme_client_misc.c.

◆ acmeClientFormatJwsProtectedHeader()

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.

Parameters

[in]	keyPair	Pointer to the key pair
[in]	kid	Key identifier (account URL)
[in]	nonce	Unique value that enables the verifier of a JWS to recognize when replay has occurred
[in]	url	URL to which the client is directing the request
[out]	buffer	Output buffer where to store the JSON object
[out]	written	Length of the resulting JSON object

Returns: Error code

Definition at line 880 of file acme_client_misc.c.

◆ acmeClientFormatRequestHeader()

error_t acmeClientFormatRequestHeader	(	AcmeClientContext *	context,
		const char_t *	method,
		const char_t *	url
	)

Format HTTP request header.

Parameters

[in]	context	Pointer to the ACME client context
[in]	method	NULL-terminating string containing the HTTP method
[in]	url	Target URL

Returns: Error code

Definition at line 764 of file acme_client_misc.c.

◆ acmeClientGenerateCsr()

error_t acmeClientGenerateCsr	(	AcmeClientContext *	context,
		uint8_t *	buffer,
		size_t *	written
	)

Generate CSR (Certificate Signing Request)

Parameters

[in]	context	Pointer to the ACME client context
[out]	buffer	Output buffer where to store the CSR
[out]	written	Length of the resulting CSR

Returns: Error code

Definition at line 1049 of file acme_client_misc.c.

◆ acmeClientGetPath()

const char_t* acmeClientGetPath ( const char_t * url )

Extract the path name from a given URL.

param[in] NULL-terminated string that contains the URL

Returns: Path component of the URL

Definition at line 1417 of file acme_client_misc.c.

◆ acmeClientInitTlsContext()

error_t acmeClientInitTlsContext	(	HttpClientContext *	httpClientContext,
		TlsContext *	tlsContext,
		void *	param
	)

TLS initialization.

Parameters

[in]	httpClientContext	Pointer to the HTTP client context
[in]	tlsContext	Pointer to the TLS context
[in]	param	Pointer to the ACME client context

Returns: Error code

Definition at line 1385 of file acme_client_misc.c.

◆ acmeClientLoadCertKeyPair()

error_t acmeClientLoadCertKeyPair	(	AcmeKeyPair *	keyPair,
		const char_t *	cert,
		size_t	certLen,
		const char_t *	privateKey,
		size_t	privateKeyLen,
		const char_t *	password
	)

Load certificate/private key pair.

Parameters

[in]	keyPair	Pointer to the key pair
[in]	cert	Certificate (PEM format)
[in]	certLen	Length of the certificate
[in]	privateKey	Private key (PEM format)
[in]	privateKeyLen	Length of the private key
[in]	password	NULL-terminated string containing the password. This parameter is required if the private key is encrypted

Returns: Error code

Definition at line 292 of file acme_client_misc.c.

◆ acmeClientLoadKeyPair()

error_t acmeClientLoadKeyPair	(	AcmeKeyPair *	keyPair,
		const char_t *	publicKey,
		size_t	publicKeyLen,
		const char_t *	privateKey,
		size_t	privateKeyLen,
		const char_t *	password
	)

Load public/private key pair.

Parameters

[in]	keyPair	Pointer to the key pair
[in]	publicKey	Public key (PEM format)
[in]	publicKeyLen	Length of the public key
[in]	privateKey	Private key (PEM format)
[in]	privateKeyLen	Length of the private key
[in]	password	NULL-terminated string containing the password. This parameter is required if the private key is encrypted

Returns: Error code

Definition at line 63 of file acme_client_misc.c.

◆ acmeClientParseProblemDetails()

error_t acmeClientParseProblemDetails ( AcmeClientContext * context )

Parse error response.

Parameters

[in] context Pointer to the ACME client context

Returns: Error code

Definition at line 1323 of file acme_client_misc.c.

◆ acmeClientParseResponseHeader()

error_t acmeClientParseResponseHeader ( AcmeClientContext * context )

Parse HTTP response header.

Parameters

[in] context Pointer to the ACME client context

Returns: Error code

Definition at line 1202 of file acme_client_misc.c.

◆ acmeClientSendRequest()

error_t acmeClientSendRequest ( AcmeClientContext * context )

Send HTTP request.

Parameters

[in] context Pointer to the ACME client context

Returns: Error code

Definition at line 562 of file acme_client_misc.c.

◆ acmeClientUnloadKeyPair()

void acmeClientUnloadKeyPair ( AcmeKeyPair * keyPair )

Unload public/private key pair.

Parameters

[in] keyPair Pointer to the key pair

Definition at line 512 of file acme_client_misc.c.

Functions

Detailed Description

License

Function Documentation

◆ acmeClientFormatJwk()

◆ acmeClientFormatJwsProtectedHeader()

◆ acmeClientFormatRequestHeader()

◆ acmeClientGenerateCsr()

◆ acmeClientGetPath()

◆ acmeClientInitTlsContext()

◆ acmeClientLoadCertKeyPair()

◆ acmeClientLoadKeyPair()

◆ acmeClientParseProblemDetails()

◆ acmeClientParseResponseHeader()

◆ acmeClientSendRequest()

◆ acmeClientUnloadKeyPair()