1 /**
2  * \file x509.h
3  *
4  * \brief X.509 generic defines and structures
5  */
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 #include "mbedtls/private_access.h"
13 
14 #include "mbedtls/build_info.h"
15 
16 #include "mbedtls/asn1.h"
17 #include "mbedtls/pk.h"
18 
19 #if defined(MBEDTLS_RSA_C)
20 #include "mbedtls/rsa.h"
21 #endif
22 
23 /**
24  * \addtogroup x509_module
25  * \{
26  */
27 
28 #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
29 /**
30  * Maximum number of intermediate CAs in a verification chain.
31  * That is, maximum length of the chain, excluding the end-entity certificate
32  * and the trusted root certificate.
33  *
34  * Set this to a low value to prevent an adversary from making you waste
35  * resources verifying an overlong certificate chain.
36  */
37 #define MBEDTLS_X509_MAX_INTERMEDIATE_CA   8
38 #endif
39 
40 /**
41  * \name X509 Error codes
42  * \{
43  */
44 /** Unavailable feature, e.g. RSA hashing/encryption combination. */
45 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE              -0x2080
46 /** Requested OID is unknown. */
47 #define MBEDTLS_ERR_X509_UNKNOWN_OID                      -0x2100
48 /** The CRT/CRL/CSR format is invalid, e.g. different type expected. */
49 #define MBEDTLS_ERR_X509_INVALID_FORMAT                   -0x2180
50 /** The CRT/CRL/CSR version element is invalid. */
51 #define MBEDTLS_ERR_X509_INVALID_VERSION                  -0x2200
52 /** The serial tag or value is invalid. */
53 #define MBEDTLS_ERR_X509_INVALID_SERIAL                   -0x2280
54 /** The algorithm tag or value is invalid. */
55 #define MBEDTLS_ERR_X509_INVALID_ALG                      -0x2300
56 /** The name tag or value is invalid. */
57 #define MBEDTLS_ERR_X509_INVALID_NAME                     -0x2380
58 /** The date tag or value is invalid. */
59 #define MBEDTLS_ERR_X509_INVALID_DATE                     -0x2400
60 /** The signature tag or value invalid. */
61 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE                -0x2480
62 /** The extension tag or value is invalid. */
63 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS               -0x2500
64 /** CRT/CRL/CSR has an unsupported version number. */
65 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION                  -0x2580
66 /** Signature algorithm (oid) is unsupported. */
67 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG                  -0x2600
68 /** Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */
69 #define MBEDTLS_ERR_X509_SIG_MISMATCH                     -0x2680
70 /** Certificate verification failed, e.g. CRL, CA or signature check failed. */
71 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED               -0x2700
72 /** Format not recognized as DER or PEM. */
73 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT              -0x2780
74 /** Input invalid. */
75 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA                   -0x2800
76 /** Allocation of memory failed. */
77 #define MBEDTLS_ERR_X509_ALLOC_FAILED                     -0x2880
78 /** Read/write of file failed. */
79 #define MBEDTLS_ERR_X509_FILE_IO_ERROR                    -0x2900
80 /** Destination buffer is too small. */
81 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL                 -0x2980
82 /** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */
83 #define MBEDTLS_ERR_X509_FATAL_ERROR                      -0x3000
84 /** \} name X509 Error codes */
85 
86 /**
87  * \name X509 Verify codes
88  * \{
89  */
90 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
91 #define MBEDTLS_X509_BADCERT_EXPIRED             0x01  /**< The certificate validity has expired. */
92 #define MBEDTLS_X509_BADCERT_REVOKED             0x02  /**< The certificate has been revoked (is on a CRL). */
93 #define MBEDTLS_X509_BADCERT_CN_MISMATCH         0x04  /**< The certificate Common Name (CN) does not match with the expected CN. */
94 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED         0x08  /**< The certificate is not correctly signed by the trusted CA. */
95 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED          0x10  /**< The CRL is not correctly signed by the trusted CA. */
96 #define MBEDTLS_X509_BADCRL_EXPIRED              0x20  /**< The CRL is expired. */
97 #define MBEDTLS_X509_BADCERT_MISSING             0x40  /**< Certificate was missing. */
98 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY         0x80  /**< Certificate verification was skipped. */
99 #define MBEDTLS_X509_BADCERT_OTHER             0x0100  /**< Other reason (can be used by verify callback) */
100 #define MBEDTLS_X509_BADCERT_FUTURE            0x0200  /**< The certificate validity starts in the future. */
101 #define MBEDTLS_X509_BADCRL_FUTURE             0x0400  /**< The CRL is from the future */
102 #define MBEDTLS_X509_BADCERT_KEY_USAGE         0x0800  /**< Usage does not match the keyUsage extension. */
103 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE     0x1000  /**< Usage does not match the extendedKeyUsage extension. */
104 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE      0x2000  /**< Usage does not match the nsCertType extension. */
105 #define MBEDTLS_X509_BADCERT_BAD_MD            0x4000  /**< The certificate is signed with an unacceptable hash. */
106 #define MBEDTLS_X509_BADCERT_BAD_PK            0x8000  /**< The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
107 #define MBEDTLS_X509_BADCERT_BAD_KEY         0x010000  /**< The certificate is signed with an unacceptable key (eg bad curve, RSA too short). */
108 #define MBEDTLS_X509_BADCRL_BAD_MD           0x020000  /**< The CRL is signed with an unacceptable hash. */
109 #define MBEDTLS_X509_BADCRL_BAD_PK           0x040000  /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
110 #define MBEDTLS_X509_BADCRL_BAD_KEY          0x080000  /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */
111 
112 /** \} name X509 Verify codes */
113 /** \} addtogroup x509_module */
114 
115 /*
116  * X.509 v3 Subject Alternative Name types.
117  *      otherName                       [0]     OtherName,
118  *      rfc822Name                      [1]     IA5String,
119  *      dNSName                         [2]     IA5String,
120  *      x400Address                     [3]     ORAddress,
121  *      directoryName                   [4]     Name,
122  *      ediPartyName                    [5]     EDIPartyName,
123  *      uniformResourceIdentifier       [6]     IA5String,
124  *      iPAddress                       [7]     OCTET STRING,
125  *      registeredID                    [8]     OBJECT IDENTIFIER
126  */
127 #define MBEDTLS_X509_SAN_OTHER_NAME                      0
128 #define MBEDTLS_X509_SAN_RFC822_NAME                     1
129 #define MBEDTLS_X509_SAN_DNS_NAME                        2
130 #define MBEDTLS_X509_SAN_X400_ADDRESS_NAME               3
131 #define MBEDTLS_X509_SAN_DIRECTORY_NAME                  4
132 #define MBEDTLS_X509_SAN_EDI_PARTY_NAME                  5
133 #define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER     6
134 #define MBEDTLS_X509_SAN_IP_ADDRESS                      7
135 #define MBEDTLS_X509_SAN_REGISTERED_ID                   8
136 
137 /*
138  * X.509 v3 Key Usage Extension flags
139  * Reminder: update mbedtls_x509_info_key_usage() when adding new flags.
140  */
141 #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE            (0x80)  /* bit 0 */
142 #define MBEDTLS_X509_KU_NON_REPUDIATION              (0x40)  /* bit 1 */
143 #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT             (0x20)  /* bit 2 */
144 #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT            (0x10)  /* bit 3 */
145 #define MBEDTLS_X509_KU_KEY_AGREEMENT                (0x08)  /* bit 4 */
146 #define MBEDTLS_X509_KU_KEY_CERT_SIGN                (0x04)  /* bit 5 */
147 #define MBEDTLS_X509_KU_CRL_SIGN                     (0x02)  /* bit 6 */
148 #define MBEDTLS_X509_KU_ENCIPHER_ONLY                (0x01)  /* bit 7 */
149 #define MBEDTLS_X509_KU_DECIPHER_ONLY              (0x8000)  /* bit 8 */
150 
151 /*
152  * Netscape certificate types
153  * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
154  */
155 
156 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT         (0x80)  /* bit 0 */
157 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER         (0x40)  /* bit 1 */
158 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL              (0x20)  /* bit 2 */
159 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING     (0x10)  /* bit 3 */
160 #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED           (0x08)  /* bit 4 */
161 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA             (0x04)  /* bit 5 */
162 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA           (0x02)  /* bit 6 */
163 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA  (0x01)  /* bit 7 */
164 
165 /*
166  * X.509 extension types
167  *
168  * Comments refer to the status for using certificates. Status can be
169  * different for writing certificates or reading CRLs or CSRs.
170  *
171  * Those are defined in oid.h as oid.c needs them in a data structure. Since
172  * these were previously defined here, let's have aliases for compatibility.
173  */
174 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
175 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER   MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
176 #define MBEDTLS_X509_EXT_KEY_USAGE                MBEDTLS_OID_X509_EXT_KEY_USAGE
177 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES     MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
178 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS          MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
179 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME         MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME         /* Supported (DNS) */
180 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME          MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
181 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS  MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
182 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS        MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS        /* Supported */
183 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS         MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
184 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS       MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
185 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE       MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
186 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS  MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
187 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY       MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
188 #define MBEDTLS_X509_EXT_FRESHEST_CRL             MBEDTLS_OID_X509_EXT_FRESHEST_CRL
189 #define MBEDTLS_X509_EXT_NS_CERT_TYPE             MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
190 
191 /*
192  * Storage format identifiers
193  * Recognized formats: PEM and DER
194  */
195 #define MBEDTLS_X509_FORMAT_DER                 1
196 #define MBEDTLS_X509_FORMAT_PEM                 2
197 
198 #define MBEDTLS_X509_MAX_DN_NAME_SIZE         256 /**< Maximum value size of a DN entry */
199 
200 #ifdef __cplusplus
201 extern "C" {
202 #endif
203 
204 /**
205  * \addtogroup x509_module
206  * \{ */
207 
208 /**
209  * \name Structures for parsing X.509 certificates, CRLs and CSRs
210  * \{
211  */
212 
213 /**
214  * Type-length-value structure that allows for ASN1 using DER.
215  */
216 typedef mbedtls_asn1_buf mbedtls_x509_buf;
217 
218 /**
219  * Container for ASN1 bit strings.
220  */
221 typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring;
222 
223 /**
224  * Container for ASN1 named information objects.
225  * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.).
226  */
227 typedef mbedtls_asn1_named_data mbedtls_x509_name;
228 
229 /**
230  * Container for a sequence of ASN.1 items
231  */
232 typedef mbedtls_asn1_sequence mbedtls_x509_sequence;
233 
234 /*
235  * Container for the fields of the Authority Key Identifier object
236  */
237 typedef struct mbedtls_x509_authority {
238     mbedtls_x509_buf keyIdentifier;
239     mbedtls_x509_sequence authorityCertIssuer;
240     mbedtls_x509_buf authorityCertSerialNumber;
241     mbedtls_x509_buf raw;
242 }
243 mbedtls_x509_authority;
244 
245 /** Container for date and time (precision in seconds). */
246 typedef struct mbedtls_x509_time {
247     int year, mon, day;         /**< Date. */
248     int hour, min, sec;         /**< Time. */
249 }
250 mbedtls_x509_time;
251 
252 /**
253  * From RFC 5280 section 4.2.1.6:
254  * OtherName ::= SEQUENCE {
255  *      type-id    OBJECT IDENTIFIER,
256  *      value      [0] EXPLICIT ANY DEFINED BY type-id }
257  *
258  * Future versions of the library may add new fields to this structure or
259  * to its embedded union and structure.
260  */
261 typedef struct mbedtls_x509_san_other_name {
262     /**
263      * The type_id is an OID as defined in RFC 5280.
264      * To check the value of the type id, you should use
265      * \p MBEDTLS_OID_CMP with a known OID mbedtls_x509_buf.
266      */
267     mbedtls_x509_buf type_id;                   /**< The type id. */
268     union {
269         /**
270          * From RFC 4108 section 5:
271          * HardwareModuleName ::= SEQUENCE {
272          *                         hwType OBJECT IDENTIFIER,
273          *                         hwSerialNum OCTET STRING }
274          */
275         struct {
276             mbedtls_x509_buf oid;               /**< The object identifier. */
277             mbedtls_x509_buf val;               /**< The named value. */
278         }
279         hardware_module_name;
280     }
281     value;
282 }
283 mbedtls_x509_san_other_name;
284 
285 /**
286  * A structure for holding the parsed Subject Alternative Name,
287  * according to type.
288  *
289  * Future versions of the library may add new fields to this structure or
290  * to its embedded union and structure.
291  */
292 typedef struct mbedtls_x509_subject_alternative_name {
293     int type;                              /**< The SAN type, value of MBEDTLS_X509_SAN_XXX. */
294     union {
295         mbedtls_x509_san_other_name other_name;
296         mbedtls_x509_name directory_name;
297         mbedtls_x509_buf unstructured_name; /**< The buffer for the unstructured types. rfc822Name, dnsName and uniformResourceIdentifier are currently supported. */
298     }
299     san; /**< A union of the supported SAN types */
300 }
301 mbedtls_x509_subject_alternative_name;
302 
303 typedef struct mbedtls_x509_san_list {
304     mbedtls_x509_subject_alternative_name node;
305     struct mbedtls_x509_san_list *next;
306 }
307 mbedtls_x509_san_list;
308 
309 /** \} name Structures for parsing X.509 certificates, CRLs and CSRs */
310 
311 /**
312  * \brief          Store the certificate DN in printable form into buf;
313  *                 no more than size characters will be written.
314  *
315  * \param buf      Buffer to write to
316  * \param size     Maximum size of buffer
317  * \param dn       The X509 name to represent
318  *
319  * \return         The length of the string written (not including the
320  *                 terminated nul byte), or a negative error code.
321  */
322 int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn);
323 
324 /**
325  * \brief          Return the next relative DN in an X509 name.
326  *
327  * \note           Intended use is to compare function result to dn->next
328  *                 in order to detect boundaries of multi-valued RDNs.
329  *
330  * \param dn       Current node in the X509 name
331  *
332  * \return         Pointer to the first attribute-value pair of the
333  *                 next RDN in sequence, or NULL if end is reached.
334  */
mbedtls_x509_dn_get_next(mbedtls_x509_name * dn)335 static inline mbedtls_x509_name *mbedtls_x509_dn_get_next(
336     mbedtls_x509_name *dn)
337 {
338     while (dn->MBEDTLS_PRIVATE(next_merged) && dn->next != NULL) {
339         dn = dn->next;
340     }
341     return dn->next;
342 }
343 
344 /**
345  * \brief          Store the certificate serial in printable form into buf;
346  *                 no more than size characters will be written.
347  *
348  * \param buf      Buffer to write to
349  * \param size     Maximum size of buffer
350  * \param serial   The X509 serial to represent
351  *
352  * \return         The length of the string written (not including the
353  *                 terminated nul byte), or a negative error code.
354  */
355 int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial);
356 
357 /**
358  * \brief          Compare pair of mbedtls_x509_time.
359  *
360  * \param t1       mbedtls_x509_time to compare
361  * \param t2       mbedtls_x509_time to compare
362  *
363  * \return         < 0 if t1 is before t2
364  *                   0 if t1 equals t2
365  *                 > 0 if t1 is after t2
366  */
367 int mbedtls_x509_time_cmp(const mbedtls_x509_time *t1, const mbedtls_x509_time *t2);
368 
369 #if defined(MBEDTLS_HAVE_TIME_DATE)
370 /**
371  * \brief          Fill mbedtls_x509_time with provided mbedtls_time_t.
372  *
373  * \param tt       mbedtls_time_t to convert
374  * \param now      mbedtls_x509_time to fill with converted mbedtls_time_t
375  *
376  * \return         \c 0 on success
377  * \return         A non-zero return value on failure.
378  */
379 int mbedtls_x509_time_gmtime(mbedtls_time_t tt, mbedtls_x509_time *now);
380 #endif /* MBEDTLS_HAVE_TIME_DATE */
381 
382 /**
383  * \brief          Check a given mbedtls_x509_time against the system time
384  *                 and tell if it's in the past.
385  *
386  * \note           Intended usage is "if( is_past( valid_to ) ) ERROR".
387  *                 Hence the return value of 1 if on internal errors.
388  *
389  * \param to       mbedtls_x509_time to check
390  *
391  * \return         1 if the given time is in the past or an error occurred,
392  *                 0 otherwise.
393  */
394 int mbedtls_x509_time_is_past(const mbedtls_x509_time *to);
395 
396 /**
397  * \brief          Check a given mbedtls_x509_time against the system time
398  *                 and tell if it's in the future.
399  *
400  * \note           Intended usage is "if( is_future( valid_from ) ) ERROR".
401  *                 Hence the return value of 1 if on internal errors.
402  *
403  * \param from     mbedtls_x509_time to check
404  *
405  * \return         1 if the given time is in the future or an error occurred,
406  *                 0 otherwise.
407  */
408 int mbedtls_x509_time_is_future(const mbedtls_x509_time *from);
409 
410 /**
411  * \brief          This function parses an item in the SubjectAlternativeNames
412  *                 extension. Please note that this function might allocate
413  *                 additional memory for a subject alternative name, thus
414  *                 mbedtls_x509_free_subject_alt_name has to be called
415  *                 to dispose of this additional memory afterwards.
416  *
417  * \param san_buf  The buffer holding the raw data item of the subject
418  *                 alternative name.
419  * \param san      The target structure to populate with the parsed presentation
420  *                 of the subject alternative name encoded in \p san_buf.
421  *
422  * \note           Supported GeneralName types, as defined in RFC 5280:
423  *                 "rfc822Name", "dnsName", "directoryName",
424  *                 "uniformResourceIdentifier" and "hardware_module_name"
425  *                 of type "otherName", as defined in RFC 4108.
426  *
427  * \note           This function should be called on a single raw data of
428  *                 subject alternative name. For example, after successful
429  *                 certificate parsing, one must iterate on every item in the
430  *                 \c crt->subject_alt_names sequence, and pass it to
431  *                 this function.
432  *
433  * \warning        The target structure contains pointers to the raw data of the
434  *                 parsed certificate, and its lifetime is restricted by the
435  *                 lifetime of the certificate.
436  *
437  * \return         \c 0 on success
438  * \return         #MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE for an unsupported
439  *                 SAN type.
440  * \return         Another negative value for any other failure.
441  */
442 int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf,
443                                         mbedtls_x509_subject_alternative_name *san);
444 /**
445  * \brief          Unallocate all data related to subject alternative name
446  *
447  * \param san      SAN structure - extra memory owned by this structure will be freed
448  */
449 void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san);
450 
451 /** \} addtogroup x509_module */
452 
453 /*
454  * Internal module functions. You probably do not want to use these unless you
455  * know you do.
456  */
457 int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end,
458                           mbedtls_x509_name *cur);
459 int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end,
460                               mbedtls_x509_buf *alg);
461 int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end,
462                          mbedtls_x509_buf *alg, mbedtls_x509_buf *params);
463 #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
464 int mbedtls_x509_get_rsassa_pss_params(const mbedtls_x509_buf *params,
465                                        mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
466                                        int *salt_len);
467 #endif
468 int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig);
469 int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
470                              mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
471                              void **sig_opts);
472 int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end,
473                           mbedtls_x509_time *t);
474 int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end,
475                             mbedtls_x509_buf *serial);
476 int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end,
477                          mbedtls_x509_buf *ext, int tag);
478 #if !defined(MBEDTLS_X509_REMOVE_INFO)
479 int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
480                               mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
481                               const void *sig_opts);
482 #endif
483 int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name);
484 int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name);
485 int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
486                                int critical, const unsigned char *val,
487                                size_t val_len);
488 int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start,
489                                   mbedtls_asn1_named_data *first);
490 int mbedtls_x509_write_names(unsigned char **p, unsigned char *start,
491                              mbedtls_asn1_named_data *first);
492 int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start,
493                            const char *oid, size_t oid_len,
494                            unsigned char *sig, size_t size,
495                            mbedtls_pk_type_t pk_alg);
496 int mbedtls_x509_get_ns_cert_type(unsigned char **p,
497                                   const unsigned char *end,
498                                   unsigned char *ns_cert_type);
499 int mbedtls_x509_get_key_usage(unsigned char **p,
500                                const unsigned char *end,
501                                unsigned int *key_usage);
502 int mbedtls_x509_get_subject_alt_name(unsigned char **p,
503                                       const unsigned char *end,
504                                       mbedtls_x509_sequence *subject_alt_name);
505 int mbedtls_x509_get_subject_alt_name_ext(unsigned char **p,
506                                           const unsigned char *end,
507                                           mbedtls_x509_sequence *subject_alt_name);
508 int mbedtls_x509_info_subject_alt_name(char **buf, size_t *size,
509                                        const mbedtls_x509_sequence
510                                        *subject_alt_name,
511                                        const char *prefix);
512 int mbedtls_x509_info_cert_type(char **buf, size_t *size,
513                                 unsigned char ns_cert_type);
514 int mbedtls_x509_info_key_usage(char **buf, size_t *size,
515                                 unsigned int key_usage);
516 
517 int mbedtls_x509_write_set_san_common(mbedtls_asn1_named_data **extensions,
518                                       const mbedtls_x509_san_list *san_list);
519 
520 /**
521  * \brief          This function parses a CN string as an IP address.
522  *
523  * \param cn       The CN string to parse. CN string MUST be null-terminated.
524  * \param dst      The target buffer to populate with the binary IP address.
525  *                 The buffer MUST be 16 bytes to save IPv6, and should be
526  *                 4-byte aligned if the result will be used as struct in_addr.
527  *                 e.g. uint32_t dst[4]
528  *
529  * \note           \p cn is parsed as an IPv6 address if string contains ':',
530  *                 else \p cn is parsed as an IPv4 address.
531  *
532  * \return         Length of binary IP address; num bytes written to target.
533  * \return         \c 0 on failure to parse CN string as an IP address.
534  */
535 size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst);
536 
537 #define MBEDTLS_X509_SAFE_SNPRINTF                          \
538     do {                                                    \
539         if (ret < 0 || (size_t) ret >= n)                  \
540         return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL;    \
541                                                           \
542         n -= (size_t) ret;                                  \
543         p += (size_t) ret;                                  \
544     } while (0)
545 
546 #ifdef __cplusplus
547 }
548 #endif
549 
550 #endif /* x509.h */
551