mbed TLS  Version 2.6.0
SSL/TLS Library for the Embedded Space
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
X.509 module

The X.509 module provides X.509 support for reading, writing and verification of certificates. More...

Structures

struct  mbedtls_x509_time
 Container for date and time (precision in seconds). More...
 
struct  mbedtls_x509_crl_entry
 Certificate revocation list entry. More...
 
struct  mbedtls_x509_crl
 Certificate revocation list structure. More...
 
struct  mbedtls_x509_crt
 Container for an X.509 certificate. More...
 
struct  mbedtls_x509_crt_profile
 Security profile for certificate verification. More...
 
struct  mbedtls_x509write_cert
 Container for writing a certificate (CRT) More...
 
struct  mbedtls_x509_csr
 Certificate Signing Request (CSR) structure. More...
 
struct  mbedtls_x509write_csr
 Container for writing a CSR. More...
 

Macros

#define MBEDTLS_X509_MAX_INTERMEDIATE_CA   8
 Maximum number of intermediate CAs in a verification chain. More...
 

Functions

int mbedtls_dhm_parse_dhm (mbedtls_dhm_context *dhm, const unsigned char *dhmin, size_t dhminlen)
 Parse DHM parameters in PEM or DER format. More...
 
int mbedtls_dhm_parse_dhmfile (mbedtls_dhm_context *dhm, const char *path)
 Load and parse DHM parameters. More...
 

X509 Error codes

#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE   -0x2080
 Unavailable feature, e.g. More...
 
#define MBEDTLS_ERR_X509_UNKNOWN_OID   -0x2100
 Requested OID is unknown. More...
 
#define MBEDTLS_ERR_X509_INVALID_FORMAT   -0x2180
 The CRT/CRL/CSR format is invalid, e.g. More...
 
#define MBEDTLS_ERR_X509_INVALID_VERSION   -0x2200
 The CRT/CRL/CSR version element is invalid. More...
 
#define MBEDTLS_ERR_X509_INVALID_SERIAL   -0x2280
 The serial tag or value is invalid. More...
 
#define MBEDTLS_ERR_X509_INVALID_ALG   -0x2300
 The algorithm tag or value is invalid. More...
 
#define MBEDTLS_ERR_X509_INVALID_NAME   -0x2380
 The name tag or value is invalid. More...
 
#define MBEDTLS_ERR_X509_INVALID_DATE   -0x2400
 The date tag or value is invalid. More...
 
#define MBEDTLS_ERR_X509_INVALID_SIGNATURE   -0x2480
 The signature tag or value invalid. More...
 
#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS   -0x2500
 The extension tag or value is invalid. More...
 
#define MBEDTLS_ERR_X509_UNKNOWN_VERSION   -0x2580
 CRT/CRL/CSR has an unsupported version number. More...
 
#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG   -0x2600
 Signature algorithm (oid) is unsupported. More...
 
#define MBEDTLS_ERR_X509_SIG_MISMATCH   -0x2680
 Signature algorithms do not match. More...
 
#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED   -0x2700
 Certificate verification failed, e.g. More...
 
#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT   -0x2780
 Format not recognized as DER or PEM. More...
 
#define MBEDTLS_ERR_X509_BAD_INPUT_DATA   -0x2800
 Input invalid. More...
 
#define MBEDTLS_ERR_X509_ALLOC_FAILED   -0x2880
 Allocation of memory failed. More...
 
#define MBEDTLS_ERR_X509_FILE_IO_ERROR   -0x2900
 Read/write of file failed. More...
 
#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL   -0x2980
 Destination buffer is too small. More...
 
#define MBEDTLS_ERR_X509_FATAL_ERROR   -0x3000
 A fatal error occured, eg the chain is too long or the vrfy callback failed. More...
 

X509 Verify codes

#define MBEDTLS_X509_BADCERT_EXPIRED   0x01
 The certificate validity has expired. More...
 
