mbedtls_x509_parse_subject_alt_name() function

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

Syntax

Show:

Summary

Declaration

Definition

from x509.h:460

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

Implemented in x509.c:1394

Arguments

Argument

Description

san_buf

The buffer holding the raw data item of the subject alternative name.

san

The target structure to populate with the parsed presentation of the subject alternative name encoded in \p san_buf.

Return value

\c 0 on success #MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE for an unsupported SAN type. Another negative value for any other failure.

Notes

Supported GeneralName types, as defined in RFC 5280: "rfc822Name", "dnsName", "directoryName", "uniformResourceIdentifier" and "hardware_module_name" of type "otherName", as defined in RFC 4108. 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.