2009-01-03 22:22:43 +01:00
/**
* \ file x509 . h
2009-01-04 17:27:10 +01:00
*
2013-09-16 13:49:26 +02:00
* \ brief X .509 generic defines and structures
2018-01-05 16:33:17 +01:00
*/
/*
2020-08-07 13:07:28 +02:00
* Copyright The Mbed TLS Contributors
2015-09-04 14:21:07 +02:00
* SPDX - License - Identifier : Apache - 2.0
2010-07-18 22:36:00 +02:00
*
2015-09-04 14:21:07 +02:00
* Licensed under the Apache License , Version 2.0 ( the " License " ) ; you may
* not use this file except in compliance with the License .
* You may obtain a copy of the License at
2010-07-18 22:36:00 +02:00
*
2015-09-04 14:21:07 +02:00
* http : //www.apache.org/licenses/LICENSE-2.0
2009-01-04 17:27:10 +01:00
*
2015-09-04 14:21:07 +02:00
* Unless required by applicable law or agreed to in writing , software
* distributed under the License is distributed on an " AS IS " BASIS , WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND , either express or implied .
* See the License for the specific language governing permissions and
* limitations under the License .
2009-01-03 22:22:43 +01:00
*/
2015-04-08 12:49:31 +02:00
# ifndef MBEDTLS_X509_H
# define MBEDTLS_X509_H
2021-05-19 19:44:07 +02:00
# include "mbedtls/private_access.h"
2009-01-03 22:22:43 +01:00
2021-05-27 11:25:03 +02:00
# include "mbedtls/build_info.h"
2013-04-18 22:46:23 +02:00
2019-07-04 21:01:14 +02:00
# include "mbedtls/asn1.h"
# include "mbedtls/pk.h"
2009-01-03 22:22:43 +01:00
2015-04-08 12:49:31 +02:00
# if defined(MBEDTLS_RSA_C)
2019-07-04 21:01:14 +02:00
# include "mbedtls/rsa.h"
2013-09-16 13:49:26 +02:00
# endif
/**
2011-01-18 15:58:55 +01:00
* \ addtogroup x509_module
2013-09-16 13:49:26 +02:00
* \ {
2009-07-28 09:18:38 +02:00
*/
2013-09-16 13:49:26 +02:00
2015-04-08 12:49:31 +02:00
# if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA)
2014-11-20 16:34:20 +01:00
/**
* 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 .
*/
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
2014-11-20 16:34:20 +01:00
# endif
2013-09-16 13:49:26 +02:00
/**
2011-01-18 15:58:55 +01:00
* \ name X509 Error codes
* \ {
2011-01-06 13:28:03 +01:00
*/
2021-07-26 18:48:10 +02:00
/** Unavailable feature, e.g. RSA hashing/encryption combination. */
# define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080
/** Requested OID is unknown. */
# define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100
/** The CRT/CRL/CSR format is invalid, e.g. different type expected. */
# define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180
/** The CRT/CRL/CSR version element is invalid. */
# define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200
/** The serial tag or value is invalid. */
# define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280
/** The algorithm tag or value is invalid. */
# define MBEDTLS_ERR_X509_INVALID_ALG -0x2300
/** The name tag or value is invalid. */
# define MBEDTLS_ERR_X509_INVALID_NAME -0x2380
/** The date tag or value is invalid. */
# define MBEDTLS_ERR_X509_INVALID_DATE -0x2400
/** The signature tag or value invalid. */
# define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480
/** The extension tag or value is invalid. */
# define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500
/** CRT/CRL/CSR has an unsupported version number. */
# define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580
/** Signature algorithm (oid) is unsupported. */
# define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600
/** Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */
# define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680
/** Certificate verification failed, e.g. CRL, CA or signature check failed. */
# define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700
/** Format not recognized as DER or PEM. */
# define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780
/** Input invalid. */
# define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800
/** Allocation of memory failed. */
# define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880
/** Read/write of file failed. */
# define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900
/** Destination buffer is too small. */
# define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
/** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */
# define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
2021-12-28 16:22:52 +01:00
/** \} name X509 Error codes */
2009-01-03 22:22:43 +01:00
2011-01-06 13:28:03 +01:00
/**
2011-01-18 15:58:55 +01:00
* \ name X509 Verify codes
* \ {
2009-07-28 09:18:38 +02:00
*/
2015-04-20 11:38:13 +02:00
/* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */
2015-04-20 13:19:02 +02:00
# define MBEDTLS_X509_BADCERT_EXPIRED 0x01 /**< The certificate validity has expired. */
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_BADCERT_REVOKED 0x02 /**< The certificate has been revoked (is on a CRL). */
# define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04 /**< The certificate Common Name (CN) does not match with the expected CN. */
# define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08 /**< The certificate is not correctly signed by the trusted CA. */
2015-04-20 11:38:13 +02:00
# define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10 /**< The CRL is not correctly signed by the trusted CA. */
# define MBEDTLS_X509_BADCRL_EXPIRED 0x20 /**< The CRL is expired. */
2015-04-20 13:19:02 +02:00
# define MBEDTLS_X509_BADCERT_MISSING 0x40 /**< Certificate was missing. */
# define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80 /**< Certificate verification was skipped. */
# define MBEDTLS_X509_BADCERT_OTHER 0x0100 /**< Other reason (can be used by verify callback) */
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_BADCERT_FUTURE 0x0200 /**< The certificate validity starts in the future. */
2015-04-20 13:19:02 +02:00
# 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. */
# define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000 /**< Usage does not match the extendedKeyUsage extension. */
# define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000 /**< Usage does not match the nsCertType extension. */
2015-06-15 10:39:46 +02:00
# 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_BAD_KEY 0x010000 /**< The certificate 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_BAD_KEY 0x080000 /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */
2021-12-28 16:22:52 +01:00
/** \} name X509 Verify codes */
/** \} addtogroup x509_module */
2009-01-03 22:22:43 +01:00
2019-03-21 12:40:13 +01:00
/*
* 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
2011-01-15 17:57:55 +01:00
/*
* X .509 v3 Key Usage Extension flags
2023-01-16 08:47:49 +01:00
* Reminder : update mbedtls_x509_info_key_usage ( ) when adding new flags .
2011-01-15 17:57:55 +01:00
*/
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
# define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */
2015-04-20 13:19:02 +02:00
# 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 */
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */
# define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */
2015-06-23 10:14:36 +02:00
# define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */
# define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */
2011-01-15 17:57:55 +01:00
/*
* Netscape certificate types
* ( http : //www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
*/
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
2015-04-20 13:19:02 +02:00
# define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
2015-04-08 12:49:31 +02:00
# 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 */
2015-04-20 13:19:02 +02:00
# 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 */
2011-01-15 17:57:55 +01:00
2013-04-07 22:00:46 +02:00
/*
* X .509 extension types
2014-04-01 12:19:09 +02:00
*
* Comments refer to the status for using certificates . Status can be
* different for writing certificates or reading CRLs or CSRs .
2019-01-28 09:20:59 +01:00
*
* 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 .
2013-04-07 22:00:46 +02:00
*/
2019-01-28 09:20:59 +01:00
# define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
# define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
# define MBEDTLS_X509_EXT_KEY_USAGE MBEDTLS_OID_X509_EXT_KEY_USAGE
# define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
# define MBEDTLS_X509_EXT_POLICY_MAPPINGS MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
# define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME /* Supported (DNS) */
# define MBEDTLS_X509_EXT_ISSUER_ALT_NAME MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
# define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
# define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS /* Supported */
# define MBEDTLS_X509_EXT_NAME_CONSTRAINTS MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
# define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
# define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
# define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
# define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
# define MBEDTLS_X509_EXT_FRESHEST_CRL MBEDTLS_OID_X509_EXT_FRESHEST_CRL
# define MBEDTLS_X509_EXT_NS_CERT_TYPE MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
2009-01-03 22:22:43 +01:00
2011-12-04 13:24:18 +01:00
/*
* Storage format identifiers
* Recognized formats : PEM and DER
*/
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_FORMAT_DER 1
# define MBEDTLS_X509_FORMAT_PEM 2
2011-12-04 13:24:18 +01:00
2015-04-08 12:49:31 +02:00
# define MBEDTLS_X509_MAX_DN_NAME_SIZE 256 /**< Maximum value size of a DN entry */
2014-08-08 12:22:30 +02:00
2013-06-27 14:29:21 +02:00
# ifdef __cplusplus
extern " C " {
# endif
2013-08-26 12:05:14 +02:00
/**
2011-01-18 15:58:55 +01:00
* \ addtogroup x509_module
* \ { */
2011-01-06 13:28:03 +01:00
/**
2013-09-09 15:35:10 +02:00
* \ name Structures for parsing X .509 certificates , CRLs and CSRs
2011-01-18 15:58:55 +01:00
* \ {
2011-01-06 13:28:03 +01:00
*/
2013-08-26 12:05:14 +02:00
/**
2011-01-06 13:28:03 +01:00
* Type - length - value structure that allows for ASN1 using DER .
2009-01-03 22:22:43 +01:00
*/
2015-04-08 12:49:31 +02:00
typedef mbedtls_asn1_buf mbedtls_x509_buf ;
2009-01-03 22:22:43 +01:00
2011-01-15 17:57:55 +01:00
/**
* Container for ASN1 bit strings .
*/
2015-04-08 12:49:31 +02:00
typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring ;
2011-01-15 17:57:55 +01:00
2011-01-06 13:28:03 +01:00
/**
2013-08-26 12:05:14 +02:00
* Container for ASN1 named information objects .
2015-03-09 18:33:07 +01:00
* It allows for Relative Distinguished Names ( e . g . cn = localhost , ou = code , etc . ) .
2011-01-06 13:28:03 +01:00
*/
2015-04-08 12:49:31 +02:00
typedef mbedtls_asn1_named_data mbedtls_x509_name ;
2009-01-03 22:22:43 +01:00
2011-01-15 17:57:55 +01:00
/**
* Container for a sequence of ASN .1 items
*/
2015-04-08 12:49:31 +02:00
typedef mbedtls_asn1_sequence mbedtls_x509_sequence ;
2011-01-15 17:57:55 +01:00
2021-02-12 16:11:17 +01:00
/*
* Container for the fields of the Authority Key Identifier object
*/
typedef struct mbedtls_x509_authority {
mbedtls_x509_buf keyIdentifier ;
2021-05-10 15:16:33 +02:00
mbedtls_x509_sequence authorityCertIssuer ;
2021-02-12 16:11:17 +01:00
mbedtls_x509_buf authorityCertSerialNumber ;
mbedtls_x509_buf raw ;
}
mbedtls_x509_authority ;
2011-01-06 13:28:03 +01:00
/** Container for date and time (precision in seconds). */
2023-01-11 14:50:10 +01:00
typedef struct mbedtls_x509_time {
2021-08-04 21:56:10 +02:00
int year , mon , day ; /**< Date. */
int hour , min , sec ; /**< Time. */
2009-01-03 22:22:43 +01:00
}
2015-04-08 12:49:31 +02:00
mbedtls_x509_time ;
2009-01-03 22:22:43 +01:00
2023-01-17 10:26:40 +01:00
/**
* 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 .
*/
typedef struct mbedtls_x509_san_other_name {
/**
* The type_id is an OID as defined in RFC 5280.
* To check the value of the type id , you should use
* \ p MBEDTLS_OID_CMP with a known OID mbedtls_x509_buf .
*/
mbedtls_x509_buf type_id ; /**< The type id. */
union {
/**
* From RFC 4108 section 5 :
* HardwareModuleName : : = SEQUENCE {
* hwType OBJECT IDENTIFIER ,
* hwSerialNum OCTET STRING }
*/
struct {
mbedtls_x509_buf oid ; /**< The object identifier. */
mbedtls_x509_buf val ; /**< The named value. */
}
hardware_module_name ;
}
value ;
}
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 .
*/
typedef struct mbedtls_x509_subject_alternative_name {
int type ; /**< The SAN type, value of MBEDTLS_X509_SAN_XXX. */
union {
2023-04-30 20:11:23 +02:00
mbedtls_x509_san_other_name other_name ;
2023-01-10 12:47:38 +01:00
mbedtls_x509_name directory_name ;
mbedtls_x509_buf unstructured_name ; /**< The buffer for the unstructured types. rfc822Name, dnsName and uniformResourceIdentifier are currently supported. */
2023-01-17 10:26:40 +01:00
}
san ; /**< A union of the supported SAN types */
}
mbedtls_x509_subject_alternative_name ;
2023-04-01 15:44:11 +02:00
typedef struct mbedtls_x509_san_list {
mbedtls_x509_subject_alternative_name node ;
struct mbedtls_x509_san_list * next ;
}
mbedtls_x509_san_list ;
2013-09-09 15:35:10 +02:00
/** \} name Structures for parsing X.509 certificates, CRLs and CSRs */
2009-05-02 17:13:40 +02:00
2009-01-03 22:22:43 +01:00
/**
* \ brief Store the certificate DN in printable form into buf ;
2009-05-02 17:13:40 +02:00
* no more than size characters will be written .
2009-07-28 09:18:38 +02:00
*
* \ param buf Buffer to write to
* \ param size Maximum size of buffer
* \ param dn The X509 name to represent
*
2015-06-23 12:10:45 +02:00
* \ return The length of the string written ( not including the
* terminated nul byte ) , or a negative error code .
2009-01-03 22:22:43 +01:00
*/
2023-01-11 14:50:10 +01:00
int mbedtls_x509_dn_gets ( char * buf , size_t size , const mbedtls_x509_name * dn ) ;
2009-01-03 22:22:43 +01:00
2022-06-17 16:59:58 +02:00
/**
* \ brief Return the next relative DN in an X509 name .
*
2022-06-27 20:12:44 +02:00
* \ note Intended use is to compare function result to dn - > next
* in order to detect boundaries of multi - valued RDNs .
*
2022-06-17 16:59:58 +02:00
* \ 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 .
*/
2023-01-11 14:50:10 +01:00
static inline mbedtls_x509_name * mbedtls_x509_dn_get_next (
mbedtls_x509_name * dn )
2022-06-27 20:12:44 +02:00
{
2023-01-11 14:50:10 +01:00
while ( dn - > MBEDTLS_PRIVATE ( next_merged ) & & dn - > next ! = NULL ) {
2022-06-27 20:12:44 +02:00
dn = dn - > next ;
2023-01-11 14:50:10 +01:00
}
return dn - > next ;
2022-06-27 20:12:44 +02:00
}
2022-06-17 16:59:58 +02:00
2011-01-16 22:34:59 +01:00
/**
* \ 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
*
2015-06-23 12:10:45 +02:00
* \ return The length of the string written ( not including the
* terminated nul byte ) , or a negative error code .
2011-01-16 22:34:59 +01:00
*/
2023-01-11 14:50:10 +01:00
int mbedtls_x509_serial_gets ( char * buf , size_t size , const mbedtls_x509_buf * serial ) ;
2011-01-16 22:34:59 +01:00
2022-06-30 06:38:53 +02:00
/**
* \ 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 ) ;
2009-01-03 22:22:43 +01:00
/**
2015-06-22 19:15:32 +02:00
* \ 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 .
2009-07-28 09:18:38 +02:00
*
2017-04-26 16:01:23 +02:00
* \ param to mbedtls_x509_time to check
2009-07-28 09:18:38 +02:00
*
2019-01-23 15:24:37 +01:00
* \ return 1 if the given time is in the past or an error occurred ,
2015-06-22 19:15:32 +02:00
* 0 otherwise .
2009-01-03 22:22:43 +01:00
*/
2023-01-11 14:50:10 +01:00
int mbedtls_x509_time_is_past ( const mbedtls_x509_time * to ) ;
2009-01-03 22:22:43 +01:00
2014-03-10 12:26:11 +01:00
/**
2015-06-22 19:15:32 +02:00
* \ 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 .
2014-03-10 12:26:11 +01:00
*
2017-04-26 16:01:23 +02:00
* \ param from mbedtls_x509_time to check
2014-03-10 12:26:11 +01:00
*
2019-01-23 15:24:37 +01:00
* \ return 1 if the given time is in the future or an error occurred ,
2015-06-22 19:15:32 +02:00
* 0 otherwise .
2014-03-10 12:26:11 +01:00
*/
2023-01-11 14:50:10 +01:00
int mbedtls_x509_time_is_future ( const mbedtls_x509_time * from ) ;
2014-03-10 12:26:11 +01:00
2023-01-17 10:26:40 +01:00
/**
* \ brief This function parses an item in the SubjectAlternativeNames
2023-02-27 22:03:41 +01:00
* 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
2023-03-06 10:48:30 +01:00
* to dispose of this additional memory afterwards .
2023-01-17 10:26:40 +01:00
*
* \ 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_raw .
*
2023-02-16 12:55:10 +01:00
* \ note Supported GeneralName types , as defined in RFC 5280 :
2023-04-30 20:11:23 +02:00
* " rfc822Name " , " dnsName " , " directoryName " ,
* " uniformResourceIdentifier " and " hardware_module_name "
2023-02-16 12:55:10 +01:00
* of type " otherName " , as defined in RFC 4108.
2023-01-17 10:26:40 +01:00
*
* \ 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
* \ p 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 ) ;
2023-02-13 13:01:59 +01:00
/**
* \ brief Unallocate all data related to subject alternative name
*
2023-03-06 10:48:30 +01:00
* \ param san SAN structure - extra memory owned by this structure will be freed
2023-02-13 13:01:59 +01:00
*/
void mbedtls_x509_free_subject_alt_name ( mbedtls_x509_subject_alternative_name * san ) ;
2023-01-17 10:26:40 +01:00
2021-12-30 12:33:31 +01:00
/** \} addtogroup x509_module */
2013-09-16 13:49:26 +02:00
/*
2013-09-18 11:11:02 +02:00
* Internal module functions . You probably do not want to use these unless you
* know you do .
2013-09-16 13:49:26 +02:00
*/
2023-01-11 14:50:10 +01:00
int mbedtls_x509_get_name ( unsigned char * * p , const unsigned char * end ,
mbedtls_x509_name * cur ) ;
int mbedtls_x509_get_alg_null ( unsigned char * * p , const unsigned char * end ,
mbedtls_x509_buf * alg ) ;
int mbedtls_x509_get_alg ( unsigned char * * p , const unsigned char * end ,
mbedtls_x509_buf * alg , mbedtls_x509_buf * params ) ;
2015-04-08 12:49:31 +02:00
# if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
2023-01-11 14:50:10 +01:00
int mbedtls_x509_get_rsassa_pss_params ( const mbedtls_x509_buf * params ,
mbedtls_md_type_t * md_alg , mbedtls_md_type_t * mgf_md ,
int * salt_len ) ;
2014-01-24 14:37:29 +01:00
# endif
2023-01-11 14:50:10 +01:00
int mbedtls_x509_get_sig ( unsigned char * * p , const unsigned char * end , mbedtls_x509_buf * sig ) ;
int mbedtls_x509_get_sig_alg ( const mbedtls_x509_buf * sig_oid , const mbedtls_x509_buf * sig_params ,
mbedtls_md_type_t * md_alg , mbedtls_pk_type_t * pk_alg ,
void * * sig_opts ) ;
int mbedtls_x509_get_time ( unsigned char * * p , const unsigned char * end ,
mbedtls_x509_time * t ) ;
int mbedtls_x509_get_serial ( unsigned char * * p , const unsigned char * end ,
mbedtls_x509_buf * serial ) ;
int mbedtls_x509_get_ext ( unsigned char * * p , const unsigned char * end ,
mbedtls_x509_buf * ext , int tag ) ;
2020-10-09 10:19:39 +02:00
# if !defined(MBEDTLS_X509_REMOVE_INFO)
2023-01-11 14:50:10 +01:00
int mbedtls_x509_sig_alg_gets ( char * buf , size_t size , const mbedtls_x509_buf * sig_oid ,
mbedtls_pk_type_t pk_alg , mbedtls_md_type_t md_alg ,
const void * sig_opts ) ;
2018-12-11 20:55:56 +01:00
# endif
2023-01-11 14:50:10 +01:00
int mbedtls_x509_key_size_helper ( char * buf , size_t buf_size , const char * name ) ;
int mbedtls_x509_string_to_names ( mbedtls_asn1_named_data * * head , const char * name ) ;
int mbedtls_x509_set_extension ( mbedtls_asn1_named_data * * head , const char * oid , size_t oid_len ,
int critical , const unsigned char * val ,
size_t val_len ) ;
int mbedtls_x509_write_extensions ( unsigned char * * p , unsigned char * start ,
mbedtls_asn1_named_data * first ) ;
int mbedtls_x509_write_names ( unsigned char * * p , unsigned char * start ,
mbedtls_asn1_named_data * first ) ;
int mbedtls_x509_write_sig ( unsigned char * * p , unsigned char * start ,
const char * oid , size_t oid_len ,
unsigned char * sig , size_t size ) ;
2023-01-16 08:47:49 +01:00
int mbedtls_x509_get_ns_cert_type ( unsigned char * * p ,
const unsigned char * end ,
unsigned char * ns_cert_type ) ;
int mbedtls_x509_get_key_usage ( unsigned char * * p ,
const unsigned char * end ,
unsigned int * key_usage ) ;
int mbedtls_x509_get_subject_alt_name ( unsigned char * * p ,
const unsigned char * end ,
mbedtls_x509_sequence * subject_alt_name ) ;
2023-02-21 08:32:37 +01:00
int mbedtls_x509_get_subject_alt_name_ext ( unsigned char * * p ,
const unsigned char * end ,
mbedtls_x509_sequence * subject_alt_name ) ;
2023-01-16 08:47:49 +01:00
int mbedtls_x509_info_subject_alt_name ( char * * buf , size_t * size ,
const mbedtls_x509_sequence
* subject_alt_name ,
const char * prefix ) ;
int mbedtls_x509_info_cert_type ( char * * buf , size_t * size ,
unsigned char ns_cert_type ) ;
int mbedtls_x509_info_key_usage ( char * * buf , size_t * size ,
unsigned int key_usage ) ;
2013-10-01 10:09:06 +02:00
2015-06-22 11:12:02 +02:00
# define MBEDTLS_X509_SAFE_SNPRINTF \
do { \
2023-01-11 14:50:10 +01:00
if ( ret < 0 | | ( size_t ) ret > = n ) \
return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL ; \
\
2015-06-22 11:12:02 +02:00
n - = ( size_t ) ret ; \
p + = ( size_t ) ret ; \
2023-01-11 14:50:10 +01:00
} while ( 0 )
2015-06-22 11:12:02 +02:00
2013-10-01 10:09:06 +02:00
# ifdef __cplusplus
}
# endif
2009-01-03 22:22:43 +01:00
# endif /* x509.h */