#define MBEDTLS_X509_BADCERT_REVOKED   0x02
 The certificate has been revoked (is on a CRL). More...
 
#define MBEDTLS_X509_BADCERT_CN_MISMATCH   0x04
 The certificate Common Name (CN) does not match with the expected CN. More...
 
#define MBEDTLS_X509_BADCERT_NOT_TRUSTED   0x08
 The certificate is not correctly signed by the trusted CA. More...
 
#define MBEDTLS_X509_BADCRL_NOT_TRUSTED   0x10
 The CRL is not correctly signed by the trusted CA. More...
 
#define MBEDTLS_X509_BADCRL_EXPIRED   0x20
 The CRL is expired. More...
 
#define MBEDTLS_X509_BADCERT_MISSING   0x40
 Certificate was missing. More...
 
#define MBEDTLS_X509_BADCERT_SKIP_VERIFY   0x80
 Certificate verification was skipped. More...
 
#define MBEDTLS_X509_BADCERT_OTHER   0x0100
 Other reason (can be used by verify callback)
 
#define MBEDTLS_X509_BADCERT_FUTURE   0x0200
 The certificate validity starts in the future. More...
 
#define MBEDTLS_X509_BADCRL_FUTURE   0x0400
 The CRL is from the future.
 
#define MBEDTLS_X509_BADCERT_KEY_USAGE   0x0800
 Usage does not match the keyUsage extension. More...
 
#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE   0x1000
 Usage does not match the extendedKeyUsage extension. More...
 
#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE   0x2000
 Usage does not match the nsCertType extension. More...
 
#define MBEDTLS_X509_BADCERT_BAD_MD   0x4000
 The certificate is signed with an unacceptable hash. More...
 
#define MBEDTLS_X509_BADCERT_BAD_PK   0x8000
 The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). More...
 
#define MBEDTLS_X509_BADCERT_BAD_KEY   0x010000
 The certificate is signed with an unacceptable key (eg bad curve, RSA too short). More...
 
#define MBEDTLS_X509_BADCRL_BAD_MD   0x020000
 The CRL is signed with an unacceptable hash. More...
 
#define MBEDTLS_X509_BADCRL_BAD_PK   0x040000
 The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). More...
 
#define MBEDTLS_X509_BADCRL_BAD_KEY   0x080000
 The CRL is signed with an unacceptable key (eg bad curve, RSA too short). More...
 

Structures for parsing X.509 certificates, CRLs and CSRs

typedef mbedtls_asn1_buf mbedtls_x509_buf
 Type-length-value structure that allows for ASN1 using DER.
 
typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring
 Container for ASN1 bit strings.
 
typedef mbedtls_asn1_named_data mbedtls_x509_name
 Container for ASN1 named information objects. More...
 
typedef mbedtls_asn1_sequence mbedtls_x509_sequence
 Container for a sequence of ASN.1 items.
 

Structures and functions for parsing CRLs

int mbedtls_x509_crl_parse_der (mbedtls_x509_crl *chain, const unsigned char *buf, size_t buflen)
 Parse a DER-encoded CRL and append it to the chained list. More...
 
int mbedtls_x509_crl_parse (mbedtls_x509_crl *chain, const unsigned char *buf, size_t buflen)
 Parse one or more CRLs and append them to the chained list. More...
 
int mbedtls_x509_crl_parse_file (mbedtls_x509_crl *chain, const char *path)
 Load one or more CRLs and append them to the chained list. More...
 
int mbedtls_x509_crl_info (char *buf, size_t size, const char *prefix, const mbedtls_x509_crl *crl)
 Returns an informational string about the CRL. More...
 
void mbedtls_x509_crl_init (mbedtls_x509_crl *crl)
 Initialize a CRL (chain) More...
 
void mbedtls_x509_crl_free (mbedtls_x509_crl *crl)
 Unallocate all CRL data. More...
 

Structures and functions for parsing and writing X.509 certificates

