blob: a9267c791e8393542883963c6e89ec86998a128b [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"
Paul Bakker5121ce52009-01-03 21:22:43 +000030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_RSA_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010032#include "mbedtls/rsa.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020033#endif
34
35/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000036 * \addtogroup x509_module
Paul Bakker7c6b2c32013-09-16 13:49:26 +020037 * \{
Paul Bakker13e2dfe2009-07-28 07:18:38 +000038 */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040#if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +010041/**
42 * Maximum number of intermediate CAs in a verification chain.
43 * That is, maximum length of the chain, excluding the end-entity certificate
44 * and the trusted root certificate.
45 *
46 * Set this to a low value to prevent an adversary from making you waste
47 * resources verifying an overlong certificate chain.
48 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +010050#endif
51
Paul Bakker7c6b2c32013-09-16 13:49:26 +020052/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000053 * \name X509 Error codes
54 * \{
Paul Bakker13e2dfe2009-07-28 07:18:38 +000055 */
Gilles Peskined2971572021-07-26 18:48:10 +020056/** Unavailable feature, e.g. RSA hashing/encryption combination. */
57#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
58/** Requested OID is unknown. */
59#define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
60/** The CRT/CRL/CSR format is invalid, e.g. different type expected. */
61#define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
62/** The CRT/CRL/CSR version element is invalid. */
63#define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
64/** The serial tag or value is invalid. */
65#define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
66/** The algorithm tag or value is invalid. */
67#define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
68/** The name tag or value is invalid. */
69#define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
70/** The date tag or value is invalid. */
71#define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
72/** The signature tag or value invalid. */
73#define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
74/** The extension tag or value is invalid. */
75#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
76/** CRT/CRL/CSR has an unsupported version number. */
77#define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
78/** Signature algorithm (oid) is unsupported. */
79#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
80/** Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */
81#define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
82/** Certificate verification failed, e.g. CRL, CA or signature check failed. */
83#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
84/** Format not recognized as DER or PEM. */
85#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
86/** Input invalid. */
87#define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
88/** Allocation of memory failed. */
89#define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
90/** Read/write of file failed. */
91#define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
92/** Destination buffer is too small. */
93#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
94/** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */
95#define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +010096/** \} name X509 Error codes */
Paul Bakker5121ce52009-01-03 21:22:43 +000097
Paul Bakker37ca75d2011-01-06 12:28:03 +000098/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000099 * \name X509 Verify codes
100 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000101 */
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100102/* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100103#define MBEDTLS_X509_BADCERT_EXPIRED 0x01 /**< The certificate validity has expired. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200104#define MBEDTLS_X509_BADCERT_REVOKED 0x02 /**< The certificate has been revoked (is on a CRL). */
105#define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04 /**< The certificate Common Name (CN) does not match with the expected CN. */
106#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 +0100107#define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10 /**< The CRL is not correctly signed by the trusted CA. */
108#define MBEDTLS_X509_BADCRL_EXPIRED 0x20 /**< The CRL is expired. */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100109#define MBEDTLS_X509_BADCERT_MISSING 0x40 /**< Certificate was missing. */
110#define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80 /**< Certificate verification was skipped. */
111#define MBEDTLS_X509_BADCERT_OTHER 0x0100 /**< Other reason (can be used by verify callback) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112#define MBEDTLS_X509_BADCERT_FUTURE 0x0200 /**< The certificate validity starts in the future. */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100113#define MBEDTLS_X509_BADCRL_FUTURE 0x0400 /**< The CRL is from the future */
114#define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800 /**< Usage does not match the keyUsage extension. */
115#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000 /**< Usage does not match the extendedKeyUsage extension. */
116#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000 /**< Usage does not match the nsCertType extension. */
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200117#define MBEDTLS_X509_BADCERT_BAD_MD 0x4000 /**< The certificate is signed with an unacceptable hash. */
118#define MBEDTLS_X509_BADCERT_BAD_PK 0x8000 /**< The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
119#define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000 /**< The certificate is signed with an unacceptable key (eg bad curve, RSA too short). */
120#define MBEDTLS_X509_BADCRL_BAD_MD 0x020000 /**< The CRL is signed with an unacceptable hash. */
121#define MBEDTLS_X509_BADCRL_BAD_PK 0x040000 /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
122#define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000 /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */
123
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100124/** \} name X509 Verify codes */
125/** \} addtogroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +0000126
127/*
Ron Eldorb2dc3fa2019-03-21 13:40:13 +0200128 * X.509 v3 Subject Alternative Name types.
129 * otherName [0] OtherName,
130 * rfc822Name [1] IA5String,
131 * dNSName [2] IA5String,
132 * x400Address [3] ORAddress,
133 * directoryName [4] Name,
134 * ediPartyName [5] EDIPartyName,
135 * uniformResourceIdentifier [6] IA5String,
136 * iPAddress [7] OCTET STRING,
137 * registeredID [8] OBJECT IDENTIFIER
138 */
139#define MBEDTLS_X509_SAN_OTHER_NAME 0
140#define MBEDTLS_X509_SAN_RFC822_NAME 1
141#define MBEDTLS_X509_SAN_DNS_NAME 2
142#define MBEDTLS_X509_SAN_X400_ADDRESS_NAME 3
143#define MBEDTLS_X509_SAN_DIRECTORY_NAME 4
144#define MBEDTLS_X509_SAN_EDI_PARTY_NAME 5
145#define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER 6
146#define MBEDTLS_X509_SAN_IP_ADDRESS 7
147#define MBEDTLS_X509_SAN_REGISTERED_ID 8
148
149/*
Paul Bakker74111d32011-01-15 16:57:55 +0000150 * X.509 v3 Key Usage Extension flags
Przemek Stekiel21c37282023-01-16 08:47:49 +0100151 * Reminder: update mbedtls_x509_info_key_usage() when adding new flags.
Paul Bakker74111d32011-01-15 16:57:55 +0000152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153#define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
154#define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100155#define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
156#define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
157#define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200158#define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
159#define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
Manuel Pégourié-Gonnard9a702252015-06-23 10:14:36 +0200160#define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
161#define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
Paul Bakker74111d32011-01-15 16:57:55 +0000162
163/*
Paul Bakker74111d32011-01-15 16:57:55 +0000164 * Netscape certificate types
165 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
166 */
167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200168#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100169#define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
171#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
172#define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +0100173#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
174#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
175#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
Paul Bakker74111d32011-01-15 16:57:55 +0000176
Paul Bakkerc70b9822013-04-07 22:00:46 +0200177/*
178 * X.509 extension types
Manuel Pégourié-Gonnardb28487d2014-04-01 12:19:09 +0200179 *
180 * Comments refer to the status for using certificates. Status can be
181 * different for writing certificates or reading CRLs or CSRs.
Manuel Pégourié-Gonnardc49ada42019-01-28 09:20:59 +0100182 *
183 * Those are defined in oid.h as oid.c needs them in a data structure. Since
184 * these were previously defined here, let's have aliases for compatibility.
Paul Bakkerc70b9822013-04-07 22:00:46 +0200185 */
Manuel Pégourié-Gonnardc49ada42019-01-28 09:20:59 +0100186#define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
187#define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
188#define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
189#define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
190#define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
191#define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
192#define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
193#define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
194#define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
195#define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
196#define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
197#define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
198#define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
199#define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
200#define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
201#define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
Paul Bakker5121ce52009-01-03 21:22:43 +0000202
Paul Bakker6c0ceb32011-12-04 12:24:18 +0000203/*
204 * Storage format identifiers
205 * Recognized formats: PEM and DER
206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207#define MBEDTLS_X509_FORMAT_DER 1
208#define MBEDTLS_X509_FORMAT_PEM 2
Paul Bakker6c0ceb32011-12-04 12:24:18 +0000209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#define MBEDTLS_X509_MAX_DN_NAME_SIZE 256 /**< Maximum value size of a DN entry */
Paul Bakker8dcb2d72014-08-08 12:22:30 +0200211
Paul Bakker407a0da2013-06-27 14:29:21 +0200212#ifdef __cplusplus
213extern "C" {
214#endif
215
Paul Bakkere5eae762013-08-26 12:05:14 +0200216/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000217 * \addtogroup x509_module
218 * \{ */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000219
220/**
Paul Bakkerf9f377e2013-09-09 15:35:10 +0200221 * \name Structures for parsing X.509 certificates, CRLs and CSRs
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000222 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000223 */
Paul Bakkere5eae762013-08-26 12:05:14 +0200224
225/**
Paul Bakker37ca75d2011-01-06 12:28:03 +0000226 * Type-length-value structure that allows for ASN1 using DER.
Paul Bakker5121ce52009-01-03 21:22:43 +0000227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200228typedef mbedtls_asn1_buf mbedtls_x509_buf;
Paul Bakker5121ce52009-01-03 21:22:43 +0000229
Paul Bakker37ca75d2011-01-06 12:28:03 +0000230/**
Paul Bakker74111d32011-01-15 16:57:55 +0000231 * Container for ASN1 bit strings.
232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring;
Paul Bakker74111d32011-01-15 16:57:55 +0000234
235/**
Paul Bakkere5eae762013-08-26 12:05:14 +0200236 * Container for ASN1 named information objects.
Manuel Pégourié-Gonnard83b04de2015-03-09 17:33:07 +0000237 * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.).
Paul Bakker37ca75d2011-01-06 12:28:03 +0000238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239typedef mbedtls_asn1_named_data mbedtls_x509_name;
Paul Bakker5121ce52009-01-03 21:22:43 +0000240
Paul Bakker74111d32011-01-15 16:57:55 +0000241/**
242 * Container for a sequence of ASN.1 items
243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244typedef mbedtls_asn1_sequence mbedtls_x509_sequence;
Paul Bakker74111d32011-01-15 16:57:55 +0000245
toth92ga41954d2021-02-12 16:11:17 +0100246/*
247 * Container for the fields of the Authority Key Identifier object
248 */
249typedef struct mbedtls_x509_authority {
250 mbedtls_x509_buf keyIdentifier;
toth92g8d435a02021-05-10 15:16:33 +0200251 mbedtls_x509_sequence authorityCertIssuer;
toth92ga41954d2021-02-12 16:11:17 +0100252 mbedtls_x509_buf authorityCertSerialNumber;
253 mbedtls_x509_buf raw;
254}
255mbedtls_x509_authority;
256
Paul Bakker37ca75d2011-01-06 12:28:03 +0000257/** Container for date and time (precision in seconds). */
Gilles Peskine449bd832023-01-11 14:50:10 +0100258typedef struct mbedtls_x509_time {
Gilles Peskine842edf42021-08-04 21:56:10 +0200259 int year, mon, day; /**< Date. */
260 int hour, min, sec; /**< Time. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000261}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262mbedtls_x509_time;
Paul Bakker5121ce52009-01-03 21:22:43 +0000263
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100264/**
265 * From RFC 5280 section 4.2.1.6:
266 * OtherName ::= SEQUENCE {
267 * type-id OBJECT IDENTIFIER,
268 * value [0] EXPLICIT ANY DEFINED BY type-id }
269 *
270 * Future versions of the library may add new fields to this structure or
271 * to its embedded union and structure.
272 */
273typedef struct mbedtls_x509_san_other_name {
274 /**
275 * The type_id is an OID as defined in RFC 5280.
276 * To check the value of the type id, you should use
277 * \p MBEDTLS_OID_CMP with a known OID mbedtls_x509_buf.
278 */
279 mbedtls_x509_buf type_id; /**< The type id. */
280 union {
281 /**
282 * From RFC 4108 section 5:
283 * HardwareModuleName ::= SEQUENCE {
284 * hwType OBJECT IDENTIFIER,
285 * hwSerialNum OCTET STRING }
286 */
287 struct {
288 mbedtls_x509_buf oid; /**< The object identifier. */
289 mbedtls_x509_buf val; /**< The named value. */
290 }
291 hardware_module_name;
292 }
293 value;
294}
295mbedtls_x509_san_other_name;
296
297/**
298 * A structure for holding the parsed Subject Alternative Name,
299 * according to type.
300 *
301 * Future versions of the library may add new fields to this structure or
302 * to its embedded union and structure.
303 */
304typedef struct mbedtls_x509_subject_alternative_name {
305 int type; /**< The SAN type, value of MBEDTLS_X509_SAN_XXX. */
306 union {
Andrzej Kurek17473042023-04-30 14:11:23 -0400307 mbedtls_x509_san_other_name other_name;
Andrzej Kureke12b01d2023-01-10 06:47:38 -0500308 mbedtls_x509_name directory_name;
309 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 +0100310 }
311 san; /**< A union of the supported SAN types */
312}
313mbedtls_x509_subject_alternative_name;
314
Andrzej Kurek1a752692023-04-01 09:44:11 -0400315typedef struct mbedtls_x509_san_list {
316 mbedtls_x509_subject_alternative_name node;
317 struct mbedtls_x509_san_list *next;
318}
319mbedtls_x509_san_list;
320
Paul Bakkerf9f377e2013-09-09 15:35:10 +0200321/** \} name Structures for parsing X.509 certificates, CRLs and CSRs */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000322
Paul Bakker37ca75d2011-01-06 12:28:03 +0000323/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000324 * \brief Store the certificate DN in printable form into buf;
Paul Bakkerd98030e2009-05-02 15:13:40 +0000325 * no more than size characters will be written.
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000326 *
327 * \param buf Buffer to write to
328 * \param size Maximum size of buffer
329 * \param dn The X509 name to represent
330 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200331 * \return The length of the string written (not including the
332 * terminated nul byte), or a negative error code.
Paul Bakker5121ce52009-01-03 21:22:43 +0000333 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100334int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn);
Paul Bakker5121ce52009-01-03 21:22:43 +0000335
336/**
Werner Lewisb3acb052022-06-17 15:59:58 +0100337 * \brief Return the next relative DN in an X509 name.
338 *
Glenn Strauss01d2f522022-06-27 14:12:44 -0400339 * \note Intended use is to compare function result to dn->next
340 * in order to detect boundaries of multi-valued RDNs.
341 *
Werner Lewisb3acb052022-06-17 15:59:58 +0100342 * \param dn Current node in the X509 name
343 *
344 * \return Pointer to the first attribute-value pair of the
345 * next RDN in sequence, or NULL if end is reached.
346 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100347static inline mbedtls_x509_name *mbedtls_x509_dn_get_next(
348 mbedtls_x509_name *dn)
Glenn Strauss01d2f522022-06-27 14:12:44 -0400349{
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 while (dn->MBEDTLS_PRIVATE(next_merged) && dn->next != NULL) {
Glenn Strauss01d2f522022-06-27 14:12:44 -0400351 dn = dn->next;
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 }
353 return dn->next;
Glenn Strauss01d2f522022-06-27 14:12:44 -0400354}
Werner Lewisb3acb052022-06-17 15:59:58 +0100355
356/**
Paul Bakkerdd476992011-01-16 21:34:59 +0000357 * \brief Store the certificate serial in printable form into buf;
358 * no more than size characters will be written.
359 *
360 * \param buf Buffer to write to
361 * \param size Maximum size of buffer
362 * \param serial The X509 serial to represent
363 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200364 * \return The length of the string written (not including the
365 * terminated nul byte), or a negative error code.
Paul Bakkerdd476992011-01-16 21:34:59 +0000366 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100367int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial);
Paul Bakkerdd476992011-01-16 21:34:59 +0000368
369/**
Glenn Strauss416dc032022-06-30 00:38:53 -0400370 * \brief Compare pair of mbedtls_x509_time.
371 *
372 * \param t1 mbedtls_x509_time to compare
373 * \param t2 mbedtls_x509_time to compare
374 *
375 * \return < 0 if t1 is before t2
376 * 0 if t1 equals t2
377 * > 0 if t1 is after t2
378 */
379int mbedtls_x509_time_cmp(const mbedtls_x509_time *t1, const mbedtls_x509_time *t2);
380
Glenn Strauss61d99302022-06-30 05:25:56 -0400381#if defined(MBEDTLS_HAVE_TIME_DATE)
382/**
383 * \brief Fill mbedtls_x509_time with provided mbedtls_time_t.
384 *
385 * \param tt mbedtls_time_t to convert
386 * \param now mbedtls_x509_time to fill with converted mbedtls_time_t
387 *
388 * \return \c 0 on success
389 * \return A non-zero return value on failure.
390 */
391int mbedtls_x509_time_gmtime(mbedtls_time_t tt, mbedtls_x509_time *now);
392#endif /* MBEDTLS_HAVE_TIME_DATE */
393
Glenn Strauss416dc032022-06-30 00:38:53 -0400394/**
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200395 * \brief Check a given mbedtls_x509_time against the system time
396 * and tell if it's in the past.
397 *
398 * \note Intended usage is "if( is_past( valid_to ) ) ERROR".
399 * Hence the return value of 1 if on internal errors.
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000400 *
Hanno Becker61937d42017-04-26 15:01:23 +0100401 * \param to mbedtls_x509_time to check
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000402 *
Antonin Décimo36e89b52019-01-23 15:24:37 +0100403 * \return 1 if the given time is in the past or an error occurred,
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200404 * 0 otherwise.
Paul Bakker5121ce52009-01-03 21:22:43 +0000405 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406int mbedtls_x509_time_is_past(const mbedtls_x509_time *to);
Paul Bakker5121ce52009-01-03 21:22:43 +0000407
408/**
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200409 * \brief Check a given mbedtls_x509_time against the system time
410 * and tell if it's in the future.
411 *
412 * \note Intended usage is "if( is_future( valid_from ) ) ERROR".
413 * Hence the return value of 1 if on internal errors.
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100414 *
Hanno Becker61937d42017-04-26 15:01:23 +0100415 * \param from mbedtls_x509_time to check
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100416 *
Antonin Décimo36e89b52019-01-23 15:24:37 +0100417 * \return 1 if the given time is in the future or an error occurred,
Manuel Pégourié-Gonnarde7e89842015-06-22 19:15:32 +0200418 * 0 otherwise.
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100419 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100420int mbedtls_x509_time_is_future(const mbedtls_x509_time *from);
Manuel Pégourié-Gonnard6304f782014-03-10 12:26:11 +0100421
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100422/**
423 * \brief This function parses an item in the SubjectAlternativeNames
Andrzej Kurek5f0c6e82023-02-27 16:03:41 -0500424 * extension. Please note that this function might allocate
425 * additional memory for a subject alternative name, thus
426 * mbedtls_x509_free_subject_alt_name has to be called
Andrzej Kurekc27ba3a2023-03-06 10:48:30 +0100427 * to dispose of this additional memory afterwards.
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100428 *
429 * \param san_buf The buffer holding the raw data item of the subject
430 * alternative name.
431 * \param san The target structure to populate with the parsed presentation
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -0500432 * of the subject alternative name encoded in \p san_buf.
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100433 *
Andrzej Kurek81b0b892023-02-16 06:55:10 -0500434 * \note Supported GeneralName types, as defined in RFC 5280:
Andrzej Kurek17473042023-04-30 14:11:23 -0400435 * "rfc822Name", "dnsName", "directoryName",
436 * "uniformResourceIdentifier" and "hardware_module_name"
Andrzej Kurek81b0b892023-02-16 06:55:10 -0500437 * of type "otherName", as defined in RFC 4108.
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100438 *
439 * \note This function should be called on a single raw data of
440 * subject alternative name. For example, after successful
441 * certificate parsing, one must iterate on every item in the
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -0500442 * \c crt->subject_alt_names sequence, and pass it to
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100443 * this function.
444 *
445 * \warning The target structure contains pointers to the raw data of the
446 * parsed certificate, and its lifetime is restricted by the
447 * lifetime of the certificate.
448 *
449 * \return \c 0 on success
450 * \return #MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE for an unsupported
451 * SAN type.
452 * \return Another negative value for any other failure.
453 */
454int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf,
455 mbedtls_x509_subject_alternative_name *san);
Andrzej Kurekd40c2b62023-02-13 07:01:59 -0500456/**
457 * \brief Unallocate all data related to subject alternative name
458 *
Andrzej Kurekc27ba3a2023-03-06 10:48:30 +0100459 * \param san SAN structure - extra memory owned by this structure will be freed
Andrzej Kurekd40c2b62023-02-13 07:01:59 -0500460 */
461void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san);
Przemek Stekielcf6ff0f2023-01-17 10:26:40 +0100462
Andrzej Kureka0defed2021-12-30 12:33:31 +0100463/** \} addtogroup x509_module */
464
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200465/*
Paul Bakker86d0c192013-09-18 11:11:02 +0200466 * Internal module functions. You probably do not want to use these unless you
467 * know you do.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200468 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100469int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end,
470 mbedtls_x509_name *cur);
471int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end,
472 mbedtls_x509_buf *alg);
473int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end,
474 mbedtls_x509_buf *alg, mbedtls_x509_buf *params);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
Gilles Peskine449bd832023-01-11 14:50:10 +0100476int mbedtls_x509_get_rsassa_pss_params(const mbedtls_x509_buf *params,
477 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
478 int *salt_len);
Manuel Pégourié-Gonnard9df5c962014-01-24 14:37:29 +0100479#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100480int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig);
481int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
482 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
483 void **sig_opts);
484int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end,
485 mbedtls_x509_time *t);
486int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end,
487 mbedtls_x509_buf *serial);
488int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end,
489 mbedtls_x509_buf *ext, int tag);
Hanno Becker612a2f12020-10-09 09:19:39 +0100490#if !defined(MBEDTLS_X509_REMOVE_INFO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100491int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
492 mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
493 const void *sig_opts);
Peter Kolbus9a969b62018-12-11 13:55:56 -0600494#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100495int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name);
496int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name);
497int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
498 int critical, const unsigned char *val,
499 size_t val_len);
500int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start,
501 mbedtls_asn1_named_data *first);
502int mbedtls_x509_write_names(unsigned char **p, unsigned char *start,
503 mbedtls_asn1_named_data *first);
504int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start,
505 const char *oid, size_t oid_len,
Marek Jansta8bde6492022-11-07 12:38:38 +0100506 unsigned char *sig, size_t size,
507 mbedtls_pk_type_t pk_alg);
Przemek Stekiel21c37282023-01-16 08:47:49 +0100508int mbedtls_x509_get_ns_cert_type(unsigned char **p,
509 const unsigned char *end,
510 unsigned char *ns_cert_type);
511int mbedtls_x509_get_key_usage(unsigned char **p,
512 const unsigned char *end,
513 unsigned int *key_usage);
514int mbedtls_x509_get_subject_alt_name(unsigned char **p,
515 const unsigned char *end,
516 mbedtls_x509_sequence *subject_alt_name);
Przemek Stekiel21903ec2023-02-21 08:32:37 +0100517int mbedtls_x509_get_subject_alt_name_ext(unsigned char **p,
518 const unsigned char *end,
519 mbedtls_x509_sequence *subject_alt_name);
Przemek Stekiel21c37282023-01-16 08:47:49 +0100520int mbedtls_x509_info_subject_alt_name(char **buf, size_t *size,
521 const mbedtls_x509_sequence
522 *subject_alt_name,
523 const char *prefix);
524int mbedtls_x509_info_cert_type(char **buf, size_t *size,
525 unsigned char ns_cert_type);
526int mbedtls_x509_info_key_usage(char **buf, size_t *size,
527 unsigned int key_usage);
Paul Bakker30b95fa2013-10-01 10:09:06 +0200528
Andrzej Kurekc508dc22023-07-07 08:20:02 -0400529int mbedtls_x509_write_set_san_common(mbedtls_asn1_named_data **extensions,
530 const mbedtls_x509_san_list *san_list);
531
Andrzej Kurekcd17ecf2023-06-05 17:02:17 -0400532/**
533 * \brief This function parses a CN string as an IP address.
534 *
Andrzej Kurekc6beb3a2023-06-15 09:54:37 -0400535 * \param cn The CN string to parse. CN string MUST be null-terminated.
Andrzej Kurekcd17ecf2023-06-05 17:02:17 -0400536 * \param dst The target buffer to populate with the binary IP address.
537 * The buffer MUST be 16 bytes to save IPv6, and should be
538 * 4-byte aligned if the result will be used as struct in_addr.
539 * e.g. uint32_t dst[4]
540 *
Andrzej Kurek5d9aeba2023-05-22 15:16:05 -0400541 * \note \p cn is parsed as an IPv6 address if string contains ':',
542 * else \p cn is parsed as an IPv4 address.
Andrzej Kurekcd17ecf2023-06-05 17:02:17 -0400543 *
544 * \return Length of binary IP address; num bytes written to target.
545 * \return \c 0 on failure to parse CN string as an IP address.
546 */
547size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst);
548
Manuel Pégourié-Gonnard16853682015-06-22 11:12:02 +0200549#define MBEDTLS_X509_SAFE_SNPRINTF \
550 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 if (ret < 0 || (size_t) ret >= n) \
552 return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL; \
553 \
Manuel Pégourié-Gonnard16853682015-06-22 11:12:02 +0200554 n -= (size_t) ret; \
555 p += (size_t) ret; \
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 } while (0)
Manuel Pégourié-Gonnard16853682015-06-22 11:12:02 +0200557
Paul Bakker30b95fa2013-10-01 10:09:06 +0200558#ifdef __cplusplus
559}
560#endif
561
Paul Bakker5121ce52009-01-03 21:22:43 +0000562#endif /* x509.h */