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