x509_crt.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645
  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. /**
  101. * Container for writing a certificate (CRT)
  102. */
  103. typedef struct mbedtls_x509write_cert
  104. {
  105. int version;
  106. mbedtls_mpi serial;
  107. mbedtls_pk_context *subject_key;
  108. mbedtls_pk_context *issuer_key;
  109. mbedtls_asn1_named_data *subject;
  110. mbedtls_asn1_named_data *issuer;
  111. mbedtls_md_type_t md_alg;
  112. char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
  113. char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
  114. mbedtls_asn1_named_data *extensions;
  115. }
  116. mbedtls_x509write_cert;
  117. #if defined(MBEDTLS_X509_CRT_PARSE_C)
  118. /**
  119. * Default security profile. Should provide a good balance between security
  120. * and compatibility with current deployments.
  121. */
  122. extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default;
  123. /**
  124. * Expected next default profile. Recommended for new deployments.
  125. * Currently targets a 128-bit security level, except for RSA-2048.
  126. */
  127. extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next;
  128. /**
  129. * NSA Suite B profile.
  130. */
  131. extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb;
  132. /**
  133. * \brief Parse a single DER formatted certificate and add it
  134. * to the chained list.
  135. *
  136. * \param chain points to the start of the chain
  137. * \param buf buffer holding the certificate DER data
  138. * \param buflen size of the buffer
  139. *
  140. * \return 0 if successful, or a specific X509 or PEM error code
  141. */
  142. int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf,
  143. size_t buflen );
  144. /**
  145. * \brief Parse one or more certificates and add them
  146. * to the chained list. Parses permissively. If some
  147. * certificates can be parsed, the result is the number
  148. * of failed certificates it encountered. If none complete
  149. * correctly, the first error is returned.
  150. *
  151. * \param chain points to the start of the chain
  152. * \param buf buffer holding the certificate data in PEM or DER format
  153. * \param buflen size of the buffer
  154. * (including the terminating null byte for PEM data)
  155. *
  156. * \return 0 if all certificates parsed successfully, a positive number
  157. * if partly successful or a specific X509 or PEM error code
  158. */
  159. int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
  160. #if defined(MBEDTLS_FS_IO)
  161. /**
  162. * \brief Load one or more certificates and add them
  163. * to the chained list. Parses permissively. If some
  164. * certificates can be parsed, the result is the number
  165. * of failed certificates it encountered. If none complete
  166. * correctly, the first error is returned.
  167. *
  168. * \param chain points to the start of the chain
  169. * \param path filename to read the certificates from
  170. *
  171. * \return 0 if all certificates parsed successfully, a positive number
  172. * if partly successful or a specific X509 or PEM error code
  173. */
  174. int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path );
  175. /**
  176. * \brief Load one or more certificate files from a path and add them
  177. * to the chained list. Parses permissively. If some
  178. * certificates can be parsed, the result is the number
  179. * of failed certificates it encountered. If none complete
  180. * correctly, the first error is returned.
  181. *
  182. * \param chain points to the start of the chain
  183. * \param path directory / folder to read the certificate files from
  184. *
  185. * \return 0 if all certificates parsed successfully, a positive number
  186. * if partly successful or a specific X509 or PEM error code
  187. */
  188. int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path );
  189. #endif /* MBEDTLS_FS_IO */
  190. /**
  191. * \brief Returns an informational string about the
  192. * certificate.
  193. *
  194. * \param buf Buffer to write to
  195. * \param size Maximum size of buffer
  196. * \param prefix A line prefix
  197. * \param crt The X509 certificate to represent
  198. *
  199. * \return The length of the string written (not including the
  200. * terminated nul byte), or a negative error code.
  201. */
  202. int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
  203. const mbedtls_x509_crt *crt );
  204. /**
  205. * \brief Returns an informational string about the
  206. * verification status of a certificate.
  207. *
  208. * \param buf Buffer to write to
  209. * \param size Maximum size of buffer
  210. * \param prefix A line prefix
  211. * \param flags Verification flags created by mbedtls_x509_crt_verify()
  212. *
  213. * \return The length of the string written (not including the
  214. * terminated nul byte), or a negative error code.
  215. */
  216. int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix,
  217. uint32_t flags );
  218. /**
  219. * \brief Verify the certificate signature
  220. *
  221. * The verify callback is a user-supplied callback that
  222. * can clear / modify / add flags for a certificate. If set,
  223. * the verification callback is called for each
  224. * certificate in the chain (from the trust-ca down to the
  225. * presented crt). The parameters for the callback are:
  226. * (void *parameter, mbedtls_x509_crt *crt, int certificate_depth,
  227. * int *flags). With the flags representing current flags for
  228. * that specific certificate and the certificate depth from
  229. * the bottom (Peer cert depth = 0).
  230. *
  231. * All flags left after returning from the callback
  232. * are also returned to the application. The function should
  233. * return 0 for anything but a fatal error.
  234. *
  235. * \note In case verification failed, the results can be displayed
  236. * using \c mbedtls_x509_crt_verify_info()
  237. *
  238. * \note Same as \c mbedtls_x509_crt_verify_with_profile() with the
  239. * default security profile.
  240. *
  241. * \param crt a certificate to be verified
  242. * \param trust_ca the trusted CA chain
  243. * \param ca_crl the CRL chain for trusted CA's
  244. * \param cn expected Common Name (can be set to
  245. * NULL if the CN must not be verified)
  246. * \param flags result of the verification
  247. * \param f_vrfy verification function
  248. * \param p_vrfy verification parameter
  249. *
  250. * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED
  251. * in which case *flags will have one or more
  252. * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags
  253. * set,
  254. * or another error in case of a fatal error encountered
  255. * during the verification process.
  256. */
  257. int mbedtls_x509_crt_verify( mbedtls_x509_crt *crt,
  258. mbedtls_x509_crt *trust_ca,
  259. mbedtls_x509_crl *ca_crl,
  260. const char *cn, uint32_t *flags,
  261. int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
  262. void *p_vrfy );
  263. /**
  264. * \brief Verify the certificate signature according to profile
  265. *
  266. * \note Same as \c mbedtls_x509_crt_verify(), but with explicit
  267. * security profile.
  268. *
  269. * \note The restrictions on keys (RSA minimum size, allowed curves
  270. * for ECDSA) apply to all certificates: trusted root,
  271. * intermediate CAs if any, and end entity certificate.
  272. *
  273. * \param crt a certificate to be verified
  274. * \param trust_ca the trusted CA chain
  275. * \param ca_crl the CRL chain for trusted CA's
  276. * \param profile security profile for verification
  277. * \param cn expected Common Name (can be set to
  278. * NULL if the CN must not be verified)
  279. * \param flags result of the verification
  280. * \param f_vrfy verification function
  281. * \param p_vrfy verification parameter
  282. *
  283. * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED
  284. * in which case *flags will have one or more
  285. * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags
  286. * set,
  287. * or another error in case of a fatal error encountered
  288. * during the verification process.
  289. */
  290. int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt,
  291. mbedtls_x509_crt *trust_ca,
  292. mbedtls_x509_crl *ca_crl,
  293. const mbedtls_x509_crt_profile *profile,
  294. const char *cn, uint32_t *flags,
  295. int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
  296. void *p_vrfy );
  297. #if defined(MBEDTLS_X509_CHECK_KEY_USAGE)
  298. /**
  299. * \brief Check usage of certificate against keyUsage extension.
  300. *
  301. * \param crt Leaf certificate used.
  302. * \param usage Intended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT
  303. * before using the certificate to perform an RSA key
  304. * exchange).
  305. *
  306. * \note Except for decipherOnly and encipherOnly, a bit set in the
  307. * usage argument means this bit MUST be set in the
  308. * certificate. For decipherOnly and encipherOnly, it means
  309. * that bit MAY be set.
  310. *
  311. * \return 0 is these uses of the certificate are allowed,
  312. * MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension
  313. * is present but does not match the usage argument.
  314. *
  315. * \note You should only call this function on leaf certificates, on
  316. * (intermediate) CAs the keyUsage extension is automatically
  317. * checked by \c mbedtls_x509_crt_verify().
  318. */
  319. int mbedtls_x509_crt_check_key_usage( const mbedtls_x509_crt *crt,
  320. unsigned int usage );
  321. #endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */
  322. #if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE)
  323. /**
  324. * \brief Check usage of certificate against extentedJeyUsage.
  325. *
  326. * \param crt Leaf certificate used.
  327. * \param usage_oid Intended usage (eg MBEDTLS_OID_SERVER_AUTH or MBEDTLS_OID_CLIENT_AUTH).
  328. * \param usage_len Length of usage_oid (eg given by MBEDTLS_OID_SIZE()).
  329. *
  330. * \return 0 if this use of the certificate is allowed,
  331. * MBEDTLS_ERR_X509_BAD_INPUT_DATA if not.
  332. *
  333. * \note Usually only makes sense on leaf certificates.
  334. */
  335. int mbedtls_x509_crt_check_extended_key_usage( const mbedtls_x509_crt *crt,
  336. const char *usage_oid,
  337. size_t usage_len );
  338. #endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE) */
  339. #if defined(MBEDTLS_X509_CRL_PARSE_C)
  340. /**
  341. * \brief Verify the certificate revocation status
  342. *
  343. * \param crt a certificate to be verified
  344. * \param crl the CRL to verify against
  345. *
  346. * \return 1 if the certificate is revoked, 0 otherwise
  347. *
  348. */
  349. int mbedtls_x509_crt_is_revoked( const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl );
  350. #endif /* MBEDTLS_X509_CRL_PARSE_C */
  351. /**
  352. * \brief Initialize a certificate (chain)
  353. *
  354. * \param crt Certificate chain to initialize
  355. */
  356. void mbedtls_x509_crt_init( mbedtls_x509_crt *crt );
  357. /**
  358. * \brief Unallocate all certificate data
  359. *
  360. * \param crt Certificate chain to free
  361. */
  362. void mbedtls_x509_crt_free( mbedtls_x509_crt *crt );
  363. #endif /* MBEDTLS_X509_CRT_PARSE_C */
  364. /* \} name */
  365. /* \} addtogroup x509_module */
  366. #if defined(MBEDTLS_X509_CRT_WRITE_C)
  367. /**
  368. * \brief Initialize a CRT writing context
  369. *
  370. * \param ctx CRT context to initialize
  371. */
  372. void mbedtls_x509write_crt_init( mbedtls_x509write_cert *ctx );
  373. /**
  374. * \brief Set the verion for a Certificate
  375. * Default: MBEDTLS_X509_CRT_VERSION_3
  376. *
  377. * \param ctx CRT context to use
  378. * \param version version to set (MBEDTLS_X509_CRT_VERSION_1, MBEDTLS_X509_CRT_VERSION_2 or
  379. * MBEDTLS_X509_CRT_VERSION_3)
  380. */
  381. void mbedtls_x509write_crt_set_version( mbedtls_x509write_cert *ctx, int version );
  382. /**
  383. * \brief Set the serial number for a Certificate.
  384. *
  385. * \param ctx CRT context to use
  386. * \param serial serial number to set
  387. *
  388. * \return 0 if successful
  389. */
  390. int mbedtls_x509write_crt_set_serial( mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial );
  391. /**
  392. * \brief Set the validity period for a Certificate
  393. * Timestamps should be in string format for UTC timezone
  394. * i.e. "YYYYMMDDhhmmss"
  395. * e.g. "20131231235959" for December 31st 2013
  396. * at 23:59:59
  397. *
  398. * \param ctx CRT context to use
  399. * \param not_before not_before timestamp
  400. * \param not_after not_after timestamp
  401. *
  402. * \return 0 if timestamp was parsed successfully, or
  403. * a specific error code
  404. */
  405. int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before,
  406. const char *not_after );
  407. /**
  408. * \brief Set the issuer name for a Certificate
  409. * Issuer names should contain a comma-separated list
  410. * of OID types and values:
  411. * e.g. "C=UK,O=ARM,CN=mbed TLS CA"
  412. *
  413. * \param ctx CRT context to use
  414. * \param issuer_name issuer name to set
  415. *
  416. * \return 0 if issuer name was parsed successfully, or
  417. * a specific error code
  418. */
  419. int mbedtls_x509write_crt_set_issuer_name( mbedtls_x509write_cert *ctx,
  420. const char *issuer_name );
  421. /**
  422. * \brief Set the subject name for a Certificate
  423. * Subject names should contain a comma-separated list
  424. * of OID types and values:
  425. * e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
  426. *
  427. * \param ctx CRT context to use
  428. * \param subject_name subject name to set
  429. *
  430. * \return 0 if subject name was parsed successfully, or
  431. * a specific error code
  432. */
  433. int mbedtls_x509write_crt_set_subject_name( mbedtls_x509write_cert *ctx,
  434. const char *subject_name );
  435. /**
  436. * \brief Set the subject public key for the certificate
  437. *
  438. * \param ctx CRT context to use
  439. * \param key public key to include
  440. */
  441. void mbedtls_x509write_crt_set_subject_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
  442. /**
  443. * \brief Set the issuer key used for signing the certificate
  444. *
  445. * \param ctx CRT context to use
  446. * \param key private key to sign with
  447. */
  448. void mbedtls_x509write_crt_set_issuer_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
  449. /**
  450. * \brief Set the MD algorithm to use for the signature
  451. * (e.g. MBEDTLS_MD_SHA1)
  452. *
  453. * \param ctx CRT context to use
  454. * \param md_alg MD algorithm to use
  455. */
  456. void mbedtls_x509write_crt_set_md_alg( mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg );
  457. /**
  458. * \brief Generic function to add to or replace an extension in the
  459. * CRT
  460. *
  461. * \param ctx CRT context to use
  462. * \param oid OID of the extension
  463. * \param oid_len length of the OID
  464. * \param critical if the extension is critical (per the RFC's definition)
  465. * \param val value of the extension OCTET STRING
  466. * \param val_len length of the value data
  467. *
  468. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  469. */
  470. int mbedtls_x509write_crt_set_extension( mbedtls_x509write_cert *ctx,
  471. const char *oid, size_t oid_len,
  472. int critical,
  473. const unsigned char *val, size_t val_len );
  474. /**
  475. * \brief Set the basicConstraints extension for a CRT
  476. *
  477. * \param ctx CRT context to use
  478. * \param is_ca is this a CA certificate
  479. * \param max_pathlen maximum length of certificate chains below this
  480. * certificate (only for CA certificates, -1 is
  481. * inlimited)
  482. *
  483. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  484. */
  485. int mbedtls_x509write_crt_set_basic_constraints( mbedtls_x509write_cert *ctx,
  486. int is_ca, int max_pathlen );
  487. #if defined(MBEDTLS_SHA1_C)
  488. /**
  489. * \brief Set the subjectKeyIdentifier extension for a CRT
  490. * Requires that mbedtls_x509write_crt_set_subject_key() has been
  491. * called before
  492. *
  493. * \param ctx CRT context to use
  494. *
  495. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  496. */
  497. int mbedtls_x509write_crt_set_subject_key_identifier( mbedtls_x509write_cert *ctx );
  498. /**
  499. * \brief Set the authorityKeyIdentifier extension for a CRT
  500. * Requires that mbedtls_x509write_crt_set_issuer_key() has been
  501. * called before
  502. *
  503. * \param ctx CRT context to use
  504. *
  505. * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
  506. */
  507. int mbedtls_x509write_crt_set_authority_key_identifier( mbedtls_x509write_cert *ctx );
  508. #endif /* MBEDTLS_SHA1_C */
  509. /**
  510. * \brief Set the Key Usage Extension flags
  511. * (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN)
  512. *
  513. * \param ctx CRT context to use
  514. * \param key_usage key usage flags to set
  515. *
  516. * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
  517. */
  518. int mbedtls_x509write_crt_set_key_usage( mbedtls_x509write_cert *ctx,
  519. unsigned int key_usage );
  520. /**
  521. * \brief Set the Netscape Cert Type flags
  522. * (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL)
  523. *
  524. * \param ctx CRT context to use
  525. * \param ns_cert_type Netscape Cert Type flags to set
  526. *
  527. * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
  528. */
  529. int mbedtls_x509write_crt_set_ns_cert_type( mbedtls_x509write_cert *ctx,
  530. unsigned char ns_cert_type );
  531. /**
  532. * \brief Free the contents of a CRT write context
  533. *
  534. * \param ctx CRT context to free
  535. */
  536. void mbedtls_x509write_crt_free( mbedtls_x509write_cert *ctx );
  537. /**
  538. * \brief Write a built up certificate to a X509 DER structure
  539. * Note: data is written at the end of the buffer! Use the
  540. * return value to determine where you should start
  541. * using the buffer
  542. *
  543. * \param ctx certificate to write away
  544. * \param buf buffer to write to
  545. * \param size size of the buffer
  546. * \param f_rng RNG function (for signature, see note)
  547. * \param p_rng RNG parameter
  548. *
  549. * \return length of data written if successful, or a specific
  550. * error code
  551. *
  552. * \note f_rng may be NULL if RSA is used for signature and the
  553. * signature is made offline (otherwise f_rng is desirable
  554. * for countermeasures against timing attacks).
  555. * ECDSA signatures always require a non-NULL f_rng.
  556. */
  557. int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
  558. int (*f_rng)(void *, unsigned char *, size_t),
  559. void *p_rng );
  560. #if defined(MBEDTLS_PEM_WRITE_C)
  561. /**
  562. * \brief Write a built up certificate to a X509 PEM string
  563. *
  564. * \param ctx certificate to write away
  565. * \param buf buffer to write to
  566. * \param size size of the buffer
  567. * \param f_rng RNG function (for signature, see note)
  568. * \param p_rng RNG parameter
  569. *
  570. * \return 0 if successful, or a specific error code
  571. *
  572. * \note f_rng may be NULL if RSA is used for signature and the
  573. * signature is made offline (otherwise f_rng is desirable
  574. * for countermeasures against timing attacks).
  575. * ECDSA signatures always require a non-NULL f_rng.
  576. */
  577. int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
  578. int (*f_rng)(void *, unsigned char *, size_t),
  579. void *p_rng );
  580. #endif /* MBEDTLS_PEM_WRITE_C */
  581. #endif /* MBEDTLS_X509_CRT_WRITE_C */
  582. #ifdef __cplusplus
  583. }
  584. #endif
  585. #endif /* mbedtls_x509_crt.h */