const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default
 Default security profile. More...
 
const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next
 Expected next default profile. More...
 
const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb
 NSA Suite B 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. More...
 
int mbedtls_x509_crt_parse (mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen)
 Parse one or more certificates and add them to the chained list. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
int mbedtls_x509_crt_check_key_usage (const mbedtls_x509_crt *crt, unsigned int usage)
 Check usage of certificate against keyUsage extension. More...
 
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 extentedJeyUsage. More...
 
int mbedtls_x509_crt_is_revoked (const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl)
 Verify the certificate revocation status. More...
 
void mbedtls_x509_crt_init (mbedtls_x509_crt *crt)
 Initialize a certificate (chain) More...
 
void mbedtls_x509_crt_free (mbedtls_x509_crt *crt)
 Unallocate all certificate data. More...
 
#define MBEDTLS_X509_ID_FLAG(id)   ( 1 << ( id - 1 ) )
 Build flag from an algorithm/curve identifier (pk, md, ecp) Since 0 is always XXX_NONE, ignore it.
 
#define MBEDTLS_X509_CRT_VERSION_1   0
 
#define MBEDTLS_X509_CRT_VERSION_2   1
 
#define MBEDTLS_X509_CRT_VERSION_3   2
 
#define MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN   32
 
#define MBEDTLS_X509_RFC5280_UTC_TIME_LEN   15
 
#define MBEDTLS_X509_MAX_FILE_PATH_LEN   512
 

Structures and functions for X.509 Certificate Signing Requests (CSR)

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. More...
 
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. More...
 
int mbedtls_x509_csr_parse_file (mbedtls_x509_csr *csr, const char *path)
 Load a Certificate Signing Request (CSR) More...
 
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. More...
 
void mbedtls_x509_csr_init (mbedtls_x509_csr *csr)
 Initialize a CSR. More...
 
void mbedtls_x509_csr_free (mbedtls_x509_csr *csr)
 Unallocate all CSR data. More...
 

Description

The X.509 module provides X.509 support for reading, writing and verification of certificates.

In summary:

This module can be used to build a certificate authority (CA) chain and verify its signature. It is also used to generate Certificate Signing Requests and X.509 certificates just as a CA would do.


Data Structure Documentation

struct mbedtls_x509_time

Container for date and time (precision in seconds).

Data Fields
int day Date.
int hour
int min
int mon
int sec Time.
int year
struct mbedtls_x509_crl_entry

Certificate revocation list entry.

Contains the CA-specific serial numbers and revocation dates.

Data Fields
mbedtls_x509_buf entry_ext
struct mbedtls_x509_crl_entry * next
mbedtls_x509_buf raw
mbedtls_x509_time revocation_date
mbedtls_x509_buf serial
struct mbedtls_x509_crl

Certificate revocation list structure.

Every CRL may have multiple entries.

Data Fields
mbedtls_x509_buf crl_ext
mbedtls_x509_crl_entry entry The CRL entries containing the certificate revocation times for this CA.
mbedtls_x509_name issuer The parsed issuer data (named information object).
mbedtls_x509_buf issuer_raw The raw issuer data (DER).
struct mbedtls_x509_crl * next
mbedtls_x509_time next_update
mbedtls_x509_buf raw The raw certificate data (DER).
mbedtls_x509_buf sig
mbedtls_md_type_t sig_md Internal representation of the MD algorithm of the signature algorithm, e.g.

MBEDTLS_MD_SHA256

mbedtls_x509_buf sig_oid CRL signature type identifier.
mbedtls_x509_buf sig_oid2
void * sig_opts Signature options to be passed to mbedtls_pk_verify_ext(), e.g.

for RSASSA-PSS

mbedtls_pk_type_t sig_pk Internal representation of the Public Key algorithm of the signature algorithm, e.g.

MBEDTLS_PK_RSA

mbedtls_x509_buf tbs The raw certificate body (DER).

