mbed TLS v3.1.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 #include "mbedtls/private_access.h"
25 
26 #include "mbedtls/build_info.h"
27 
28 #include "mbedtls/x509.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
50 typedef struct mbedtls_x509_csr
51 {
55  int version;
66  void *MBEDTLS_PRIVATE(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 
125 #if !defined(MBEDTLS_X509_REMOVE_INFO)
126 
138 int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix,
139  const mbedtls_x509_csr *csr );
140 #endif /* !MBEDTLS_X509_REMOVE_INFO */
141 
148 
155 #endif /* MBEDTLS_X509_CSR_PARSE_C */
156 
157 /* \} name */
158 /* \} addtogroup x509_module */
159 
160 #if defined(MBEDTLS_X509_CSR_WRITE_C)
161 
167 
181  const char *subject_name );
182 
191 
200 
218 int mbedtls_x509write_csr_set_key_usage( mbedtls_x509write_csr *ctx, unsigned char key_usage );
219 
230  unsigned char ns_cert_type );
231 
246  const char *oid, size_t oid_len,
247  int critical,
248  const unsigned char *val, size_t val_len );
249 
256 
275 int mbedtls_x509write_csr_der( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
276  int (*f_rng)(void *, unsigned char *, size_t),
277  void *p_rng );
278 
279 #if defined(MBEDTLS_PEM_WRITE_C)
280 
294 int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
295  int (*f_rng)(void *, unsigned char *, size_t),
296  void *p_rng );
297 #endif /* MBEDTLS_PEM_WRITE_C */
298 #endif /* MBEDTLS_X509_CSR_WRITE_C */
299 
300 #ifdef __cplusplus
301 }
302 #endif
303 
304 #endif /* mbedtls_x509_csr.h */
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.
mbedtls_x509_name subject
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:199
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 ...
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_...
#define MBEDTLS_PRIVATE(member)
mbedtls_pk_type_t
Public key types.
Definition: pk.h:90
struct mbedtls_x509_csr mbedtls_x509_csr
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:62
mbedtls_x509_buf raw
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:53
Macro wrapper for struct's memebrs.
X.509 generic defines and structures.
mbedtls_x509_buf subject_raw
Definition: x509_csr.h:57
Build-time configuration info.
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_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:55
mbedtls_pk_context pk
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.