x509_cert_ext_format.h
Go to the documentation of this file.
1 /**
2  * @file x509_cert_ext_format.h
3  * @brief X.509 extension formatting
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO 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.5.2
29  **/
30 
31 #ifndef _X509_CERT_EXT_FORMAT_H
32 #define _X509_CERT_EXT_FORMAT_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "pkix/x509_common.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //X.509 related functions
44 error_t x509FormatExtensions(const X509Extensions *extensions,
45  const X509SubjectKeyId *subjectKeyId, const X509AuthKeyId *authKeyId,
46  uint8_t *output, size_t *written);
47 
48 error_t x509FormatExtension(const X509Extension *extension, uint8_t *output,
49  size_t *written);
50 
51 error_t x509FormatBasicConstraints(const X509BasicConstraints *basicConstraints,
52  uint8_t *output, size_t *written);
53 
54 error_t x509FormatKeyUsage(const X509KeyUsage *keyUsage, uint8_t *output,
55  size_t *written);
56 
57 error_t x509FormatExtendedKeyUsage(const X509ExtendedKeyUsage *extKeyUsage,
58  uint8_t *output, size_t *written);
59 
60 error_t x509FormatKeyPurposes(uint16_t bitmap, uint8_t *output,
61  size_t *written);
62 
63 error_t x509FormatSubjectAltName(const X509SubjectAltName *subjectAltName,
64  uint8_t *output, size_t *written);
65 
66 error_t x509FormatSubjectKeyId(const X509SubjectKeyId *subjectKeyId,
67  uint8_t *output, size_t *written);
68 
69 error_t x509FormatAuthorityKeyId(const X509AuthKeyId *authKeyId,
70  uint8_t *output, size_t *written);
71 
72 error_t x509FormatNsCertType(const X509NsCertType *nsCertType,
73  uint8_t *output, size_t *written);
74 
75 //C++ guard
76 #ifdef __cplusplus
77 }
78 #endif
79 
80 #endif
x509_common.h
X.509 common definitions.
x509FormatKeyUsage
error_t x509FormatKeyUsage(const X509KeyUsage *keyUsage, uint8_t *output, size_t *written)
Format KeyUsage extension.
Definition: x509_cert_ext_format.c:489
x509FormatKeyPurposes
error_t x509FormatKeyPurposes(uint16_t bitmap, uint8_t *output, size_t *written)
Format the list of key purposes.
Definition: x509_cert_ext_format.c:752
extensions
uint8_t extensions[]
Definition: ntp_common.h:207
X509SubjectKeyId
Subject Key Identifier extension.
Definition: x509_common.h:932
x509FormatNsCertType
error_t x509FormatNsCertType(const X509NsCertType *nsCertType, uint8_t *output, size_t *written)
Format NetscapeCertType extension.
Definition: x509_cert_ext_format.c:1276
x509FormatBasicConstraints
error_t x509FormatBasicConstraints(const X509BasicConstraints *basicConstraints, uint8_t *output, size_t *written)
Format BasicConstraints extension.
Definition: x509_cert_ext_format.c:305
error_t
error_t
Error codes.
Definition: error.h:43
X509ExtendedKeyUsage
Extended Key Usage extension.
Definition: x509_common.h:896
x509FormatAuthorityKeyId
error_t x509FormatAuthorityKeyId(const X509AuthKeyId *authKeyId, uint8_t *output, size_t *written)
Format AuthorityKeyIdentifier extension.
Definition: x509_cert_ext_format.c:1163
X509Extension
X.509 certificate extension.
Definition: x509_common.h:1039
X509AuthKeyId
Authority Key Identifier extension.
Definition: x509_common.h:944
crypto.h
General definitions for cryptographic algorithms.
X509SubjectAltName
Subject Alternative Name extension.
Definition: x509_common.h:919
X509NsCertType
Netscape certificate type.
Definition: x509_common.h:1028
x509FormatSubjectAltName
error_t x509FormatSubjectAltName(const X509SubjectAltName *subjectAltName, uint8_t *output, size_t *written)
Format SubjectAltName extension.
Definition: x509_cert_ext_format.c:931
X509BasicConstraints
Basic Constraints extension.
Definition: x509_common.h:861
X509Extensions
X.509 certificate extensions.
Definition: x509_common.h:1051
x509FormatSubjectKeyId
error_t x509FormatSubjectKeyId(const X509SubjectKeyId *subjectKeyId, uint8_t *output, size_t *written)
Format SubjectKeyIdentifier extension.
Definition: x509_cert_ext_format.c:1065
x509FormatExtension
error_t x509FormatExtension(const X509Extension *extension, uint8_t *output, size_t *written)
Format X.509 certificate extension.
Definition: x509_cert_ext_format.c:205
x509FormatExtendedKeyUsage
error_t x509FormatExtendedKeyUsage(const X509ExtendedKeyUsage *extKeyUsage, uint8_t *output, size_t *written)
Format ExtendedKeyUsage extension.
Definition: x509_cert_ext_format.c:636
x509FormatExtensions
error_t x509FormatExtensions(const X509Extensions *extensions, const X509SubjectKeyId *subjectKeyId, const X509AuthKeyId *authKeyId, uint8_t *output, size_t *written)
Format Extensions structure.
Definition: x509_cert_ext_format.c:55
X509KeyUsage
Key Usage extension.
Definition: x509_common.h:885