The part that is To Be Signed.

mbedtls_x509_time this_update
int version CRL version (1=v1, 2=v2)
struct mbedtls_x509_crt

Container for an X.509 certificate.

The certificate may be chained.

Data Fields
int ca_istrue Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise.
mbedtls_x509_sequence ext_key_usage Optional list of extended key usage OIDs.
int ext_types Bit string containing detected and parsed extensions.
mbedtls_x509_name issuer The parsed issuer data (named information object).
mbedtls_x509_buf issuer_id Optional X.509 v2/v3 issuer unique identifier.
mbedtls_x509_buf issuer_raw The raw issuer data (DER).

Used for quick comparison.

unsigned int key_usage Optional key usage extension value: See the values in x509.h.
int max_pathlen Optional Basic Constraint extension value: The maximum path length to the root certificate.

Path length is 1 higher than RFC 5280 'meaning', so 1+

struct mbedtls_x509_crt * next Next certificate in the CA-chain.
unsigned char ns_cert_type Optional Netscape certificate type extension value: See the values in x509.h.
mbedtls_pk_context pk Container for the public key context.
mbedtls_x509_buf raw The raw certificate data (DER).
mbedtls_x509_buf serial Unique id for certificate issued by a specific CA.
mbedtls_x509_buf sig Signature: hash of the tbs part signed with the private key.
mbedtls_md_type_t sig_md Internal representation of the MD algorithm of the signature algorithm, e.g.

MBEDTLS_MD_SHA256

mbedtls_x509_buf sig_oid Signature algorithm, e.g.

sha1RSA

void * sig_opts Signature options to be passed to mbedtls_pk_verify_ext(), e.g.

for RSASSA-PSS

mbedtls_pk_type_t sig_pk Internal representation of the Public Key algorithm of the signature algorithm, e.g.

MBEDTLS_PK_RSA

mbedtls_x509_name subject The parsed subject data (named information object).
mbedtls_x509_sequence subject_alt_names Optional list of Subject Alternative Names (Only dNSName supported).
mbedtls_x509_buf subject_id Optional X.509 v2/v3 subject unique identifier.
mbedtls_x509_buf subject_raw The raw subject data (DER).

Used for quick comparison.

mbedtls_x509_buf tbs The raw certificate body (DER).

The part that is To Be Signed.

mbedtls_x509_buf v3_ext Optional X.509 v3 extensions.
mbedtls_x509_time valid_from Start time of certificate validity.
mbedtls_x509_time valid_to End time of certificate validity.
int version The X.509 version.

(1=v1, 2=v2, 3=v3)

struct mbedtls_x509_crt_profile

Security profile for certificate verification.

All lists are bitfields, built by ORing flags from MBEDTLS_X509_ID_FLAG().

Data Fields
uint32_t allowed_curves Elliptic curves for ECDSA.
uint32_t allowed_mds MDs for signatures.
uint32_t allowed_pks PK algs for signatures.
uint32_t rsa_min_bitlen Minimum size for RSA keys.
struct mbedtls_x509write_cert

Container for writing a certificate (CRT)

Data Fields
mbedtls_asn1_named_data * extensions
mbedtls_asn1_named_data * issuer
mbedtls_pk_context * issuer_key
mbedtls_md_type_t md_alg
char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN+1]
char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN+1]
mbedtls_mpi serial
mbedtls_asn1_named_data * subject
mbedtls_pk_context * subject_key
int version
struct mbedtls_x509_csr

Certificate Signing Request (CSR) structure.

Data Fields
mbedtls_x509_buf cri The raw CertificateRequestInfo body (DER).
mbedtls_pk_context pk Container for the public key context.
mbedtls_x509_buf raw The raw CSR data (DER).
mbedtls_x509_buf sig
mbedtls_md_type_t sig_md Internal representation of the MD algorithm of the signature algorithm, e.g.

MBEDTLS_MD_SHA256

