/** * \file x509.h * * \brief X.509 generic defines and structures */ /* * 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_RSA_C) #include "mbedtls/rsa.h" #endif /** * \addtogroup x509_module * \{ */ #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA) /** * 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. */ #define MBEDTLS_X509_MAX_INTERMEDIATE_CA … #endif /** * \name X509 Error codes * \{ */ /** Unavailable feature, e.g. RSA hashing/encryption combination. */ #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE … /** Requested OID is unknown. */ #define MBEDTLS_ERR_X509_UNKNOWN_OID … /** The CRT/CRL/CSR format is invalid, e.g. different type expected. */ #define MBEDTLS_ERR_X509_INVALID_FORMAT … /** The CRT/CRL/CSR version element is invalid. */ #define MBEDTLS_ERR_X509_INVALID_VERSION … /** The serial tag or value is invalid. */ #define MBEDTLS_ERR_X509_INVALID_SERIAL … /** The algorithm tag or value is invalid. */ #define MBEDTLS_ERR_X509_INVALID_ALG … /** The name tag or value is invalid. */ #define MBEDTLS_ERR_X509_INVALID_NAME … /** The date tag or value is invalid. */ #define MBEDTLS_ERR_X509_INVALID_DATE … /** The signature tag or value invalid. */ #define MBEDTLS_ERR_X509_INVALID_SIGNATURE … /** The extension tag or value is invalid. */ #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS … /** CRT/CRL/CSR has an unsupported version number. */ #define MBEDTLS_ERR_X509_UNKNOWN_VERSION … /** Signature algorithm (oid) is unsupported. */ #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG … /** Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */ #define MBEDTLS_ERR_X509_SIG_MISMATCH … /** Certificate verification failed, e.g. CRL, CA or signature check failed. */ #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED … /** Format not recognized as DER or PEM. */ #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT … /** Input invalid. */ #define MBEDTLS_ERR_X509_BAD_INPUT_DATA … /** Allocation of memory failed. */ #define MBEDTLS_ERR_X509_ALLOC_FAILED … /** Read/write of file failed. */ #define MBEDTLS_ERR_X509_FILE_IO_ERROR … /** Destination buffer is too small. */ #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL … /** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */ #define MBEDTLS_ERR_X509_FATAL_ERROR … /** \} name X509 Error codes */ /** * \name X509 Verify codes * \{ */ /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */ #define MBEDTLS_X509_BADCERT_EXPIRED … #define MBEDTLS_X509_BADCERT_REVOKED … #define MBEDTLS_X509_BADCERT_CN_MISMATCH … #define MBEDTLS_X509_BADCERT_NOT_TRUSTED … #define MBEDTLS_X509_BADCRL_NOT_TRUSTED … #define MBEDTLS_X509_BADCRL_EXPIRED … #define MBEDTLS_X509_BADCERT_MISSING … #define MBEDTLS_X509_BADCERT_SKIP_VERIFY … #define MBEDTLS_X509_BADCERT_OTHER … #define MBEDTLS_X509_BADCERT_FUTURE … #define MBEDTLS_X509_BADCRL_FUTURE … #define MBEDTLS_X509_BADCERT_KEY_USAGE … #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE … #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE … #define MBEDTLS_X509_BADCERT_BAD_MD … #define MBEDTLS_X509_BADCERT_BAD_PK … #define MBEDTLS_X509_BADCERT_BAD_KEY … #define MBEDTLS_X509_BADCRL_BAD_MD … #define MBEDTLS_X509_BADCRL_BAD_PK … #define MBEDTLS_X509_BADCRL_BAD_KEY … /** \} name X509 Verify codes */ /** \} addtogroup x509_module */ /* * 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 … #define MBEDTLS_X509_SAN_RFC822_NAME … #define MBEDTLS_X509_SAN_DNS_NAME … #define MBEDTLS_X509_SAN_X400_ADDRESS_NAME … #define MBEDTLS_X509_SAN_DIRECTORY_NAME … #define MBEDTLS_X509_SAN_EDI_PARTY_NAME … #define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER … #define MBEDTLS_X509_SAN_IP_ADDRESS … #define MBEDTLS_X509_SAN_REGISTERED_ID … /* * X.509 v3 Key Usage Extension flags * Reminder: update mbedtls_x509_info_key_usage() when adding new flags. */ #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE … #define MBEDTLS_X509_KU_NON_REPUDIATION … #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT … #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT … #define MBEDTLS_X509_KU_KEY_AGREEMENT … #define MBEDTLS_X509_KU_KEY_CERT_SIGN … #define MBEDTLS_X509_KU_CRL_SIGN … #define MBEDTLS_X509_KU_ENCIPHER_ONLY … #define MBEDTLS_X509_KU_DECIPHER_ONLY … /* * Netscape certificate types * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html) */ #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT … #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER … #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL … #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING … #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED … #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA … #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA … #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA … /* * X.509 extension types * * Comments refer to the status for using certificates. Status can be * different for writing certificates or reading CRLs or CSRs. * * Those are defined in oid.h as oid.c needs them in a data structure. Since * these were previously defined here, let's have aliases for compatibility. */ #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER … #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER … #define MBEDTLS_X509_EXT_KEY_USAGE … #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES … #define MBEDTLS_X509_EXT_POLICY_MAPPINGS … #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME … #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME … #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS … #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS … #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS … #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS … #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE … #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS … #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY … #define MBEDTLS_X509_EXT_FRESHEST_CRL … #define MBEDTLS_X509_EXT_NS_CERT_TYPE … /* * Storage format identifiers * Recognized formats: PEM and DER */ #define MBEDTLS_X509_FORMAT_DER … #define MBEDTLS_X509_FORMAT_PEM … #define MBEDTLS_X509_MAX_DN_NAME_SIZE … #ifdef __cplusplus extern "C" { #endif /** * \addtogroup x509_module * \{ */ /** * \name Structures for parsing X.509 certificates, CRLs and CSRs * \{ */ /** * Type-length-value structure that allows for ASN1 using DER. */ mbedtls_x509_buf; /** * Container for ASN1 bit strings. */ mbedtls_x509_bitstring; /** * Container for ASN1 named information objects. * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.). */ mbedtls_x509_name; /** * Container for a sequence of ASN.1 items */ mbedtls_x509_sequence; /* * Container for the fields of the Authority Key Identifier object */ mbedtls_x509_authority; /** Container for date and time (precision in seconds). */ mbedtls_x509_time; /** * From RFC 5280 section 4.2.1.6: * OtherName ::= SEQUENCE { * type-id OBJECT IDENTIFIER, * value [0] EXPLICIT ANY DEFINED BY type-id } * * Future versions of the library may add new fields to this structure or * to its embedded union and structure. */ mbedtls_x509_san_other_name; /** * A structure for holding the parsed Subject Alternative Name, * according to type. * * Future versions of the library may add new fields to this structure or * to its embedded union and structure. */ mbedtls_x509_subject_alternative_name; mbedtls_x509_san_list; /** \} name Structures for parsing X.509 certificates, CRLs and CSRs */ /** \} addtogroup x509_module */ /** * \brief Store the certificate DN in printable form into buf; * no more than size characters will be written. * * \param buf Buffer to write to * \param size Maximum size of buffer * \param dn The X509 name to represent * * \return The length of the string written (not including the * terminated nul byte), or a negative error code. */ int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn); /** * \brief Convert the certificate DN string \p name into * a linked list of mbedtls_x509_name (equivalent to * mbedtls_asn1_named_data). * * \note This function allocates a linked list, and places the head * pointer in \p head. This list must later be freed by a * call to mbedtls_asn1_free_named_data_list(). * * \param[out] head Address in which to store the pointer to the head of the * allocated list of mbedtls_x509_name * \param[in] name The string representation of a DN to convert * * \return 0 on success, or a negative error code. */ int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name); /** * \brief Return the next relative DN in an X509 name. * * \note Intended use is to compare function result to dn->next * in order to detect boundaries of multi-valued RDNs. * * \param dn Current node in the X509 name * * \return Pointer to the first attribute-value pair of the * next RDN in sequence, or NULL if end is reached. */ static inline mbedtls_x509_name *mbedtls_x509_dn_get_next( mbedtls_x509_name *dn) { … } /** * \brief Store the certificate serial in printable form into buf; * no more than size characters will be written. * * \param buf Buffer to write to * \param size Maximum size of buffer * \param serial The X509 serial to represent * * \return The length of the string written (not including the * terminated nul byte), or a negative error code. */ int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial); /** * \brief Compare pair of mbedtls_x509_time. * * \param t1 mbedtls_x509_time to compare * \param t2 mbedtls_x509_time to compare * * \return < 0 if t1 is before t2 * 0 if t1 equals t2 * > 0 if t1 is after t2 */ int mbedtls_x509_time_cmp(const mbedtls_x509_time *t1, const mbedtls_x509_time *t2); #if defined(MBEDTLS_HAVE_TIME_DATE) /** * \brief Fill mbedtls_x509_time with provided mbedtls_time_t. * * \param tt mbedtls_time_t to convert * \param now mbedtls_x509_time to fill with converted mbedtls_time_t * * \return \c 0 on success * \return A non-zero return value on failure. */ int mbedtls_x509_time_gmtime(mbedtls_time_t tt, mbedtls_x509_time *now); #endif /* MBEDTLS_HAVE_TIME_DATE */ /** * \brief Check a given mbedtls_x509_time against the system time * and tell if it's in the past. * * \note Intended usage is "if( is_past( valid_to ) ) ERROR". * Hence the return value of 1 if on internal errors. * * \param to mbedtls_x509_time to check * * \return 1 if the given time is in the past or an error occurred, * 0 otherwise. */ int mbedtls_x509_time_is_past(const mbedtls_x509_time *to); /** * \brief Check a given mbedtls_x509_time against the system time * and tell if it's in the future. * * \note Intended usage is "if( is_future( valid_from ) ) ERROR". * Hence the return value of 1 if on internal errors. * * \param from mbedtls_x509_time to check * * \return 1 if the given time is in the future or an error occurred, * 0 otherwise. */ int mbedtls_x509_time_is_future(const mbedtls_x509_time *from); /** * \brief This function parses an item in the SubjectAlternativeNames * extension. Please note that this function might allocate * additional memory for a subject alternative name, thus * mbedtls_x509_free_subject_alt_name has to be called * to dispose of this additional memory afterwards. * * \param san_buf The buffer holding the raw data item of the subject * alternative name. * \param san The target structure to populate with the parsed presentation * of the subject alternative name encoded in \p san_buf. * * \note Supported GeneralName types, as defined in RFC 5280: * "rfc822Name", "dnsName", "directoryName", * "uniformResourceIdentifier" and "hardware_module_name" * of type "otherName", as defined in RFC 4108. * * \note This function should be called on a single raw data of * subject alternative name. For example, after successful * certificate parsing, one must iterate on every item in the * \c crt->subject_alt_names sequence, and pass it to * this function. * * \warning The target structure contains pointers to the raw data of the * parsed certificate, and its lifetime is restricted by the * lifetime of the certificate. * * \return \c 0 on success * \return #MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE for an unsupported * SAN type. * \return Another negative value for any other failure. */ int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf, mbedtls_x509_subject_alternative_name *san); /** * \brief Unallocate all data related to subject alternative name * * \param san SAN structure - extra memory owned by this structure will be freed */ void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san); /** * \brief This function parses a CN string as an IP address. * * \param cn The CN string to parse. CN string MUST be null-terminated. * \param dst The target buffer to populate with the binary IP address. * The buffer MUST be 16 bytes to save IPv6, and should be * 4-byte aligned if the result will be used as struct in_addr. * e.g. uint32_t dst[4] * * \note \p cn is parsed as an IPv6 address if string contains ':', * else \p cn is parsed as an IPv4 address. * * \return Length of binary IP address; num bytes written to target. * \return \c 0 on failure to parse CN string as an IP address. */ size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst); #define MBEDTLS_X509_SAFE_SNPRINTF … #ifdef __cplusplus } #endif #endif /* MBEDTLS_X509_H */
Codebase Browser
godot