mbed TLS v2.28.0
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
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  */
22 #ifndef MBEDTLS_X509_CSR_H
23 #define MBEDTLS_X509_CSR_H
24 
25 #if !defined(MBEDTLS_CONFIG_FILE)
26 #include "mbedtls/config.h"
27 #else
28 #include MBEDTLS_CONFIG_FILE
29 #endif
30 
31 #include "mbedtls/x509.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
49 typedef struct mbedtls_x509_csr
50 {
54  int version;
65  void *sig_opts;
66 }
68 
72 typedef struct mbedtls_x509write_csr
73 {
78 }
80 
81 #if defined(MBEDTLS_X509_CSR_PARSE_C)
82 
94  const unsigned char *buf, size_t buflen );
95 
108 int mbedtls_x509_csr_parse( mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen );
109 
110 #if defined(MBEDTLS_FS_IO)
111 
121 int mbedtls_x509_csr_parse_file( mbedtls_x509_csr *csr, const char *path );
122 #endif /* MBEDTLS_FS_IO */
123 
136 int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix,
137  const mbedtls_x509_csr *csr );
138 
145 
152 #endif /* MBEDTLS_X509_CSR_PARSE_C */
153 
154 /* \} name */
155 /* \} addtogroup x509_module */
156 
157 #if defined(MBEDTLS_X509_CSR_WRITE_C)
158 
164 
178  const char *subject_name );
179 
188 
197 
215 int mbedtls_x509write_csr_set_key_usage( mbedtls_x509write_csr *ctx, unsigned char key_usage );
216 
227  unsigned char ns_cert_type );
228 
242  const char *oid, size_t oid_len,
243  const unsigned char *val, size_t val_len );
244 
251 
273 int mbedtls_x509write_csr_der( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
274  int (*f_rng)(void *, unsigned char *, size_t),
275  void *p_rng );
276 
277 #if defined(MBEDTLS_PEM_WRITE_C)
278 
295 int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
296  int (*f_rng)(void *, unsigned char *, size_t),
297  void *p_rng );
298 #endif /* MBEDTLS_PEM_WRITE_C */
299 #endif /* MBEDTLS_X509_CSR_WRITE_C */
300 
301 #ifdef __cplusplus
302 }
303 #endif
304 
305 #endif /* mbedtls_x509_csr.h */
mbedtls_x509_buf sig
Definition: x509_csr.h:62
mbedtls_x509_name subject
Definition: x509_csr.h:57
void mbedtls_x509write_csr_free(mbedtls_x509write_csr *ctx)
Free the contents of a CSR context.
Public key container.
Definition: pk.h:200
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. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TY...
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:74
mbedtls_md_type_t sig_md
Definition: x509_csr.h:63
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_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_...
mbedtls_md_type_t md_alg
Definition: x509_csr.h:76
mbedtls_pk_type_t
Public key types.
Definition: pk.h:95
Configuration options (set of defines)
struct mbedtls_x509_csr mbedtls_x509_csr
mbedtls_asn1_named_data * extensions
Definition: x509_csr.h:77
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
Definition: x509_csr.h:64
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:61
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:51
void * sig_opts
Definition: x509_csr.h:65
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:52
X.509 generic defines and structures.
mbedtls_x509_buf subject_raw
Definition: x509_csr.h:56
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:75
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
Supported message digests.
Definition: md.h:62
mbedtls_pk_context pk
Definition: x509_csr.h:59
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.