mbedtls_x509_buf sig_oid
void * sig_opts Signature options to be passed to mbedtls_pk_verify_ext(), e.g.

for RSASSA-PSS

mbedtls_pk_type_t sig_pk Internal representation of the Public Key algorithm of the signature algorithm, e.g.

MBEDTLS_PK_RSA

mbedtls_x509_name subject The parsed subject data (named information object).
mbedtls_x509_buf subject_raw The raw subject data (DER).
int version CSR version (1=v1).
struct mbedtls_x509write_csr

Container for writing a CSR.

Data Fields
mbedtls_asn1_named_data * extensions
mbedtls_pk_context * key
mbedtls_md_type_t md_alg
mbedtls_asn1_named_data * subject

Macro Definition Documentation

#define MBEDTLS_ERR_X509_ALLOC_FAILED   -0x2880

Allocation of memory failed.

#define MBEDTLS_ERR_X509_BAD_INPUT_DATA   -0x2800

Input invalid.

#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL   -0x2980

Destination buffer is too small.

#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT   -0x2780

Format not recognized as DER or PEM.

#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED   -0x2700

Certificate verification failed, e.g.

CRL, CA or signature check failed.

#define MBEDTLS_ERR_X509_FATAL_ERROR   -0x3000

A fatal error occured, eg the chain is too long or the vrfy callback failed.

#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE   -0x2080

Unavailable feature, e.g.

RSA hashing/encryption combination.

#define MBEDTLS_ERR_X509_FILE_IO_ERROR   -0x2900

Read/write of file failed.

#define MBEDTLS_ERR_X509_INVALID_ALG   -0x2300

The algorithm tag or value is invalid.

#define MBEDTLS_ERR_X509_INVALID_DATE   -0x2400

The date tag or value is invalid.

#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS   -0x2500

The extension tag or value is invalid.

#define MBEDTLS_ERR_X509_INVALID_FORMAT   -0x2180

The CRT/CRL/CSR format is invalid, e.g.

different type expected.

#define MBEDTLS_ERR_X509_INVALID_NAME   -0x2380

The name tag or value is invalid.

#define MBEDTLS_ERR_X509_INVALID_SERIAL   -0x2280

The serial tag or value is invalid.

#define MBEDTLS_ERR_X509_INVALID_SIGNATURE   -0x2480

The signature tag or value invalid.

#define MBEDTLS_ERR_X509_INVALID_VERSION   -0x2200

The CRT/CRL/CSR version element is invalid.

#define MBEDTLS_ERR_X509_SIG_MISMATCH   -0x2680

Signature algorithms do not match.

(see mbedtls_x509_crt sig_oid)

#define MBEDTLS_ERR_X509_UNKNOWN_OID   -0x2100

Requested OID is unknown.

#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG   -0x2600

Signature algorithm (oid) is unsupported.

#define MBEDTLS_ERR_X509_UNKNOWN_VERSION   -0x2580

CRT/CRL/CSR has an unsupported version number.

#define MBEDTLS_X509_BADCERT_BAD_KEY   0x010000

The certificate is signed with an unacceptable key (eg bad curve, RSA too short).

#define MBEDTLS_X509_BADCERT_BAD_MD   0x4000

The certificate is signed with an unacceptable hash.

#define MBEDTLS_X509_BADCERT_BAD_PK   0x8000

The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA).

#define MBEDTLS_X509_BADCERT_CN_MISMATCH   0x04

The certificate Common Name (CN) does not match with the expected CN.

#define MBEDTLS_X509_BADCERT_EXPIRED   0x01

The certificate validity has expired.

#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE   0x1000

Usage does not match the extendedKeyUsage extension.

#define MBEDTLS_X509_BADCERT_FUTURE   0x0200

The certificate validity starts in the future.

#define MBEDTLS_X509_BADCERT_KEY_USAGE   0x0800

Usage does not match the keyUsage extension.

