Mbed TLS v4.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
x509_csr.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  */
10 #ifndef MBEDTLS_X509_CSR_H
11 #define MBEDTLS_X509_CSR_H
12 #include "mbedtls/private_access.h"
13 
14 #include "mbedtls/build_info.h"
15 
16 #include "mbedtls/x509.h"
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
38 typedef struct mbedtls_x509_csr {
42  int version;
49  unsigned int key_usage;
50  unsigned char ns_cert_type;
53  int MBEDTLS_PRIVATE(ext_types);
56  mbedtls_x509_buf MBEDTLS_PRIVATE(sig);
57  mbedtls_md_type_t MBEDTLS_PRIVATE(sig_md);
58  mbedtls_pk_sigalg_t MBEDTLS_PRIVATE(sig_pk);
59 }
61 
65 typedef struct mbedtls_x509write_csr {
66  mbedtls_pk_context *MBEDTLS_PRIVATE(key);
67  mbedtls_asn1_named_data *MBEDTLS_PRIVATE(subject);
68  mbedtls_md_type_t MBEDTLS_PRIVATE(md_alg);
69  mbedtls_asn1_named_data *MBEDTLS_PRIVATE(extensions);
70 }
72 
73 #if defined(MBEDTLS_X509_CSR_PARSE_C)
74 
91  const unsigned char *buf, size_t buflen);
92 
121 typedef int (*mbedtls_x509_csr_ext_cb_t)(void *p_ctx,
122  mbedtls_x509_csr const *csr,
123  mbedtls_x509_buf const *oid,
124  int critical,
125  const unsigned char *p,
126  const unsigned char *end);
127 
149  const unsigned char *buf, size_t buflen,
151  void *p_ctx);
152 
168 int mbedtls_x509_csr_parse(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen);
169 
170 #if defined(MBEDTLS_FS_IO)
171 
181 int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path);
182 #endif /* MBEDTLS_FS_IO */
183 
184 #if !defined(MBEDTLS_X509_REMOVE_INFO)
185 
197 int mbedtls_x509_csr_info(char *buf, size_t size, const char *prefix,
198  const mbedtls_x509_csr *csr);
199 #endif /* !MBEDTLS_X509_REMOVE_INFO */
200 
207 
214 #endif /* MBEDTLS_X509_CSR_PARSE_C */
215 
218 #if defined(MBEDTLS_X509_CSR_WRITE_C)
219 
225 
239  const char *subject_name);
240 
249 
258 
276 int mbedtls_x509write_csr_set_key_usage(mbedtls_x509write_csr *ctx, unsigned char key_usage);
277 
290  const mbedtls_x509_san_list *san_list);
291 
302  unsigned char ns_cert_type);
303 
318  const char *oid, size_t oid_len,
319  int critical,
320  const unsigned char *val, size_t val_len);
321 
328 
344 int mbedtls_x509write_csr_der(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size);
345 
346 #if defined(MBEDTLS_PEM_WRITE_C)
347 
358 int mbedtls_x509write_csr_pem(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size);
359 #endif /* MBEDTLS_PEM_WRITE_C */
360 #endif /* MBEDTLS_X509_CSR_WRITE_C */
361 
364 #ifdef __cplusplus
365 }
366 #endif
367 
368 #endif /* mbedtls_x509_csr.h */
mbedtls_x509_name subject
Definition: x509_csr.h:45
mbedtls_x509_sequence subject_alt_names
Definition: x509_csr.h:51
Public key container.
Definition: pk.h:142
int mbedtls_x509write_csr_set_key_usage(mbedtls_x509write_csr *ctx, unsigned char key_usage)
Set the Key Usage Extension flags (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_...
int mbedtls_x509_csr_parse(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen)
Load a Certificate Signing Request (CSR), DER or PEM format.
int mbedtls_x509write_csr_der(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size)
Write a CSR (Certificate Signing Request) to a DER structure Note: data is written at the end of the ...
void mbedtls_x509write_csr_set_md_alg(mbedtls_x509write_csr *ctx, mbedtls_md_type_t md_alg)
Set the MD algorithm to use for the signature (e.g. MBEDTLS_MD_SHA1)
int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path)
Load a Certificate Signing Request (CSR)
int mbedtls_x509write_csr_set_subject_name(mbedtls_x509write_csr *ctx, const char *subject_name)
Set the subject name for a CSR Subject names should contain a comma-separated list of OID types and v...
void mbedtls_x509_csr_free(mbedtls_x509_csr *csr)
Unallocate all CSR data.
struct mbedtls_x509_csr mbedtls_x509_csr
int mbedtls_x509write_csr_set_extension(mbedtls_x509write_csr *ctx, const char *oid, size_t oid_len, int critical, const unsigned char *val, size_t val_len)
Generic function to add to or replace an extension in the CSR.
int mbedtls_x509write_csr_pem(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size)
Write a CSR (Certificate Signing Request) to a PEM string.
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:55
mbedtls_x509_buf raw
Definition: x509_csr.h:39
void mbedtls_x509write_csr_set_key(mbedtls_x509write_csr *ctx, mbedtls_pk_context *key)
Set the key for a CSR (public key will be included, private key used to sign the CSR when writing it)...
int mbedtls_x509write_csr_set_subject_alternative_name(mbedtls_x509write_csr *ctx, const mbedtls_x509_san_list *san_list)
Set Subject Alternative Name.
void mbedtls_x509_csr_init(mbedtls_x509_csr *csr)
Initialize a CSR.
unsigned int key_usage
Definition: x509_csr.h:49
struct mbedtls_x509write_csr mbedtls_x509write_csr
mbedtls_x509_buf cri
Definition: x509_csr.h:40
void mbedtls_x509write_csr_init(mbedtls_x509write_csr *ctx)
Initialize a CSR context.
Build-time configuration info.
X.509 generic defines and structures.
mbedtls_x509_buf subject_raw
Definition: x509_csr.h:44
int mbedtls_x509_csr_parse_der_with_ext_cb(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen, mbedtls_x509_csr_ext_cb_t cb, void *p_ctx)
Load a Certificate Signing Request (CSR) in DER format.
int mbedtls_x509write_csr_set_ns_cert_type(mbedtls_x509write_csr *ctx, unsigned char ns_cert_type)
Set the Netscape Cert Type flags (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TY...
unsigned char ns_cert_type
Definition: x509_csr.h:50
void mbedtls_x509write_csr_free(mbedtls_x509write_csr *ctx)
Free the contents of a CSR context.
int(* mbedtls_x509_csr_ext_cb_t)(void *p_ctx, mbedtls_x509_csr const *csr, mbedtls_x509_buf const *oid, int critical, const unsigned char *p, const unsigned char *end)
The type of certificate extension callbacks.
Definition: x509_csr.h:121
mbedtls_md_type_t
Supported message digests.
Definition: md.h:50
mbedtls_pk_sigalg_t
Definition: pk.h:53
mbedtls_pk_context pk
Definition: x509_csr.h:47
int mbedtls_x509_csr_parse_der(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen)
Load a Certificate Signing Request (CSR) in DER format.