mbed TLS v2.16.6
x509.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: GPL-2.0
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  *
24  * This file is part of mbed TLS (https://tls.mbed.org)
25  */
26 #ifndef MBEDTLS_X509_H
27 #define MBEDTLS_X509_H
28 
29 #if !defined(MBEDTLS_CONFIG_FILE)
30 #include "config.h"
31 #else
32 #include MBEDTLS_CONFIG_FILE
33 #endif
34 
35 #include "asn1.h"
36 #include "pk.h"
37 
38 #if defined(MBEDTLS_RSA_C)
39 #include "rsa.h"
40 #endif
41 
47 #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
48 
56 #define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
57 #endif
58 
63 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
64 #define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
65 #define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
66 #define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
67 #define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
68 #define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
69 #define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
70 #define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
71 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
72 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
73 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
74 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
75 #define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
76 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
77 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
78 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
79 #define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
80 #define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
81 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
82 #define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
83 /* \} name */
84 
89 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
90 #define MBEDTLS_X509_BADCERT_EXPIRED 0x01
91 #define MBEDTLS_X509_BADCERT_REVOKED 0x02
92 #define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04
93 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08
94 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10
95 #define MBEDTLS_X509_BADCRL_EXPIRED 0x20
96 #define MBEDTLS_X509_BADCERT_MISSING 0x40
97 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80
98 #define MBEDTLS_X509_BADCERT_OTHER 0x0100
99 #define MBEDTLS_X509_BADCERT_FUTURE 0x0200
100 #define MBEDTLS_X509_BADCRL_FUTURE 0x0400
101 #define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800
102 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000
103 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000
104 #define MBEDTLS_X509_BADCERT_BAD_MD 0x4000
105 #define MBEDTLS_X509_BADCERT_BAD_PK 0x8000
106 #define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000
107 #define MBEDTLS_X509_BADCRL_BAD_MD 0x020000
108 #define MBEDTLS_X509_BADCRL_BAD_PK 0x040000
109 #define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000
111 /* \} name */
112 /* \} addtogroup x509_module */
113 
114 /*
115  * X.509 v3 Key Usage Extension flags
116  * Reminder: update x509_info_key_usage() when adding new flags.
117  */
118 #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
119 #define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
120 #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
121 #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
122 #define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
123 #define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
124 #define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
125 #define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
126 #define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
127 
128 /*
129  * Netscape certificate types
130  * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
131  */
132 
133 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
134 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
135 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
136 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
137 #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
138 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
139 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
140 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
141 
142 /*
143  * X.509 extension types
144  *
145  * Comments refer to the status for using certificates. Status can be
146  * different for writing certificates or reading CRLs or CSRs.
147  */
148 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
149 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER (1 << 1)
150 #define MBEDTLS_X509_EXT_KEY_USAGE (1 << 2)
151 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES (1 << 3)
152 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS (1 << 4)
153 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME (1 << 5) /* Supported (DNS) */
154 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME (1 << 6)
155 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7)
156 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS (1 << 8) /* Supported */
157 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS (1 << 9)
158 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS (1 << 10)
159 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE (1 << 11)
160 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS (1 << 12)
161 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY (1 << 13)
162 #define MBEDTLS_X509_EXT_FRESHEST_CRL (1 << 14)
163 
164 #define MBEDTLS_X509_EXT_NS_CERT_TYPE (1 << 16)
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
175 #ifdef __cplusplus
176 extern "C" {
177 #endif
178 
192 
197 
203 
208 
210 typedef struct mbedtls_x509_time
211 {
212  int year, mon, day;
213  int hour, min, sec;
214 }
216 
231 int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
232 
244 int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial );
245 
259 
273 
274 #if defined(MBEDTLS_SELF_TEST)
275 
281 int 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  */
289 int mbedtls_x509_get_name( unsigned char **p, const unsigned char *end,
290  mbedtls_x509_name *cur );
291 int mbedtls_x509_get_alg_null( unsigned char **p, const unsigned char *end,
292  mbedtls_x509_buf *alg );
293 int 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)
296 int 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
300 int mbedtls_x509_get_sig( unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig );
301 int 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 );
304 int mbedtls_x509_get_time( unsigned char **p, const unsigned char *end,
305  mbedtls_x509_time *t );
306 int mbedtls_x509_get_serial( unsigned char **p, const unsigned char *end,
307  mbedtls_x509_buf *serial );
308 int mbedtls_x509_get_ext( unsigned char **p, const unsigned char *end,
309  mbedtls_x509_buf *ext, int tag );
310 int 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 );
313 int mbedtls_x509_key_size_helper( char *buf, size_t buf_size, const char *name );
314 int mbedtls_x509_string_to_names( mbedtls_asn1_named_data **head, const char *name );
315 int 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 );
318 int mbedtls_x509_write_extensions( unsigned char **p, unsigned char *start,
319  mbedtls_asn1_named_data *first );
320 int mbedtls_x509_write_names( unsigned char **p, unsigned char *start,
321  mbedtls_asn1_named_data *first );
322 int 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 */
int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end, mbedtls_x509_name *cur)
int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start, mbedtls_asn1_named_data *first)
mbedtls_asn1_buf mbedtls_x509_buf
Definition: x509.h:191
int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *alg, mbedtls_x509_buf *params)
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.
int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig)
int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name)
mbedtls_pk_type_t
Public key types.
Definition: pk.h:80
Configuration options (set of defines)
int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start, const char *oid, size_t oid_len, unsigned char *sig, size_t size)
int mbedtls_x509_write_names(unsigned char **p, unsigned char *start, mbedtls_asn1_named_data *first)
int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name)
Public Key abstraction layer.
int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params, mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg, void **sig_opts)
int mbedtls_x509_get_rsassa_pss_params(const mbedtls_x509_buf *params, mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md, int *salt_len)
mbedtls_asn1_sequence mbedtls_x509_sequence
Definition: x509.h:207
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...
Generic ASN.1 parsing.
struct mbedtls_x509_time mbedtls_x509_time
int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid, mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg, const void *sig_opts)
mbedtls_asn1_bitstring mbedtls_x509_bitstring
Definition: x509.h:196
mbedtls_asn1_named_data mbedtls_x509_name
Definition: x509.h:202
This file provides an API for the RSA public-key cryptosystem.
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_self_test(int verbose)
Checkup routine.
int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len, int critical, const unsigned char *val, size_t val_len)
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...
int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *ext, int tag)
int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *alg)
mbedtls_md_type_t
Supported message digests.
Definition: md.h:60
int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *serial)
int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end, mbedtls_x509_time *t)