mbed TLS v2.16.3: x509.h Source File

mbed TLS v2.16.3

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: 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
45 #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
46
54 #define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
55 #endif
56
61 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
62 #define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
63 #define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
64 #define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
65 #define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
66 #define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
67 #define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
68 #define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
69 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
70 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
71 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
72 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
73 #define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
74 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
75 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
76 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
77 #define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
78 #define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
79 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
80 #define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
81 /* \} name */
82
87 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
88 #define MBEDTLS_X509_BADCERT_EXPIRED 0x01
89 #define MBEDTLS_X509_BADCERT_REVOKED 0x02
90 #define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04
91 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08
92 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10
93 #define MBEDTLS_X509_BADCRL_EXPIRED 0x20
94 #define MBEDTLS_X509_BADCERT_MISSING 0x40
95 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80
96 #define MBEDTLS_X509_BADCERT_OTHER 0x0100
97 #define MBEDTLS_X509_BADCERT_FUTURE 0x0200
98 #define MBEDTLS_X509_BADCRL_FUTURE 0x0400
99 #define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800
100 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000
101 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000
102 #define MBEDTLS_X509_BADCERT_BAD_MD 0x4000
103 #define MBEDTLS_X509_BADCERT_BAD_PK 0x8000
104 #define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000
105 #define MBEDTLS_X509_BADCRL_BAD_MD 0x020000
106 #define MBEDTLS_X509_BADCRL_BAD_PK 0x040000
107 #define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000
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 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
147 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER (1 << 1)
148 #define MBEDTLS_X509_EXT_KEY_USAGE (1 << 2)
149 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES (1 << 3)
150 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS (1 << 4)
151 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME (1 << 5) /* Supported (DNS) */
152 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME (1 << 6)
153 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7)
154 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS (1 << 8) /* Supported */
155 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS (1 << 9)
156 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS (1 << 10)
157 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE (1 << 11)
158 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS (1 << 12)
159 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY (1 << 13)
160 #define MBEDTLS_X509_EXT_FRESHEST_CRL (1 << 14)
161
162 #define MBEDTLS_X509_EXT_NS_CERT_TYPE (1 << 16)
163
164 /*
165 * Storage format identifiers
166 * Recognized formats: PEM and DER
167 */
168 #define MBEDTLS_X509_FORMAT_DER 1
169 #define MBEDTLS_X509_FORMAT_PEM 2
170
171 #define MBEDTLS_X509_MAX_DN_NAME_SIZE 256
173 #ifdef __cplusplus
174 extern "C" {
175 #endif
176
189 typedef mbedtls_asn1_buf mbedtls_x509_buf;
190
194 typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring;
195
200 typedef mbedtls_asn1_named_data mbedtls_x509_name;
201
205 typedef mbedtls_asn1_sequence mbedtls_x509_sequence;
206
208 typedef struct mbedtls_x509_time
209 {
210 int year, mon, day;
211 int hour, min, sec;
212 }
213 mbedtls_x509_time;
214
229 int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
230
242 int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial );
243
256 int mbedtls_x509_time_is_past( const mbedtls_x509_time *to );
257
270 int mbedtls_x509_time_is_future( const mbedtls_x509_time *from );
271
272 #if defined(MBEDTLS_SELF_TEST)
273
279 int mbedtls_x509_self_test( int verbose );
280
281 #endif /* MBEDTLS_SELF_TEST */
282
283 /*
284 * Internal module functions. You probably do not want to use these unless you
285 * know you do.
286 */
287 int mbedtls_x509_get_name( unsigned char **p, const unsigned char *end,
288 mbedtls_x509_name *cur );
289 int mbedtls_x509_get_alg_null( unsigned char **p, const unsigned char *end,
290 mbedtls_x509_buf *alg );
291 int mbedtls_x509_get_alg( unsigned char **p, const unsigned char *end,
292 mbedtls_x509_buf *alg, mbedtls_x509_buf *params );
293 #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
294 int mbedtls_x509_get_rsassa_pss_params( const mbedtls_x509_buf *params,
295 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
296 int *salt_len );
297 #endif
298 int mbedtls_x509_get_sig( unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig );
299 int mbedtls_x509_get_sig_alg( const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
300 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
301 void **sig_opts );
302 int mbedtls_x509_get_time( unsigned char **p, const unsigned char *end,
303 mbedtls_x509_time *t );
304 int mbedtls_x509_get_serial( unsigned char **p, const unsigned char *end,
305 mbedtls_x509_buf *serial );
306 int mbedtls_x509_get_ext( unsigned char **p, const unsigned char *end,
307 mbedtls_x509_buf *ext, int tag );
308 int mbedtls_x509_sig_alg_gets( char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
309 mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
310 const void *sig_opts );
311 int mbedtls_x509_key_size_helper( char *buf, size_t buf_size, const char *name );
312 int mbedtls_x509_string_to_names( mbedtls_asn1_named_data **head, const char *name );
313 int mbedtls_x509_set_extension( mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
314 int critical, const unsigned char *val,
315 size_t val_len );
316 int mbedtls_x509_write_extensions( unsigned char **p, unsigned char *start,
317 mbedtls_asn1_named_data *first );
318 int mbedtls_x509_write_names( unsigned char **p, unsigned char *start,
319 mbedtls_asn1_named_data *first );
320 int mbedtls_x509_write_sig( unsigned char **p, unsigned char *start,
321 const char *oid, size_t oid_len,
322 unsigned char *sig, size_t size );
323
324 #define MBEDTLS_X509_SAFE_SNPRINTF \
325 do { \
326 if( ret < 0 || (size_t) ret >= n ) \
327 return( MBEDTLS_ERR_X509_BUFFER_TOO_SMALL ); \
328 \
329 n -= (size_t) ret; \
330 p += (size_t) ret; \
331 } while( 0 )
332
333 #ifdef __cplusplus
334 }
335 #endif
336
337 #endif /* x509.h */
mbedtls_md_type_t
mbedtls_md_type_t
Supported message digests.
Definition: md.h:58
mbedtls_x509_get_time
int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end, mbedtls_x509_time *t)
mbedtls_x509_get_ext
int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *ext, int tag)
mbedtls_x509_get_sig_alg
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)
mbedtls_x509_get_rsassa_pss_params
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_x509_time::min
int min
Definition: x509.h:211
mbedtls_asn1_named_data
Definition: asn1.h:166
mbedtls_x509_string_to_names
int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name)
mbedtls_x509_sequence
mbedtls_asn1_sequence mbedtls_x509_sequence
Definition: x509.h:205
mbedtls_x509_get_sig
int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig)
mbedtls_x509_serial_gets
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...
mbedtls_x509_time
Definition: x509.h:208
mbedtls_x509_get_name
int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end, mbedtls_x509_name *cur)
mbedtls_x509_write_names
int mbedtls_x509_write_names(unsigned char **p, unsigned char *start, mbedtls_asn1_named_data *first)
mbedtls_x509_get_serial
int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *serial)
mbedtls_x509_time_is_future
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_x509_sig_alg_gets
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_x509_set_extension
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)
mbedtls_x509_time::day
int day
Definition: x509.h:210
rsa.h
This file provides an API for the RSA public-key cryptosystem.
mbedtls_x509_buf
mbedtls_asn1_buf mbedtls_x509_buf
Definition: x509.h:189
mbedtls_asn1_sequence
Definition: asn1.h:156
mbedtls_pk_type_t
mbedtls_pk_type_t
Public key types.
Definition: pk.h:78
mbedtls_x509_time::year
int year
Definition: x509.h:210
mbedtls_x509_time::mon
int mon
Definition: x509.h:210
mbedtls_x509_key_size_helper
int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name)
mbedtls_x509_dn_gets
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_x509_self_test
int mbedtls_x509_self_test(int verbose)
Checkup routine.
mbedtls_x509_write_extensions
int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start, mbedtls_asn1_named_data *first)
mbedtls_x509_time_is_past
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.
mbedtls_asn1_bitstring
Definition: asn1.h:145
mbedtls_x509_time
struct mbedtls_x509_time mbedtls_x509_time
mbedtls_x509_bitstring
mbedtls_asn1_bitstring mbedtls_x509_bitstring
Definition: x509.h:194
pk.h
Public Key abstraction layer.
mbedtls_x509_write_sig
int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start, const char *oid, size_t oid_len, unsigned char *sig, size_t size)
config.h
Configuration options (set of defines)
mbedtls_x509_time::hour
int hour
Definition: x509.h:211
mbedtls_asn1_buf
Definition: asn1.h:134
mbedtls_x509_get_alg_null
int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *alg)
mbedtls_x509_name
mbedtls_asn1_named_data mbedtls_x509_name
Definition: x509.h:200
asn1.h
Generic ASN.1 parsing.
mbedtls_x509_time::sec
int sec
Definition: x509.h:211
mbedtls_x509_get_alg
int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *alg, mbedtls_x509_buf *params)