mbed TLS v2.16.1
x509_csr.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: GPL-2.0
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  *
24  * This file is part of mbed TLS (https://tls.mbed.org)
25  */
26 #ifndef MBEDTLS_X509_CSR_H
27 #define MBEDTLS_X509_CSR_H
28 
29 #if !defined(MBEDTLS_CONFIG_FILE)
30 #include "config.h"
31 #else
32 #include MBEDTLS_CONFIG_FILE
33 #endif
34 
35 #include "x509.h"
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
53 typedef struct mbedtls_x509_csr
54 {
58  int version;
69  void *sig_opts;
70 }
72 
76 typedef struct mbedtls_x509write_csr
77 {
82 }
84 
85 #if defined(MBEDTLS_X509_CSR_PARSE_C)
86 
98  const unsigned char *buf, size_t buflen );
99 
112 int mbedtls_x509_csr_parse( mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen );
113 
114 #if defined(MBEDTLS_FS_IO)
115 
125 int mbedtls_x509_csr_parse_file( mbedtls_x509_csr *csr, const char *path );
126 #endif /* MBEDTLS_FS_IO */
127 
140 int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix,
141  const mbedtls_x509_csr *csr );
142 
149 
156 #endif /* MBEDTLS_X509_CSR_PARSE_C */
157 
158 /* \} name */
159 /* \} addtogroup x509_module */
160 
161 #if defined(MBEDTLS_X509_CSR_WRITE_C)
162 
168 
182  const char *subject_name );
183 
192 
201 
219 int mbedtls_x509write_csr_set_key_usage( mbedtls_x509write_csr *ctx, unsigned char key_usage );
220 
231  unsigned char ns_cert_type );
232 
246  const char *oid, size_t oid_len,
247  const unsigned char *val, size_t val_len );
248 
255 
277 int mbedtls_x509write_csr_der( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
278  int (*f_rng)(void *, unsigned char *, size_t),
279  void *p_rng );
280 
281 #if defined(MBEDTLS_PEM_WRITE_C)
282 
299 int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
300  int (*f_rng)(void *, unsigned char *, size_t),
301  void *p_rng );
302 #endif /* MBEDTLS_PEM_WRITE_C */
303 #endif /* MBEDTLS_X509_CSR_WRITE_C */
304 
305 #ifdef __cplusplus
306 }
307 #endif
308 
309 #endif /* mbedtls_x509_csr.h */
mbedtls_x509_buf sig
Definition: x509_csr.h:66
mbedtls_x509_name subject
Definition: x509_csr.h:61
void mbedtls_x509write_csr_free(mbedtls_x509write_csr *ctx)
Free the contents of a CSR context.
Public key container.
Definition: pk.h:132
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:78
mbedtls_md_type_t sig_md
Definition: x509_csr.h:67
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:80
mbedtls_pk_type_t
Public key types.
Definition: pk.h:80
Configuration options (set of defines)
struct mbedtls_x509_csr mbedtls_x509_csr
mbedtls_asn1_named_data * extensions
Definition: x509_csr.h:81
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:68
mbedtls_x509_buf sig_oid
Definition: x509_csr.h:65
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:55
void * sig_opts
Definition: x509_csr.h:69
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:56
X.509 generic defines and structures.
mbedtls_x509_buf subject_raw
Definition: x509_csr.h:60
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:79
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:60
mbedtls_pk_context pk
Definition: x509_csr.h:63
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.