#define MBEDTLS_X509_BADCERT_MISSING   0x40

Certificate was missing.

#define MBEDTLS_X509_BADCERT_NOT_TRUSTED   0x08

The certificate is not correctly signed by the trusted CA.

#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE   0x2000

Usage does not match the nsCertType extension.

#define MBEDTLS_X509_BADCERT_REVOKED   0x02

The certificate has been revoked (is on a CRL).

#define MBEDTLS_X509_BADCERT_SKIP_VERIFY   0x80

Certificate verification was skipped.

#define MBEDTLS_X509_BADCRL_BAD_KEY   0x080000

The CRL is signed with an unacceptable key (eg bad curve, RSA too short).

#define MBEDTLS_X509_BADCRL_BAD_MD   0x020000

The CRL is signed with an unacceptable hash.

#define MBEDTLS_X509_BADCRL_BAD_PK   0x040000

The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA).

#define MBEDTLS_X509_BADCRL_EXPIRED   0x20

The CRL is expired.

#define MBEDTLS_X509_BADCRL_NOT_TRUSTED   0x10

The CRL is not correctly signed by the trusted CA.

#define MBEDTLS_X509_MAX_INTERMEDIATE_CA   8

Maximum number of intermediate CAs in a verification chain.

That is, maximum length of the chain, excluding the end-entity certificate and the trusted root certificate.

Set this to a low value to prevent an adversary from making you waste resources verifying an overlong certificate chain.

Typedef Documentation

Container for ASN1 named information objects.

It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.).

Function Documentation

int mbedtls_dhm_parse_dhm ( mbedtls_dhm_context dhm,
const unsigned char *  dhmin,
size_t  dhminlen 
)

Parse DHM parameters in PEM or DER format.

Parameters
dhmDHM context to be initialized
dhmininput buffer
dhminlensize of the buffer (including the terminating null byte for PEM data)
Returns
0 if successful, or a specific DHM or PEM error code
int mbedtls_dhm_parse_dhmfile ( mbedtls_dhm_context dhm,
const char *  path 
)

Load and parse DHM parameters.

Parameters
dhmDHM context to be initialized
pathfilename to read the DHM Parameters from
Returns
0 if successful, or a specific DHM or PEM error code
void mbedtls_x509_crl_free ( mbedtls_x509_crl crl)

Unallocate all CRL data.

Parameters
crlCRL chain to free
int mbedtls_x509_crl_info ( char *  buf,
size_t  size,
const char *  prefix,
const mbedtls_x509_crl crl 
)

Returns an informational string about the CRL.

Parameters
bufBuffer to write to
sizeMaximum size of buffer
prefixA line prefix
crlThe X509 CRL to represent
Returns
The length of the string written (not including the terminated nul byte), or a negative error code.
void mbedtls_x509_crl_init ( mbedtls_x509_crl crl)

Initialize a CRL (chain)

Parameters
crlCRL chain to initialize
int mbedtls_x509_crl_parse ( mbedtls_x509_crl chain,
const unsigned char *  buf,
size_t  buflen 
)

Parse one or more CRLs and append them to the chained list.

Note
Mutliple CRLs are accepted only if using PEM format
Parameters
chainpoints to the start of the chain
bufbuffer holding the CRL data in PEM or DER format
buflensize of the buffer (including the terminating null byte for PEM data)
Returns
0 if successful, or a specific X509 or PEM error code
int mbedtls_x509_crl_parse_der ( mbedtls_x509_crl chain,
const unsigned char *  buf,
size_t  buflen 
)

Parse a DER-encoded CRL and append it to the chained list.

Parameters
chainpoints to the start of the chain
bufbuffer holding the CRL data in DER format
buflensize of the buffer (including the terminating null byte for PEM data)
Returns
0 if successful, or a specific X509 or PEM error code
int mbedtls_x509_crl_parse_file ( mbedtls_x509_crl chain,
const char *  path 
)

