blob: ba2396a5b16bb962998ee56b76068c0d40f6977d [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file x509.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02004 * \brief X.509 generic defines and structures
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#ifndef MBEDTLS_X509_H
23#define MBEDTLS_X509_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020024#include "mbedtls/private_access.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Bence Szépkútic662b362021-05-27 11:25:03 +020026#include "mbedtls/build_info.h"
Paul Bakkered27a042013-04-18 22:46:23 +020027
Jaeden Amero6609aef2019-07-04 20:01:14 +010028#include "mbedtls/asn1.h"
29#include "mbedtls/pk.h"
Valerio Setti77a75682023-05-15 11:18:46 +020030#include "pk_internal.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#if defined(MBEDTLS_RSA_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010033#include "mbedtls/rsa.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020034#endif
35
36/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000037 * \addtogroup x509_module
Paul Bakker7c6b2c32013-09-16 13:49:26 +020038 * \{
Paul Bakker13e2dfe2009-07-28 07:18:38 +000039 */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +010042/**
43 * Maximum number of intermediate CAs in a verification chain.
44 * That is, maximum length of the chain, excluding the end-entity certificate
45 * and the trusted root certificate.
46 *
47 * Set this to a low value to prevent an adversary from making you waste
48 * resources verifying an overlong certificate chain.
49 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +010051#endif
52
Paul Bakker7c6b2c32013-09-16 13:49:26 +020053/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000054 * \name X509 Error codes
55 * \{
Paul Bakker13e2dfe2009-07-28 07:18:38 +000056 */
Gilles Peskined2971572021-07-26 18:48:10 +020057/** Unavailable feature, e.g. RSA hashing/encryption combination. */
58#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
59/** Requested OID is unknown. */
60#define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
61/** The CRT/CRL/CSR format is invalid, e.g. different type expected. */
62#define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
63/** The CRT/CRL/CSR version element is invalid. */
64#define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
65/** The serial tag or value is invalid. */
66#define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
67/** The algorithm tag or value is invalid. */
68#define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
69/** The name tag or value is invalid. */
70#define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
71/** The date tag or value is invalid. */
72#define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
73/** The signature tag or value invalid. */
74#define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
75/** The extension tag or value is invalid. */
76#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
77/** CRT/CRL/CSR has an unsupported version number. */
78#define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
79/** Signature algorithm (oid) is unsupported. */
80#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
81/** Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */
82#define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
83/** Certificate verification failed, e.g. CRL, CA or signature check failed. */
84#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
85/** Format not recognized as DER or PEM. */
86#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
87/** Input invalid. */
88#define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
89/** Allocation of memory failed. */
90#define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
91/** Read/write of file failed. */
92#define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
93/** Destination buffer is too small. */
94#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
95/** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */
96#define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +010097/** \} name X509 Error codes */
Paul Bakker5121ce52009-01-03 21:22:43 +000098
Paul Bakker37ca75d2011-01-06 12:28:03 +000099/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000100 * \name X509 Verify codes
101 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000102 */
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100103/* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100104#define MBEDTLS_X509_BADCERT_EXPIRED 0x01 /**< The certificate validity has expired. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105#define MBEDTLS_X509_BADCERT_REVOKED 0x02 /**< The certificate has been revoked (is on a CRL). */
106#define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04 /**< The certificate Common Name (CN) does not match with the expected CN. */
107#define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08 /**< The certificate is not correctly signed by the trusted CA. */
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100108#define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10 /**< The CRL is not correctly signed by the trusted CA. */
109#define MBEDTLS_X509_BADCRL_EXPIRED 0x20 /**< The CRL is expired. */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100110#define MBEDTLS_X509_BADCERT_MISSING 0x40 /**< Certificate was missing. */
111#define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80 /**< Certificate verification was skipped. */
112#define MBEDTLS_X509_BADCERT_OTHER 0x0100 /**< Other reason (can be used by verify callback) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113#define MBEDTLS_X509_BADCERT_FUTURE 0x0200 /**< The certificate validity starts in the future. */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100114#define MBEDTLS_X509_BADCRL_FUTURE 0x0400 /**< The CRL is from the future */
115#define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800 /**< Usage does not match the keyUsage extension. */
116#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000 /**< Usage does not match the extendedKeyUsage extension. */
117#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000 /**< Usage does not match the nsCertType extension. */
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200118#define MBEDTLS_X509_BADCERT_BAD_MD 0x4000 /**< The certificate is signed with an unacceptable hash. */
119#define MBEDTLS_X509_BADCERT_BAD_PK 0x8000 /**< The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
120#define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000 /**< The certificate is signed with an unacceptable key (eg bad curve, RSA too short). */
121#define MBEDTLS_X509_BADCRL_BAD_MD 0x020000 /**< The CRL is signed with an unacceptable hash. */
122#define MBEDTLS_X509_BADCRL_BAD_PK 0x040000 /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
123#define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000 /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */
124
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100125/** \} name X509 Verify codes */
126/** \} addtogroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +0000127
128/*
Ron Eldorb2dc3fa2019-03-21 13:40:13 +0200129 * X.509 v3 Subject Alternative Name types.
130 * otherName [0] OtherName,
131 * rfc822Name [1] IA5String,
132 * dNSName [2] IA5String,
133 * x400Address [3] ORAddress,
134 * directoryName [4] Name,
135 * ediPartyName [5] EDIPartyName,
136 * uniformResourceIdentifier [6] IA5String,
137 * iPAddress [7] OCTET STRING,
138 * registeredID [8] OBJECT IDENTIFIER
139 */
140#define MBEDTLS_X509_SAN_OTHER_NAME 0
141#define MBEDTLS_X509_SAN_RFC822_NAME 1
142#define MBEDTLS_X509_SAN_DNS_NAME 2
143#define MBEDTLS_X509_SAN_X400_ADDRESS_NAME 3
144#define MBEDTLS_X509_SAN_DIRECTORY_NAME 4
145#define MBEDTLS_X509_SAN_EDI_PARTY_NAME 5
146#define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER 6
147#define MBEDTLS_X509_SAN_IP_ADDRESS 7
148#define MBEDTLS_X509_SAN_REGISTERED_ID 8
149
150/*
Paul Bakker74111d32011-01-15 16:57:55 +0000151 * X.509 v3 Key Usage Extension flags
Przemek Stekiel21c37282023-01-16 08:47:49 +0100152 * Reminder: update mbedtls_x509_info_key_usage() when adding new flags.
Paul Bakker74111d32011-01-15 16:57:55 +0000153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154#define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
155#define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100156#define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
157#define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
158#define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159#define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
160#define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
Manuel Pégourié-Gonnard9a702252015-06-23 10:14:36 +0200161#define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
162#define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
Paul Bakker74111d32011-01-15 16:57:55 +0000163
164/*
Paul Bakker74111d32011-01-15 16:57:55 +0000165 * Netscape certificate types
166 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
167 */
168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100170#define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200171#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
172#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
173#define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100174#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
175#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
176#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
Paul Bakker74111d32011-01-15 16:57:55 +0000177
Paul Bakkerc70b9822013-04-07 22:00:46 +0200178/*
179 * X.509 extension types
Manuel Pégourié-Gonnardb28487d2014-04-01 12:19:09 +0200180 *
181 * Comments refer to the status for using certificates. Status can be
182 * different for writing certificates or reading CRLs or CSRs.
Manuel Pégourié-Gonnardc49ada42019-01-28 09:20:59 +0100183 *
184 * Those are defined in oid.h as oid.c needs them in a data structure. Since
185 * these were previously defined here, let's have aliases for compatibility.
Paul Bakkerc70b9822013-04-07 22:00:46 +0200186 */
Manuel Pégourié-Gonnardc49ada42019-01-28 09:20:59 +0100187#define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
188#define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
189#define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
190#define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
191#define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
192#define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
193#define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
194#define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
195#define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
196#define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
197#define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
198#define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
199#define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
200#define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
201#define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
202#define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
Paul Bakker5121ce52009-01-03 21:22:43 +0000203
Paul Bakker6c0ceb32011-12-04 12:24:18 +0000204/*
205 * Storage format identifiers
206 * Recognized formats: PEM and DER
207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#define MBEDTLS_X509_FORMAT_DER 1
209#define MBEDTLS_X509_FORMAT_PEM 2
Paul Bakker6c0ceb32011-12-04 12:24:18 +0000210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211#define MBEDTLS_X509_MAX_DN_NAME_SIZE 256 /**< Maximum value size of a DN entry */
Paul Bakker8dcb2d72014-08-08 12:22:30 +0200212
Paul Bakker407a0da2013-06-27 14:29:21 +0200213#ifdef __cplusplus
214extern "C" {
215#endif
216
Paul Bakkere5eae762013-08-26 12:05:14 +0200217/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000218 * \addtogroup x509_module
219 * \{ */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000220
221/**
Paul Bakkerf9f377e2013-09-09 15:35:10 +0200222 * \name Structures for parsing X.509 certificates, CRLs and CSRs
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000223 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000224 */
Paul Bakkere5eae762013-08-26 12:05:14 +0200225
226/**
Paul Bakker37ca75d2011-01-06 12:28:03 +0000227 * Type-length-value structure that allows for ASN1 using DER.
Paul Bakker5121ce52009-01-03 21:22:43 +0000228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229typedef mbedtls_asn1_buf mbedtls_x509_buf;
Paul Bakker5121ce52009-01-03 21:22:43 +0000230
Paul Bakker37ca75d2011-01-06 12:28:03 +0000231/**
Paul Bakker74111d32011-01-15 16:57:55 +0000232 * Container for ASN1 bit strings.
233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring;
Paul Bakker74111d32011-01-15 16:57:55 +0000235
236/**
Paul Bakkere5eae762013-08-26 12:05:14 +0200237 * Container for ASN1 named information objects.
Manuel Pégourié-Gonnard83b04de2015-03-09 17:33:07 +0000238 * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.).
Paul Bakker37ca75d2011-01-06 12:28:03 +0000239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240typedef mbedtls_asn1_named_data mbedtls_x509_name;
Paul Bakker5121ce52009-01-03 21:22:43 +0000241
Paul Bakker74111d32011-01-15 16:57:55 +0000242/**
243 * Container for a sequence of ASN.1 items
244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245typedef mbedtls_asn1_sequence mbedtls_x509_sequence;
Paul Bakker74111d32011-01-15 16:57:55 +0000246
toth92ga41954d2021-02-12 16:11:17 +0100247/*
248 * Container for the fields of the Authority Key Identifier object
249 */
250typedef struct mbedtls_x509_authority {
251 mbedtls_x509_buf keyIdentifier;
toth92g8d435a02021-05-10 15:16:33 +0200252 mbedtls_x509_sequence authorityCertIssuer;
toth92ga41954d2021-02-12 16:11:17 +0100253 mbedtls_x509_buf authorityCertSerialNumber;
254 mbedtls_x509_buf raw;
255}
256mbedtls_x509_authority;
257
Paul Bakker37ca75d2011-01-06 12:28:03 +0000258/** Container for date and time (precision in seconds). */
Gilles Peskine449bd832023-01-11 14:50:10 +0100259typedef struct mbedtls_x509_time {
Gilles Peskine842edf42021-08-04 21:56:10 +0200260 int year, mon, day; /**< Date. */
261 int hour, min, sec; /**< Time. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000262}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263mbedtls_x509_time;
Paul Bakker5121ce52009-01-03 21:22:43 +0000264
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100265/**
266 * From RFC 5280 section 4.2.1.6:
267 * OtherName ::= SEQUENCE {
268 * type-id OBJECT IDENTIFIER,
269 * value [0] EXPLICIT ANY DEFINED BY type-id }
270 *
271 * Future versions of the library may add new fields to this structure or
272 * to its embedded union and structure.
273 */
274typedef struct mbedtls_x509_san_other_name {
275 /**
276 * The type_id is an OID as defined in RFC 5280.
277 * To check the value of the type id, you should use
278 * \p MBEDTLS_OID_CMP with a known OID mbedtls_x509_buf.
279 */
280 mbedtls_x509_buf type_id; /**< The type id. */
281 union {
282 /**
283 * From RFC 4108 section 5:
284 * HardwareModuleName ::= SEQUENCE {
285 * hwType OBJECT IDENTIFIER,
286 * hwSerialNum OCTET STRING }
287 */
288 struct {
289 mbedtls_x509_buf oid; /**< The object identifier. */
290 mbedtls_x509_buf val; /**< The named value. */
291 }
292 hardware_module_name;
293 }
294 value;
295}
296mbedtls_x509_san_other_name;
297
298/**
299 * A structure for holding the parsed Subject Alternative Name,
300 * according to type.
301 *
302 * Future versions of the library may add new fields to this structure or
303 * to its embedded union and structure.
304 */
305typedef struct mbedtls_x509_subject_alternative_name {
306 int type; /**< The SAN type, value of MBEDTLS_X509_SAN_XXX. */
307 union {
308 mbedtls_x509_san_other_name other_name; /**< The otherName supported type. */
Andrzej Kureke12b01d2023-01-10 06:47:38 -0500309 mbedtls_x509_name directory_name;
310 mbedtls_x509_buf unstructured_name; /**< The buffer for the unstructured types. rfc822Name, dnsName and uniformResourceIdentifier are currently supported. */
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100311 }
312 san; /**< A union of the supported SAN types */
313}
314mbedtls_x509_subject_alternative_name;
315
Paul Bakkerf9f377e2013-09-09 15:35:10 +0200316/** \} name Structures for parsing X.509 certificates, CRLs and CSRs */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000317
Paul Bakker37ca75d2011-01-06 12:28:03 +0000318/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000319 * \brief Store the certificate DN in printable form into buf;
Paul Bakkerd98030e2009-05-02 15:13:40 +0000320 * no more than size characters will be written.
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000321 *
322 * \param buf Buffer to write to
323 * \param size Maximum size of buffer
324 * \param dn The X509 name to represent
325 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200326 * \return The length of the string written (not including the
327 * terminated nul byte), or a negative error code.
Paul Bakker5121ce52009-01-03 21:22:43 +0000328 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100329int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn);
Paul Bakker5121ce52009-01-03 21:22:43 +0000330
331/**
Werner Lewisb3acb052022-06-17 15:59:58 +0100332 * \brief Return the next relative DN in an X509 name.
333 *
Glenn Strauss01d2f522022-06-27 14:12:44 -0400334 * \note Intended use is to compare function result to dn->next
335 * in order to detect boundaries of multi-valued RDNs.
336 *
Werner Lewisb3acb052022-06-17 15:59:58 +0100337 * \param dn Current node in the X509 name
338 *
339 * \return Pointer to the first attribute-value pair of the
340 * next RDN in sequence, or NULL if end is reached.
341 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100342static inline mbedtls_x509_name *mbedtls_x509_dn_get_next(
343 mbedtls_x509_name *dn)
Glenn Strauss01d2f522022-06-27 14:12:44 -0400344{
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 while (dn->MBEDTLS_PRIVATE(next_merged) && dn->next != NULL) {
Glenn Strauss01d2f522022-06-27 14:12:44 -0400346 dn = dn->next;
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 }
348 return dn->next;
Glenn Strauss01d2f522022-06-27 14:12:44 -0400349}
Werner Lewisb3acb052022-06-17 15:59:58 +0100350
351/**
Paul Bakkerdd476992011-01-16 21:34:59 +0000352 * \brief Store the certificate serial in printable form into buf;
353 * no more than size characters will be written.
354 *
355 * \param buf Buffer to write to
356 * \param size Maximum size of buffer
357 * \param serial The X509 serial to represent
358 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200359 * \return The length of the string written (not including the
360 * terminated nul byte), or a negative error code.
Paul Bakkerdd476992011-01-16 21:34:59 +0000361 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100362int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial);
Paul Bakkerdd476992011-01-16 21:34:59 +0000363
364/**
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200365 * \brief Check a given mbedtls_x509_time against the system time
366 * and tell if it's in the past.
367 *
368 * \note Intended usage is "if( is_past( valid_to ) ) ERROR".
369 * Hence the return value of 1 if on internal errors.
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000370 *
Hanno Becker61937d42017-04-26 15:01:23 +0100371 * \param to mbedtls_x509_time to check
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000372 *
Antonin Décimo36e89b52019-01-23 15:24:37 +0100373 * \return 1 if the given time is in the past or an error occurred,
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200374 * 0 otherwise.
Paul Bakker5121ce52009-01-03 21:22:43 +0000375 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100376int mbedtls_x509_time_is_past(const mbedtls_x509_time *to);
Paul Bakker5121ce52009-01-03 21:22:43 +0000377
378/**
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200379 * \brief Check a given mbedtls_x509_time against the system time
380 * and tell if it's in the future.
381 *
382 * \note Intended usage is "if( is_future( valid_from ) ) ERROR".
383 * Hence the return value of 1 if on internal errors.
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100384 *
Hanno Becker61937d42017-04-26 15:01:23 +0100385 * \param from mbedtls_x509_time to check
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100386 *
Antonin Décimo36e89b52019-01-23 15:24:37 +0100387 * \return 1 if the given time is in the future or an error occurred,
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200388 * 0 otherwise.
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100389 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100390int mbedtls_x509_time_is_future(const mbedtls_x509_time *from);
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100391
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100392/**
393 * \brief This function parses an item in the SubjectAlternativeNames
Andrzej Kurek5f0c6e82023-02-27 16:03:41 -0500394 * extension. Please note that this function might allocate
395 * additional memory for a subject alternative name, thus
396 * mbedtls_x509_free_subject_alt_name has to be called
Andrzej Kurekc27ba3a2023-03-06 10:48:30 +0100397 * to dispose of this additional memory afterwards.
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100398 *
399 * \param san_buf The buffer holding the raw data item of the subject
400 * alternative name.
401 * \param san The target structure to populate with the parsed presentation
402 * of the subject alternative name encoded in \p san_raw.
403 *
Andrzej Kurek81b0b892023-02-16 06:55:10 -0500404 * \note Supported GeneralName types, as defined in RFC 5280:
Przemek Stekielecee12f2023-02-09 14:43:49 +0100405 * "rfc822Name", "dnsName", "uniformResourceIdentifier" and "hardware_module_name"
Andrzej Kurek81b0b892023-02-16 06:55:10 -0500406 * of type "otherName", as defined in RFC 4108.
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100407 *
408 * \note This function should be called on a single raw data of
409 * subject alternative name. For example, after successful
410 * certificate parsing, one must iterate on every item in the
411 * \p crt->subject_alt_names sequence, and pass it to
412 * this function.
413 *
414 * \warning The target structure contains pointers to the raw data of the
415 * parsed certificate, and its lifetime is restricted by the
416 * lifetime of the certificate.
417 *
418 * \return \c 0 on success
419 * \return #MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE for an unsupported
420 * SAN type.
421 * \return Another negative value for any other failure.
422 */
423int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf,
424 mbedtls_x509_subject_alternative_name *san);
Andrzej Kurekd40c2b62023-02-13 07:01:59 -0500425/**
426 * \brief Unallocate all data related to subject alternative name
427 *
Andrzej Kurekc27ba3a2023-03-06 10:48:30 +0100428 * \param san SAN structure - extra memory owned by this structure will be freed
Andrzej Kurekd40c2b62023-02-13 07:01:59 -0500429 */
430void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san);
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100431
Andrzej Kureka0defed2021-12-30 12:33:31 +0100432/** \} addtogroup x509_module */
433
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200434/*
Paul Bakker86d0c192013-09-18 11:11:02 +0200435 * Internal module functions. You probably do not want to use these unless you
436 * know you do.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200437 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100438int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end,
439 mbedtls_x509_name *cur);
440int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end,
441 mbedtls_x509_buf *alg);
442int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end,
443 mbedtls_x509_buf *alg, mbedtls_x509_buf *params);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200444#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
Gilles Peskine449bd832023-01-11 14:50:10 +0100445int mbedtls_x509_get_rsassa_pss_params(const mbedtls_x509_buf *params,
446 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
447 int *salt_len);
Manuel Pégourié-Gonnard9df5c962014-01-24 14:37:29 +0100448#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100449int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig);
450int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
451 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
452 void **sig_opts);
453int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end,
454 mbedtls_x509_time *t);
455int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end,
456 mbedtls_x509_buf *serial);
457int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end,
458 mbedtls_x509_buf *ext, int tag);
Hanno Becker612a2f12020-10-09 09:19:39 +0100459#if !defined(MBEDTLS_X509_REMOVE_INFO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100460int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
461 mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
462 const void *sig_opts);
Peter Kolbus9a969b62018-12-11 13:55:56 -0600463#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100464int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name);
465int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name);
466int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
467 int critical, const unsigned char *val,
468 size_t val_len);
469int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start,
470 mbedtls_asn1_named_data *first);
471int mbedtls_x509_write_names(unsigned char **p, unsigned char *start,
472 mbedtls_asn1_named_data *first);
473int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start,
474 const char *oid, size_t oid_len,
475 unsigned char *sig, size_t size);
Przemek Stekiel21c37282023-01-16 08:47:49 +0100476int mbedtls_x509_get_ns_cert_type(unsigned char **p,
477 const unsigned char *end,
478 unsigned char *ns_cert_type);
479int mbedtls_x509_get_key_usage(unsigned char **p,
480 const unsigned char *end,
481 unsigned int *key_usage);
482int mbedtls_x509_get_subject_alt_name(unsigned char **p,
483 const unsigned char *end,
484 mbedtls_x509_sequence *subject_alt_name);
Przemek Stekiel21903ec2023-02-21 08:32:37 +0100485int mbedtls_x509_get_subject_alt_name_ext(unsigned char **p,
486 const unsigned char *end,
487 mbedtls_x509_sequence *subject_alt_name);
Przemek Stekiel21c37282023-01-16 08:47:49 +0100488int mbedtls_x509_info_subject_alt_name(char **buf, size_t *size,
489 const mbedtls_x509_sequence
490 *subject_alt_name,
491 const char *prefix);
492int mbedtls_x509_info_cert_type(char **buf, size_t *size,
493 unsigned char ns_cert_type);
494int mbedtls_x509_info_key_usage(char **buf, size_t *size,
495 unsigned int key_usage);
Paul Bakker30b95fa2013-10-01 10:09:06 +0200496
Manuel Pégourié-Gonnard16853682015-06-22 11:12:02 +0200497#define MBEDTLS_X509_SAFE_SNPRINTF \
498 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 if (ret < 0 || (size_t) ret >= n) \
500 return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL; \
501 \
Manuel Pégourié-Gonnard16853682015-06-22 11:12:02 +0200502 n -= (size_t) ret; \
503 p += (size_t) ret; \
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 } while (0)
Manuel Pégourié-Gonnard16853682015-06-22 11:12:02 +0200505
Paul Bakker30b95fa2013-10-01 10:09:06 +0200506#ifdef __cplusplus
507}
508#endif
509
Paul Bakker5121ce52009-01-03 21:22:43 +0000510#endif /* x509.h */