mbed TLS v3.4.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 {
54  int version;
61  unsigned int key_usage;
62  unsigned char ns_cert_type;
65  int MBEDTLS_PRIVATE(ext_types);
71  void *MBEDTLS_PRIVATE(sig_opts);
72 }
74 
78 typedef struct mbedtls_x509write_csr {
83 }
85 
86 typedef struct mbedtls_x509_san_list {
89 }
91 
92 #if defined(MBEDTLS_X509_CSR_PARSE_C)
93 
109  const unsigned char *buf, size_t buflen);
110 
127 int mbedtls_x509_csr_parse(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen);
128 
129 #if defined(MBEDTLS_FS_IO)
130 
140 int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path);
141 #endif /* MBEDTLS_FS_IO */
142 
143 #if !defined(MBEDTLS_X509_REMOVE_INFO)
144 
156 int mbedtls_x509_csr_info(char *buf, size_t size, const char *prefix,
157  const mbedtls_x509_csr *csr);
158 #endif /* !MBEDTLS_X509_REMOVE_INFO */
159 
166 
173 #endif /* MBEDTLS_X509_CSR_PARSE_C */
174 
177 #if defined(MBEDTLS_X509_CSR_WRITE_C)
178 
184 
198  const char *subject_name);
199 
208 
217 
235 int mbedtls_x509write_csr_set_key_usage(mbedtls_x509write_csr *ctx, unsigned char key_usage);
236 
249  const mbedtls_x509_san_list *san_list);
250 
261  unsigned char ns_cert_type);
262 
277  const char *oid, size_t oid_len,
278  int critical,
279  const unsigned char *val, size_t val_len);
280 
287 
306 int mbedtls_x509write_csr_der(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
307  int (*f_rng)(void *, unsigned char *, size_t),
308  void *p_rng);
309 
310 #if defined(MBEDTLS_PEM_WRITE_C)
311 
325 int mbedtls_x509write_csr_pem(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
326  int (*f_rng)(void *, unsigned char *, size_t),
327  void *p_rng);
328 #endif /* MBEDTLS_PEM_WRITE_C */
329 #endif /* MBEDTLS_X509_CSR_WRITE_C */
330 
333 #ifdef __cplusplus
334 }
335 #endif
336 
337 #endif /* mbedtls_x509_csr.h */
mbedtls_x509_name subject
Definition: x509_csr.h:57
mbedtls_x509_sequence subject_alt_names
Definition: x509_csr.h:63
Public key container.
Definition: pk.h:233
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_x509_subject_alternative_name node
Definition: x509_csr.h:87
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)
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.
#define MBEDTLS_PRIVATE(member)
mbedtls_pk_type_t
Public key types.
Definition: pk.h:85
struct mbedtls_x509_csr mbedtls_x509_csr
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_buf sig_oid
Definition: x509_csr.h:67
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 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_set_subject_alternative_name(mbedtls_x509write_csr *ctx, const mbedtls_x509_san_list *san_list)
Set Subject Alternative Name.
void mbedtls_x509_csr_init(mbedtls_x509_csr *csr)
Initialize a CSR.
unsigned int key_usage
Definition: x509_csr.h:61
struct mbedtls_x509write_csr mbedtls_x509write_csr
struct mbedtls_x509_san_list * next
Definition: x509_csr.h:88
mbedtls_x509_buf cri
Definition: x509_csr.h:52
Macro wrapper for struct's members.
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:56
Build-time configuration info.
struct mbedtls_x509_san_list mbedtls_x509_san_list
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...
unsigned char ns_cert_type
Definition: x509_csr.h:62
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:143
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.