mbed TLS v2.16.9
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 OR GPL-2.0-or-later
9 *
10 * This file is provided under the Apache License 2.0, or the
11 * GNU General Public License v2.0 or later.
12 *
13 * **********
14 * Apache License 2.0:
15 *
16 * Licensed under the Apache License, Version 2.0 (the "License"); you may
17 * not use this file except in compliance with the License.
18 * You may obtain a copy of the License at
19 *
20 * http://www.apache.org/licenses/LICENSE-2.0
21 *
22 * Unless required by applicable law or agreed to in writing, software
23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25 * See the License for the specific language governing permissions and
26 * limitations under the License.
27 *
28 * **********
29 *
30 * **********
31 * GNU General Public License v2.0 or later:
32 *
33 * This program is free software; you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation; either version 2 of the License, or
36 * (at your option) any later version.
37 *
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
42 *
43 * You should have received a copy of the GNU General Public License along
44 * with this program; if not, write to the Free Software Foundation, Inc.,
45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46 *
47 * **********
48 */
49#ifndef MBEDTLS_X509_CSR_H
50#define MBEDTLS_X509_CSR_H
51
52#if !defined(MBEDTLS_CONFIG_FILE)
53#include "config.h"
54#else
55#include MBEDTLS_CONFIG_FILE
56#endif
57
58#include "x509.h"
59
60#ifdef __cplusplus
61extern "C" {
62#endif
63
76typedef struct mbedtls_x509_csr
77{
81 int version;
92 void *sig_opts;
93}
95
100{
105}
107
108#if defined(MBEDTLS_X509_CSR_PARSE_C)
121 const unsigned char *buf, size_t buflen );
122
135int mbedtls_x509_csr_parse( mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen );
136
137#if defined(MBEDTLS_FS_IO)
148int mbedtls_x509_csr_parse_file( mbedtls_x509_csr *csr, const char *path );
149#endif /* MBEDTLS_FS_IO */
150
163int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix,
164 const mbedtls_x509_csr *csr );
165
172
179#endif /* MBEDTLS_X509_CSR_PARSE_C */
180
181/* \} name */
182/* \} addtogroup x509_module */
183
184#if defined(MBEDTLS_X509_CSR_WRITE_C)
191
205 const char *subject_name );
206
215
224
243
254 unsigned char ns_cert_type );
255
269 const char *oid, size_t oid_len,
270 const unsigned char *val, size_t val_len );
271
278
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)
322int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
323 int (*f_rng)(void *, unsigned char *, size_t),
324 void *p_rng );
325#endif /* MBEDTLS_PEM_WRITE_C */
326#endif /* MBEDTLS_X509_CSR_WRITE_C */
327
328#ifdef __cplusplus
329}
330#endif
331
332#endif /* mbedtls_x509_csr.h */
Configuration options (set of defines)
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_x509_name subject
Definition x509_csr.h:84
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...
mbedtls_x509_buf sig
Definition x509_csr.h:89
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_x509_buf sig_oid
Definition x509_csr.h:88
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.
mbedtls_pk_type_t sig_pk
Definition x509_csr.h:91
mbedtls_md_type_t md_alg
Definition x509_csr.h:103
mbedtls_x509_buf cri
Definition x509_csr.h:79
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.
mbedtls_pk_context * key
Definition x509_csr.h:101
mbedtls_pk_context pk
Definition x509_csr.h:86
void * sig_opts
Definition x509_csr.h:92
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_...
mbedtls_x509_buf raw
Definition x509_csr.h:78
mbedtls_x509_buf subject_raw
Definition x509_csr.h:83
mbedtls_asn1_named_data * extensions
Definition x509_csr.h:104
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)
mbedtls_md_type_t sig_md
Definition x509_csr.h:90
mbedtls_asn1_named_data * subject
Definition x509_csr.h:102
mbedtls_md_type_t
Supported message digests.
Definition md.h:83
mbedtls_pk_type_t
Public key types.
Definition pk.h:103
Public key container.
Definition pk.h:156
X.509 generic defines and structures.