1 /** 2 * \file x509_csr.h 3 * 4 * \brief X.509 certificate signing request 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_CSR_H 24 #define MBEDTLS_X509_CSR_H 25 26 #if !defined(MBEDTLS_CONFIG_FILE) 27 #include "config.h" 28 #else 29 #include MBEDTLS_CONFIG_FILE 30 #endif 31 32 #include "x509.h" 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 /** 39 * \addtogroup x509_module 40 * \{ */ 41 42 /** 43 * \name Structures and functions for X.509 Certificate Signing Requests (CSR) 44 * \{ 45 */ 46 47 /** 48 * Certificate Signing Request (CSR) structure. 49 */ 50 typedef struct mbedtls_x509_csr 51 { 52 mbedtls_x509_buf raw; /**< The raw CSR data (DER). */ 53 mbedtls_x509_buf cri; /**< The raw CertificateRequestInfo body (DER). */ 54 55 int version; /**< CSR version (1=v1). */ 56 57 mbedtls_x509_buf subject_raw; /**< The raw subject data (DER). */ 58 mbedtls_x509_name subject; /**< The parsed subject data (named information object). */ 59 60 mbedtls_pk_context pk; /**< Container for the public key context. */ 61 62 mbedtls_x509_buf sig_oid; 63 mbedtls_x509_buf sig; 64 mbedtls_md_type_t sig_md; /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */ 65 mbedtls_pk_type_t sig_pk; /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */ 66 void *sig_opts; /**< Signature options to be passed to mbedtls_pk_verify_ext(), e.g. for RSASSA-PSS */ 67 } 68 mbedtls_x509_csr; 69 70 /** 71 * Container for writing a CSR 72 */ 73 typedef struct mbedtls_x509write_csr 74 { 75 mbedtls_pk_context *key; 76 mbedtls_asn1_named_data *subject; 77 mbedtls_md_type_t md_alg; 78 mbedtls_asn1_named_data *extensions; 79 } 80 mbedtls_x509write_csr; 81 82 #if defined(MBEDTLS_X509_CSR_PARSE_C) 83 /** 84 * \brief Load a Certificate Signing Request (CSR) in DER format 85 * 86 * \note CSR attributes (if any) are currently silently ignored. 87 * 88 * \param csr CSR context to fill 89 * \param buf buffer holding the CRL data 90 * \param buflen size of the buffer 91 * 92 * \return 0 if successful, or a specific X509 error code 93 */ 94 int mbedtls_x509_csr_parse_der( mbedtls_x509_csr *csr, 95 const unsigned char *buf, size_t buflen ); 96 97 /** 98 * \brief Load a Certificate Signing Request (CSR), DER or PEM format 99 * 100 * \note See notes for \c mbedtls_x509_csr_parse_der() 101 * 102 * \param csr CSR context to fill 103 * \param buf buffer holding the CRL data 104 * \param buflen size of the buffer 105 * (including the terminating null byte for PEM data) 106 * 107 * \return 0 if successful, or a specific X509 or PEM error code 108 */ 109 int mbedtls_x509_csr_parse( mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen ); 110 111 #if defined(MBEDTLS_FS_IO) 112 /** 113 * \brief Load a Certificate Signing Request (CSR) 114 * 115 * \note See notes for \c mbedtls_x509_csr_parse() 116 * 117 * \param csr CSR context to fill 118 * \param path filename to read the CSR from 119 * 120 * \return 0 if successful, or a specific X509 or PEM error code 121 */ 122 int mbedtls_x509_csr_parse_file( mbedtls_x509_csr *csr, const char *path ); 123 #endif /* MBEDTLS_FS_IO */ 124 125 /** 126 * \brief Returns an informational string about the 127 * CSR. 128 * 129 * \param buf Buffer to write to 130 * \param size Maximum size of buffer 131 * \param prefix A line prefix 132 * \param csr The X509 CSR to represent 133 * 134 * \return The length of the string written (not including the 135 * terminated nul byte), or a negative error code. 136 */ 137 int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix, 138 const mbedtls_x509_csr *csr ); 139 140 /** 141 * \brief Initialize a CSR 142 * 143 * \param csr CSR to initialize 144 */ 145 void mbedtls_x509_csr_init( mbedtls_x509_csr *csr ); 146 147 /** 148 * \brief Unallocate all CSR data 149 * 150 * \param csr CSR to free 151 */ 152 void mbedtls_x509_csr_free( mbedtls_x509_csr *csr ); 153 #endif /* MBEDTLS_X509_CSR_PARSE_C */ 154 155 /* \} name */ 156 /* \} addtogroup x509_module */ 157 158 #if defined(MBEDTLS_X509_CSR_WRITE_C) 159 /** 160 * \brief Initialize a CSR context 161 * 162 * \param ctx CSR context to initialize 163 */ 164 void mbedtls_x509write_csr_init( mbedtls_x509write_csr *ctx ); 165 166 /** 167 * \brief Set the subject name for a CSR 168 * Subject names should contain a comma-separated list 169 * of OID types and values: 170 * e.g. "C=UK,O=ARM,CN=mbed TLS Server 1" 171 * 172 * \param ctx CSR context to use 173 * \param subject_name subject name to set 174 * 175 * \return 0 if subject name was parsed successfully, or 176 * a specific error code 177 */ 178 int mbedtls_x509write_csr_set_subject_name( mbedtls_x509write_csr *ctx, 179 const char *subject_name ); 180 181 /** 182 * \brief Set the key for a CSR (public key will be included, 183 * private key used to sign the CSR when writing it) 184 * 185 * \param ctx CSR context to use 186 * \param key Asymetric key to include 187 */ 188 void mbedtls_x509write_csr_set_key( mbedtls_x509write_csr *ctx, mbedtls_pk_context *key ); 189 190 /** 191 * \brief Set the MD algorithm to use for the signature 192 * (e.g. MBEDTLS_MD_SHA1) 193 * 194 * \param ctx CSR context to use 195 * \param md_alg MD algorithm to use 196 */ 197 void mbedtls_x509write_csr_set_md_alg( mbedtls_x509write_csr *ctx, mbedtls_md_type_t md_alg ); 198 199 /** 200 * \brief Set the Key Usage Extension flags 201 * (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN) 202 * 203 * \param ctx CSR context to use 204 * \param key_usage key usage flags to set 205 * 206 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED 207 */ 208 int mbedtls_x509write_csr_set_key_usage( mbedtls_x509write_csr *ctx, unsigned char key_usage ); 209 210 /** 211 * \brief Set the Netscape Cert Type flags 212 * (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL) 213 * 214 * \param ctx CSR context to use 215 * \param ns_cert_type Netscape Cert Type flags to set 216 * 217 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED 218 */ 219 int mbedtls_x509write_csr_set_ns_cert_type( mbedtls_x509write_csr *ctx, 220 unsigned char ns_cert_type ); 221 222 /** 223 * \brief Generic function to add to or replace an extension in the 224 * CSR 225 * 226 * \param ctx CSR context to use 227 * \param oid OID of the extension 228 * \param oid_len length of the OID 229 * \param val value of the extension OCTET STRING 230 * \param val_len length of the value data 231 * 232 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED 233 */ 234 int mbedtls_x509write_csr_set_extension( mbedtls_x509write_csr *ctx, 235 const char *oid, size_t oid_len, 236 const unsigned char *val, size_t val_len ); 237 238 /** 239 * \brief Free the contents of a CSR context 240 * 241 * \param ctx CSR context to free 242 */ 243 void mbedtls_x509write_csr_free( mbedtls_x509write_csr *ctx ); 244 245 /** 246 * \brief Write a CSR (Certificate Signing Request) to a 247 * DER structure 248 * Note: data is written at the end of the buffer! Use the 249 * return value to determine where you should start 250 * using the buffer 251 * 252 * \param ctx CSR to write away 253 * \param buf buffer to write to 254 * \param size size of the buffer 255 * \param f_rng RNG function (for signature, see note) 256 * \param p_rng RNG parameter 257 * 258 * \return length of data written if successful, or a specific 259 * error code 260 * 261 * \note f_rng may be NULL if RSA is used for signature and the 262 * signature is made offline (otherwise f_rng is desirable 263 * for countermeasures against timing attacks). 264 * ECDSA signatures always require a non-NULL f_rng. 265 */ 266 int mbedtls_x509write_csr_der( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size, 267 int (*f_rng)(void *, unsigned char *, size_t), 268 void *p_rng ); 269 270 #if defined(MBEDTLS_PEM_WRITE_C) 271 /** 272 * \brief Write a CSR (Certificate Signing Request) to a 273 * PEM string 274 * 275 * \param ctx CSR to write away 276 * \param buf buffer to write to 277 * \param size size of the buffer 278 * \param f_rng RNG function (for signature, see note) 279 * \param p_rng RNG parameter 280 * 281 * \return 0 if successful, or a specific error code 282 * 283 * \note f_rng may be NULL if RSA is used for signature and the 284 * signature is made offline (otherwise f_rng is desirable 285 * for countermeasures against timing attacks). 286 * ECDSA signatures always require a non-NULL f_rng. 287 */ 288 int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size, 289 int (*f_rng)(void *, unsigned char *, size_t), 290 void *p_rng ); 291 #endif /* MBEDTLS_PEM_WRITE_C */ 292 #endif /* MBEDTLS_X509_CSR_WRITE_C */ 293 294 #ifdef __cplusplus 295 } 296 #endif 297 298 #endif /* mbedtls_x509_csr.h */ 299