mbed TLS v2.3.0
x509_csr.h
Go to the documentation of this file.
1 
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 
50 typedef struct mbedtls_x509_csr
51 {
55  int version;
66  void *sig_opts;
67 }
69 
73 typedef struct mbedtls_x509write_csr
74 {
79 }
81 
82 #if defined(MBEDTLS_X509_CSR_PARSE_C)
83 
95  const unsigned char *buf, size_t buflen );
96 
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 
122 int mbedtls_x509_csr_parse_file( mbedtls_x509_csr *csr, const char *path );
123 #endif /* MBEDTLS_FS_IO */
124 
137 int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix,
138  const mbedtls_x509_csr *csr );
139 
146 
153 #endif /* MBEDTLS_X509_CSR_PARSE_C */
154 
155 /* \} name */
156 /* \} addtogroup x509_module */
157 
158 #if defined(MBEDTLS_X509_CSR_WRITE_C)
159 
165 
179  const char *subject_name );
180 
189 
198 
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 
294 #ifdef __cplusplus
295 }
296 #endif
297 
298 #endif /* mbedtls_x509_csr.h */
Certificate Signing Request (CSR) structure.
Definition: x509_csr.h:50
mbedtls_x509_buf sig
Definition: x509_csr.h:63
mbedtls_x509_name subject
The parsed subject data (named information object).
Definition: x509_csr.h:58
void mbedtls_x509write_csr_free(mbedtls_x509write_csr *ctx)
Free the contents of a CSR context.
Public key container.
Definition: pk.h:126
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...
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_set_ns_cert_type(mbedtls_x509write_csr *ctx, unsigned char ns_cert_type)
Set the Netscape Cert Type flags (e.g.
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_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:75
int version
CSR version (1=v1).
Definition: x509_csr.h:55
mbedtls_md_type_t sig_md
Internal representation of the MD algorithm of the signature algorithm, e.g.
Definition: x509_csr.h:64
int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path)
Load a Certificate Signing Request (CSR)
void mbedtls_x509write_csr_init(mbedtls_x509write_csr *ctx)
Initialize a CSR context.
void mbedtls_x509_csr_free(mbedtls_x509_csr *csr)
Unallocate all CSR data.
int mbedtls_x509write_csr_set_key_usage(mbedtls_x509write_csr *ctx, unsigned char key_usage)
Set the Key Usage Extension flags (e.g.
mbedtls_md_type_t md_alg
Definition: x509_csr.h:77
mbedtls_pk_type_t
Public key types.
Definition: pk.h:74
Configuration options (set of defines)
struct mbedtls_x509_csr mbedtls_x509_csr
Certificate Signing Request (CSR) structure.
mbedtls_asn1_named_data * extensions
Definition: x509_csr.h:78
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.
mbedtls_pk_type_t sig_pk
Internal representation of the Public Key algorithm of the signature algorithm, e.g.
Definition: x509_csr.h:65
Container for a sequence or list of 'named' ASN.1 data items.
Definition: asn1.h:150
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:62
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
The raw CSR data (DER).
Definition: x509_csr.h:52
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:118
void * sig_opts
Signature options to be passed to mbedtls_pk_verify_ext(), e.g.
Definition: x509_csr.h:66
void mbedtls_x509_csr_init(mbedtls_x509_csr *csr)
Initialize a CSR.
struct mbedtls_x509write_csr mbedtls_x509write_csr
Container for writing a CSR.
mbedtls_x509_buf cri
The raw CertificateRequestInfo body (DER).
Definition: x509_csr.h:53
X.509 generic defines and structures.
mbedtls_x509_buf subject_raw
The raw subject data (DER).
Definition: x509_csr.h:57
Container for writing a CSR.
Definition: x509_csr.h:73
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.
mbedtls_asn1_named_data * subject
Definition: x509_csr.h:76
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_type_t
Definition: md.h:39
mbedtls_pk_context pk
Container for the public key context.
Definition: x509_csr.h:60
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.