reactos/sdk/include/reactos/libs/mbedtls/x509.h

   1 /**
   2  * \file x509.h
   3  *
   4  * \brief X.509 generic defines and structures
   5  *
   6  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   7  *  SPDX-License-Identifier: GPL-2.0
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License along
  20  *  with this program; if not, write to the Free Software Foundation, Inc.,
  21  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  *
  23  *  This file is part of mbed TLS (https://tls.mbed.org)
  24  */
  25 #ifndef MBEDTLS_X509_H
  26 #define MBEDTLS_X509_H
  27
  28 #if !defined(MBEDTLS_CONFIG_FILE)
  29 #include "config.h"
  30 #else
  31 #include MBEDTLS_CONFIG_FILE
  32 #endif
  33
  34 #include "asn1.h"
  35 #include "pk.h"
  36
  37 #if defined(MBEDTLS_RSA_C)
  38 #include "rsa.h"
  39 #endif
  40
  41 /**
  42  * \addtogroup x509_module
  43  * \{
  44  */
  45
  46 #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
  47 /**
  48  * Maximum number of intermediate CAs in a verification chain.
  49  * That is, maximum length of the chain, excluding the end-entity certificate
  50  * and the trusted root certificate.
  51  *
  52  * Set this to a low value to prevent an adversary from making you waste
  53  * resources verifying an overlong certificate chain.
  54  */
  55 #define MBEDTLS_X509_MAX_INTERMEDIATE_CA   8
  56 #endif
  57
  58 /**
  59  * \name X509 Error codes
  60  * \{
  61  */
  62 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE              -0x2080  /**< Unavailable feature, e.g. RSA hashing/encryption combination. */
  63 #define MBEDTLS_ERR_X509_UNKNOWN_OID                      -0x2100  /**< Requested OID is unknown. */
  64 #define MBEDTLS_ERR_X509_INVALID_FORMAT                   -0x2180  /**< The CRT/CRL/CSR format is invalid, e.g. different type expected. */
  65 #define MBEDTLS_ERR_X509_INVALID_VERSION                  -0x2200  /**< The CRT/CRL/CSR version element is invalid. */
  66 #define MBEDTLS_ERR_X509_INVALID_SERIAL                   -0x2280  /**< The serial tag or value is invalid. */
  67 #define MBEDTLS_ERR_X509_INVALID_ALG                      -0x2300  /**< The algorithm tag or value is invalid. */
  68 #define MBEDTLS_ERR_X509_INVALID_NAME                     -0x2380  /**< The name tag or value is invalid. */
  69 #define MBEDTLS_ERR_X509_INVALID_DATE                     -0x2400  /**< The date tag or value is invalid. */
  70 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE                -0x2480  /**< The signature tag or value invalid. */
  71 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS               -0x2500  /**< The extension tag or value is invalid. */
  72 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION                  -0x2580  /**< CRT/CRL/CSR has an unsupported version number. */
  73 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG                  -0x2600  /**< Signature algorithm (oid) is unsupported. */
  74 #define MBEDTLS_ERR_X509_SIG_MISMATCH                     -0x2680  /**< Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */
  75 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED               -0x2700  /**< Certificate verification failed, e.g. CRL, CA or signature check failed. */
  76 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT              -0x2780  /**< Format not recognized as DER or PEM. */
  77 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA                   -0x2800  /**< Input invalid. */
  78 #define MBEDTLS_ERR_X509_ALLOC_FAILED                     -0x2880  /**< Allocation of memory failed. */
  79 #define MBEDTLS_ERR_X509_FILE_IO_ERROR                    -0x2900  /**< Read/write of file failed. */
  80 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL                 -0x2980  /**< Destination buffer is too small. */
  81 /* \} name */
  82
  83 /**
  84  * \name X509 Verify codes
  85  * \{
  86  */
  87 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
  88 #define MBEDTLS_X509_BADCERT_EXPIRED             0x01  /**< The certificate validity has expired. */
  89 #define MBEDTLS_X509_BADCERT_REVOKED             0x02  /**< The certificate has been revoked (is on a CRL). */
  90 #define MBEDTLS_X509_BADCERT_CN_MISMATCH         0x04  /**< The certificate Common Name (CN) does not match with the expected CN. */
  91 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED         0x08  /**< The certificate is not correctly signed by the trusted CA. */
  92 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED          0x10  /**< The CRL is not correctly signed by the trusted CA. */
  93 #define MBEDTLS_X509_BADCRL_EXPIRED              0x20  /**< The CRL is expired. */
  94 #define MBEDTLS_X509_BADCERT_MISSING             0x40  /**< Certificate was missing. */
  95 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY         0x80  /**< Certificate verification was skipped. */
  96 #define MBEDTLS_X509_BADCERT_OTHER             0x0100  /**< Other reason (can be used by verify callback) */
  97 #define MBEDTLS_X509_BADCERT_FUTURE            0x0200  /**< The certificate validity starts in the future. */
  98 #define MBEDTLS_X509_BADCRL_FUTURE             0x0400  /**< The CRL is from the future */
  99 #define MBEDTLS_X509_BADCERT_KEY_USAGE         0x0800  /**< Usage does not match the keyUsage extension. */
 100 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE     0x1000  /**< Usage does not match the extendedKeyUsage extension. */
 101 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE      0x2000  /**< Usage does not match the nsCertType extension. */
 102 #define MBEDTLS_X509_BADCERT_BAD_MD            0x4000  /**< The certificate is signed with an unacceptable hash. */
 103 #define MBEDTLS_X509_BADCERT_BAD_PK            0x8000  /**< The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
 104 #define MBEDTLS_X509_BADCERT_BAD_KEY         0x010000  /**< The certificate is signed with an unacceptable key (eg bad curve, RSA too short). */
 105 #define MBEDTLS_X509_BADCRL_BAD_MD           0x020000  /**< The CRL is signed with an unacceptable hash. */
 106 #define MBEDTLS_X509_BADCRL_BAD_PK           0x040000  /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
 107 #define MBEDTLS_X509_BADCRL_BAD_KEY          0x080000  /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */
 108
 109 /* \} name */
 110 /* \} addtogroup x509_module */
 111
 112 /*
 113  * X.509 v3 Key Usage Extension flags
 114  * Reminder: update x509_info_key_usage() when adding new flags.
 115  */
 116 #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE            (0x80)  /* bit 0 */
 117 #define MBEDTLS_X509_KU_NON_REPUDIATION              (0x40)  /* bit 1 */
 118 #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT             (0x20)  /* bit 2 */
 119 #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT            (0x10)  /* bit 3 */
 120 #define MBEDTLS_X509_KU_KEY_AGREEMENT                (0x08)  /* bit 4 */
 121 #define MBEDTLS_X509_KU_KEY_CERT_SIGN                (0x04)  /* bit 5 */
 122 #define MBEDTLS_X509_KU_CRL_SIGN                     (0x02)  /* bit 6 */
 123 #define MBEDTLS_X509_KU_ENCIPHER_ONLY                (0x01)  /* bit 7 */
 124 #define MBEDTLS_X509_KU_DECIPHER_ONLY              (0x8000)  /* bit 8 */
 125
 126 /*
 127  * Netscape certificate types
 128  * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
 129  */
 130
 131 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT         (0x80)  /* bit 0 */
 132 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER         (0x40)  /* bit 1 */
 133 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL              (0x20)  /* bit 2 */
 134 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING     (0x10)  /* bit 3 */
 135 #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED           (0x08)  /* bit 4 */
 136 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA             (0x04)  /* bit 5 */
 137 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA           (0x02)  /* bit 6 */
 138 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA  (0x01)  /* bit 7 */
 139
 140 /*
 141  * X.509 extension types
 142  *
 143  * Comments refer to the status for using certificates. Status can be
 144  * different for writing certificates or reading CRLs or CSRs.
 145  */
 146 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER    (1 << 0)
 147 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER      (1 << 1)
 148 #define MBEDTLS_X509_EXT_KEY_USAGE                   (1 << 2)
 149 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES        (1 << 3)
 150 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS             (1 << 4)
 151 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME            (1 << 5)    /* Supported (DNS) */
 152 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME             (1 << 6)
 153 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS     (1 << 7)
 154 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS           (1 << 8)    /* Supported */
 155 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS            (1 << 9)
 156 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS          (1 << 10)
 157 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE          (1 << 11)
 158 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS     (1 << 12)
 159 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY          (1 << 13)
 160 #define MBEDTLS_X509_EXT_FRESHEST_CRL                (1 << 14)
 161
 162 #define MBEDTLS_X509_EXT_NS_CERT_TYPE                (1 << 16)   /* Parsed (and then ?) */
 163
 164 /*
 165  * Storage format identifiers
 166  * Recognized formats: PEM and DER
 167  */
 168 #define MBEDTLS_X509_FORMAT_DER                 1
 169 #define MBEDTLS_X509_FORMAT_PEM                 2
 170
 171 #define MBEDTLS_X509_MAX_DN_NAME_SIZE         256 /**< Maximum value size of a DN entry */
 172
 173 #ifdef __cplusplus
 174 extern "C" {
 175 #endif
 176
 177 /**
 178  * \addtogroup x509_module
 179  * \{ */
 180
 181 /**
 182  * \name Structures for parsing X.509 certificates, CRLs and CSRs
 183  * \{
 184  */
 185
 186 /**
 187  * Type-length-value structure that allows for ASN1 using DER.
 188  */
 189 typedef mbedtls_asn1_buf mbedtls_x509_buf;
 190
 191 /**
 192  * Container for ASN1 bit strings.
 193  */
 194 typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring;
 195
 196 /**
 197  * Container for ASN1 named information objects.
 198  * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.).
 199  */
 200 typedef mbedtls_asn1_named_data mbedtls_x509_name;
 201
 202 /**
 203  * Container for a sequence of ASN.1 items
 204  */
 205 typedef mbedtls_asn1_sequence mbedtls_x509_sequence;
 206
 207 /** Container for date and time (precision in seconds). */
 208 typedef struct mbedtls_x509_time
 209 {
 210     int year, mon, day;         /**< Date. */
 211     int hour, min, sec;         /**< Time. */
 212 }
 213 mbedtls_x509_time;
 214
 215 /** \} name Structures for parsing X.509 certificates, CRLs and CSRs */
 216 /** \} addtogroup x509_module */
 217
 218 /**
 219  * \brief          Store the certificate DN in printable form into buf;
 220  *                 no more than size characters will be written.
 221  *
 222  * \param buf      Buffer to write to
 223  * \param size     Maximum size of buffer
 224  * \param dn       The X509 name to represent
 225  *
 226  * \return         The length of the string written (not including the
 227  *                 terminated nul byte), or a negative error code.
 228  */
 229 int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
 230
 231 /**
 232  * \brief          Store the certificate serial in printable form into buf;
 233  *                 no more than size characters will be written.
 234  *
 235  * \param buf      Buffer to write to
 236  * \param size     Maximum size of buffer
 237  * \param serial   The X509 serial to represent
 238  *
 239  * \return         The length of the string written (not including the
 240  *                 terminated nul byte), or a negative error code.
 241  */
 242 int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial );
 243
 244 /**
 245  * \brief          Check a given mbedtls_x509_time against the system time
 246  *                 and tell if it's in the past.
 247  *
 248  * \note           Intended usage is "if( is_past( valid_to ) ) ERROR".
 249  *                 Hence the return value of 1 if on internal errors.
 250  *
 251  * \param time     mbedtls_x509_time to check
 252  *
 253  * \return         1 if the given time is in the past or an error occured,
 254  *                 0 otherwise.
 255  */
 256 int mbedtls_x509_time_is_past( const mbedtls_x509_time *time );
 257
 258 /**
 259  * \brief          Check a given mbedtls_x509_time against the system time
 260  *                 and tell if it's in the future.
 261  *
 262  * \note           Intended usage is "if( is_future( valid_from ) ) ERROR".
 263  *                 Hence the return value of 1 if on internal errors.
 264  *
 265  * \param time     mbedtls_x509_time to check
 266  *
 267  * \return         1 if the given time is in the future or an error occured,
 268  *                 0 otherwise.
 269  */
 270 int mbedtls_x509_time_is_future( const mbedtls_x509_time *time );
 271
 272 /**
 273  * \brief          Checkup routine
 274  *
 275  * \return         0 if successful, or 1 if the test failed
 276  */
 277 int mbedtls_x509_self_test( int verbose );
 278
 279 /*
 280  * Internal module functions. You probably do not want to use these unless you
 281  * know you do.
 282  */
 283 int mbedtls_x509_get_name( unsigned char **p, const unsigned char *end,
 284                    mbedtls_x509_name *cur );
 285 int mbedtls_x509_get_alg_null( unsigned char **p, const unsigned char *end,
 286                        mbedtls_x509_buf *alg );
 287 int mbedtls_x509_get_alg( unsigned char **p, const unsigned char *end,
 288                   mbedtls_x509_buf *alg, mbedtls_x509_buf *params );
 289 #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
 290 int mbedtls_x509_get_rsassa_pss_params( const mbedtls_x509_buf *params,
 291                                 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md,
 292                                 int *salt_len );
 293 #endif
 294 int mbedtls_x509_get_sig( unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig );
 295 int mbedtls_x509_get_sig_alg( const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params,
 296                       mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg,
 297                       void **sig_opts );
 298 int mbedtls_x509_get_time( unsigned char **p, const unsigned char *end,
 299                    mbedtls_x509_time *time );
 300 int mbedtls_x509_get_serial( unsigned char **p, const unsigned char *end,
 301                      mbedtls_x509_buf *serial );
 302 int mbedtls_x509_get_ext( unsigned char **p, const unsigned char *end,
 303                   mbedtls_x509_buf *ext, int tag );
 304 int mbedtls_x509_sig_alg_gets( char *buf, size_t size, const mbedtls_x509_buf *sig_oid,
 305                        mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
 306                        const void *sig_opts );
 307 int mbedtls_x509_key_size_helper( char *buf, size_t buf_size, const char *name );
 308 int mbedtls_x509_string_to_names( mbedtls_asn1_named_data **head, const char *name );
 309 int mbedtls_x509_set_extension( mbedtls_asn1_named_data **head, const char *oid, size_t oid_len,
 310                         int critical, const unsigned char *val,
 311                         size_t val_len );
 312 int mbedtls_x509_write_extensions( unsigned char **p, unsigned char *start,
 313                            mbedtls_asn1_named_data *first );
 314 int mbedtls_x509_write_names( unsigned char **p, unsigned char *start,
 315                       mbedtls_asn1_named_data *first );
 316 int mbedtls_x509_write_sig( unsigned char **p, unsigned char *start,
 317                     const char *oid, size_t oid_len,
 318                     unsigned char *sig, size_t size );
 319
 320 #define MBEDTLS_X509_SAFE_SNPRINTF                          \
 321     do {                                                    \
 322         if( ret < 0 || (size_t) ret >= n )                  \
 323             return( MBEDTLS_ERR_X509_BUFFER_TOO_SMALL );    \
 324                                                             \
 325         n -= (size_t) ret;                                  \
 326         p += (size_t) ret;                                  \
 327     } while( 0 )
 328
 329 #ifdef __cplusplus
 330 }
 331 #endif
 332
 333 #endif /* x509.h */