x509.h

Go to the documentation of this file.

/*
 *  Copyright The Mbed TLS Contributors
 *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
 */
#ifndef MBEDTLS_X509_H
#define MBEDTLS_X509_H
#include "mbedtls/private_access.h"

#include "mbedtls/build_info.h"

#include "mbedtls/asn1.h"
#include "mbedtls/pk.h"

#if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)

#define MBEDTLS_X509_MAX_INTERMEDIATE_CA   8
#endif

#define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE              -0x2080

#define MBEDTLS_ERR_X509_UNKNOWN_OID                      -0x2100

#define MBEDTLS_ERR_X509_INVALID_FORMAT                   -0x2180

#define MBEDTLS_ERR_X509_INVALID_VERSION                  -0x2200

#define MBEDTLS_ERR_X509_INVALID_SERIAL                   -0x2280

#define MBEDTLS_ERR_X509_INVALID_ALG                      -0x2300

#define MBEDTLS_ERR_X509_INVALID_NAME                     -0x2380

#define MBEDTLS_ERR_X509_INVALID_DATE                     -0x2400

#define MBEDTLS_ERR_X509_INVALID_SIGNATURE                -0x2480

#define MBEDTLS_ERR_X509_INVALID_EXTENSIONS               -0x2500

#define MBEDTLS_ERR_X509_UNKNOWN_VERSION                  -0x2580

#define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG                  -0x2600

#define MBEDTLS_ERR_X509_SIG_MISMATCH                     -0x2680

#define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED               -0x2700

#define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT              -0x2780

#define MBEDTLS_ERR_X509_BAD_INPUT_DATA                   -0x2800

#define MBEDTLS_ERR_X509_ALLOC_FAILED                     PSA_ERROR_INSUFFICIENT_MEMORY

#define MBEDTLS_ERR_X509_FILE_IO_ERROR                    -0x2900

#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL                 PSA_ERROR_BUFFER_TOO_SMALL

#define MBEDTLS_ERR_X509_FATAL_ERROR                      -0x3000

/* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
#define MBEDTLS_X509_BADCERT_EXPIRED             0x01  
#define MBEDTLS_X509_BADCERT_REVOKED             0x02  
#define MBEDTLS_X509_BADCERT_CN_MISMATCH         0x04  
#define MBEDTLS_X509_BADCERT_NOT_TRUSTED         0x08  
#define MBEDTLS_X509_BADCRL_NOT_TRUSTED          0x10  
#define MBEDTLS_X509_BADCRL_EXPIRED              0x20  
#define MBEDTLS_X509_BADCERT_MISSING             0x40  
#define MBEDTLS_X509_BADCERT_SKIP_VERIFY         0x80  
#define MBEDTLS_X509_BADCERT_OTHER             0x0100  
#define MBEDTLS_X509_BADCERT_FUTURE            0x0200  
#define MBEDTLS_X509_BADCRL_FUTURE             0x0400  
#define MBEDTLS_X509_BADCERT_KEY_USAGE         0x0800  
#define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE     0x1000  
#define MBEDTLS_X509_BADCERT_NS_CERT_TYPE      0x2000  
#define MBEDTLS_X509_BADCERT_BAD_MD            0x4000  
#define MBEDTLS_X509_BADCERT_BAD_PK            0x8000  
#define MBEDTLS_X509_BADCERT_BAD_KEY         0x010000  
#define MBEDTLS_X509_BADCRL_BAD_MD           0x020000  
#define MBEDTLS_X509_BADCRL_BAD_PK           0x040000  
#define MBEDTLS_X509_BADCRL_BAD_KEY          0x080000  
/*
 * X.509 v3 Subject Alternative Name types.
 *      otherName                       [0]     OtherName,
 *      rfc822Name                      [1]     IA5String,
 *      dNSName                         [2]     IA5String,
 *      x400Address                     [3]     ORAddress,
 *      directoryName                   [4]     Name,
 *      ediPartyName                    [5]     EDIPartyName,
 *      uniformResourceIdentifier       [6]     IA5String,
 *      iPAddress                       [7]     OCTET STRING,
 *      registeredID                    [8]     OBJECT IDENTIFIER
 */
#define MBEDTLS_X509_SAN_OTHER_NAME                      0
#define MBEDTLS_X509_SAN_RFC822_NAME                     1
#define MBEDTLS_X509_SAN_DNS_NAME                        2
#define MBEDTLS_X509_SAN_X400_ADDRESS_NAME               3
#define MBEDTLS_X509_SAN_DIRECTORY_NAME                  4
#define MBEDTLS_X509_SAN_EDI_PARTY_NAME                  5
#define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER     6
#define MBEDTLS_X509_SAN_IP_ADDRESS                      7
#define MBEDTLS_X509_SAN_REGISTERED_ID                   8

/*
 * X.509 v3 Key Usage Extension flags
 * Reminder: update mbedtls_x509_info_key_usage() when adding new flags.
 */
