Mbed TLS v3.6.3
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);
59  void *MBEDTLS_PRIVATE(sig_opts);
60 }
62 
66 typedef struct mbedtls_x509write_csr {
71 }
73 
74 #if defined(MBEDTLS_X509_CSR_PARSE_C)
93  const unsigned char *buf, size_t buflen);
94 
123 typedef int (*mbedtls_x509_csr_ext_cb_t)(void *p_ctx,
124  mbedtls_x509_csr const *csr,
125  mbedtls_x509_buf const *oid,
126  int critical,
127  const unsigned char *p,
128  const unsigned char *end);
129 
152  const unsigned char *buf, size_t buflen,
154  void *p_ctx);
155 
172 int mbedtls_x509_csr_parse(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen);
173 
174 #if defined(MBEDTLS_FS_IO)
185 int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path);
186 #endif /* MBEDTLS_FS_IO */
187 
188 #if !defined(MBEDTLS_X509_REMOVE_INFO)
201 int mbedtls_x509_csr_info(char *buf, size_t size, const char *prefix,
202  const mbedtls_x509_csr *csr);
203 #endif /* !MBEDTLS_X509_REMOVE_INFO */
204 
211 
218 #endif /* MBEDTLS_X509_CSR_PARSE_C */
219 
222 #if defined(MBEDTLS_X509_CSR_WRITE_C)
229 
243  const char *subject_name);
244 
253 
262 
281 
294  const mbedtls_x509_san_list *san_list);
295 
306  unsigned char ns_cert_type);
307 
322  const char *oid, size_t oid_len,
323  int critical,
324  const unsigned char *val, size_t val_len);
325 
332 
351 int mbedtls_x509write_csr_der(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
352  int (*f_rng)(void *, unsigned char *, size_t),
353  void *p_rng);
354 
355 #if defined(MBEDTLS_PEM_WRITE_C)
370 int mbedtls_x509write_csr_pem(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
371  int (*f_rng)(void *, unsigned char *, size_t),
372  void *p_rng);
373 #endif /* MBEDTLS_PEM_WRITE_C */
374 #endif /* MBEDTLS_X509_CSR_WRITE_C */
375 
378 #ifdef __cplusplus
379 }
380 #endif
381 
382 #endif /* mbedtls_x509_csr.h */
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:123
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_x509write_csr_free(mbedtls_x509write_csr *ctx)
Free the contents of a CSR context.
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...
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_der(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen)
Load a Certificate Signing Request (CSR) in DER format.
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_pem(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Write a CSR (Certificate Signing Request) to a PEM string.
void mbedtls_x509write_csr_init(mbedtls_x509write_csr *ctx)
Initialize a CSR context.
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_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_init(mbedtls_x509_csr *csr)
Initialize a 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.
struct mbedtls_x509write_csr mbedtls_x509write_csr
struct mbedtls_x509_csr mbedtls_x509_csr
void mbedtls_x509_csr_free(mbedtls_x509_csr *csr)
Unallocate all CSR data.
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_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_x509write_csr_der(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Write a CSR (Certificate Signing Request) to a DER structure Note: data is written at the end of the ...
int mbedtls_x509_csr_info(char *buf, size_t size, const char *prefix, const mbedtls_x509_csr *csr)
Returns an informational string about the CSR.
int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path)
Load a Certificate Signing Request (CSR)
Build-time configuration info.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:47
mbedtls_pk_type_t
Public key types.
Definition: pk.h:73
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
Public key container.
Definition: pk.h:220
mbedtls_x509_name subject
Definition: x509_csr.h:45
mbedtls_x509_sequence subject_alt_names
Definition: x509_csr.h:51
unsigned char ns_cert_type
Definition: x509_csr.h:50
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:55
mbedtls_x509_buf cri
Definition: x509_csr.h:40
mbedtls_pk_context pk
Definition: x509_csr.h:47
unsigned int key_usage
Definition: x509_csr.h:49
mbedtls_x509_buf raw
Definition: x509_csr.h:39
mbedtls_x509_buf subject_raw
Definition: x509_csr.h:44
X.509 generic defines and structures.