Load one or more CRLs and append them to the chained list.

Note
Mutliple CRLs are accepted only if using PEM format
Parameters
chainpoints to the start of the chain
pathfilename to read the CRLs from (in PEM or DER encoding)
Returns
0 if successful, or a specific X509 or PEM error code
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 extentedJeyUsage.

Parameters
crtLeaf certificate used.
usage_oidIntended usage (eg MBEDTLS_OID_SERVER_AUTH or MBEDTLS_OID_CLIENT_AUTH).
usage_lenLength of usage_oid (eg given by MBEDTLS_OID_SIZE()).
Returns
0 if this use of the certificate is allowed, MBEDTLS_ERR_X509_BAD_INPUT_DATA if not.
Note
Usually only makes sense on leaf certificates.
int mbedtls_x509_crt_check_key_usage ( const mbedtls_x509_crt crt,
unsigned int  usage 
)

Check usage of certificate against keyUsage extension.

Parameters
crtLeaf certificate used.
usageIntended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT before using the certificate to perform an RSA key exchange).
Note
Except for decipherOnly and encipherOnly, a bit set in the usage argument means this bit MUST be set in the certificate. For decipherOnly and encipherOnly, it means that bit MAY be set.
Returns
0 is these uses of the certificate are allowed, MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension is present but does not match the usage argument.
Note
You should only call this function on leaf certificates, on (intermediate) CAs the keyUsage extension is automatically checked by mbedtls_x509_crt_verify().
void mbedtls_x509_crt_free ( mbedtls_x509_crt crt)

Unallocate all certificate data.

Parameters
crtCertificate chain to free
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.

Parameters
bufBuffer to write to
sizeMaximum size of buffer
prefixA line prefix
crtThe X509 certificate to represent
Returns
The length of the string written (not including the terminated nul byte), or a negative error code.
void mbedtls_x509_crt_init ( mbedtls_x509_crt crt)

Initialize a certificate (chain)

Parameters
crtCertificate chain to initialize
int mbedtls_x509_crt_is_revoked ( const mbedtls_x509_crt crt,
const mbedtls_x509_crl crl 
)

Verify the certificate revocation status.

Parameters
crta certificate to be verified
crlthe CRL to verify against
Returns
1 if the certificate is revoked, 0 otherwise
int mbedtls_x509_crt_parse ( mbedtls_x509_crt chain,
const unsigned char *  buf,
size_t  buflen 
)

Parse 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.

Parameters
chainpoints to the start of the chain
bufbuffer holding the certificate data in PEM or DER format
buflensize of the buffer (including the terminating null byte for PEM data)
Returns
0 if all certificates parsed successfully, a positive number if partly successful or a specific X509 or PEM error code
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.

Parameters
chainpoints to the start of the chain
bufbuffer holding the certificate DER data
buflensize of the buffer
Returns
0 if successful, or a specific X509 or PEM error code
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.

Parameters
chainpoints to the start of the chain
pathfilename to read the certificates from
Returns
0 if all certificates parsed successfully, a positive number if partly successful or a specific X509 or PEM error code
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. 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.

Parameters
chainpoints to the start of the chain
pathdirectory / folder to read the certificate files from
Returns
0 if all certificates parsed successfully, a positive number if partly successful or a specific X509 or PEM error code
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(*)(void *, mbedtls_x509_crt *, int, uint32_t *)  f_vrfy,
void *  p_vrfy 
)

Verify the certificate signature.

The verify callback is a user-supplied callback that can clear / modify / add flags for a certificate. If set, the verification callback is called for each certificate in the chain (from the trust-ca down to the presented crt). The parameters for the callback are: (void *parameter, mbedtls_x509_crt *crt, int certificate_depth, int *flags). With the flags representing current flags for that specific certificate and the certificate depth from the bottom (Peer cert depth = 0).

