mbed TLS v1.3.21
x509_crt.h
Go to the documentation of this file.
1 
24 #ifndef POLARSSL_X509_CRT_H
25 #define POLARSSL_X509_CRT_H
26 
27 #if !defined(POLARSSL_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include POLARSSL_CONFIG_FILE
31 #endif
32 
33 #include "x509.h"
34 #include "x509_crl.h"
35 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
53 typedef struct _x509_crt
54 {
58  int version;
78  int ext_types;
79  int ca_istrue;
82  unsigned char key_usage;
86  unsigned char ns_cert_type;
92  void *sig_opts;
94  struct _x509_crt *next;
95 }
96 x509_crt;
97 
98 #define X509_CRT_VERSION_1 0
99 #define X509_CRT_VERSION_2 1
100 #define X509_CRT_VERSION_3 2
101 
102 #define X509_RFC5280_MAX_SERIAL_LEN 32
103 #define X509_RFC5280_UTC_TIME_LEN 15
104 
108 typedef struct _x509write_cert
109 {
110  int version;
120 }
122 
123 #if defined(POLARSSL_X509_CRT_PARSE_C)
124 
134 int x509_crt_parse_der( x509_crt *chain, const unsigned char *buf,
135  size_t buflen );
136 
151 int x509_crt_parse( x509_crt *chain, const unsigned char *buf, size_t buflen );
152 
153 #if defined(POLARSSL_FS_IO)
154 
167 int x509_crt_parse_file( x509_crt *chain, const char *path );
168 
187 int x509_crt_parse_path( x509_crt *chain, const char *path );
188 #endif /* POLARSSL_FS_IO */
189 
202 int x509_crt_info( char *buf, size_t size, const char *prefix,
203  const x509_crt *crt );
204 
217 int x509_crt_verify_info( char *buf, size_t size, const char *prefix,
218  int flags );
219 
263 int x509_crt_verify( x509_crt *crt,
264  x509_crt *trust_ca,
265  x509_crl *ca_crl,
266  const char *cn, int *flags,
267  int (*f_vrfy)(void *, x509_crt *, int, int *),
268  void *p_vrfy );
269 
270 #if defined(POLARSSL_X509_CHECK_KEY_USAGE)
271 
287 int x509_crt_check_key_usage( const x509_crt *crt, int usage );
288 #endif /* POLARSSL_X509_CHECK_KEY_USAGE) */
289 
290 #if defined(POLARSSL_X509_CHECK_EXTENDED_KEY_USAGE)
291 
304  const char *usage_oid,
305  size_t usage_len );
306 #endif /* POLARSSL_X509_CHECK_EXTENDED_KEY_USAGE) */
307 
308 #if defined(POLARSSL_X509_CRL_PARSE_C)
309 
318 int x509_crt_revoked( const x509_crt *crt, const x509_crl *crl );
319 #endif /* POLARSSL_X509_CRL_PARSE_C */
320 
326 void x509_crt_init( x509_crt *crt );
327 
333 void x509_crt_free( x509_crt *crt );
334 #endif /* POLARSSL_X509_CRT_PARSE_C */
335 
336 /* \} name */
337 /* \} addtogroup x509_module */
338 
339 #if defined(POLARSSL_X509_CRT_WRITE_C)
340 
346 
355 void x509write_crt_set_version( x509write_cert *ctx, int version );
356 
365 int x509write_crt_set_serial( x509write_cert *ctx, const mpi *serial );
366 
381 int x509write_crt_set_validity( x509write_cert *ctx, const char *not_before,
382  const char *not_after );
383 
397  const char *issuer_name );
398 
412  const char *subject_name );
413 
421 
429 
438 
453  const char *oid, size_t oid_len,
454  int critical,
455  const unsigned char *val, size_t val_len );
456 
469  int is_ca, int max_pathlen );
470 
471 #if defined(POLARSSL_SHA1_C)
472 
482 
493 #endif /* POLARSSL_SHA1_C */
494 
504 int x509write_crt_set_key_usage( x509write_cert *ctx, unsigned char key_usage );
505 
516  unsigned char ns_cert_type );
517 
524 
545 int x509write_crt_der( x509write_cert *ctx, unsigned char *buf, size_t size,
546  int (*f_rng)(void *, unsigned char *, size_t),
547  void *p_rng );
548 
549 #if defined(POLARSSL_PEM_WRITE_C)
550 
566 int x509write_crt_pem( x509write_cert *ctx, unsigned char *buf, size_t size,
567  int (*f_rng)(void *, unsigned char *, size_t),
568  void *p_rng );
569 #endif /* POLARSSL_PEM_WRITE_C */
570 #endif /* POLARSSL_X509_CRT_WRITE_C */
571 
572 #ifdef __cplusplus
573 }
574 #endif
575 
576 #endif /* x509_crt.h */
struct _x509_crt x509_crt
Container for an X.509 certificate.
void x509write_crt_set_version(x509write_cert *ctx, int version)
Set the verion for a Certificate Default: X509_CRT_VERSION_3.
int x509write_crt_der(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 x509_crt_verify_info(char *buf, size_t size, const char *prefix, int flags)
Returns an informational string about the verification status of a certificate.
int x509write_crt_set_validity(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...
x509_sequence subject_alt_names
Optional list of Subject Alternative Names (Only dNSName supported).
Definition: x509_crt.h:76
char not_after[X509_RFC5280_UTC_TIME_LEN+1]
Definition: x509_crt.h:118
x509_buf raw
The raw certificate data (DER).
Definition: x509_crt.h:55
asn1_named_data * extensions
Definition: x509_crt.h:119
int ext_types
Bit string containing detected and parsed extensions.
Definition: x509_crt.h:78
void * sig_opts
Signature options to be passed to pk_verify_ext(), e.g.
Definition: x509_crt.h:92
unsigned char ns_cert_type
Optional Netscape certificate type extension value: See the values in x509.h.
Definition: x509_crt.h:86
x509_buf issuer_raw
The raw issuer data (DER).
Definition: x509_crt.h:62
Container for date and time (precision in seconds).
Definition: x509.h:199
int x509_crt_parse(x509_crt *chain, const unsigned char *buf, size_t buflen)
Parse one or more certificates and add them to the chained list.
x509_buf sig_oid2
Signature algorithm.
Definition: x509_crt.h:88
void x509_crt_free(x509_crt *crt)
Unallocate all certificate data.
Configuration options (set of defines)
x509_buf tbs
The raw certificate body (DER).
Definition: x509_crt.h:56
x509_buf serial
Unique id for certificate issued by a specific CA.
Definition: x509_crt.h:59
md_type_t sig_md
Internal representation of the MD algorithm of the signature algorithm, e.g.
Definition: x509_crt.h:90
int ca_istrue
Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise...
Definition: x509_crt.h:79
int x509_crt_parse_der(x509_crt *chain, const unsigned char *buf, size_t buflen)
Parse a single DER formatted certificate and add it to the chained list.
pk_context * subject_key
Definition: x509_crt.h:112
void x509write_crt_set_md_alg(x509write_cert *ctx, md_type_t md_alg)
Set the MD algorithm to use for the signature (e.g.
MPI structure.
Definition: bignum.h:183
int max_pathlen
Optional Basic Constraint extension value: The maximum path length to the root certificate.
Definition: x509_crt.h:80
struct _x509_crt * next
Next certificate in the CA-chain.
Definition: x509_crt.h:94
int x509_crt_check_key_usage(const x509_crt *crt, int usage)
Check usage of certificate against keyUsage extension.
md_type_t
Definition: md.h:45
Container for a sequence of ASN.1 items.
Definition: asn1.h:143
int x509write_crt_set_key_usage(x509write_cert *ctx, unsigned char key_usage)
Set the Key Usage Extension flags (e.g.
void x509write_crt_free(x509write_cert *ctx)
Free the contents of a CRT write context.
Container for an X.509 certificate.
Definition: x509_crt.h:53
x509_time valid_from
Start time of certificate validity.
Definition: x509_crt.h:68
int x509write_crt_set_subject_key_identifier(x509write_cert *ctx)
Set the subjectKeyIdentifier extension for a CRT Requires that x509write_crt_set_subject_key() has be...
char not_before[X509_RFC5280_UTC_TIME_LEN+1]
Definition: x509_crt.h:117
x509_sequence ext_key_usage
Optional list of extended key usage OIDs.
Definition: x509_crt.h:84
int x509write_crt_set_extension(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.
void x509_crt_init(x509_crt *crt)
Initialize a certificate (chain)
x509_name subject
The parsed subject data (named information object).
Definition: x509_crt.h:66
int x509write_crt_set_issuer_name(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...
int x509_crt_verify(x509_crt *crt, x509_crt *trust_ca, x509_crl *ca_crl, const char *cn, int *flags, int(*f_vrfy)(void *, x509_crt *, int, int *), void *p_vrfy)
Verify the certificate signature.
asn1_named_data * issuer
Definition: x509_crt.h:115
x509_time valid_to
End time of certificate validity.
Definition: x509_crt.h:69
void x509write_crt_set_issuer_key(x509write_cert *ctx, pk_context *key)
Set the issuer key used for signing the certificate.
x509_buf sig_oid1
Signature algorithm, e.g.
Definition: x509_crt.h:60
pk_type_t
Public key types.
Definition: pk.h:92
int x509write_crt_set_serial(x509write_cert *ctx, const mpi *serial)
Set the serial number for a Certificate.
X.509 generic defines and structures.
int x509write_crt_set_authority_key_identifier(x509write_cert *ctx)
Set the authorityKeyIdentifier extension for a CRT Requires that x509write_crt_set_issuer_key() has b...
int x509write_crt_set_ns_cert_type(x509write_cert *ctx, unsigned char ns_cert_type)
Set the Netscape Cert Type flags (e.g.
Container for writing a certificate (CRT)
Definition: x509_crt.h:108
int x509_crt_revoked(const x509_crt *crt, const x509_crl *crl)
Verify the certificate revocation status.
Container for a sequence or list of 'named' ASN.1 data items.
Definition: asn1.h:153
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:121
int x509write_crt_set_subject_name(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...
x509_name issuer
The parsed issuer data (named information object).
Definition: x509_crt.h:65
int x509write_crt_set_basic_constraints(x509write_cert *ctx, int is_ca, int max_pathlen)
Set the basicConstraints extension for a CRT.
struct _x509write_cert x509write_cert
Container for writing a certificate (CRT)
md_type_t md_alg
Definition: x509_crt.h:116
pk_context * issuer_key
Definition: x509_crt.h:113
X.509 certificate revocation list parsing.
Certificate revocation list structure.
Definition: x509_crl.h:70
pk_context pk
Container for the public key context.
Definition: x509_crt.h:71
x509_buf issuer_id
Optional X.509 v2/v3 issuer unique identifier.
Definition: x509_crt.h:73
int x509_crt_parse_path(x509_crt *chain, const char *path)
Load one or more certificate files from a path and add them to the chained list.
void x509write_crt_init(x509write_cert *ctx)
Initialize a CRT writing context.
x509_buf v3_ext
Optional X.509 v3 extensions.
Definition: x509_crt.h:75
x509_buf subject_id
Optional X.509 v2/v3 subject unique identifier.
Definition: x509_crt.h:74
int version
The X.509 version.
Definition: x509_crt.h:58
pk_type_t sig_pk
Internal representation of the Public Key algorithm of the signature algorithm, e.g.
Definition: x509_crt.h:91
void x509write_crt_set_subject_key(x509write_cert *ctx, pk_context *key)
Set the subject public key for the certificate.
int x509_crt_info(char *buf, size_t size, const char *prefix, const x509_crt *crt)
Returns an informational string about the certificate.
unsigned char key_usage
Optional key usage extension value: See the values in x509.h.
Definition: x509_crt.h:82
x509_buf subject_raw
The raw subject data (DER).
Definition: x509_crt.h:63
int x509_crt_check_extended_key_usage(const x509_crt *crt, const char *usage_oid, size_t usage_len)
Check usage of certificate against extentedJeyUsage.
int x509write_crt_pem(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.
#define X509_RFC5280_UTC_TIME_LEN
Definition: x509_crt.h:103
Public key container.
Definition: pk.h:194
int x509_crt_parse_file(x509_crt *chain, const char *path)
Load one or more certificates and add them to the chained list.
asn1_named_data * subject
Definition: x509_crt.h:114
x509_buf sig
Signature: hash of the tbs part signed with the private key.
Definition: x509_crt.h:89