blob: b63e864e3fdaeaa464a223d771ccf15b3b9d53a8 [file] [log] [blame]
Gilles Peskine458b8f22020-02-26 18:28:28 +01001/**
2 * \file x509.h
3 *
4 * \brief X.509 generic defines and structures
5 */
6/*
7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8 * 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.
21 *
22 * This file is part of mbed TLS (https://tls.mbed.org)
23 */
24#ifndef MBEDTLS_X509_H
25#define MBEDTLS_X509_H
26
27#if !defined(MBEDTLS_CONFIG_FILE)
28#include "config.h"
29#else
30#include MBEDTLS_CONFIG_FILE
31#endif
32
33#include "asn1.h"
34#include "pk.h"
35
36#if defined(MBEDTLS_RSA_C)
37#include "rsa.h"
38#endif
39
40/**
41 * \addtogroup x509_module
42 * \{
43 */
44
45#if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
46/**
47 * Maximum number of intermediate CAs in a verification chain.
48 * That is, maximum length of the chain, excluding the end-entity certificate
49 * and the trusted root certificate.
50 *
51 * Set this to a low value to prevent an adversary from making you waste
52 * resources verifying an overlong certificate chain.
53 */
54#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
55#endif
56
57/**
58 * \name X509 Error codes
59 * \{
60 */
61#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080 /**< Unavailable feature, e.g. RSA hashing/encryption combination. */
62#define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100 /**< Requested OID is unknown. */
63#define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180 /**< The CRT/CRL/CSR format is invalid, e.g. different type expected. */
64#define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200 /**< The CRT/CRL/CSR version element is invalid. */
65#define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280 /**< The serial tag or value is invalid. */
66#define MBEDTLS_ERR_X509_INVALID_ALG -0x2300 /**< The algorithm tag or value is invalid. */
67#define MBEDTLS_ERR_X509_INVALID_NAME -0x2380 /**< The name tag or value is invalid. */
68#define MBEDTLS_ERR_X509_INVALID_DATE -0x2400 /**< The date tag or value is invalid. */
69#define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480 /**< The signature tag or value invalid. */
70#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500 /**< The extension tag or value is invalid. */
71#define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580 /**< CRT/CRL/CSR has an unsupported version number. */
72#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600 /**< Signature algorithm (oid) is unsupported. */
73#define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680 /**< Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */
74#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700 /**< Certificate verification failed, e.g. CRL, CA or signature check failed. */
75#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780 /**< Format not recognized as DER or PEM. */
76#define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800 /**< Input invalid. */
77#define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880 /**< Allocation of memory failed. */
78#define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900 /**< Read/write of file failed. */
79#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980 /**< Destination buffer is too small. */
80#define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000 /**< A fatal error occurred, eg the chain is too long or the vrfy callback failed. */
81/* \} name */
82
83/**
84 * \name X509 Verify codes
85 * \{
86 */
87/* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
88#define MBEDTLS_X509_BADCERT_EXPIRED 0x01 /**< The certificate validity has expired. */
89#define MBEDTLS_X509_BADCERT_REVOKED 0x02 /**< The certificate has been revoked (is on a CRL). */
90#define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04 /**< The certificate Common Name (CN) does not match with the expected CN. */
91#define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08 /**< The certificate is not correctly signed by the trusted CA. */
92#define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10 /**< The CRL is not correctly signed by the trusted CA. */
93#define MBEDTLS_X509_BADCRL_EXPIRED 0x20 /**< The CRL is expired. */
94#define MBEDTLS_X509_BADCERT_MISSING 0x40 /**< Certificate was missing. */
95#define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80 /**< Certificate verification was skipped. */
96#define MBEDTLS_X509_BADCERT_OTHER 0x0100 /**< Other reason (can be used by verify callback) */
97#define MBEDTLS_X509_BADCERT_FUTURE 0x0200 /**< The certificate validity starts in the future. */
98#define MBEDTLS_X509_BADCRL_FUTURE 0x0400 /**< The CRL is from the future */
99#define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800 /**< Usage does not match the keyUsage extension. */
100#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000 /**< Usage does not match the extendedKeyUsage extension. */
101#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000 /**< Usage does not match the nsCertType extension. */
102#define MBEDTLS_X509_BADCERT_BAD_MD 0x4000 /**< The certificate is signed with an unacceptable hash. */
103#define MBEDTLS_X509_BADCERT_BAD_PK 0x8000 /**< The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
104#define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000 /**< The certificate is signed with an unacceptable key (eg bad curve, RSA too short). */
105#define MBEDTLS_X509_BADCRL_BAD_MD 0x020000 /**< The CRL is signed with an unacceptable hash. */
106#define MBEDTLS_X509_BADCRL_BAD_PK 0x040000 /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
107#define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000 /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */
108
109/* \} name */
110/* \} addtogroup x509_module */
111
112/*
113 * X.509 v3 Key Usage Extension flags
114 * Reminder: update x509_info_key_usage() when adding new flags.
115 */
116#define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
117#define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
118#define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
119#define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
120#define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
121#define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
122#define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
123#define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
124#define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
125
126/*
127 * Netscape certificate types
128 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
129 */
130
131#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
132#define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
133#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
134#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
135#define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
136#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
137#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
138#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
139
140/*
141 * X.509 extension types
142 *
143 * Comments refer to the status for using certificates. Status can be
144 * different for writing certificates or reading CRLs or CSRs.
145 *
146 * Those are defined in oid.h as oid.c needs them in a data structure. Since
147 * these were previously defined here, let's have aliases for compatibility.
148 */
149#define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
150#define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
151#define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
152#define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
153#define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
154#define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
155#define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
156#define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
157#define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
158#define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
159#define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
160#define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
161#define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
162#define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
163#define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
164#define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
165
166/*
167 * Storage format identifiers
168 * Recognized formats: PEM and DER
169 */
170#define MBEDTLS_X509_FORMAT_DER 1
171#define MBEDTLS_X509_FORMAT_PEM 2
172
173#define MBEDTLS_X509_MAX_DN_NAME_SIZE 256 /**< Maximum value size of a DN entry */
174
175#ifdef __cplusplus
176extern "C" {
177#endif
178
179/**
180 * \addtogroup x509_module
181 * \{ */
182
183/**
184 * \name Structures for parsing X.509 certificates, CRLs and CSRs
185 * \{
186 */
187
188/**
189 * Type-length-value structure that allows for ASN1 using DER.
190 */
191typedef mbedtls_asn1_buf mbedtls_x509_buf;
192
193/**
194 * Container for ASN1 bit strings.
195 */
196typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring;
197
198/**
199 * Container for ASN1 named information objects.
200 * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.).
201 */
202typedef mbedtls_asn1_named_data mbedtls_x509_name;
203
204/**
205 * Container for a sequence of ASN.1 items
206 */
207typedef mbedtls_asn1_sequence mbedtls_x509_sequence;
208
209/** Container for date and time (precision in seconds). */
210typedef struct mbedtls_x509_time
211{
212 int year, mon, day; /**< Date. */
213 int hour, min, sec; /**< Time. */
214}
215mbedtls_x509_time;
216
217/** \} name Structures for parsing X.509 certificates, CRLs and CSRs */
218/** \} addtogroup x509_module */
219
220/**
221 * \brief Store the certificate DN in printable form into buf;
222 * no more than size characters will be written.
223 *
224 * \param buf Buffer to write to
225 * \param size Maximum size of buffer
226 * \param dn The X509 name to represent
227 *
228 * \return The length of the string written (not including the
229 * terminated nul byte), or a negative error code.
230 */
231int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
232
233/**
234 * \brief Store the certificate serial in printable form into buf;
235 * no more than size characters will be written.
236 *
237 * \param buf Buffer to write to
238 * \param size Maximum size of buffer
239 * \param serial The X509 serial to represent
240 *
241 * \return The length of the string written (not including the
242 * terminated nul byte), or a negative error code.
243 */
244int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial );
245
246/**
247 * \brief Check a given mbedtls_x509_time against the system time
248 * and tell if it's in the past.
249 *
250 * \note Intended usage is "if( is_past( valid_to ) ) ERROR".
251 * Hence the return value of 1 if on internal errors.
252 *
253 * \param to mbedtls_x509_time to check
254 *
255 * \return 1 if the given time is in the past or an error occurred,
256 * 0 otherwise.
257 */
258int mbedtls_x509_time_is_past( const mbedtls_x509_time *to );
259
260/**
261 * \brief Check a given mbedtls_x509_time against the system time
262 * and tell if it's in the future.
263 *
264 * \note Intended usage is "if( is_future( valid_from ) ) ERROR".
265 * Hence the return value of 1 if on internal errors.
266 *
267 * \param from mbedtls_x509_time to check
268 *
269 * \return 1 if the given time is in the future or an error occurred,
270 * 0 otherwise.
271 */
272int mbedtls_x509_time_is_future( const mbedtls_x509_time *from );
273
274#if defined(MBEDTLS_SELF_TEST)
275
276/**
277 * \brief Checkup routine
278 *
279 * \return 0 if successful, or 1 if the test failed
280 */
281int mbedtls_x509_self_test( int verbose );
282
283#endif /* MBEDTLS_SELF_TEST */
284
285/*
286 * Internal module functions. You probably do not want to use these unless you
287 * know you do.
288 */
289int mbedtls_x509_get_name( unsigned char **p, const unsigned char *end,
290 mbedtls_x509_name *cur );
291int mbedtls_x509_get_alg_null( unsigned char **p, const unsigned char *end,
292 mbedtls_x509_buf *alg );
293int mbedtls_x509_get_alg( unsigned char **p, const unsigned char *end,
294 mbedtls_x509_buf *alg, mbedtls_x509_buf *params );
295#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
296int mbedtls_x509_get_rsassa_pss_params( const mbedtls_x509_buf *params,
297 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
298 int *salt_len );
299#endif
300int mbedtls_x509_get_sig( unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig );
301int mbedtls_x509_get_sig_alg( const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
302 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
303 void **sig_opts );
304int mbedtls_x509_get_time( unsigned char **p, const unsigned char *end,
305 mbedtls_x509_time *t );
306int mbedtls_x509_get_serial( unsigned char **p, const unsigned char *end,
307 mbedtls_x509_buf *serial );
308int mbedtls_x509_get_ext( unsigned char **p, const unsigned char *end,
309 mbedtls_x509_buf *ext, int tag );
310int mbedtls_x509_sig_alg_gets( char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
311 mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
312 const void *sig_opts );
313int mbedtls_x509_key_size_helper( char *buf, size_t buf_size, const char *name );
314int mbedtls_x509_string_to_names( mbedtls_asn1_named_data **head, const char *name );
315int mbedtls_x509_set_extension( mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
316 int critical, const unsigned char *val,
317 size_t val_len );
318int mbedtls_x509_write_extensions( unsigned char **p, unsigned char *start,
319 mbedtls_asn1_named_data *first );
320int mbedtls_x509_write_names( unsigned char **p, unsigned char *start,
321 mbedtls_asn1_named_data *first );
322int mbedtls_x509_write_sig( unsigned char **p, unsigned char *start,
323 const char *oid, size_t oid_len,
324 unsigned char *sig, size_t size );
325
326#define MBEDTLS_X509_SAFE_SNPRINTF \
327 do { \
328 if( ret < 0 || (size_t) ret >= n ) \
329 return( MBEDTLS_ERR_X509_BUFFER_TOO_SMALL ); \
330 \
331 n -= (size_t) ret; \
332 p += (size_t) ret; \
333 } while( 0 )
334
335#ifdef __cplusplus
336}
337#endif
338
339#endif /* x509.h */