mbed TLS v2.16.9
x509_crt.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_CRT_H
50 #define MBEDTLS_X509_CRT_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 #include "x509_crl.h"
60 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
78 typedef struct mbedtls_x509_crt
79 {
83  int version;
103  int ext_types;
104  int ca_istrue;
107  unsigned int key_usage;
111  unsigned char ns_cert_type;
116  void *sig_opts;
119 }
121 
126 #define MBEDTLS_X509_ID_FLAG( id ) ( 1 << ( (id) - 1 ) )
127 
134 {
135  uint32_t allowed_mds;
136  uint32_t allowed_pks;
137  uint32_t allowed_curves;
138  uint32_t rsa_min_bitlen;
139 }
141 
142 #define MBEDTLS_X509_CRT_VERSION_1 0
143 #define MBEDTLS_X509_CRT_VERSION_2 1
144 #define MBEDTLS_X509_CRT_VERSION_3 2
145 
146 #define MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN 32
147 #define MBEDTLS_X509_RFC5280_UTC_TIME_LEN 15
148 
149 #if !defined( MBEDTLS_X509_MAX_FILE_PATH_LEN )
150 #define MBEDTLS_X509_MAX_FILE_PATH_LEN 512
151 #endif
152 
157 {
158  int version;
168 }
170 
174 typedef struct {
176  uint32_t flags;
178 
182 #define MBEDTLS_X509_MAX_VERIFY_CHAIN_SIZE ( MBEDTLS_X509_MAX_INTERMEDIATE_CA + 2 )
183 
187 typedef struct
188 {
190  unsigned len;
192 
193 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
194 
198 typedef struct
199 {
200  /* for check_signature() */
202 
203  /* for find_parent_in() */
204  mbedtls_x509_crt *parent; /* non-null iff parent_in in progress */
205  mbedtls_x509_crt *fallback_parent;
206  int fallback_signature_is_good;
207 
208  /* for find_parent() */
209  int parent_is_trusted; /* -1 if find_parent is not in progress */
210 
211  /* for verify_chain() */
212  enum {
213  x509_crt_rs_none,
214  x509_crt_rs_find_parent,
215  } in_progress; /* none if no operation is in progress */
216  int self_cnt;
218 
220 
221 #else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
222 
223 /* Now we can declare functions that take a pointer to that */
225 
226 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
227 
228 #if defined(MBEDTLS_X509_CRT_PARSE_C)
229 
234 
240 
245 
256 int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf,
257  size_t buflen );
258 
289 int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
290 
291 #if defined(MBEDTLS_FS_IO)
292 
305 int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path );
306 
320 int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path );
321 #endif /* MBEDTLS_FS_IO */
322 
335 int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
336  const mbedtls_x509_crt *crt );
337 
350 int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix,
351  uint32_t flags );
352 
412  mbedtls_x509_crt *trust_ca,
413  mbedtls_x509_crl *ca_crl,
414  const char *cn, uint32_t *flags,
415  int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
416  void *p_vrfy );
417 
446  mbedtls_x509_crt *trust_ca,
447  mbedtls_x509_crl *ca_crl,
448  const mbedtls_x509_crt_profile *profile,
449  const char *cn, uint32_t *flags,
450  int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
451  void *p_vrfy );
452 
476  mbedtls_x509_crt *trust_ca,
477  mbedtls_x509_crl *ca_crl,
478  const mbedtls_x509_crt_profile *profile,
479  const char *cn, uint32_t *flags,
480  int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
481  void *p_vrfy,
483 
484 #if defined(MBEDTLS_X509_CHECK_KEY_USAGE)
485 
507  unsigned int usage );
508 #endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */
509 
510 #if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE)
511 
525  const char *usage_oid,
526  size_t usage_len );
527 #endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE */
528 
529 #if defined(MBEDTLS_X509_CRL_PARSE_C)
530 
540 #endif /* MBEDTLS_X509_CRL_PARSE_C */
541 
548 
555 
556 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
557 
560 void mbedtls_x509_crt_restart_init( mbedtls_x509_crt_restart_ctx *ctx );
561 
565 void mbedtls_x509_crt_restart_free( mbedtls_x509_crt_restart_ctx *ctx );
566 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
567 #endif /* MBEDTLS_X509_CRT_PARSE_C */
568 
569 /* \} name */
570 /* \} addtogroup x509_module */
571 
572 #if defined(MBEDTLS_X509_CRT_WRITE_C)
573 
579 
589 
599 
614 int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before,
615  const char *not_after );
616 
630  const char *issuer_name );
631 
645  const char *subject_name );
646 
654 
662 
671 
686  const char *oid, size_t oid_len,
687  int critical,
688  const unsigned char *val, size_t val_len );
689 
702  int is_ca, int max_pathlen );
703 
704 #if defined(MBEDTLS_SHA1_C)
705 
715 
726 #endif /* MBEDTLS_SHA1_C */
727 
738  unsigned int key_usage );
739 
750  unsigned char ns_cert_type );
751 
758 
779 int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
780  int (*f_rng)(void *, unsigned char *, size_t),
781  void *p_rng );
782 
783 #if defined(MBEDTLS_PEM_WRITE_C)
784 
800 int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
801  int (*f_rng)(void *, unsigned char *, size_t),
802  void *p_rng );
803 #endif /* MBEDTLS_PEM_WRITE_C */
804 #endif /* MBEDTLS_X509_CRT_WRITE_C */
805 
806 #ifdef __cplusplus
807 }
808 #endif
809 
810 #endif /* mbedtls_x509_crt.h */
int mbedtls_x509write_crt_set_authority_key_identifier(mbedtls_x509write_cert *ctx)
Set the authorityKeyIdentifier extension for a CRT Requires that mbedtls_x509write_crt_set_issuer_key...
int mbedtls_x509_crt_verify(mbedtls_x509_crt *crt, mbedtls_x509_crt *trust_ca, mbedtls_x509_crl *ca_crl, const char *cn, uint32_t *flags, int(*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), void *p_vrfy)
Verify the certificate signature.
Public key container.
Definition: pk.h:155
int mbedtls_x509write_crt_der(mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Write a built up certificate to a X509 DER structure Note: data is written at the end of the buffer! ...
int mbedtls_x509_crt_verify_with_profile(mbedtls_x509_crt *crt, mbedtls_x509_crt *trust_ca, mbedtls_x509_crl *ca_crl, const mbedtls_x509_crt_profile *profile, const char *cn, uint32_t *flags, int(*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), void *p_vrfy)
Verify the certificate signature according to profile.
mbedtls_x509_sequence subject_alt_names
Definition: x509_crt.h:101
int mbedtls_x509_crt_verify_restartable(mbedtls_x509_crt *crt, mbedtls_x509_crt *trust_ca, mbedtls_x509_crl *ca_crl, const mbedtls_x509_crt_profile *profile, const char *cn, uint32_t *flags, int(*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), void *p_vrfy, mbedtls_x509_crt_restart_ctx *rs_ctx)
Restartable version of mbedtls_crt_verify_with_profile()
int mbedtls_x509_crt_parse_der(mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen)
Parse a single DER formatted certificate and add it to the chained list.
int mbedtls_x509write_crt_set_extension(mbedtls_x509write_cert *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 CRT.
int mbedtls_x509write_crt_set_ns_cert_type(mbedtls_x509write_cert *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_pk_type_t
Public key types.
Definition: pk.h:103
int mbedtls_x509_crt_is_revoked(const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl)
Verify the certificate revocation status.
Configuration options (set of defines)
char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN+1]
Definition: x509_crt.h:166
int mbedtls_x509write_crt_pem(mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Write a built up certificate to a X509 PEM string.
struct mbedtls_x509_crt * next
Definition: x509_crt.h:118
const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default
int mbedtls_x509_crt_check_key_usage(const mbedtls_x509_crt *crt, unsigned int usage)
Check usage of certificate against keyUsage extension.
mbedtls_x509_name issuer
Definition: x509_crt.h:90
void mbedtls_x509write_crt_set_subject_key(mbedtls_x509write_cert *ctx, mbedtls_pk_context *key)
Set the subject public key for the certificate.
int mbedtls_x509write_crt_set_key_usage(mbedtls_x509write_cert *ctx, unsigned int key_usage)
Set the Key Usage Extension flags (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_...
void mbedtls_x509write_crt_init(mbedtls_x509write_cert *ctx)
Initialize a CRT writing context.
mbedtls_x509_buf subject_id
Definition: x509_crt.h:99
struct mbedtls_x509write_cert mbedtls_x509write_cert
void mbedtls_x509write_crt_set_md_alg(mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg)
Set the MD algorithm to use for the signature (e.g. MBEDTLS_MD_SHA1)
mbedtls_x509_buf tbs
Definition: x509_crt.h:81
mbedtls_x509_buf subject_raw
Definition: x509_crt.h:88
void mbedtls_x509_crt_free(mbedtls_x509_crt *crt)
Unallocate all certificate data.
mbedtls_x509_buf sig_oid
Definition: x509_crt.h:85
void mbedtls_pk_restart_ctx
Definition: pk.h:172
mbedtls_x509_buf issuer_raw
Definition: x509_crt.h:87
const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb
int mbedtls_x509write_crt_set_basic_constraints(mbedtls_x509write_cert *ctx, int is_ca, int max_pathlen)
Set the basicConstraints extension for a CRT.
mbedtls_x509_name subject
Definition: x509_crt.h:91
mbedtls_x509_time valid_to
Definition: x509_crt.h:94
int mbedtls_x509_crt_parse(mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen)
Parse one DER-encoded or one or more concatenated PEM-encoded certificates and add them to the chaine...
struct mbedtls_x509_crt_profile mbedtls_x509_crt_profile
unsigned char ns_cert_type
Definition: x509_crt.h:111
int mbedtls_x509_crt_parse_path(mbedtls_x509_crt *chain, const char *path)
Load one or more certificate files from a path and add them to the chained list. Parses permissively...
int mbedtls_x509write_crt_set_subject_key_identifier(mbedtls_x509write_cert *ctx)
Set the subjectKeyIdentifier extension for a CRT Requires that mbedtls_x509write_crt_set_subject_key(...
int mbedtls_x509write_crt_set_subject_name(mbedtls_x509write_cert *ctx, const char *subject_name)
Set the subject name for a Certificate Subject names should contain a comma-separated list of OID typ...
mbedtls_x509_buf serial
Definition: x509_crt.h:84
void mbedtls_x509_crt_restart_ctx
Definition: x509_crt.h:224
void mbedtls_x509write_crt_set_version(mbedtls_x509write_cert *ctx, int version)
Set the verion for a Certificate Default: MBEDTLS_X509_CRT_VERSION_3.
mbedtls_x509_time valid_from
Definition: x509_crt.h:93
mbedtls_x509_buf raw
Definition: x509_crt.h:80
int mbedtls_x509_crt_check_extended_key_usage(const mbedtls_x509_crt *crt, const char *usage_oid, size_t usage_len)
Check usage of certificate against extendedKeyUsage.
int mbedtls_x509write_crt_set_validity(mbedtls_x509write_cert *ctx, const char *not_before, const char *not_after)
Set the validity period for a Certificate Timestamps should be in string format for UTC timezone i...
#define MBEDTLS_X509_RFC5280_UTC_TIME_LEN
Definition: x509_crt.h:147
#define MBEDTLS_X509_MAX_VERIFY_CHAIN_SIZE
Definition: x509_crt.h:182
void mbedtls_x509write_crt_set_issuer_key(mbedtls_x509write_cert *ctx, mbedtls_pk_context *key)
Set the issuer key used for signing the certificate.
const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next
mbedtls_pk_context * subject_key
Definition: x509_crt.h:160
mbedtls_pk_type_t sig_pk
Definition: x509_crt.h:115
X.509 generic defines and structures.
int mbedtls_x509_crt_info(char *buf, size_t size, const char *prefix, const mbedtls_x509_crt *crt)
Returns an informational string about the certificate.
int mbedtls_x509write_crt_set_issuer_name(mbedtls_x509write_cert *ctx, const char *issuer_name)
Set the issuer name for a Certificate Issuer names should contain a comma-separated list of OID types...
mbedtls_asn1_named_data * subject
Definition: x509_crt.h:162
int mbedtls_x509_crt_parse_file(mbedtls_x509_crt *chain, const char *path)
Load one or more certificates and add them to the chained list. Parses permissively. If some certificates can be parsed, the result is the number of failed certificates it encountered. If none complete correctly, the first error is returned.
mbedtls_pk_context * issuer_key
Definition: x509_crt.h:161
void * sig_opts
Definition: x509_crt.h:116
char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN+1]
Definition: x509_crt.h:165
mbedtls_md_type_t md_alg
Definition: x509_crt.h:164
mbedtls_x509_buf issuer_id
Definition: x509_crt.h:98
int mbedtls_x509write_crt_set_serial(mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial)
Set the serial number for a Certificate.
MPI structure.
Definition: bignum.h:210
X.509 certificate revocation list parsing.
void mbedtls_x509write_crt_free(mbedtls_x509write_cert *ctx)
Free the contents of a CRT write context.
struct mbedtls_x509_crt mbedtls_x509_crt
mbedtls_x509_sequence ext_key_usage
Definition: x509_crt.h:109
void mbedtls_x509_crt_init(mbedtls_x509_crt *crt)
Initialize a certificate (chain)
mbedtls_asn1_named_data * extensions
Definition: x509_crt.h:167
unsigned int key_usage
Definition: x509_crt.h:107
mbedtls_pk_context pk
Definition: x509_crt.h:96
mbedtls_x509_buf sig
Definition: x509_crt.h:113
mbedtls_md_type_t
Supported message digests.
Definition: md.h:83
int mbedtls_x509_crt_verify_info(char *buf, size_t size, const char *prefix, uint32_t flags)
Returns an informational string about the verification status of a certificate.
mbedtls_asn1_named_data * issuer
Definition: x509_crt.h:163
mbedtls_mpi serial
Definition: x509_crt.h:159
mbedtls_x509_buf v3_ext
Definition: x509_crt.h:100
mbedtls_md_type_t sig_md
Definition: x509_crt.h:114