Mbed TLS v2.28.8
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 
13 #if !defined(MBEDTLS_CONFIG_FILE)
14 #include "mbedtls/config.h"
15 #else
16 #include MBEDTLS_CONFIG_FILE
17 #endif
18 
19 #include "mbedtls/x509.h"
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
37 typedef struct mbedtls_x509_csr {
41  int version;
52  void *sig_opts;
53 }
55 
59 typedef struct mbedtls_x509write_csr {
64 }
66 
67 #if defined(MBEDTLS_X509_CSR_PARSE_C)
68 
84  const unsigned char *buf, size_t buflen);
85 
102 int mbedtls_x509_csr_parse(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen);
103 
104 #if defined(MBEDTLS_FS_IO)
105 
115 int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path);
116 #endif /* MBEDTLS_FS_IO */
117 
130 int mbedtls_x509_csr_info(char *buf, size_t size, const char *prefix,
131  const mbedtls_x509_csr *csr);
132 
139 
146 #endif /* MBEDTLS_X509_CSR_PARSE_C */
147 
150 #if defined(MBEDTLS_X509_CSR_WRITE_C)
151 
157 
171  const char *subject_name);
172 
181 
190 
208 int mbedtls_x509write_csr_set_key_usage(mbedtls_x509write_csr *ctx, unsigned char key_usage);
209 
220  unsigned char ns_cert_type);
221 
235  const char *oid, size_t oid_len,
236  const unsigned char *val, size_t val_len);
237 
244 
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 
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 
296 #ifdef __cplusplus
297 }
298 #endif
299 
300 #endif /* mbedtls_x509_csr.h */
mbedtls_x509_buf sig
Definition: x509_csr.h:49
mbedtls_x509_name subject
Definition: x509_csr.h:44
Public key container.
Definition: pk.h:185
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, 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 ...
mbedtls_pk_context * key
Definition: x509_csr.h:60
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)
mbedtls_md_type_t sig_md
Definition: x509_csr.h:50
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.
mbedtls_md_type_t md_alg
Definition: x509_csr.h:62
mbedtls_pk_type_t
Public key types.
Definition: pk.h:83
Configuration options (set of defines)
struct mbedtls_x509_csr mbedtls_x509_csr
mbedtls_asn1_named_data * extensions
Definition: x509_csr.h:63
mbedtls_pk_type_t sig_pk
Definition: x509_csr.h:51
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:48
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.
mbedtls_x509_buf raw
Definition: x509_csr.h:38
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)...
void * sig_opts
Definition: x509_csr.h:52
void mbedtls_x509_csr_init(mbedtls_x509_csr *csr)
Initialize a CSR.
struct mbedtls_x509write_csr mbedtls_x509write_csr
mbedtls_x509_buf cri
Definition: x509_csr.h:39
int mbedtls_x509write_csr_set_extension(mbedtls_x509write_csr *ctx, const char *oid, size_t oid_len, const unsigned char *val, size_t val_len)
Generic function to add to or replace an extension in the CSR.
void mbedtls_x509write_csr_init(mbedtls_x509write_csr *ctx)
Initialize a CSR context.
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.
X.509 generic defines and structures.
mbedtls_x509_buf subject_raw
Definition: x509_csr.h:43
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...
mbedtls_asn1_named_data * subject
Definition: x509_csr.h:61
void mbedtls_x509write_csr_free(mbedtls_x509write_csr *ctx)
Free the contents of a CSR context.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:50
mbedtls_pk_context pk
Definition: x509_csr.h:46
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.