mbed TLS v1.3.11
x509_csr.h
Go to the documentation of this file.
1 
24 #ifndef POLARSSL_X509_CSR_H
25 #define POLARSSL_X509_CSR_H
26 
27 #if !defined(POLARSSL_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include POLARSSL_CONFIG_FILE
31 #endif
32 
33 #include "x509.h"
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
51 typedef struct _x509_csr
52 {
56  int version;
67  void *sig_opts;
68 }
69 x509_csr;
70 
74 typedef struct _x509write_csr
75 {
80 }
82 
83 #if defined(POLARSSL_X509_CSR_PARSE_C)
84 
94  const unsigned char *buf, size_t buflen );
95 
105 int x509_csr_parse( x509_csr *csr, const unsigned char *buf, size_t buflen );
106 
107 #if defined(POLARSSL_FS_IO)
108 
116 int x509_csr_parse_file( x509_csr *csr, const char *path );
117 #endif /* POLARSSL_FS_IO */
118 
131 int x509_csr_info( char *buf, size_t size, const char *prefix,
132  const x509_csr *csr );
133 
139 void x509_csr_init( x509_csr *csr );
140 
146 void x509_csr_free( x509_csr *csr );
147 #endif /* POLARSSL_X509_CSR_PARSE_C */
148 
149 /* \} name */
150 /* \} addtogroup x509_module */
151 
152 #if defined(POLARSSL_X509_CSR_WRITE_C)
153 
158 void x509write_csr_init( x509write_csr *ctx );
159 
173  const char *subject_name );
174 
183 
192 
202 int x509write_csr_set_key_usage( x509write_csr *ctx, unsigned char key_usage );
203 
214  unsigned char ns_cert_type );
215 
229  const char *oid, size_t oid_len,
230  const unsigned char *val, size_t val_len );
231 
237 void x509write_csr_free( x509write_csr *ctx );
238 
260 int x509write_csr_der( x509write_csr *ctx, unsigned char *buf, size_t size,
261  int (*f_rng)(void *, unsigned char *, size_t),
262  void *p_rng );
263 
264 #if defined(POLARSSL_PEM_WRITE_C)
265 
282 int x509write_csr_pem( x509write_csr *ctx, unsigned char *buf, size_t size,
283  int (*f_rng)(void *, unsigned char *, size_t),
284  void *p_rng );
285 #endif /* POLARSSL_PEM_WRITE_C */
286 #endif /* POLARSSL_X509_CSR_WRITE_C */
287 
288 #ifdef __cplusplus
289 }
290 #endif
291 
292 #endif /* x509_csr.h */
void x509write_csr_free(x509write_csr *ctx)
Free the contents of a CSR context.
int x509_csr_parse_der(x509_csr *csr, const unsigned char *buf, size_t buflen)
Load a Certificate Signing Request (CSR) in DER format.
int x509write_csr_der(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 x509write_csr_set_extension(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 x509write_csr_set_md_alg(x509write_csr *ctx, md_type_t md_alg)
Set the MD algorithm to use for the signature (e.g.
int x509write_csr_set_ns_cert_type(x509write_csr *ctx, unsigned char ns_cert_type)
Set the Netscape Cert Type flags (e.g.
Configuration options (set of defines)
int x509write_csr_pem(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.
int x509write_csr_set_key_usage(x509write_csr *ctx, unsigned char key_usage)
Set the Key Usage Extension flags (e.g.
md_type_t md_alg
Definition: x509_csr.h:78
x509_name subject
The parsed subject data (named information object).
Definition: x509_csr.h:59
void * sig_opts
Signature options to be passed to pk_verify_ext(), e.g.
Definition: x509_csr.h:67
md_type_t
Definition: md.h:48
x509_buf cri
The raw CertificateRequestInfo body (DER).
Definition: x509_csr.h:54
x509_buf sig_oid
Definition: x509_csr.h:63
asn1_named_data * subject
Definition: x509_csr.h:77
x509_buf sig
Definition: x509_csr.h:64
void x509_csr_free(x509_csr *csr)
Unallocate all CSR data.
void x509write_csr_init(x509write_csr *ctx)
Initialize a CSR context.
pk_type_t
Public key types.
Definition: pk.h:92
X.509 generic defines and structures.
pk_context * key
Definition: x509_csr.h:76
void x509write_csr_set_key(x509write_csr *ctx, pk_context *key)
Set the key for a CSR (public key will be included, private key used to sign the CSR when writing it)...
struct _x509write_csr x509write_csr
Container for writing a CSR.
pk_type_t sig_pk
Internal representation of the Public Key algorithm of the signature algorithm, e.g.
Definition: x509_csr.h:66
asn1_named_data * extensions
Definition: x509_csr.h:79
pk_context pk
Container for the public key context.
Definition: x509_csr.h:61
int x509_csr_parse(x509_csr *csr, const unsigned char *buf, size_t buflen)
Load a Certificate Signing Request (CSR), DER or PEM format.
Container for a sequence or list of 'named' ASN.1 data items.
Definition: asn1.h:153
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:121
x509_buf raw
The raw CSR data (DER).
Definition: x509_csr.h:53
struct _x509_csr x509_csr
Certificate Signing Request (CSR) structure.
int x509_csr_info(char *buf, size_t size, const char *prefix, const x509_csr *csr)
Returns an informational string about the CSR.
int version
CSR version (1=v1).
Definition: x509_csr.h:56
int x509write_csr_set_subject_name(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...
Certificate Signing Request (CSR) structure.
Definition: x509_csr.h:51
int x509_csr_parse_file(x509_csr *csr, const char *path)
Load a Certificate Signing Request (CSR)
md_type_t sig_md
Internal representation of the MD algorithm of the signature algorithm, e.g.
Definition: x509_csr.h:65
void x509_csr_init(x509_csr *csr)
Initialize a CSR.
Public key container.
Definition: pk.h:194
Container for writing a CSR.
Definition: x509_csr.h:74
x509_buf subject_raw
The raw subject data (DER).
Definition: x509_csr.h:58