mbed TLS v2.6.0
x509.h
Go to the documentation of this file.
1 
25 #ifndef MBEDTLS_X509_H
26 #define MBEDTLS_X509_H
27 
28 #if !defined(MBEDTLS_CONFIG_FILE)
29 #include "config.h"
30 #else
31 #include MBEDTLS_CONFIG_FILE
32 #endif
33 
34 #include "asn1.h"
35 #include "pk.h"
36 
37 #if defined(MBEDTLS_RSA_C)
38 #include "rsa.h"
39 #endif
40 
46 #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
47 
55 #define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
56 #endif
57 
62 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
63 #define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
64 #define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
65 #define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
66 #define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
67 #define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
68 #define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
69 #define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
70 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
71 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
72 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
73 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
74 #define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
75 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
76 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
77 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
78 #define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
79 #define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
80 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
81 #define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
82 /* \} name */
83 
88 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
89 #define MBEDTLS_X509_BADCERT_EXPIRED 0x01
90 #define MBEDTLS_X509_BADCERT_REVOKED 0x02
91 #define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04
92 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08
93 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10
94 #define MBEDTLS_X509_BADCRL_EXPIRED 0x20
95 #define MBEDTLS_X509_BADCERT_MISSING 0x40
96 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80
97 #define MBEDTLS_X509_BADCERT_OTHER 0x0100
98 #define MBEDTLS_X509_BADCERT_FUTURE 0x0200
99 #define MBEDTLS_X509_BADCRL_FUTURE 0x0400
100 #define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800
101 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000
102 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000
103 #define MBEDTLS_X509_BADCERT_BAD_MD 0x4000
104 #define MBEDTLS_X509_BADCERT_BAD_PK 0x8000
105 #define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000
106 #define MBEDTLS_X509_BADCRL_BAD_MD 0x020000
107 #define MBEDTLS_X509_BADCRL_BAD_PK 0x040000
108 #define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000
110 /* \} name */
111 /* \} addtogroup x509_module */
112 
113 /*
114  * X.509 v3 Key Usage Extension flags
115  * Reminder: update x509_info_key_usage() when adding new flags.
116  */
117 #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
118 #define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
119 #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
120 #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
121 #define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */
122 #define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
123 #define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
124 #define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
125 #define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
126 
127 /*
128  * Netscape certificate types
129  * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
130  */
131 
132 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
133 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
134 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
135 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
136 #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
137 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
138 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
139 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
140 
141 /*
142  * X.509 extension types
143  *
144  * Comments refer to the status for using certificates. Status can be
145  * different for writing certificates or reading CRLs or CSRs.
146  */
147 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
148 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER (1 << 1)
149 #define MBEDTLS_X509_EXT_KEY_USAGE (1 << 2)
150 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES (1 << 3)
151 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS (1 << 4)
152 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME (1 << 5) /* Supported (DNS) */
153 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME (1 << 6)
154 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7)
155 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS (1 << 8) /* Supported */
156 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS (1 << 9)
157 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS (1 << 10)
158 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE (1 << 11)
159 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS (1 << 12)
160 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY (1 << 13)
161 #define MBEDTLS_X509_EXT_FRESHEST_CRL (1 << 14)
162 
163 #define MBEDTLS_X509_EXT_NS_CERT_TYPE (1 << 16)
164 
165 /*
166  * Storage format identifiers
167  * Recognized formats: PEM and DER
168  */
169 #define MBEDTLS_X509_FORMAT_DER 1
170 #define MBEDTLS_X509_FORMAT_PEM 2
171 
172 #define MBEDTLS_X509_MAX_DN_NAME_SIZE 256
174 #ifdef __cplusplus
175 extern "C" {
176 #endif
177 
191 
196 
202 
207 
209 typedef struct mbedtls_x509_time
210 {
211  int year, mon, day;
212  int hour, min, sec;
213 }
215 
230 int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
231 
243 int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial );
244 
258 
272 
278 int mbedtls_x509_self_test( int verbose );
279 
280 /*
281  * Internal module functions. You probably do not want to use these unless you
282  * know you do.
283  */
284 int mbedtls_x509_get_name( unsigned char **p, const unsigned char *end,
285  mbedtls_x509_name *cur );
286 int mbedtls_x509_get_alg_null( unsigned char **p, const unsigned char *end,
287  mbedtls_x509_buf *alg );
288 int mbedtls_x509_get_alg( unsigned char **p, const unsigned char *end,
289  mbedtls_x509_buf *alg, mbedtls_x509_buf *params );
290 #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
291 int mbedtls_x509_get_rsassa_pss_params( const mbedtls_x509_buf *params,
292  mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
293  int *salt_len );
294 #endif
295 int mbedtls_x509_get_sig( unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig );
296 int mbedtls_x509_get_sig_alg( const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
297  mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
298  void **sig_opts );
299 int mbedtls_x509_get_time( unsigned char **p, const unsigned char *end,
300  mbedtls_x509_time *t );
301 int mbedtls_x509_get_serial( unsigned char **p, const unsigned char *end,
302  mbedtls_x509_buf *serial );
303 int mbedtls_x509_get_ext( unsigned char **p, const unsigned char *end,
304  mbedtls_x509_buf *ext, int tag );
305 int mbedtls_x509_sig_alg_gets( char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
306  mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
307  const void *sig_opts );
308 int mbedtls_x509_key_size_helper( char *buf, size_t buf_size, const char *name );
309 int mbedtls_x509_string_to_names( mbedtls_asn1_named_data **head, const char *name );
310 int mbedtls_x509_set_extension( mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
311  int critical, const unsigned char *val,
312  size_t val_len );
313 int mbedtls_x509_write_extensions( unsigned char **p, unsigned char *start,
314  mbedtls_asn1_named_data *first );
315 int mbedtls_x509_write_names( unsigned char **p, unsigned char *start,
316  mbedtls_asn1_named_data *first );
317 int mbedtls_x509_write_sig( unsigned char **p, unsigned char *start,
318  const char *oid, size_t oid_len,
319  unsigned char *sig, size_t size );
320 
321 #define MBEDTLS_X509_SAFE_SNPRINTF \
322  do { \
323  if( ret < 0 || (size_t) ret >= n ) \
324  return( MBEDTLS_ERR_X509_BUFFER_TOO_SMALL ); \
325  \
326  n -= (size_t) ret; \
327  p += (size_t) ret; \
328  } while( 0 )
329 
330 #ifdef __cplusplus
331 }
332 #endif
333 
334 #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
Type-length-value structure that allows for ASN1 using DER.
Definition: x509.h:190
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:76
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)
Container for a sequence of ASN.1 items.
Definition: asn1.h:142
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.
Container for a sequence or list of 'named' ASN.1 data items.
Definition: asn1.h:152
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
Container for a sequence of ASN.1 items.
Definition: x509.h:206
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.
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:120
Container for date and time (precision in seconds).
Definition: x509.h:209
struct mbedtls_x509_time mbedtls_x509_time
Container for date and time (precision in seconds).
int day
Date.
Definition: x509.h:211
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 sec
Time.
Definition: x509.h:212
mbedtls_asn1_bitstring mbedtls_x509_bitstring
Container for ASN1 bit strings.
Definition: x509.h:195
mbedtls_asn1_named_data mbedtls_x509_name
Container for ASN1 named information objects.
Definition: x509.h:201
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.
Container for ASN1 bit strings.
Definition: asn1.h:131
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
Definition: md.h:41
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)