Mbed TLS v3.5.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
25
26#include "mbedtls/build_info.h"
27
28#include "mbedtls/x509.h"
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
50typedef 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
78typedef struct mbedtls_x509write_csr {
83}
85
86#if defined(MBEDTLS_X509_CSR_PARSE_C)
103 const unsigned char *buf, size_t buflen);
104
121int mbedtls_x509_csr_parse(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen);
122
123#if defined(MBEDTLS_FS_IO)
135#endif /* MBEDTLS_FS_IO */
136
137#if !defined(MBEDTLS_X509_REMOVE_INFO)
150int mbedtls_x509_csr_info(char *buf, size_t size, const char *prefix,
151 const mbedtls_x509_csr *csr);
152#endif /* !MBEDTLS_X509_REMOVE_INFO */
153
160
167#endif /* MBEDTLS_X509_CSR_PARSE_C */
168
171#if defined(MBEDTLS_X509_CSR_WRITE_C)
178
192 const char *subject_name);
193
202
211
230
243 const mbedtls_x509_san_list *san_list);
244
255 unsigned char ns_cert_type);
256
271 const char *oid, size_t oid_len,
272 int critical,
273 const unsigned char *val, size_t val_len);
274
281
300int mbedtls_x509write_csr_der(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
301 int (*f_rng)(void *, unsigned char *, size_t),
302 void *p_rng);
303
304#if defined(MBEDTLS_PEM_WRITE_C)
319int mbedtls_x509write_csr_pem(mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
320 int (*f_rng)(void *, unsigned char *, size_t),
321 void *p_rng);
322#endif /* MBEDTLS_PEM_WRITE_C */
323#endif /* MBEDTLS_X509_CSR_WRITE_C */
324
327#ifdef __cplusplus
328}
329#endif
330
331#endif /* mbedtls_x509_csr.h */
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_x509write_csr_free(mbedtls_x509write_csr *ctx)
Free the contents of a CSR context.
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_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_der(mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen)
Load a Certificate Signing Request (CSR) in DER format.
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_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_init(mbedtls_x509write_csr *ctx)
Initialize a CSR context.
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_init(mbedtls_x509_csr *csr)
Initialize a 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.
struct mbedtls_x509write_csr mbedtls_x509write_csr
struct mbedtls_x509_csr mbedtls_x509_csr
void mbedtls_x509_csr_free(mbedtls_x509_csr *csr)
Unallocate all CSR data.
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_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_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_info(char *buf, size_t size, const char *prefix, const mbedtls_x509_csr *csr)
Returns an informational string about the CSR.
int mbedtls_x509_csr_parse_file(mbedtls_x509_csr *csr, const char *path)
Load a Certificate Signing Request (CSR)
Build-time configuration info.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:173
mbedtls_pk_type_t
Public key types.
Definition: pk.h:85
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
Public key container.
Definition: pk.h:239
mbedtls_x509_name subject
Definition: x509_csr.h:57
mbedtls_x509_sequence subject_alt_names
Definition: x509_csr.h:63
unsigned char ns_cert_type
Definition: x509_csr.h:62
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:67
mbedtls_x509_buf cri
Definition: x509_csr.h:52
mbedtls_pk_context pk
Definition: x509_csr.h:59
unsigned int key_usage
Definition: x509_csr.h:61
mbedtls_x509_buf raw
Definition: x509_csr.h:51
mbedtls_x509_buf subject_raw
Definition: x509_csr.h:56
X.509 generic defines and structures.