Mbed TLS v2.28.5
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 
60 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
61 
62 #define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
63 
64 #define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
65 
66 #define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
67 
68 #define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
69 
70 #define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
71 
72 #define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
73 
74 #define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
75 
76 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
77 
78 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
79 
80 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
81 
82 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
83 
84 #define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
85 
86 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
87 
88 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
89 
90 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
91 
92 #define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
93 
94 #define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
95 
96 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
97 
98 #define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
99 
105 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
106 #define MBEDTLS_X509_BADCERT_EXPIRED 0x01
107 #define MBEDTLS_X509_BADCERT_REVOKED 0x02
108 #define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04
109 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08
110 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10
111 #define MBEDTLS_X509_BADCRL_EXPIRED 0x20
112 #define MBEDTLS_X509_BADCERT_MISSING 0x40
113 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80
114 #define MBEDTLS_X509_BADCERT_OTHER 0x0100
115 #define MBEDTLS_X509_BADCERT_FUTURE 0x0200
116 #define MBEDTLS_X509_BADCRL_FUTURE 0x0400
117 #define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800
118 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000
119 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000
120 #define MBEDTLS_X509_BADCERT_BAD_MD 0x4000
121 #define MBEDTLS_X509_BADCERT_BAD_PK 0x8000
122 #define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000
123 #define MBEDTLS_X509_BADCRL_BAD_MD 0x020000
124 #define MBEDTLS_X509_BADCRL_BAD_PK 0x040000
125 #define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000
130 /*
131  * X.509 v3 Subject Alternative Name types.
132  * otherName [0] OtherName,
133  * rfc822Name [1] IA5String,
134  * dNSName [2] IA5String,
135  * x400Address [3] ORAddress,
136  * directoryName [4] Name,
137  * ediPartyName [5] EDIPartyName,
138  * uniformResourceIdentifier [6] IA5String,
139  * iPAddress [7] OCTET STRING,
140  * registeredID [8] OBJECT IDENTIFIER
141  */
142 #define MBEDTLS_X509_SAN_OTHER_NAME 0
143 #define MBEDTLS_X509_SAN_RFC822_NAME 1
144 #define MBEDTLS_X509_SAN_DNS_NAME 2
145 #define MBEDTLS_X509_SAN_X400_ADDRESS_NAME 3
146 #define MBEDTLS_X509_SAN_DIRECTORY_NAME 4
147 #define MBEDTLS_X509_SAN_EDI_PARTY_NAME 5
148 #define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER 6
149 #define MBEDTLS_X509_SAN_IP_ADDRESS 7
150 #define MBEDTLS_X509_SAN_REGISTERED_ID 8
151 
152 /*
153  * X.509 v3 Key Usage Extension flags
154  * Reminder: update x509_info_key_usage() when adding new flags.
155  */
156 #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
157 #define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
158 #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
159 #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
160 #define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
161 #define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
162 #define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
163 #define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
164 #define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
165 
166 /*
167  * Netscape certificate types
168  * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
169  */
170 
171 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
172 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
173 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
174 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
175 #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
176 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
177 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
178 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
179 
180 /*
181  * X.509 extension types
182  *
183  * Comments refer to the status for using certificates. Status can be
184  * different for writing certificates or reading CRLs or CSRs.
185  *
186  * Those are defined in oid.h as oid.c needs them in a data structure. Since
187  * these were previously defined here, let's have aliases for compatibility.
188  */
189 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
190 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
191 #define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
192 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
193 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
194 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
195 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
196 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
197 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
198 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
199 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
200 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
201 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
202 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
203 #define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
204 #define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
205 
206 /*
207  * Storage format identifiers
208  * Recognized formats: PEM and DER
209  */
210 #define MBEDTLS_X509_FORMAT_DER 1
211 #define MBEDTLS_X509_FORMAT_PEM 2
212 
213 #define MBEDTLS_X509_MAX_DN_NAME_SIZE 256
215 #ifdef __cplusplus
216 extern "C" {
217 #endif
218 
232 
237 
243 
248 
250 typedef struct mbedtls_x509_time {
251  int year, mon, day;
252  int hour, min, sec;
253 }
255 
269 int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn);
270 
282 int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial);
283 
297 
311 
314 #if defined(MBEDTLS_SELF_TEST)
315 
321 int mbedtls_x509_self_test(int verbose);
322 
323 #endif /* MBEDTLS_SELF_TEST */
324 
325 /*
326  * Internal module functions. You probably do not want to use these unless you
327  * know you do.
328  */
329 int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end,
330  mbedtls_x509_name *cur);
331 int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end,
332  mbedtls_x509_buf *alg);
333 int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end,
334  mbedtls_x509_buf *alg, mbedtls_x509_buf *params);
335 #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
337  mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
338  int *salt_len);
339 #endif
340 int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig);
341 int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
342  mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
343  void **sig_opts);
344 int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end,
345  mbedtls_x509_time *t);
346 int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end,
347  mbedtls_x509_buf *serial);
348 int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end,
349  mbedtls_x509_buf *ext, int tag);
350 int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
351  mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
352  const void *sig_opts);
353 int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name);
354 int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name);
355 int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
356  int critical, const unsigned char *val,
357  size_t val_len);
358 int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start,
359  mbedtls_asn1_named_data *first);
360 int mbedtls_x509_write_names(unsigned char **p, unsigned char *start,
361  mbedtls_asn1_named_data *first);
362 int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start,
363  const char *oid, size_t oid_len,
364  unsigned char *sig, size_t size,
365  mbedtls_pk_type_t pk_alg);
366 
367 #define MBEDTLS_X509_SAFE_SNPRINTF \
368  do { \
369  if (ret < 0 || (size_t) ret >= n) \
370  return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL; \
371  \
372  n -= (size_t) ret; \
373  p += (size_t) ret; \
374  } while (0)
375 
376 #ifdef __cplusplus
377 }
378 #endif
379 
380 #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:231
int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *alg, mbedtls_x509_buf *params)
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:95
Configuration options (set of defines)
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...
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:247
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)
int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start, const char *oid, size_t oid_len, unsigned char *sig, size_t size, mbedtls_pk_type_t pk_alg)
mbedtls_asn1_bitstring mbedtls_x509_bitstring
Definition: x509.h:236
mbedtls_asn1_named_data mbedtls_x509_name
Definition: x509.h:242
This file provides an API for the RSA public-key cryptosystem.
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_time_is_past(const mbedtls_x509_time *to)
Check a given mbedtls_x509_time against the system time and tell if it&#39;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&#39;s in the future.
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:62
int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *serial)
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_time(unsigned char **p, const unsigned char *end, mbedtls_x509_time *t)