#define MBEDTLS_X509_KU_DIGITAL_SIGNATURE            (0x80)  /* bit 0 */
#define MBEDTLS_X509_KU_NON_REPUDIATION              (0x40)  /* bit 1 */
#define MBEDTLS_X509_KU_KEY_ENCIPHERMENT             (0x20)  /* bit 2 */
#define MBEDTLS_X509_KU_DATA_ENCIPHERMENT            (0x10)  /* bit 3 */
#define MBEDTLS_X509_KU_KEY_AGREEMENT                (0x08)  /* bit 4 */
#define MBEDTLS_X509_KU_KEY_CERT_SIGN                (0x04)  /* bit 5 */
#define MBEDTLS_X509_KU_CRL_SIGN                     (0x02)  /* bit 6 */
#define MBEDTLS_X509_KU_ENCIPHER_ONLY                (0x01)  /* bit 7 */
#define MBEDTLS_X509_KU_DECIPHER_ONLY              (0x8000)  /* bit 8 */

/*
 * Netscape certificate types
 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
 */

#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT         (0x80)  /* bit 0 */
#define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER         (0x40)  /* bit 1 */
#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL              (0x20)  /* bit 2 */
#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING     (0x10)  /* bit 3 */
#define MBEDTLS_X509_NS_CERT_TYPE_RESERVED           (0x08)  /* bit 4 */
#define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA             (0x04)  /* bit 5 */
#define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA           (0x02)  /* bit 6 */
#define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA  (0x01)  /* bit 7 */

/*
 * X.509 extension types
 *
 * Comments refer to the status for using certificates. Status can be
 * different for writing certificates or reading CRLs or CSRs.
 */
#define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
#define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER   (1 << 1)
#define MBEDTLS_X509_EXT_KEY_USAGE                (1 << 2)
#define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES     (1 << 3)
#define MBEDTLS_X509_EXT_POLICY_MAPPINGS          (1 << 4)
#define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME         (1 << 5)  /* Supported (DNS) */
#define MBEDTLS_X509_EXT_ISSUER_ALT_NAME          (1 << 6)
#define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS  (1 << 7)
#define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS        (1 << 8)  /* Supported */
#define MBEDTLS_X509_EXT_NAME_CONSTRAINTS         (1 << 9)
#define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS       (1 << 10)
#define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE       (1 << 11)
#define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS  (1 << 12)
#define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY       (1 << 13)
#define MBEDTLS_X509_EXT_FRESHEST_CRL             (1 << 14)
#define MBEDTLS_X509_EXT_NS_CERT_TYPE             (1 << 16)

/*
 * Storage format identifiers
 * Recognized formats: PEM and DER
 */
#define MBEDTLS_X509_FORMAT_DER                 1
#define MBEDTLS_X509_FORMAT_PEM                 2

#define MBEDTLS_X509_MAX_DN_NAME_SIZE         256 
#ifdef __cplusplus
extern "C" {
#endif

typedef mbedtls_asn1_buf mbedtls_x509_buf;

typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring;

typedef mbedtls_asn1_named_data mbedtls_x509_name;

typedef mbedtls_asn1_sequence mbedtls_x509_sequence;

/*
 * Container for the fields of the Authority Key Identifier object
 */
typedef struct mbedtls_x509_authority {
    mbedtls_x509_buf keyIdentifier;
    mbedtls_x509_sequence authorityCertIssuer;
    mbedtls_x509_buf authorityCertSerialNumber;
    mbedtls_x509_buf raw;
}
mbedtls_x509_authority;

typedef struct mbedtls_x509_time {
    int year, mon, day;         
    int hour, min, sec;         
}
mbedtls_x509_time;

typedef struct mbedtls_x509_san_other_name {
    mbedtls_x509_buf type_id;                   
    union {
        struct {
            mbedtls_x509_buf oid;               
            mbedtls_x509_buf val;               
        }
        hardware_module_name;
    }
    value;
}
mbedtls_x509_san_other_name;

typedef struct mbedtls_x509_subject_alternative_name {
    int type;                              
    union {
        mbedtls_x509_san_other_name other_name;
        mbedtls_x509_name directory_name;
        mbedtls_x509_buf unstructured_name; 
    }
    san; 
}
mbedtls_x509_subject_alternative_name;

typedef struct mbedtls_x509_san_list {
    mbedtls_x509_subject_alternative_name node;
    struct mbedtls_x509_san_list *next;
}
mbedtls_x509_san_list;

int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn);

int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name);

static inline mbedtls_x509_name *mbedtls_x509_dn_get_next(
    mbedtls_x509_name *dn)
{
    while (dn->MBEDTLS_PRIVATE(next_merged) && dn->next != NULL) {
        dn = dn->next;
    }
    return dn->next;
}

int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial);

int mbedtls_x509_time_cmp(const mbedtls_x509_time *t1, const mbedtls_x509_time *t2);

#if defined(MBEDTLS_HAVE_TIME_DATE)

int mbedtls_x509_time_gmtime(mbedtls_time_t tt, mbedtls_x509_time *now);
#endif /* MBEDTLS_HAVE_TIME_DATE */

int mbedtls_x509_time_is_past(const mbedtls_x509_time *to);

int mbedtls_x509_time_is_future(const mbedtls_x509_time *from);

int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf,
                                        mbedtls_x509_subject_alternative_name *san);
void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san);

size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst);

#define MBEDTLS_X509_SAFE_SNPRINTF                          \
    do {                                                    \
        if (ret < 0 || (size_t) ret >= n)                  \
        return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL;    \
                                                          \
        n -= (size_t) ret;                                  \
        p += (size_t) ret;                                  \
    } while (0)

#ifdef __cplusplus
}
#endif

#endif /* MBEDTLS_X509_H */