1 /** 2 * \file x509_crt.h 3 * 4 * \brief X.509 certificate parsing and writing 5 */ 6 /* 7 * Copyright The Mbed TLS Contributors 8 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 9 * 10 * This file is provided under the Apache License 2.0, or the 11 * GNU General Public License v2.0 or later. 12 * 13 * ********** 14 * Apache License 2.0: 15 * 16 * Licensed under the Apache License, Version 2.0 (the "License"); you may 17 * not use this file except in compliance with the License. 18 * You may obtain a copy of the License at 19 * 20 * http://www.apache.org/licenses/LICENSE-2.0 21 * 22 * Unless required by applicable law or agreed to in writing, software 23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 25 * See the License for the specific language governing permissions and 26 * limitations under the License. 27 * 28 * ********** 29 * 30 * ********** 31 * GNU General Public License v2.0 or later: 32 * 33 * This program is free software; you can redistribute it and/or modify 34 * it under the terms of the GNU General Public License as published by 35 * the Free Software Foundation; either version 2 of the License, or 36 * (at your option) any later version. 37 * 38 * This program is distributed in the hope that it will be useful, 39 * but WITHOUT ANY WARRANTY; without even the implied warranty of 40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 41 * GNU General Public License for more details. 42 * 43 * You should have received a copy of the GNU General Public License along 44 * with this program; if not, write to the Free Software Foundation, Inc., 45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 46 * 47 * ********** 48 */ 49 #ifndef MBEDTLS_X509_CRT_H 50 #define MBEDTLS_X509_CRT_H 51 52 #if !defined(MBEDTLS_CONFIG_FILE) 53 #include "config.h" 54 #else 55 #include MBEDTLS_CONFIG_FILE 56 #endif 57 58 #include "x509.h" 59 #include "x509_crl.h" 60 61 /** 62 * \addtogroup x509_module 63 * \{ 64 */ 65 66 #ifdef __cplusplus 67 extern "C" { 68 #endif 69 70 /** 71 * \name Structures and functions for parsing and writing X.509 certificates 72 * \{ 73 */ 74 75 /** 76 * Container for an X.509 certificate. The certificate may be chained. 77 */ 78 typedef struct mbedtls_x509_crt 79 { 80 mbedtls_x509_buf raw; /**< The raw certificate data (DER). */ 81 mbedtls_x509_buf tbs; /**< The raw certificate body (DER). The part that is To Be Signed. */ 82 83 int version; /**< The X.509 version. (1=v1, 2=v2, 3=v3) */ 84 mbedtls_x509_buf serial; /**< Unique id for certificate issued by a specific CA. */ 85 mbedtls_x509_buf sig_oid; /**< Signature algorithm, e.g. sha1RSA */ 86 87 mbedtls_x509_buf issuer_raw; /**< The raw issuer data (DER). Used for quick comparison. */ 88 mbedtls_x509_buf subject_raw; /**< The raw subject data (DER). Used for quick comparison. */ 89 90 mbedtls_x509_name issuer; /**< The parsed issuer data (named information object). */ 91 mbedtls_x509_name subject; /**< The parsed subject data (named information object). */ 92 93 mbedtls_x509_time valid_from; /**< Start time of certificate validity. */ 94 mbedtls_x509_time valid_to; /**< End time of certificate validity. */ 95 96 mbedtls_pk_context pk; /**< Container for the public key context. */ 97 98 mbedtls_x509_buf issuer_id; /**< Optional X.509 v2/v3 issuer unique identifier. */ 99 mbedtls_x509_buf subject_id; /**< Optional X.509 v2/v3 subject unique identifier. */ 100 mbedtls_x509_buf v3_ext; /**< Optional X.509 v3 extensions. */ 101 mbedtls_x509_sequence subject_alt_names; /**< Optional list of Subject Alternative Names (Only dNSName supported). */ 102 103 int ext_types; /**< Bit string containing detected and parsed extensions */ 104 int ca_istrue; /**< Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise. */ 105 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+ */ 106 107 unsigned int key_usage; /**< Optional key usage extension value: See the values in x509.h */ 108 109 mbedtls_x509_sequence ext_key_usage; /**< Optional list of extended key usage OIDs. */ 110 111 unsigned char ns_cert_type; /**< Optional Netscape certificate type extension value: See the values in x509.h */ 112 113 mbedtls_x509_buf sig; /**< Signature: hash of the tbs part signed with the private key. */ 114 mbedtls_md_type_t sig_md; /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */ 115 mbedtls_pk_type_t sig_pk; /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */ 116 void *sig_opts; /**< Signature options to be passed to mbedtls_pk_verify_ext(), e.g. for RSASSA-PSS */ 117 118 struct mbedtls_x509_crt *next; /**< Next certificate in the CA-chain. */ 119 } 120 mbedtls_x509_crt; 121 122 /** 123 * Build flag from an algorithm/curve identifier (pk, md, ecp) 124 * Since 0 is always XXX_NONE, ignore it. 125 */ 126 #define MBEDTLS_X509_ID_FLAG( id ) ( 1 << ( (id) - 1 ) ) 127 128 /** 129 * Security profile for certificate verification. 130 * 131 * All lists are bitfields, built by ORing flags from MBEDTLS_X509_ID_FLAG(). 132 */ 133 typedef struct mbedtls_x509_crt_profile 134 { 135 uint32_t allowed_mds; /**< MDs for signatures */ 136 uint32_t allowed_pks; /**< PK algs for signatures */ 137 uint32_t allowed_curves; /**< Elliptic curves for ECDSA */ 138 uint32_t rsa_min_bitlen; /**< Minimum size for RSA keys */ 139 } 140 mbedtls_x509_crt_profile; 141 142 #define MBEDTLS_X509_CRT_VERSION_1 0 143 #define MBEDTLS_X509_CRT_VERSION_2 1 144 #define MBEDTLS_X509_CRT_VERSION_3 2 145 146 #define MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN 32 147 #define MBEDTLS_X509_RFC5280_UTC_TIME_LEN 15 148 149 #if !defined( MBEDTLS_X509_MAX_FILE_PATH_LEN ) 150 #define MBEDTLS_X509_MAX_FILE_PATH_LEN 512 151 #endif 152 153 /** 154 * Container for writing a certificate (CRT) 155 */ 156 typedef struct mbedtls_x509write_cert 157 { 158 int version; 159 mbedtls_mpi serial; 160 mbedtls_pk_context *subject_key; 161 mbedtls_pk_context *issuer_key; 162 mbedtls_asn1_named_data *subject; 163 mbedtls_asn1_named_data *issuer; 164 mbedtls_md_type_t md_alg; 165 char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1]; 166 char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1]; 167 mbedtls_asn1_named_data *extensions; 168 } 169 mbedtls_x509write_cert; 170 171 /** 172 * Item in a verification chain: cert and flags for it 173 */ 174 typedef struct { 175 mbedtls_x509_crt *crt; 176 uint32_t flags; 177 } mbedtls_x509_crt_verify_chain_item; 178 179 /** 180 * Max size of verification chain: end-entity + intermediates + trusted root 181 */ 182 #define MBEDTLS_X509_MAX_VERIFY_CHAIN_SIZE ( MBEDTLS_X509_MAX_INTERMEDIATE_CA + 2 ) 183 184 /** 185 * Verification chain as built by \c mbedtls_crt_verify_chain() 186 */ 187 typedef struct 188 { 189 mbedtls_x509_crt_verify_chain_item items[MBEDTLS_X509_MAX_VERIFY_CHAIN_SIZE]; 190 unsigned len; 191 } mbedtls_x509_crt_verify_chain; 192 193 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE) 194 195 /** 196 * \brief Context for resuming X.509 verify operations 197 */ 198 typedef struct 199 { 200 /* for check_signature() */ 201 mbedtls_pk_restart_ctx pk; 202 203 /* for find_parent_in() */ 204 mbedtls_x509_crt *parent; /* non-null iff parent_in in progress */ 205 mbedtls_x509_crt *fallback_parent; 206 int fallback_signature_is_good; 207 208 /* for find_parent() */ 209 int parent_is_trusted; /* -1 if find_parent is not in progress */ 210 211 /* for verify_chain() */ 212 enum { 213 x509_crt_rs_none, 214 x509_crt_rs_find_parent, 215 } in_progress; /* none if no operation is in progress */ 216 int self_cnt; 217 mbedtls_x509_crt_verify_chain ver_chain; 218 219 } mbedtls_x509_crt_restart_ctx; 220 221 #else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */ 222 223 /* Now we can declare functions that take a pointer to that */ 224 typedef void mbedtls_x509_crt_restart_ctx; 225 226 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */ 227 228 #if defined(MBEDTLS_X509_CRT_PARSE_C) 229 /** 230 * Default security profile. Should provide a good balance between security 231 * and compatibility with current deployments. 232 * 233 * This profile permits: 234 * - SHA2 hashes. 235 * - All supported elliptic curves. 236 * - RSA with 2048 bits and above. 237 * 238 * New minor versions of Mbed TLS may extend this profile, for example if 239 * new curves are added to the library. New minor versions of Mbed TLS will 240 * not reduce this profile unless serious security concerns require it. 241 */ 242 extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default; 243 244 /** 245 * Expected next default profile. Recommended for new deployments. 246 * Currently targets a 128-bit security level, except for allowing RSA-2048. 247 */ 248 extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next; 249 250 /** 251 * NSA Suite B profile. 252 */ 253 extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb; 254 255 /** 256 * \brief Parse a single DER formatted certificate and add it 257 * to the chained list. 258 * 259 * \param chain points to the start of the chain 260 * \param buf buffer holding the certificate DER data 261 * \param buflen size of the buffer 262 * 263 * \return 0 if successful, or a specific X509 or PEM error code 264 */ 265 int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf, 266 size_t buflen ); 267 268 /** 269 * \brief Parse one DER-encoded or one or more concatenated PEM-encoded 270 * certificates and add them to the chained list. 271 * 272 * For CRTs in PEM encoding, the function parses permissively: 273 * if at least one certificate can be parsed, the function 274 * returns the number of certificates for which parsing failed 275 * (hence \c 0 if all certificates were parsed successfully). 276 * If no certificate could be parsed, the function returns 277 * the first (negative) error encountered during parsing. 278 * 279 * PEM encoded certificates may be interleaved by other data 280 * such as human readable descriptions of their content, as 281 * long as the certificates are enclosed in the PEM specific 282 * '-----{BEGIN/END} CERTIFICATE-----' delimiters. 283 * 284 * \param chain The chain to which to add the parsed certificates. 285 * \param buf The buffer holding the certificate data in PEM or DER format. 286 * For certificates in PEM encoding, this may be a concatenation 287 * of multiple certificates; for DER encoding, the buffer must 288 * comprise exactly one certificate. 289 * \param buflen The size of \p buf, including the terminating \c NULL byte 290 * in case of PEM encoded data. 291 * 292 * \return \c 0 if all certificates were parsed successfully. 293 * \return The (positive) number of certificates that couldn't 294 * be parsed if parsing was partly successful (see above). 295 * \return A negative X509 or PEM error code otherwise. 296 * 297 */ 298 int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen ); 299 300 #if defined(MBEDTLS_FS_IO) 301 /** 302 * \brief Load one or more certificates and add them 303 * to the chained list. Parses permissively. If some 304 * certificates can be parsed, the result is the number 305 * of failed certificates it encountered. If none complete 306 * correctly, the first error is returned. 307 * 308 * \param chain points to the start of the chain 309 * \param path filename to read the certificates from 310 * 311 * \return 0 if all certificates parsed successfully, a positive number 312 * if partly successful or a specific X509 or PEM error code 313 */ 314 int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path ); 315 316 /** 317 * \brief Load one or more certificate files from a path and add them 318 * to the chained list. Parses permissively. If some 319 * certificates can be parsed, the result is the number 320 * of failed certificates it encountered. If none complete 321 * correctly, the first error is returned. 322 * 323 * \param chain points to the start of the chain 324 * \param path directory / folder to read the certificate files from 325 * 326 * \return 0 if all certificates parsed successfully, a positive number 327 * if partly successful or a specific X509 or PEM error code 328 */ 329 int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path ); 330 #endif /* MBEDTLS_FS_IO */ 331 332 /** 333 * \brief Returns an informational string about the 334 * certificate. 335 * 336 * \param buf Buffer to write to 337 * \param size Maximum size of buffer 338 * \param prefix A line prefix 339 * \param crt The X509 certificate to represent 340 * 341 * \return The length of the string written (not including the 342 * terminated nul byte), or a negative error code. 343 */ 344 int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix, 345 const mbedtls_x509_crt *crt ); 346 347 /** 348 * \brief Returns an informational string about the 349 * verification status of a certificate. 350 * 351 * \param buf Buffer to write to 352 * \param size Maximum size of buffer 353 * \param prefix A line prefix 354 * \param flags Verification flags created by mbedtls_x509_crt_verify() 355 * 356 * \return The length of the string written (not including the 357 * terminated nul byte), or a negative error code. 358 */ 359 int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix, 360 uint32_t flags ); 361 362 /** 363 * \brief Verify the certificate signature 364 * 365 * The verify callback is a user-supplied callback that 366 * can clear / modify / add flags for a certificate. If set, 367 * the verification callback is called for each 368 * certificate in the chain (from the trust-ca down to the 369 * presented crt). The parameters for the callback are: 370 * (void *parameter, mbedtls_x509_crt *crt, int certificate_depth, 371 * int *flags). With the flags representing current flags for 372 * that specific certificate and the certificate depth from 373 * the bottom (Peer cert depth = 0). 374 * 375 * All flags left after returning from the callback 376 * are also returned to the application. The function should 377 * return 0 for anything (including invalid certificates) 378 * other than fatal error, as a non-zero return code 379 * immediately aborts the verification process. For fatal 380 * errors, a specific error code should be used (different 381 * from MBEDTLS_ERR_X509_CERT_VERIFY_FAILED which should not 382 * be returned at this point), or MBEDTLS_ERR_X509_FATAL_ERROR 383 * can be used if no better code is available. 384 * 385 * \note In case verification failed, the results can be displayed 386 * using \c mbedtls_x509_crt_verify_info() 387 * 388 * \note Same as \c mbedtls_x509_crt_verify_with_profile() with the 389 * default security profile. 390 * 391 * \note It is your responsibility to provide up-to-date CRLs for 392 * all trusted CAs. If no CRL is provided for the CA that was 393 * used to sign the certificate, CRL verification is skipped 394 * silently, that is *without* setting any flag. 395 * 396 * \note The \c trust_ca list can contain two types of certificates: 397 * (1) those of trusted root CAs, so that certificates 398 * chaining up to those CAs will be trusted, and (2) 399 * self-signed end-entity certificates to be trusted (for 400 * specific peers you know) - in that case, the self-signed 401 * certificate doesn't need to have the CA bit set. 402 * 403 * \param crt a certificate (chain) to be verified 404 * \param trust_ca the list of trusted CAs (see note above) 405 * \param ca_crl the list of CRLs for trusted CAs (see note above) 406 * \param cn expected Common Name (can be set to 407 * NULL if the CN must not be verified) 408 * \param flags result of the verification 409 * \param f_vrfy verification function 410 * \param p_vrfy verification parameter 411 * 412 * \return 0 (and flags set to 0) if the chain was verified and valid, 413 * MBEDTLS_ERR_X509_CERT_VERIFY_FAILED if the chain was verified 414 * but found to be invalid, in which case *flags will have one 415 * or more MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX 416 * flags set, or another error (and flags set to 0xffffffff) 417 * in case of a fatal error encountered during the 418 * verification process. 419 */ 420 int mbedtls_x509_crt_verify( mbedtls_x509_crt *crt, 421 mbedtls_x509_crt *trust_ca, 422 mbedtls_x509_crl *ca_crl, 423 const char *cn, uint32_t *flags, 424 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), 425 void *p_vrfy ); 426 427 /** 428 * \brief Verify the certificate signature according to profile 429 * 430 * \note Same as \c mbedtls_x509_crt_verify(), but with explicit 431 * security profile. 432 * 433 * \note The restrictions on keys (RSA minimum size, allowed curves 434 * for ECDSA) apply to all certificates: trusted root, 435 * intermediate CAs if any, and end entity certificate. 436 * 437 * \param crt a certificate (chain) to be verified 438 * \param trust_ca the list of trusted CAs 439 * \param ca_crl the list of CRLs for trusted CAs 440 * \param profile security profile for verification 441 * \param cn expected Common Name (can be set to 442 * NULL if the CN must not be verified) 443 * \param flags result of the verification 444 * \param f_vrfy verification function 445 * \param p_vrfy verification parameter 446 * 447 * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED 448 * in which case *flags will have one or more 449 * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags 450 * set, 451 * or another error in case of a fatal error encountered 452 * during the verification process. 453 */ 454 int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt, 455 mbedtls_x509_crt *trust_ca, 456 mbedtls_x509_crl *ca_crl, 457 const mbedtls_x509_crt_profile *profile, 458 const char *cn, uint32_t *flags, 459 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), 460 void *p_vrfy ); 461 462 /** 463 * \brief Restartable version of \c mbedtls_crt_verify_with_profile() 464 * 465 * \note Performs the same job as \c mbedtls_crt_verify_with_profile() 466 * but can return early and restart according to the limit 467 * set with \c mbedtls_ecp_set_max_ops() to reduce blocking. 468 * 469 * \param crt a certificate (chain) to be verified 470 * \param trust_ca the list of trusted CAs 471 * \param ca_crl the list of CRLs for trusted CAs 472 * \param profile security profile for verification 473 * \param cn expected Common Name (can be set to 474 * NULL if the CN must not be verified) 475 * \param flags result of the verification 476 * \param f_vrfy verification function 477 * \param p_vrfy verification parameter 478 * \param rs_ctx restart context (NULL to disable restart) 479 * 480 * \return See \c mbedtls_crt_verify_with_profile(), or 481 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of 482 * operations was reached: see \c mbedtls_ecp_set_max_ops(). 483 */ 484 int mbedtls_x509_crt_verify_restartable( mbedtls_x509_crt *crt, 485 mbedtls_x509_crt *trust_ca, 486 mbedtls_x509_crl *ca_crl, 487 const mbedtls_x509_crt_profile *profile, 488 const char *cn, uint32_t *flags, 489 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), 490 void *p_vrfy, 491 mbedtls_x509_crt_restart_ctx *rs_ctx ); 492 493 #if defined(MBEDTLS_X509_CHECK_KEY_USAGE) 494 /** 495 * \brief Check usage of certificate against keyUsage extension. 496 * 497 * \param crt Leaf certificate used. 498 * \param usage Intended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT 499 * before using the certificate to perform an RSA key 500 * exchange). 501 * 502 * \note Except for decipherOnly and encipherOnly, a bit set in the 503 * usage argument means this bit MUST be set in the 504 * certificate. For decipherOnly and encipherOnly, it means 505 * that bit MAY be set. 506 * 507 * \return 0 is these uses of the certificate are allowed, 508 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension 509 * is present but does not match the usage argument. 510 * 511 * \note You should only call this function on leaf certificates, on 512 * (intermediate) CAs the keyUsage extension is automatically 513 * checked by \c mbedtls_x509_crt_verify(). 514 */ 515 int mbedtls_x509_crt_check_key_usage( const mbedtls_x509_crt *crt, 516 unsigned int usage ); 517 #endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */ 518 519 #if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE) 520 /** 521 * \brief Check usage of certificate against extendedKeyUsage. 522 * 523 * \param crt Leaf certificate used. 524 * \param usage_oid Intended usage (eg MBEDTLS_OID_SERVER_AUTH or 525 * MBEDTLS_OID_CLIENT_AUTH). 526 * \param usage_len Length of usage_oid (eg given by MBEDTLS_OID_SIZE()). 527 * 528 * \return 0 if this use of the certificate is allowed, 529 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if not. 530 * 531 * \note Usually only makes sense on leaf certificates. 532 */ 533 int mbedtls_x509_crt_check_extended_key_usage( const mbedtls_x509_crt *crt, 534 const char *usage_oid, 535 size_t usage_len ); 536 #endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE */ 537 538 #if defined(MBEDTLS_X509_CRL_PARSE_C) 539 /** 540 * \brief Verify the certificate revocation status 541 * 542 * \param crt a certificate to be verified 543 * \param crl the CRL to verify against 544 * 545 * \return 1 if the certificate is revoked, 0 otherwise 546 * 547 */ 548 int mbedtls_x509_crt_is_revoked( const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl ); 549 #endif /* MBEDTLS_X509_CRL_PARSE_C */ 550 551 /** 552 * \brief Initialize a certificate (chain) 553 * 554 * \param crt Certificate chain to initialize 555 */ 556 void mbedtls_x509_crt_init( mbedtls_x509_crt *crt ); 557 558 /** 559 * \brief Unallocate all certificate data 560 * 561 * \param crt Certificate chain to free 562 */ 563 void mbedtls_x509_crt_free( mbedtls_x509_crt *crt ); 564 565 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE) 566 /** 567 * \brief Initialize a restart context 568 */ 569 void mbedtls_x509_crt_restart_init( mbedtls_x509_crt_restart_ctx *ctx ); 570 571 /** 572 * \brief Free the components of a restart context 573 */ 574 void mbedtls_x509_crt_restart_free( mbedtls_x509_crt_restart_ctx *ctx ); 575 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */ 576 #endif /* MBEDTLS_X509_CRT_PARSE_C */ 577 578 /* \} name */ 579 /* \} addtogroup x509_module */ 580 581 #if defined(MBEDTLS_X509_CRT_WRITE_C) 582 /** 583 * \brief Initialize a CRT writing context 584 * 585 * \param ctx CRT context to initialize 586 */ 587 void mbedtls_x509write_crt_init( mbedtls_x509write_cert *ctx ); 588 589 /** 590 * \brief Set the verion for a Certificate 591 * Default: MBEDTLS_X509_CRT_VERSION_3 592 * 593 * \param ctx CRT context to use 594 * \param version version to set (MBEDTLS_X509_CRT_VERSION_1, MBEDTLS_X509_CRT_VERSION_2 or 595 * MBEDTLS_X509_CRT_VERSION_3) 596 */ 597 void mbedtls_x509write_crt_set_version( mbedtls_x509write_cert *ctx, int version ); 598 599 /** 600 * \brief Set the serial number for a Certificate. 601 * 602 * \param ctx CRT context to use 603 * \param serial serial number to set 604 * 605 * \return 0 if successful 606 */ 607 int mbedtls_x509write_crt_set_serial( mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial ); 608 609 /** 610 * \brief Set the validity period for a Certificate 611 * Timestamps should be in string format for UTC timezone 612 * i.e. "YYYYMMDDhhmmss" 613 * e.g. "20131231235959" for December 31st 2013 614 * at 23:59:59 615 * 616 * \param ctx CRT context to use 617 * \param not_before not_before timestamp 618 * \param not_after not_after timestamp 619 * 620 * \return 0 if timestamp was parsed successfully, or 621 * a specific error code 622 */ 623 int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before, 624 const char *not_after ); 625 626 /** 627 * \brief Set the issuer name for a Certificate 628 * Issuer names should contain a comma-separated list 629 * of OID types and values: 630 * e.g. "C=UK,O=ARM,CN=mbed TLS CA" 631 * 632 * \param ctx CRT context to use 633 * \param issuer_name issuer name to set 634 * 635 * \return 0 if issuer name was parsed successfully, or 636 * a specific error code 637 */ 638 int mbedtls_x509write_crt_set_issuer_name( mbedtls_x509write_cert *ctx, 639 const char *issuer_name ); 640 641 /** 642 * \brief Set the subject name for a Certificate 643 * Subject names should contain a comma-separated list 644 * of OID types and values: 645 * e.g. "C=UK,O=ARM,CN=mbed TLS Server 1" 646 * 647 * \param ctx CRT context to use 648 * \param subject_name subject name to set 649 * 650 * \return 0 if subject name was parsed successfully, or 651 * a specific error code 652 */ 653 int mbedtls_x509write_crt_set_subject_name( mbedtls_x509write_cert *ctx, 654 const char *subject_name ); 655 656 /** 657 * \brief Set the subject public key for the certificate 658 * 659 * \param ctx CRT context to use 660 * \param key public key to include 661 */ 662 void mbedtls_x509write_crt_set_subject_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key ); 663 664 /** 665 * \brief Set the issuer key used for signing the certificate 666 * 667 * \param ctx CRT context to use 668 * \param key private key to sign with 669 */ 670 void mbedtls_x509write_crt_set_issuer_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key ); 671 672 /** 673 * \brief Set the MD algorithm to use for the signature 674 * (e.g. MBEDTLS_MD_SHA1) 675 * 676 * \param ctx CRT context to use 677 * \param md_alg MD algorithm to use 678 */ 679 void mbedtls_x509write_crt_set_md_alg( mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg ); 680 681 /** 682 * \brief Generic function to add to or replace an extension in the 683 * CRT 684 * 685 * \param ctx CRT context to use 686 * \param oid OID of the extension 687 * \param oid_len length of the OID 688 * \param critical if the extension is critical (per the RFC's definition) 689 * \param val value of the extension OCTET STRING 690 * \param val_len length of the value data 691 * 692 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED 693 */ 694 int mbedtls_x509write_crt_set_extension( mbedtls_x509write_cert *ctx, 695 const char *oid, size_t oid_len, 696 int critical, 697 const unsigned char *val, size_t val_len ); 698 699 /** 700 * \brief Set the basicConstraints extension for a CRT 701 * 702 * \param ctx CRT context to use 703 * \param is_ca is this a CA certificate 704 * \param max_pathlen maximum length of certificate chains below this 705 * certificate (only for CA certificates, -1 is 706 * inlimited) 707 * 708 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED 709 */ 710 int mbedtls_x509write_crt_set_basic_constraints( mbedtls_x509write_cert *ctx, 711 int is_ca, int max_pathlen ); 712 713 #if defined(MBEDTLS_SHA1_C) 714 /** 715 * \brief Set the subjectKeyIdentifier extension for a CRT 716 * Requires that mbedtls_x509write_crt_set_subject_key() has been 717 * called before 718 * 719 * \param ctx CRT context to use 720 * 721 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED 722 */ 723 int mbedtls_x509write_crt_set_subject_key_identifier( mbedtls_x509write_cert *ctx ); 724 725 /** 726 * \brief Set the authorityKeyIdentifier extension for a CRT 727 * Requires that mbedtls_x509write_crt_set_issuer_key() has been 728 * called before 729 * 730 * \param ctx CRT context to use 731 * 732 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED 733 */ 734 int mbedtls_x509write_crt_set_authority_key_identifier( mbedtls_x509write_cert *ctx ); 735 #endif /* MBEDTLS_SHA1_C */ 736 737 /** 738 * \brief Set the Key Usage Extension flags 739 * (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN) 740 * 741 * \param ctx CRT context to use 742 * \param key_usage key usage flags to set 743 * 744 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED 745 */ 746 int mbedtls_x509write_crt_set_key_usage( mbedtls_x509write_cert *ctx, 747 unsigned int key_usage ); 748 749 /** 750 * \brief Set the Netscape Cert Type flags 751 * (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL) 752 * 753 * \param ctx CRT context to use 754 * \param ns_cert_type Netscape Cert Type flags to set 755 * 756 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED 757 */ 758 int mbedtls_x509write_crt_set_ns_cert_type( mbedtls_x509write_cert *ctx, 759 unsigned char ns_cert_type ); 760 761 /** 762 * \brief Free the contents of a CRT write context 763 * 764 * \param ctx CRT context to free 765 */ 766 void mbedtls_x509write_crt_free( mbedtls_x509write_cert *ctx ); 767 768 /** 769 * \brief Write a built up certificate to a X509 DER structure 770 * Note: data is written at the end of the buffer! Use the 771 * return value to determine where you should start 772 * using the buffer 773 * 774 * \param ctx certificate to write away 775 * \param buf buffer to write to 776 * \param size size of the buffer 777 * \param f_rng RNG function (for signature, see note) 778 * \param p_rng RNG parameter 779 * 780 * \return length of data written if successful, or a specific 781 * error code 782 * 783 * \note f_rng may be NULL if RSA is used for signature and the 784 * signature is made offline (otherwise f_rng is desirable 785 * for countermeasures against timing attacks). 786 * ECDSA signatures always require a non-NULL f_rng. 787 */ 788 int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size, 789 int (*f_rng)(void *, unsigned char *, size_t), 790 void *p_rng ); 791 792 #if defined(MBEDTLS_PEM_WRITE_C) 793 /** 794 * \brief Write a built up certificate to a X509 PEM string 795 * 796 * \param ctx certificate to write away 797 * \param buf buffer to write to 798 * \param size size of the buffer 799 * \param f_rng RNG function (for signature, see note) 800 * \param p_rng RNG parameter 801 * 802 * \return 0 if successful, or a specific error code 803 * 804 * \note f_rng may be NULL if RSA is used for signature and the 805 * signature is made offline (otherwise f_rng is desirable 806 * for countermeasures against timing attacks). 807 * ECDSA signatures always require a non-NULL f_rng. 808 */ 809 int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size, 810 int (*f_rng)(void *, unsigned char *, size_t), 811 void *p_rng ); 812 #endif /* MBEDTLS_PEM_WRITE_C */ 813 #endif /* MBEDTLS_X509_CRT_WRITE_C */ 814 815 #ifdef __cplusplus 816 } 817 #endif 818 819 #endif /* mbedtls_x509_crt.h */ 820