mbed TLS v2.24.0
x509.h
Go to the documentation of this file.
1 
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 
43 #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
44 
52 #define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
53 #endif
54 
59 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
60 #define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
61 #define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
62 #define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
63 #define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
64 #define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
65 #define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
66 #define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
67 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
68 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
69 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
70 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
71 #define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
72 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
73 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
74 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
75 #define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
76 #define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
77 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
78 #define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
79 /* \} name */
80 
85 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
86 #define MBEDTLS_X509_BADCERT_EXPIRED 0x01
87 #define MBEDTLS_X509_BADCERT_REVOKED 0x02
88 #define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04
89 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08
90 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10
91 #define MBEDTLS_X509_BADCRL_EXPIRED 0x20
92 #define MBEDTLS_X509_BADCERT_MISSING 0x40
93 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80
94 #define MBEDTLS_X509_BADCERT_OTHER 0x0100
95 #define MBEDTLS_X509_BADCERT_FUTURE 0x0200
96 #define MBEDTLS_X509_BADCRL_FUTURE 0x0400
97 #define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800
98 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000
99 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000
100 #define MBEDTLS_X509_BADCERT_BAD_MD 0x4000
101 #define MBEDTLS_X509_BADCERT_BAD_PK 0x8000
102 #define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000
103 #define MBEDTLS_X509_BADCRL_BAD_MD 0x020000
104 #define MBEDTLS_X509_BADCRL_BAD_PK 0x040000
105 #define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000
107 /* \} name */
108 /* \} addtogroup x509_module */
109 
110 /*
111  * X.509 v3 Subject Alternative Name types.
112  * otherName [0] OtherName,
113  * rfc822Name [1] IA5String,
114  * dNSName [2] IA5String,
115  * x400Address [3] ORAddress,
116  * directoryName [4] Name,
117  * ediPartyName [5] EDIPartyName,
118  * uniformResourceIdentifier [6] IA5String,
119  * iPAddress [7] OCTET STRING,
120  * registeredID [8] OBJECT IDENTIFIER
121  */
122 #define MBEDTLS_X509_SAN_OTHER_NAME 0
123 #define MBEDTLS_X509_SAN_RFC822_NAME 1
124 #define MBEDTLS_X509_SAN_DNS_NAME 2
125 #define MBEDTLS_X509_SAN_X400_ADDRESS_NAME 3
126 #define MBEDTLS_X509_SAN_DIRECTORY_NAME 4
127 #define MBEDTLS_X509_SAN_EDI_PARTY_NAME 5
128 #define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER 6
129 #define MBEDTLS_X509_SAN_IP_ADDRESS 7
130 #define MBEDTLS_X509_SAN_REGISTERED_ID 8
131 
132 /*
133  * X.509 v3 Key Usage Extension flags
134  * Reminder: update x509_info_key_usage() when adding new flags.
135  */
136 #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
137 #define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
138 #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
139 #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
140 #define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
141 #define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
142 #define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
143 #define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
144 #define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
145 
146 /*
147  * Netscape certificate types
148  * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
149  */
150 
151 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
152 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
153 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
154 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
155 #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
156 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
157 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
158 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
159 
160 /*
161  * X.509 extension types
162  *
163  * Comments refer to the status for using certificates. Status can be
164  * different for writing certificates or reading CRLs or CSRs.
165  *
166  * Those are defined in oid.h as oid.c needs them in a data structure. Since
167  * these were previously defined here, let's have aliases for compatibility.
168  */
169 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
170 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
171 #define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
172 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
173 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
174 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
175 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
176 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
177 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
178 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
179 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
180 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
181 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
182 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
183 #define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
184 #define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
185 
186 /*
187  * Storage format identifiers
188  * Recognized formats: PEM and DER
189  */
190 #define MBEDTLS_X509_FORMAT_DER 1
191 #define MBEDTLS_X509_FORMAT_PEM 2
192 
193 #define MBEDTLS_X509_MAX_DN_NAME_SIZE 256
195 #ifdef __cplusplus
196 extern "C" {
197 #endif
198 
212 
217 
223 
228 
230 typedef struct mbedtls_x509_time
231 {
232  int year, mon, day;
233  int hour, min, sec;
234 }
236 
251 int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
252 
264 int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial );
265 
279 
293 
294 #if defined(MBEDTLS_SELF_TEST)
295 
301 int mbedtls_x509_self_test( int verbose );
302 
303 #endif /* MBEDTLS_SELF_TEST */
304 
305 /*
306  * Internal module functions. You probably do not want to use these unless you
307  * know you do.
308  */
309 int mbedtls_x509_get_name( unsigned char **p, const unsigned char *end,
310  mbedtls_x509_name *cur );
311 int mbedtls_x509_get_alg_null( unsigned char **p, const unsigned char *end,
312  mbedtls_x509_buf *alg );
313 int mbedtls_x509_get_alg( unsigned char **p, const unsigned char *end,
314  mbedtls_x509_buf *alg, mbedtls_x509_buf *params );
315 #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
316 int mbedtls_x509_get_rsassa_pss_params( const mbedtls_x509_buf *params,
317  mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
318  int *salt_len );
319 #endif
320 int mbedtls_x509_get_sig( unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig );
321 int mbedtls_x509_get_sig_alg( const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
322  mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
323  void **sig_opts );
324 int mbedtls_x509_get_time( unsigned char **p, const unsigned char *end,
325  mbedtls_x509_time *t );
326 int mbedtls_x509_get_serial( unsigned char **p, const unsigned char *end,
327  mbedtls_x509_buf *serial );
328 int mbedtls_x509_get_ext( unsigned char **p, const unsigned char *end,
329  mbedtls_x509_buf *ext, int tag );
330 int mbedtls_x509_sig_alg_gets( char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
331  mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
332  const void *sig_opts );
333 int mbedtls_x509_key_size_helper( char *buf, size_t buf_size, const char *name );
334 int mbedtls_x509_string_to_names( mbedtls_asn1_named_data **head, const char *name );
335 int mbedtls_x509_set_extension( mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
336  int critical, const unsigned char *val,
337  size_t val_len );
338 int mbedtls_x509_write_extensions( unsigned char **p, unsigned char *start,
339  mbedtls_asn1_named_data *first );
340 int mbedtls_x509_write_names( unsigned char **p, unsigned char *start,
341  mbedtls_asn1_named_data *first );
342 int mbedtls_x509_write_sig( unsigned char **p, unsigned char *start,
343  const char *oid, size_t oid_len,
344  unsigned char *sig, size_t size );
345 
346 #define MBEDTLS_X509_SAFE_SNPRINTF \
347  do { \
348  if( ret < 0 || (size_t) ret >= n ) \
349  return( MBEDTLS_ERR_X509_BUFFER_TOO_SMALL ); \
350  \
351  n -= (size_t) ret; \
352  p += (size_t) ret; \
353  } while( 0 )
354 
355 #ifdef __cplusplus
356 }
357 #endif
358 
359 #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:211
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:227
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:216
mbedtls_asn1_named_data mbedtls_x509_name
Definition: x509.h:222
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:56
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)