x509_crt.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661
  1. /**
  2. * \file x509_crt.h
  3. *
  4. * \brief X.509 certificate parsing and writing
  5. *
  6. * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  7. * SPDX-License-Identifier: Apache-2.0
  8. *
  9. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  10. * not use this file except in compliance with the License.
  11. * You may obtain a copy of the License at
  12. *
  13. * http://www.apache.org/licenses/LICENSE-2.0
  14. *
  15. * Unless required by applicable law or agreed to in writing, software
  16. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18. * See the License for the specific language governing permissions and
  19. * limitations under the License.
  20. *
  21. * This file is part of mbed TLS (https://tls.mbed.org)
  22. */
  23. #ifndef MBEDTLS_X509_CRT_H
  24. #define MBEDTLS_X509_CRT_H
  25. #if !defined(MBEDTLS_CONFIG_FILE)
  26. #include "config.h"
  27. #else
  28. #include MBEDTLS_CONFIG_FILE
  29. #endif
  30. #include "x509.h"
  31. #include "x509_crl.h"
  32. /**
  33. * \addtogroup x509_module
  34. * \{
  35. */
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  39. /**
  40. * \name Structures and functions for parsing and writing X.509 certificates
  41. * \{
  42. */
  43. /**
  44. * Container for an X.509 certificate. The certificate may be chained.
  45. */
  46. typedef struct mbedtls_x509_crt
  47. {
  48. mbedtls_x509_buf raw; /**< The raw certificate data (DER). */
  49. mbedtls_x509_buf tbs; /**< The raw certificate body (DER). The part that is To Be Signed. */
  50. int version; /**< The X.509 version. (1=v1, 2=v2, 3=v3) */
  51. mbedtls_x509_buf serial; /**< Unique id for certificate issued by a specific CA. */
  52. mbedtls_x509_buf sig_oid; /**< Signature algorithm, e.g. sha1RSA */
  53. mbedtls_x509_buf issuer_raw; /**< The raw issuer data (DER). Used for quick comparison. */
  54. mbedtls_x509_buf subject_raw; /**< The raw subject data (DER). Used for quick comparison. */
  55. mbedtls_x509_name issuer; /**< The parsed issuer data (named information object). */
  56. mbedtls_x509_name subject; /**< The parsed subject data (named information object). */
  57. mbedtls_x509_time valid_from; /**< Start time of certificate validity. */
  58. mbedtls_x509_time valid_to; /**< End time of certificate validity. */
  59. mbedtls_pk_context pk; /**< Container for the public key context. */
  60. mbedtls_x509_buf issuer_id; /**< Optional X.509 v2/v3 issuer unique identifier. */
  61. mbedtls_x509_buf subject_id; /**< Optional X.509 v2/v3 subject unique identifier. */
  62. mbedtls_x509_buf v3_ext; /**< Optional X.509 v3 extensions. */
  63. mbedtls_x509_sequence subject_alt_names; /**< Optional list of Subject Alternative Names (Only dNSName supported). */
  64. int ext_types; /**< Bit string containing detected and parsed extensions */
  65. int ca_istrue; /**< Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise. */
  66. int max_pathlen; /**< Optional Basic Constraint extension value: The maximum path length to the root certificate. Path length is 1 higher than RFC 5280 'meaning', so 1+ */
  67. unsigned int key_usage; /**< Optional key usage extension value: See the values in x509.h */
  68. mbedtls_x509_sequence ext_key_usage; /**< Optional list of extended key usage OIDs. */
  69. unsigned char ns_cert_type; /**< Optional Netscape certificate type extension value: See the values in x509.h */
  70. mbedtls_x509_buf sig; /**< Signature: hash of the tbs part signed with the private key. */
  71. mbedtls_md_type_t sig_md; /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */
  72. mbedtls_pk_type_t sig_pk; /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */
  73. void *sig_opts; /**< Signature options to be passed to mbedtls_pk_verify_ext(), e.g. for RSASSA-PSS */
  74. struct mbedtls_x509_crt *next; /**< Next certificate in the CA-chain. */
  75. }
  76. mbedtls_x509_crt;
  77. /**
  78. * Build flag from an algorithm/curve identifier (pk, md, ecp)
  79. * Since 0 is always XXX_NONE, ignore it.
  80. */
  81. #define MBEDTLS_X509_ID_FLAG( id ) ( 1 << ( id - 1 ) )
  82. /**
  83. * Security profile for certificate verification.
  84. *
  85. * All lists are bitfields, built by ORing flags from MBEDTLS_X509_ID_FLAG().
  86. */
  87. typedef struct
  88. {
  89. uint32_t allowed_mds; /**< MDs for signatures */
  90. uint32_t allowed_pks; /**< PK algs for signatures */
  91. uint32_t allowed_curves; /**< Elliptic curves for ECDSA */
  92. uint32_t rsa_min_bitlen; /**< Minimum size for RSA keys */
  93. }
  94. mbedtls_x509_crt_profile;
  95. #define MBEDTLS_X509_CRT_VERSION_1 0
  96. #define MBEDTLS_X509_CRT_VERSION_2 1
  97. #define MBEDTLS_X509_CRT_VERSION_3 2
  98. #define MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN 32
  99. #define MBEDTLS_X509_RFC5280_UTC_TIME_LEN 15
  100. #if !defined( MBEDTLS_X509_MAX_FILE_PATH_LEN )
  101. #define MBEDTLS_X509_MAX_FILE_PATH_LEN 512
  102. #endif
  103. /**
  104. * Container for writing a certificate (CRT)
  105. */
  106. typedef struct mbedtls_x509write_cert
  107. {
  108. int version;
  109. mbedtls_mpi serial;
  110. mbedtls_pk_context *subject_key;
  111. mbedtls_pk_context *issuer_key;
  112. mbedtls_asn1_named_data *subject;
  113. mbedtls_asn1_named_data *issuer;
  114. mbedtls_md_type_t md_alg;
  115. char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
  116. char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
  117. mbedtls_asn1_named_data *extensions;
  118. }
  119. mbedtls_x509write_cert;
  120. #if defined(MBEDTLS_X509_CRT_PARSE_C)
  121. /**
  122. * Default security profile. Should provide a good balance between security
  123. * and compatibility with current deployments.
  124. */
  125. extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default;
  126. /**
  127. * Expected next default profile. Recommended for new deployments.
  128. * Currently targets a 128-bit security level, except for RSA-2048.
  129. */
  130. extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next;
  131. /**
  132. * NSA Suite B profile.
  133. */
  134. extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb;
  135. /**
  136. * \brief Parse a single DER formatted certificate and add it
  137. * to the chained list.
  138. *
  139. * \param chain points to the start of the chain
  140. * \param buf buffer holding the certificate DER data
  141. * \param buflen size of the buffer
  142. *
  143. * \return 0 if successful, or a specific X509 or PEM error code
  144. */
  145. int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf,
  146. size_t buflen );
  147. /**
  148. * \brief Parse one or more certificates and add them
  149. * to the chained list. Parses permissively. If some
  150. * certificates can be parsed, the result is the number
  151. * of failed certificates it encountered. If none complete
  152. * correctly, the first error is returned.
  153. *
  154. * \param chain points to the start of the chain
  155. * \param buf buffer holding the certificate data in PEM or DER format
  156. * \param buflen size of the buffer
  157. * (including the terminating null byte for PEM data)
  158. *
  159. * \return 0 if all certificates parsed successfully, a positive number
  160. * if partly successful or a specific X509 or PEM error code
  161. */
  162. int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
  163. #if defined(MBEDTLS_FS_IO)
  164. /**
  165. * \brief Load one or more certificates and add them
  166. * to the chained list. Parses permissively. If some
  167. * certificates can be parsed, the result is the number
  168. * of failed certificates it encountered. If none complete
  169. * correctly, the first error is returned.
  170. *
  171. * \param chain points to the start of the chain
  172. * \param path filename to read the certificates from
  173. *
  174. * \return 0 if all certificates parsed successfully, a positive number
  175. * if partly successful or a specific X509 or PEM error code
  176. */
  177. int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path );
  178. /**
  179. * \brief Load one or more certificate files from a path and add them
  180. * to the chained list. Parses permissively. If some
  181. * certificates can be parsed, the result is the number
  182. * of failed certificates it encountered. If none complete
  183. * correctly, the first error is returned.
  184. *
  185. * \param chain points to the start of the chain
  186. * \param path directory / folder to read the certificate files from
  187. *
  188. * \return 0 if all certificates parsed successfully, a positive number
  189. * if partly successful or a specific X509 or PEM error code
  190. */
  191. int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path );
  192. #endif /* MBEDTLS_FS_IO */
  193. /**
  194. * \brief Returns an informational string about the
  195. * certificate.
  196. *
  197. * \param buf Buffer to write to
  198. * \param size Maximum size of buffer
  199. * \param prefix A line prefix
  200. * \param crt The X509 certificate to represent
  201. *
  202. * \return The length of the string written (not including the
  203. * terminated nul byte), or a negative error code.
  204. */
  205. int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
  206. const mbedtls_x509_crt *crt );
  207. /**
  208. * \brief Returns an informational string about the
  209. * verification status of a certificate.
  210. *
  211. * \param buf Buffer to write to
  212. * \param size Maximum size of buffer
  213. * \param prefix A line prefix
  214. * \param flags Verification flags created by mbedtls_x509_crt_verify()
  215. *
  216. * \return The length of the string written (not including the
  217. * terminated nul byte), or a negative error code.
  218. */
  219. int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix,
  220. uint32_t flags );
  221. /**
  222. * \brief Verify the certificate signature
  223. *
  224. * The verify callback is a user-supplied callback that
  225. * can clear / modify / add flags for a certificate. If set,
  226. * the verification callback is called for each
  227. * certificate in the chain (from the trust-ca down to the
  228. * presented crt). The parameters for the callback are:
  229. * (void *parameter, mbedtls_x509_crt *crt, int certificate_depth,
  230. * int *flags). With the flags representing current flags for
  231. * that specific certificate and the certificate depth from
  232. * the bottom (Peer cert depth = 0).
  233. *
  234. * All flags left after returning from the callback
  235. * are also returned to the application. The function should
  236. * return 0 for anything (including invalid certificates)
  237. * other than fatal error, as a non-zero return code
  238. * immediately aborts the verification process. For fatal
  239. * errors, a specific error code should be used (different
  240. * from MBEDTLS_ERR_X509_CERT_VERIFY_FAILED which should not
  241. * be returned at this point), or MBEDTLS_ERR_X509_FATAL_ERROR
  242. * can be used if no better code is available.
  243. *
  244. * \note In case verification failed, the results can be displayed
  245. * using \c mbedtls_x509_crt_verify_info()
  246. *
  247. * \note Same as \c mbedtls_x509_crt_verify_with_profile() with the
  248. * default security profile.
  249. *
  250. * \note It is your responsibility to provide up-to-date CRLs for
  251. * all trusted CAs. If no CRL is provided for the CA that was
  252. * used to sign the certificate, CRL verification is skipped
  253. * silently, that is *without* setting any flag.
  254. *
  255. * \param crt a certificate (chain) to be verified
  256. * \param trust_ca the list of trusted CAs
  257. * \param ca_crl the list of CRLs for trusted CAs (see note above)
  258. * \param cn expected Common Name (can be set to
  259. * NULL if the CN must not be verified)
  260. * \param flags result of the verification
  261. * \param f_vrfy verification function
  262. * \param p_vrfy verification parameter
  263. *
  264. * \return 0 (and flags set to 0) if the chain was verified and valid,
  265. * MBEDTLS_ERR_X509_CERT_VERIFY_FAILED if the chain was verified
  266. * but found to be invalid, in which case *flags will have one
  267. * or more MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX
  268. * flags set, or another error (and flags set to 0xffffffff)
  269. * in case of a fatal error encountered during the
  270. * verification process.
  271. */
  272. int mbedtls_x509_crt_verify( mbedtls_x509_crt *crt,
  273. mbedtls_x509_crt *trust_ca,
  274. mbedtls_x509_crl *ca_crl,
  275. const char *cn, uint32_t *flags,
  276. int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
  277. void *p_vrfy );
  278. /**
  279. * \brief Verify the certificate signature according to profile
  280. *
  281. * \note Same as \c mbedtls_x509_crt_verify(), but with explicit
  282. * security profile.
  283. *
  284. * \note The restrictions on keys (RSA minimum size, allowed curves
  285. * for ECDSA) apply to all certificates: trusted root,
  286. * intermediate CAs if any, and end entity certificate.
  287. *
  288. * \param crt a certificate (chain) to be verified
  289. * \param trust_ca the list of trusted CAs
  290. * \param ca_crl the list of CRLs for trusted CAs
  291. * \param profile security profile for verification
  292. * \param cn expected Common Name (can be set to
  293. * NULL if the CN must not be verified)
  294. * \param flags result of the verification
  295. * \param f_vrfy verification function
  296. * \param p_vrfy verification parameter
  297. *
  298. * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED
  299. * in which case *flags will have one or more
  300. * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags
  301. * set,
  302. * or another error in case of a fatal error encountered
  303. * during the verification process.
  304. */
  305. int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt,
  306. mbedtls_x509_crt *trust_ca,
  307. mbedtls_x509_crl *ca_crl,
  308. const mbedtls_x509_crt_profile *profile,
  309. const char *cn, uint32_t *flags,
  310. int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
  311. void *p_vrfy );
  312. #if defined(MBEDTLS_X509_CHECK_KEY_USAGE)
  313. /**
  314. * \brief Check usage of certificate against keyUsage extension.
  315. *
  316. * \param crt Leaf certificate used.
  317. * \param usage Intended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT
  318. * before using the certificate to perform an RSA key
  319. * exchange).
  320. *
  321. * \note Except for decipherOnly and encipherOnly, a bit set in the
  322. * usage argument means this bit MUST be set in the
  323. * certificate. For decipherOnly and encipherOnly, it means
  324. * that bit MAY be set.
  325. *
  326. * \return 0 is these uses of the certificate are allowed,
  327. * MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension
  328. * is present but does not match the usage argument.
  329. *
  330. * \note You should only call this function on leaf certificates, on
  331. * (intermediate) CAs the keyUsage extension is automatically
  332. * checked by \c mbedtls_x509_crt_verify().
  333. */
  334. int mbedtls_x509_crt_check_key_usage( const mbedtls_x509_crt *crt,
  335. unsigned int usage );
  336. #endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */
  337. #if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE)
  338. /**
  339. * \brief Check usage of certificate against extentedJeyUsage.
  340. *
  341. * \param crt Leaf certificate used.
  342. * \param usage_oid Intended usage (eg MBEDTLS_OID_SERVER_AUTH or MBEDTLS_OID_CLIENT_AUTH).
  343. * \param usage_len Length of usage_oid (eg given by MBEDTLS_OID_SIZE()).
  344. *
  345. * \return 0 if this use of the certificate is allowed,
  346. * MBEDTLS_ERR_X509_BAD_INPUT_DATA if not.
  347. *
  348. * \note Usually only makes sense on leaf certificates.
  349. */
  350. int mbedtls_x509_crt_check_extended_key_usage( const mbedtls_x509_crt *crt,
  351. const char *usage_oid,
  352. size_t usage_len );
  353. #endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE) */
  354. #if defined(MBEDTLS_X509_CRL_PARSE_C)
  355. /**
  356. * \brief Verify the certificate revocation status
  357. *
  358. * \param crt a certificate to be verified
  359. * \param crl the CRL to verify against
  360. *
  361. * \return 1 if the certificate is revoked, 0 otherwise
  362. *
  363. */
  364. int mbedtls_x509_crt_is_revoked( const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl );
  365. #endif /* MBEDTLS_X509_CRL_PARSE_C */
  366. /**
  367. * \brief Initialize a certificate (chain)
  368. *
  369. * \param crt Certificate chain to initialize
  370. */
  371. void mbedtls_x509_crt_init( mbedtls_x509_crt *crt );
  372. /**
  373. * \brief Unallocate all certificate data
  374. *
  375. * \param crt Certificate chain to free
  376. */
  377. void mbedtls_x509_crt_free( mbedtls_x509_crt *crt );
  378. #endif /* MBEDTLS_X509_CRT_PARSE_C */
  379. /* \} name */
  380. /* \} addtogroup x509_module */
  381. #if defined(MBEDTLS_X509_CRT_WRITE_C)
  382. /**
  383. * \brief Initialize a CRT writing context
  384. *
  385. * \param ctx CRT context to initialize
  386. */
  387. void mbedtls_x509write_crt_init( mbedtls_x509write_cert *ctx );
  388. /**
  389. * \brief Set the verion for a Certificate
  390. * Default: MBEDTLS_X509_CRT_VERSION_3
  391. *
  392. * \param ctx CRT context to use
  393. * \param version version to set (MBEDTLS_X509_CRT_VERSION_1, MBEDTLS_X509_CRT_VERSION_2 or
  394. * MBEDTLS_X509_CRT_VERSION_3)
  395. */
  396. void mbedtls_x509write_crt_set_version( mbedtls_x509write_cert *ctx, int version );
  397. /**
  398. * \brief Set the serial number for a Certificate.
  399. *
  400. * \param ctx CRT context to use
  401. * \param serial serial number to set
  402. *
  403. * \return 0 if successful
  404. */
  405. int mbedtls_x509write_crt_set_serial( mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial );
  406. /**
  407. * \brief Set the validity period for a Certificate
  408. * Timestamps should be in string format for UTC timezone
  409. * i.e. "YYYYMMDDhhmmss"
  410. * e.g. "20131231235959" for December 31st 2013
  411. * at 23:59:59
  412. *
  413. * \param ctx CRT context to use
  414. * \param not_before not_before timestamp
  415. * \param not_after not_after timestamp
  416. *
  417. * \return 0 if timestamp was parsed successfully, or
  418. * a specific error code
  419. */
  420. int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before,
  421. const char *not_after );
  422. /**
  423. * \brief Set the issuer name for a Certificate
  424. * Issuer names should contain a comma-separated list
  425. * of OID types and values:
  426. * e.g. "C=UK,O=ARM,CN=mbed TLS CA"
  427. *
  428. * \param ctx CRT context to use
  429. * \param issuer_name issuer name to set
  430. *
  431. * \return 0 if issuer name was parsed successfully, or
  432. * a specific error code
  433. */
  434. int mbedtls_x509write_crt_set_issuer_name( mbedtls_x509write_cert *ctx,
  435. const char *issuer_name );
  436. /**
  437. * \brief Set the subject name for a Certificate
  438. * Subject names should contain a comma-separated list
  439. * of OID types and values:
  440. * e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
  441. *
  442. * \param ctx CRT context to use
  443. * \param subject_name subject name to set
  444. *
  445. * \return 0 if subject name was parsed successfully, or
  446. * a specific error code
  447. */
  448. int mbedtls_x509write_crt_set_subject_name( mbedtls_x509write_cert *ctx,
  449. const char *subject_name );
  450. /**
  451. * \brief Set the subject public key for the certificate
  452. *
  453. * \param ctx CRT context to use
  454. * \param key public key to include
  455. */
  456. void mbedtls_x509write_crt_set_subject_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
  457. /**
  458. * \brief Set the issuer key used for signing the certificate
  459. *
  460. * \param ctx CRT context to use
  461. * \param key private key to sign with
  462. */
  463. void mbedtls_x509write_crt_set_issuer_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
  464. /**
  465. * \brief Set the MD algorithm to use for the signature
  466. * (e.g. MBEDTLS_MD_SHA1)
  467. *
  468. * \param ctx CRT context to use
  469. * \param md_alg MD algorithm to use
  470. */
  471. void mbedtls_x509write_crt_set_md_alg( mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg );
  472. /**
  473. * \brief Generic function to add to or replace an extension in the
  474. * CRT
  475. *
  476. * \param ctx CRT context to use
  477. * \param oid OID of the extension
  478. * \param oid_len length of the OID
  479. * \param critical if the extension is critical (per the RFC's definition)
  480. * \param val value of the extension OCTET STRING
  481. * \param val_len length of the value data
  482. *
  483. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  484. */
  485. int mbedtls_x509write_crt_set_extension( mbedtls_x509write_cert *ctx,
  486. const char *oid, size_t oid_len,
  487. int critical,
  488. const unsigned char *val, size_t val_len );
  489. /**
  490. * \brief Set the basicConstraints extension for a CRT
  491. *
  492. * \param ctx CRT context to use
  493. * \param is_ca is this a CA certificate
  494. * \param max_pathlen maximum length of certificate chains below this
  495. * certificate (only for CA certificates, -1 is
  496. * inlimited)
  497. *
  498. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  499. */
  500. int mbedtls_x509write_crt_set_basic_constraints( mbedtls_x509write_cert *ctx,
  501. int is_ca, int max_pathlen );
  502. #if defined(MBEDTLS_SHA1_C)
  503. /**
  504. * \brief Set the subjectKeyIdentifier extension for a CRT
  505. * Requires that mbedtls_x509write_crt_set_subject_key() has been
  506. * called before
  507. *
  508. * \param ctx CRT context to use
  509. *
  510. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  511. */
  512. int mbedtls_x509write_crt_set_subject_key_identifier( mbedtls_x509write_cert *ctx );
  513. /**
  514. * \brief Set the authorityKeyIdentifier extension for a CRT
  515. * Requires that mbedtls_x509write_crt_set_issuer_key() has been
  516. * called before
  517. *
  518. * \param ctx CRT context to use
  519. *
  520. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  521. */
  522. int mbedtls_x509write_crt_set_authority_key_identifier( mbedtls_x509write_cert *ctx );
  523. #endif /* MBEDTLS_SHA1_C */
  524. /**
  525. * \brief Set the Key Usage Extension flags
  526. * (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN)
  527. *
  528. * \param ctx CRT context to use
  529. * \param key_usage key usage flags to set
  530. *
  531. * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
  532. */
  533. int mbedtls_x509write_crt_set_key_usage( mbedtls_x509write_cert *ctx,
  534. unsigned int key_usage );
  535. /**
  536. * \brief Set the Netscape Cert Type flags
  537. * (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL)
  538. *
  539. * \param ctx CRT context to use
  540. * \param ns_cert_type Netscape Cert Type flags to set
  541. *
  542. * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
  543. */
  544. int mbedtls_x509write_crt_set_ns_cert_type( mbedtls_x509write_cert *ctx,
  545. unsigned char ns_cert_type );
  546. /**
  547. * \brief Free the contents of a CRT write context
  548. *
  549. * \param ctx CRT context to free
  550. */
  551. void mbedtls_x509write_crt_free( mbedtls_x509write_cert *ctx );
  552. /**
  553. * \brief Write a built up certificate to a X509 DER structure
  554. * Note: data is written at the end of the buffer! Use the
  555. * return value to determine where you should start
  556. * using the buffer
  557. *
  558. * \param ctx certificate to write away
  559. * \param buf buffer to write to
  560. * \param size size of the buffer
  561. * \param f_rng RNG function (for signature, see note)
  562. * \param p_rng RNG parameter
  563. *
  564. * \return length of data written if successful, or a specific
  565. * error code
  566. *
  567. * \note f_rng may be NULL if RSA is used for signature and the
  568. * signature is made offline (otherwise f_rng is desirable
  569. * for countermeasures against timing attacks).
  570. * ECDSA signatures always require a non-NULL f_rng.
  571. */
  572. int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
  573. int (*f_rng)(void *, unsigned char *, size_t),
  574. void *p_rng );
  575. #if defined(MBEDTLS_PEM_WRITE_C)
  576. /**
  577. * \brief Write a built up certificate to a X509 PEM string
  578. *
  579. * \param ctx certificate to write away
  580. * \param buf buffer to write to
  581. * \param size size of the buffer
  582. * \param f_rng RNG function (for signature, see note)
  583. * \param p_rng RNG parameter
  584. *
  585. * \return 0 if successful, or a specific error code
  586. *
  587. * \note f_rng may be NULL if RSA is used for signature and the
  588. * signature is made offline (otherwise f_rng is desirable
  589. * for countermeasures against timing attacks).
  590. * ECDSA signatures always require a non-NULL f_rng.
  591. */
  592. int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
  593. int (*f_rng)(void *, unsigned char *, size_t),
  594. void *p_rng );
  595. #endif /* MBEDTLS_PEM_WRITE_C */
  596. #endif /* MBEDTLS_X509_CRT_WRITE_C */
  597. #ifdef __cplusplus
  598. }
  599. #endif
  600. #endif /* mbedtls_x509_crt.h */