PolarSSL v1.3.7
x509_crt.h
Go to the documentation of this file.
1 
27 #ifndef POLARSSL_X509_CRT_H
28 #define POLARSSL_X509_CRT_H
29 
30 #if !defined(POLARSSL_CONFIG_FILE)
31 #include "config.h"
32 #else
33 #include POLARSSL_CONFIG_FILE
34 #endif
35 
36 #include "x509.h"
37 
38 #include "x509_crl.h"
39 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
57 typedef struct _x509_crt
58 {
62  int version;
82  int ext_types;
83  int ca_istrue;
86  unsigned char key_usage;
90  unsigned char ns_cert_type;
96 
97  struct _x509_crt *next;
98 }
99 x509_crt;
100 
101 #define X509_CRT_VERSION_1 0
102 #define X509_CRT_VERSION_2 1
103 #define X509_CRT_VERSION_3 2
104 
105 #define X509_RFC5280_MAX_SERIAL_LEN 32
106 #define X509_RFC5280_UTC_TIME_LEN 15
107 
111 typedef struct _x509write_cert
112 {
113  int version;
123 }
125 
126 #if defined(POLARSSL_X509_CRT_PARSE_C)
127 
137 int x509_crt_parse_der( x509_crt *chain, const unsigned char *buf,
138  size_t buflen );
139 
154 int x509_crt_parse( x509_crt *chain, const unsigned char *buf, size_t buflen );
155 
156 #if defined(POLARSSL_FS_IO)
157 
170 int x509_crt_parse_file( x509_crt *chain, const char *path );
171 
190 int x509_crt_parse_path( x509_crt *chain, const char *path );
191 #endif /* POLARSSL_FS_IO */
192 
205 int x509_crt_info( char *buf, size_t size, const char *prefix,
206  const x509_crt *crt );
207 
244 int x509_crt_verify( x509_crt *crt,
245  x509_crt *trust_ca,
246  x509_crl *ca_crl,
247  const char *cn, int *flags,
248  int (*f_vrfy)(void *, x509_crt *, int, int *),
249  void *p_vrfy );
250 
251 #if defined(POLARSSL_X509_CHECK_KEY_USAGE)
252 
268 int x509_crt_check_key_usage( const x509_crt *crt, int usage );
269 #endif /* POLARSSL_X509_CHECK_KEY_USAGE) */
270 
271 #if defined(POLARSSL_X509_CHECK_EXTENDED_KEY_USAGE)
272 
285  const char *usage_oid,
286  size_t usage_len );
287 #endif /* POLARSSL_X509_CHECK_EXTENDED_KEY_USAGE) */
288 
289 #if defined(POLARSSL_X509_CRL_PARSE_C)
290 
299 int x509_crt_revoked( const x509_crt *crt, const x509_crl *crl );
300 #endif /* POLARSSL_X509_CRL_PARSE_C */
301 
307 void x509_crt_init( x509_crt *crt );
308 
314 void x509_crt_free( x509_crt *crt );
315 #endif /* POLARSSL_X509_CRT_PARSE_C */
316 
317 /* \} name */
318 /* \} addtogroup x509_module */
319 
320 #if defined(POLARSSL_X509_CRT_WRITE_C)
321 
327 
336 void x509write_crt_set_version( x509write_cert *ctx, int version );
337 
346 int x509write_crt_set_serial( x509write_cert *ctx, const mpi *serial );
347 
362 int x509write_crt_set_validity( x509write_cert *ctx, const char *not_before,
363  const char *not_after );
364 
378  const char *issuer_name );
379 
393  const char *subject_name );
394 
402 
410 
419 
434  const char *oid, size_t oid_len,
435  int critical,
436  const unsigned char *val, size_t val_len );
437 
450  int is_ca, int max_pathlen );
451 
452 #if defined(POLARSSL_SHA1_C)
453 
463 
474 #endif /* POLARSSL_SHA1_C */
475 
485 int x509write_crt_set_key_usage( x509write_cert *ctx, unsigned char key_usage );
486 
497  unsigned char ns_cert_type );
498 
505 
526 int x509write_crt_der( x509write_cert *ctx, unsigned char *buf, size_t size,
527  int (*f_rng)(void *, unsigned char *, size_t),
528  void *p_rng );
529 
530 #if defined(POLARSSL_PEM_WRITE_C)
531 
547 int x509write_crt_pem( x509write_cert *ctx, unsigned char *buf, size_t size,
548  int (*f_rng)(void *, unsigned char *, size_t),
549  void *p_rng );
550 #endif /* POLARSSL_PEM_WRITE_C */
551 #endif /* POLARSSL_X509_CRT_WRITE_C */
552 
553 #ifdef __cplusplus
554 }
555 #endif
556 
557 #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 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:80
char not_after[X509_RFC5280_UTC_TIME_LEN+1]
Definition: x509_crt.h:121
x509_buf raw
The raw certificate data (DER).
Definition: x509_crt.h:59
asn1_named_data * extensions
Definition: x509_crt.h:122
int ext_types
Bit string containing detected and parsed extensions.
Definition: x509_crt.h:82
unsigned char ns_cert_type
Optional Netscape certificate type extension value: See the values in x509.h.
Definition: x509_crt.h:90
x509_buf issuer_raw
The raw issuer data (DER).
Definition: x509_crt.h:66
Container for date and time (precision in seconds).
Definition: x509.h:181
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:92
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:60
x509_buf serial
Unique id for certificate issued by a specific CA.
Definition: x509_crt.h:63
md_type_t sig_md
Internal representation of the MD algorithm of the signature algorithm, e.g.
Definition: x509_crt.h:94
int ca_istrue
Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise...
Definition: x509_crt.h:83
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:115
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:181
int max_pathlen
Optional Basic Constraint extension value: The maximum path length to the root certificate.
Definition: x509_crt.h:84
struct _x509_crt * next
Next certificate in the CA-chain.
Definition: x509_crt.h:97
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:51
Container for a sequence of ASN.1 items.
Definition: asn1.h:142
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:57
x509_time valid_from
Start time of certificate validity.
Definition: x509_crt.h:72
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:120
x509_sequence ext_key_usage
Optional list of extended key usage OIDs.
Definition: x509_crt.h:88
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:70
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:118
x509_time valid_to
End time of certificate validity.
Definition: x509_crt.h:73
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:64
pk_type_t
Public key types.
Definition: pk.h:95
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:111
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:152
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:120
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:69
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:119
pk_context * issuer_key
Definition: x509_crt.h:116
X.509 certificate revocation list parsing.
Certificate revocation list structure.
Definition: x509_crl.h:73
pk_context pk
Container for the public key context.
Definition: x509_crt.h:75
x509_buf issuer_id
Optional X.509 v2/v3 issuer unique identifier.
Definition: x509_crt.h:77
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:79
x509_buf subject_id
Optional X.509 v2/v3 subject unique identifier.
Definition: x509_crt.h:78
int version
The X.509 version.
Definition: x509_crt.h:62
pk_type_t sig_pk
< Internal representation of the Public Key algorithm of the signature algorithm, e...
Definition: x509_crt.h:95
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:86
x509_buf subject_raw
The raw subject data (DER).
Definition: x509_crt.h:67
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:106
Public key container.
Definition: pk.h:182
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:117
x509_buf sig
Signature: hash of the tbs part signed with the private key.
Definition: x509_crt.h:93