All flags left after returning from the callback are also returned to the application. The function should return 0 for anything (including invalid certificates) other than fatal error, as a non-zero return code immediately aborts the verification process. For fatal errors, a specific error code should be used (different from MBEDTLS_ERR_X509_CERT_VERIFY_FAILED which should not be returned at this point), or MBEDTLS_ERR_X509_FATAL_ERROR can be used if no better code is available.

Note
In case verification failed, the results can be displayed using mbedtls_x509_crt_verify_info()
Same as mbedtls_x509_crt_verify_with_profile() with the default security profile.
It is your responsibility to provide up-to-date CRLs for all trusted CAs. If no CRL is provided for the CA that was used to sign the certificate, CRL verification is skipped silently, that is without setting any flag.
Parameters
crta certificate (chain) to be verified
trust_cathe list of trusted CAs
ca_crlthe list of CRLs for trusted CAs (see note above)
cnexpected Common Name (can be set to NULL if the CN must not be verified)
flagsresult of the verification
f_vrfyverification function
p_vrfyverification parameter
Returns
0 (and flags set to 0) if the chain was verified and valid, MBEDTLS_ERR_X509_CERT_VERIFY_FAILED if the chain was verified but found to be invalid, in which case *flags will have one or more MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags set, or another error (and flags set to 0xffffffff) in case of a fatal error encountered during the verification process.
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.

Parameters
bufBuffer to write to
sizeMaximum size of buffer
prefixA line prefix
flagsVerification flags created by mbedtls_x509_crt_verify()
Returns
The length of the string written (not including the terminated nul byte), or a negative error code.
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(*)(void *, mbedtls_x509_crt *, int, uint32_t *)  f_vrfy,
void *  p_vrfy 
)

Verify the certificate signature according to profile.

Note
Same as mbedtls_x509_crt_verify(), but with explicit security profile.
The restrictions on keys (RSA minimum size, allowed curves for ECDSA) apply to all certificates: trusted root, intermediate CAs if any, and end entity certificate.
Parameters
crta certificate (chain) to be verified
trust_cathe list of trusted CAs
ca_crlthe list of CRLs for trusted CAs
profilesecurity profile for verification
cnexpected Common Name (can be set to NULL if the CN must not be verified)
flagsresult of the verification
f_vrfyverification function
p_vrfyverification parameter
Returns
0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED in which case *flags will have one or more MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags set, or another error in case of a fatal error encountered during the verification process.
void mbedtls_x509_csr_free ( mbedtls_x509_csr csr)

Unallocate all CSR data.

Parameters
csrCSR to free
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.

Parameters
bufBuffer to write to
sizeMaximum size of buffer
prefixA line prefix
csrThe X509 CSR to represent
Returns
The length of the string written (not including the terminated nul byte), or a negative error code.
void mbedtls_x509_csr_init ( mbedtls_x509_csr csr)

Initialize a CSR.

Parameters
csrCSR to initialize
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.

Note
See notes for mbedtls_x509_csr_parse_der()
Parameters
csrCSR context to fill
bufbuffer holding the CRL data
buflensize of the buffer (including the terminating null byte for PEM data)
Returns
0 if successful, or a specific X509 or PEM error code
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.

Note
CSR attributes (if any) are currently silently ignored.
Parameters
csrCSR context to fill
bufbuffer holding the CRL data
buflensize of the buffer
Returns
0 if successful, or a specific X509 error code
int mbedtls_x509_csr_parse_file ( mbedtls_x509_csr csr,
const char *  path 
)

Load a Certificate Signing Request (CSR)

Note
See notes for mbedtls_x509_csr_parse()
Parameters
csrCSR context to fill
pathfilename to read the CSR from
Returns
0 if successful, or a specific X509 or PEM error code

Variable Documentation

const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default

Default security profile.

Should provide a good balance between security and compatibility with current deployments.

const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next

Expected next default profile.

Recommended for new deployments. Currently targets a 128-bit security level, except for RSA-2048.