Mbed TLS v3.5.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
25
26#include "mbedtls/build_info.h"
27
28#include "mbedtls/asn1.h"
29#include "mbedtls/pk.h"
30
31#if defined(MBEDTLS_RSA_C)
32#include "mbedtls/rsa.h"
33#endif
34
40#if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
49#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
50#endif
51
57#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
59#define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
61#define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
63#define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
65#define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
67#define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
69#define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
71#define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
73#define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
75#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
77#define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
79#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
81#define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
83#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
85#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
87#define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
89#define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
91#define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
93#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
95#define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
102/* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
103#define MBEDTLS_X509_BADCERT_EXPIRED 0x01
104#define MBEDTLS_X509_BADCERT_REVOKED 0x02
105#define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04
106#define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08
107#define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10
108#define MBEDTLS_X509_BADCRL_EXPIRED 0x20
109#define MBEDTLS_X509_BADCERT_MISSING 0x40
110#define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80
111#define MBEDTLS_X509_BADCERT_OTHER 0x0100
112#define MBEDTLS_X509_BADCERT_FUTURE 0x0200
113#define MBEDTLS_X509_BADCRL_FUTURE 0x0400
114#define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800
115#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000
116#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000
117#define MBEDTLS_X509_BADCERT_BAD_MD 0x4000
118#define MBEDTLS_X509_BADCERT_BAD_PK 0x8000
119#define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000
120#define MBEDTLS_X509_BADCRL_BAD_MD 0x020000
121#define MBEDTLS_X509_BADCRL_BAD_PK 0x040000
122#define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000
127/*
128 * X.509 v3 Subject Alternative Name types.
129 * otherName [0] OtherName,
130 * rfc822Name [1] IA5String,
131 * dNSName [2] IA5String,
132 * x400Address [3] ORAddress,
133 * directoryName [4] Name,
134 * ediPartyName [5] EDIPartyName,
135 * uniformResourceIdentifier [6] IA5String,
136 * iPAddress [7] OCTET STRING,
137 * registeredID [8] OBJECT IDENTIFIER
138 */
139#define MBEDTLS_X509_SAN_OTHER_NAME 0
140#define MBEDTLS_X509_SAN_RFC822_NAME 1
141#define MBEDTLS_X509_SAN_DNS_NAME 2
142#define MBEDTLS_X509_SAN_X400_ADDRESS_NAME 3
143#define MBEDTLS_X509_SAN_DIRECTORY_NAME 4
144#define MBEDTLS_X509_SAN_EDI_PARTY_NAME 5
145#define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER 6
146#define MBEDTLS_X509_SAN_IP_ADDRESS 7
147#define MBEDTLS_X509_SAN_REGISTERED_ID 8
148
149/*
150 * X.509 v3 Key Usage Extension flags
151 * Reminder: update mbedtls_x509_info_key_usage() when adding new flags.
152 */
153#define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
154#define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
155#define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
156#define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
157#define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
158#define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
159#define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
160#define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
161#define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
162
163/*
164 * Netscape certificate types
165 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
166 */
167
168#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
169#define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
170#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
171#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
172#define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
173#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
174#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
175#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
176
177/*
178 * X.509 extension types
179 *
180 * Comments refer to the status for using certificates. Status can be
181 * different for writing certificates or reading CRLs or CSRs.
182 *
183 * Those are defined in oid.h as oid.c needs them in a data structure. Since
184 * these were previously defined here, let's have aliases for compatibility.
185 */
186#define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
187#define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
188#define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
189#define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
190#define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
191#define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
192#define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
193#define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
194#define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
195#define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
196#define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
197#define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
198#define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
199#define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
200#define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
201#define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
202
203/*
204 * Storage format identifiers
205 * Recognized formats: PEM and DER
206 */
207#define MBEDTLS_X509_FORMAT_DER 1
208#define MBEDTLS_X509_FORMAT_PEM 2
209
210#define MBEDTLS_X509_MAX_DN_NAME_SIZE 256
212#ifdef __cplusplus
213extern "C" {
214#endif
215
229
234
240
245
246/*
247 * Container for the fields of the Authority Key Identifier object
248 */
254}
256
258typedef struct mbedtls_x509_time {
259 int year, mon, day;
260 int hour, min, sec;
261}
263
280 union {
287 struct {
290 }
292 }
294}
296
305 int type;
306 union {
310 }
312}
314
315typedef struct mbedtls_x509_san_list {
318}
320
334int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn);
335
349{
350 while (dn->MBEDTLS_PRIVATE(next_merged) && dn->next != NULL) {
351 dn = dn->next;
352 }
353 return dn->next;
354}
355
367int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial);
368
380
381#if defined(MBEDTLS_HAVE_TIME_DATE)
392#endif /* MBEDTLS_HAVE_TIME_DATE */
393
407
421
462
465/*
466 * Internal module functions. You probably do not want to use these unless you
467 * know you do.
468 */
469int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end,
470 mbedtls_x509_name *cur);
471int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end,
472 mbedtls_x509_buf *alg);
473int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end,
474 mbedtls_x509_buf *alg, mbedtls_x509_buf *params);
475#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
477 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
478 int *salt_len);
479#endif
480int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig);
481int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
482 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
483 void **sig_opts);
484int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end,
486int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end,
487 mbedtls_x509_buf *serial);
488int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end,
489 mbedtls_x509_buf *ext, int tag);
490#if !defined(MBEDTLS_X509_REMOVE_INFO)
491int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
493 const void *sig_opts);
494#endif
495int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name);
497int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
498 int critical, const unsigned char *val,
499 size_t val_len);
500int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start,
502int mbedtls_x509_write_names(unsigned char **p, unsigned char *start,
504int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start,
505 const char *oid, size_t oid_len,
506 unsigned char *sig, size_t size,
507 mbedtls_pk_type_t pk_alg);
508int mbedtls_x509_get_ns_cert_type(unsigned char **p,
509 const unsigned char *end,
510 unsigned char *ns_cert_type);
511int mbedtls_x509_get_key_usage(unsigned char **p,
512 const unsigned char *end,
513 unsigned int *key_usage);
515 const unsigned char *end,
516 mbedtls_x509_sequence *subject_alt_name);
518 const unsigned char *end,
519 mbedtls_x509_sequence *subject_alt_name);
520int mbedtls_x509_info_subject_alt_name(char **buf, size_t *size,
522 *subject_alt_name,
523 const char *prefix);
524int mbedtls_x509_info_cert_type(char **buf, size_t *size,
525 unsigned char ns_cert_type);
526int mbedtls_x509_info_key_usage(char **buf, size_t *size,
527 unsigned int key_usage);
528
530 const mbedtls_x509_san_list *san_list);
531
547size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst);
548
549#define MBEDTLS_X509_SAFE_SNPRINTF \
550 do { \
551 if (ret < 0 || (size_t) ret >= n) \
552 return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL; \
553 \
554 n -= (size_t) ret; \
555 p += (size_t) ret; \
556 } while (0)
557
558#ifdef __cplusplus
559}
560#endif
561
562#endif /* x509.h */
Generic ASN.1 parsing.
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.
struct mbedtls_x509_authority mbedtls_x509_authority
mbedtls_asn1_named_data mbedtls_x509_name
Definition: x509.h:239
int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf, mbedtls_x509_subject_alternative_name *san)
This function parses an item in the SubjectAlternativeNames extension. Please note that this function...
void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san)
Unallocate all data related to subject alternative name.
struct mbedtls_x509_time mbedtls_x509_time
mbedtls_asn1_buf mbedtls_x509_buf
Definition: x509.h:228
static mbedtls_x509_name * mbedtls_x509_dn_get_next(mbedtls_x509_name *dn)
Return the next relative DN in an X509 name.
Definition: x509.h:347
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_time_cmp(const mbedtls_x509_time *t1, const mbedtls_x509_time *t2)
Compare pair of mbedtls_x509_time.
int mbedtls_x509_time_gmtime(mbedtls_time_t tt, mbedtls_x509_time *now)
Fill mbedtls_x509_time with provided mbedtls_time_t.
struct mbedtls_x509_san_other_name mbedtls_x509_san_other_name
struct mbedtls_x509_san_list mbedtls_x509_san_list
mbedtls_asn1_sequence mbedtls_x509_sequence
Definition: x509.h:244
struct mbedtls_x509_subject_alternative_name mbedtls_x509_subject_alternative_name
mbedtls_asn1_bitstring mbedtls_x509_bitstring
Definition: x509.h:233
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...
Build-time configuration info.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:173
Public Key abstraction layer.
mbedtls_pk_type_t
Public key types.
Definition: pk.h:85
time_t mbedtls_time_t
Definition: platform_time.h:39
Macro wrapper for struct's members.
This file provides an API for the RSA public-key cryptosystem.
struct mbedtls_asn1_named_data * next
Definition: asn1.h:201
mbedtls_x509_buf raw
Definition: x509.h:253
mbedtls_x509_buf authorityCertSerialNumber
Definition: x509.h:252
mbedtls_x509_sequence authorityCertIssuer
Definition: x509.h:251
mbedtls_x509_buf keyIdentifier
Definition: x509.h:250
mbedtls_x509_subject_alternative_name node
Definition: x509.h:316
struct mbedtls_x509_san_list * next
Definition: x509.h:317
struct mbedtls_x509_san_other_name::@2::@3 hardware_module_name
mbedtls_x509_buf oid
Definition: x509.h:288
mbedtls_x509_buf val
Definition: x509.h:289
union mbedtls_x509_san_other_name::@2 value
mbedtls_x509_buf type_id
Definition: x509.h:279
mbedtls_x509_san_other_name other_name
Definition: x509.h:307
mbedtls_x509_buf unstructured_name
Definition: x509.h:309
union mbedtls_x509_subject_alternative_name::@4 san
mbedtls_x509_name directory_name
Definition: x509.h:308
int mbedtls_x509_get_subject_alt_name(unsigned char **p, const unsigned char *end, mbedtls_x509_sequence *subject_alt_name)
int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start, mbedtls_asn1_named_data *first)
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)
int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end, mbedtls_x509_name *cur)
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_write_names(unsigned char **p, unsigned char *start, mbedtls_asn1_named_data *first)
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)
int mbedtls_x509_write_set_san_common(mbedtls_asn1_named_data **extensions, const mbedtls_x509_san_list *san_list)
int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *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)
int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *alg, mbedtls_x509_buf *params)
int mbedtls_x509_get_key_usage(unsigned char **p, const unsigned char *end, unsigned int *key_usage)
int mbedtls_x509_info_cert_type(char **buf, size_t *size, unsigned char ns_cert_type)
size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst)
This function parses a CN string as an IP address.
int mbedtls_x509_info_key_usage(char **buf, size_t *size, unsigned int key_usage)
int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *ext, int tag)
int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name)
int mbedtls_x509_info_subject_alt_name(char **buf, size_t *size, const mbedtls_x509_sequence *subject_alt_name, const char *prefix)
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_get_serial(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *serial)
int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig)
int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end, mbedtls_x509_time *t)
int mbedtls_x509_get_ns_cert_type(unsigned char **p, const unsigned char *end, unsigned char *ns_cert_type)
int mbedtls_x509_get_subject_alt_name_ext(unsigned char **p, const unsigned char *end, mbedtls_x509_sequence *subject_alt_name)
int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name)