Mbed TLS v2.28.9
Loading...
Searching...
No Matches
x509.h
Go to the documentation of this file.
1
6/*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9 */
10#ifndef MBEDTLS_X509_H
11#define MBEDTLS_X509_H
12
13#if !defined(MBEDTLS_CONFIG_FILE)
14#include "mbedtls/config.h"
15#else
16#include MBEDTLS_CONFIG_FILE
17#endif
18
19#include "mbedtls/asn1.h"
20#include "mbedtls/pk.h"
21
22#if defined(MBEDTLS_RSA_C)
23#include "mbedtls/rsa.h"
24#endif
25
31#if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
40#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
41#endif
42
48#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
50#define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
52#define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
54#define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
56#define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
58#define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
60#define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
62#define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
64#define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
66#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
68#define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
70#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
72#define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
74#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
76#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
78#define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
80#define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
82#define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
84#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
86#define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
93/* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
94#define MBEDTLS_X509_BADCERT_EXPIRED 0x01
95#define MBEDTLS_X509_BADCERT_REVOKED 0x02
96#define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04
97#define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08
98#define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10
99#define MBEDTLS_X509_BADCRL_EXPIRED 0x20
100#define MBEDTLS_X509_BADCERT_MISSING 0x40
101#define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80
102#define MBEDTLS_X509_BADCERT_OTHER 0x0100
103#define MBEDTLS_X509_BADCERT_FUTURE 0x0200
104#define MBEDTLS_X509_BADCRL_FUTURE 0x0400
105#define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800
106#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000
107#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000
108#define MBEDTLS_X509_BADCERT_BAD_MD 0x4000
109#define MBEDTLS_X509_BADCERT_BAD_PK 0x8000
110#define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000
111#define MBEDTLS_X509_BADCRL_BAD_MD 0x020000
112#define MBEDTLS_X509_BADCRL_BAD_PK 0x040000
113#define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000
118/*
119 * X.509 v3 Subject Alternative Name types.
120 * otherName [0] OtherName,
121 * rfc822Name [1] IA5String,
122 * dNSName [2] IA5String,
123 * x400Address [3] ORAddress,
124 * directoryName [4] Name,
125 * ediPartyName [5] EDIPartyName,
126 * uniformResourceIdentifier [6] IA5String,
127 * iPAddress [7] OCTET STRING,
128 * registeredID [8] OBJECT IDENTIFIER
129 */
130#define MBEDTLS_X509_SAN_OTHER_NAME 0
131#define MBEDTLS_X509_SAN_RFC822_NAME 1
132#define MBEDTLS_X509_SAN_DNS_NAME 2
133#define MBEDTLS_X509_SAN_X400_ADDRESS_NAME 3
134#define MBEDTLS_X509_SAN_DIRECTORY_NAME 4
135#define MBEDTLS_X509_SAN_EDI_PARTY_NAME 5
136#define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER 6
137#define MBEDTLS_X509_SAN_IP_ADDRESS 7
138#define MBEDTLS_X509_SAN_REGISTERED_ID 8
139
140/*
141 * X.509 v3 Key Usage Extension flags
142 * Reminder: update x509_info_key_usage() when adding new flags.
143 */
144#define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
145#define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
146#define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
147#define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
148#define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
149#define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
150#define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
151#define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
152#define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
153
154/*
155 * Netscape certificate types
156 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
157 */
158
159#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
160#define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
161#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
162#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
163#define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
164#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
165#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
166#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
167
168/*
169 * X.509 extension types
170 *
171 * Comments refer to the status for using certificates. Status can be
172 * different for writing certificates or reading CRLs or CSRs.
173 *
174 * Those are defined in oid.h as oid.c needs them in a data structure. Since
175 * these were previously defined here, let's have aliases for compatibility.
176 */
177#define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
178#define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
179#define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
180#define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
181#define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
182#define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
183#define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
184#define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
185#define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
186#define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
187#define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
188#define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
189#define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
190#define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
191#define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
192#define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
193
194/*
195 * Storage format identifiers
196 * Recognized formats: PEM and DER
197 */
198#define MBEDTLS_X509_FORMAT_DER 1
199#define MBEDTLS_X509_FORMAT_PEM 2
200
201#define MBEDTLS_X509_MAX_DN_NAME_SIZE 256
203#ifdef __cplusplus
204extern "C" {
205#endif
206
220
225
231
236
238typedef struct mbedtls_x509_time {
239 int year, mon, day;
240 int hour, min, sec;
241}
243
257int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn);
258
270int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial);
271
285
299
302#if defined(MBEDTLS_SELF_TEST)
303
309int mbedtls_x509_self_test(int verbose);
310
311#endif /* MBEDTLS_SELF_TEST */
312
313/*
314 * Internal module functions. You probably do not want to use these unless you
315 * know you do.
316 */
317int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end,
318 mbedtls_x509_name *cur);
319int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end,
320 mbedtls_x509_buf *alg);
321int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end,
322 mbedtls_x509_buf *alg, mbedtls_x509_buf *params);
323#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
325 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
326 int *salt_len);
327#endif
328int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig);
329int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
330 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
331 void **sig_opts);
332int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end,
334int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end,
335 mbedtls_x509_buf *serial);
336int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end,
337 mbedtls_x509_buf *ext, int tag);
338int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
340 const void *sig_opts);
341int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name);
343int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
344 int critical, const unsigned char *val,
345 size_t val_len);
346int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start,
348int mbedtls_x509_write_names(unsigned char **p, unsigned char *start,
350int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start,
351 const char *oid, size_t oid_len,
352 unsigned char *sig, size_t size,
353 mbedtls_pk_type_t pk_alg);
354
355#define MBEDTLS_X509_SAFE_SNPRINTF \
356 do { \
357 if (ret < 0 || (size_t) ret >= n) \
358 return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL; \
359 \
360 n -= (size_t) ret; \
361 p += (size_t) ret; \
362 } while (0)
363
364#ifdef __cplusplus
365}
366#endif
367
368#endif /* x509.h */
Generic ASN.1 parsing.
Configuration options (set of defines)
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.
mbedtls_asn1_named_data mbedtls_x509_name
Definition x509.h:230
struct mbedtls_x509_time mbedtls_x509_time
mbedtls_asn1_buf mbedtls_x509_buf
Definition x509.h:219
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_asn1_sequence mbedtls_x509_sequence
Definition x509.h:235
mbedtls_asn1_bitstring mbedtls_x509_bitstring
Definition x509.h:224
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_md_type_t
Supported message digests.
Definition md.h:50
Public Key abstraction layer.
mbedtls_pk_type_t
Public key types.
Definition pk.h:83
This file provides an API for the RSA public-key cryptosystem.
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_self_test(int verbose)
Checkup routine.
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_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_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_string_to_names(mbedtls_asn1_named_data **head, const char *name)