Skip to content

FFI: add *_count() functions for some FFI enumerators #5232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reneme merged 1 commit into from
Jan 13, 2026
Merged

FFI: add *_count() functions for some FFI enumerators #5232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions doc/api_ref/ffi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1825,6 +1825,11 @@ X.509 Certificates
objects. If the given index is not available,
:cpp:enumerator:`BOTAN_FFI_ERROR_OUT_OF_RANGE` is returned.

.. cpp:function:: int botan_x509_cert_permitted_name_constraints_count(botan_x509_cert_t cert, \
size_t* count)

Get the number of permitted name constraints in the certificate.

.. cpp:function:: int botan_x509_cert_excluded_name_constraints(botan_x509_cert_t cert, \
size_t index, \
botan_x509_general_name_t* constraint)
Expand All @@ -1833,6 +1838,11 @@ X.509 Certificates
objects. If the given index is not available,
:cpp:enumerator:`BOTAN_FFI_ERROR_OUT_OF_RANGE` is returned.

.. cpp:function:: int botan_x509_cert_excluded_name_constraints_count(botan_x509_cert_t cert, \
size_t* count)

Get the number of excluded name constraints in the certificate.

.. cpp:function:: int botan_x509_cert_subject_alternative_names(botan_x509_cert_t cert, \
size_t index, \
botan_x509_general_name_t* alt_name)
Expand All @@ -1841,6 +1851,11 @@ X.509 Certificates
objects. If the given index is not available,
:cpp:enumerator:`BOTAN_FFI_ERROR_OUT_OF_RANGE` is returned.

.. cpp:function:: int botan_x509_cert_subject_alternative_names_count(botan_x509_cert_t cert, \
size_t* count)

Get the number of subject alternative names in the certificate.

.. cpp:function:: int botan_x509_cert_issuer_alternative_names(botan_x509_cert_t cert, \
size_t index, \
botan_x509_general_name_t* alt_name)
Expand All @@ -1849,6 +1864,11 @@ X.509 Certificates
objects. If the given index is not available,
:cpp:enumerator:`BOTAN_FFI_ERROR_OUT_OF_RANGE` is returned.

.. cpp:function:: int botan_x509_cert_issuer_alternative_names_count(botan_x509_cert_t cert, \
size_t* count)

Get the number of issuer alternative names in the certificate.

.. cpp:function:: int botan_x509_cert_verify(int* validation_result, \
botan_x509_cert_t cert, \
const botan_x509_cert_t* intermediates, \
Expand Down Expand Up @@ -1952,6 +1972,10 @@ X.509 Certificate Revocation Lists
enumerate all entries in the CRL. If the list of entries is exhausted, this
will return :cpp:enumerator:`BOTAN_FFI_ERROR_OUT_OF_RANGE`.

.. cpp:function:: int botan_x509_crl_entries_count(botan_x509_crl_t crl, size_t* count)

Get the number of entries in the CRL.

.. cpp:function:: int botan_x509_crl_entry_reason(botan_x509_crl_entry_t entry, int* reason_code)

Get the revocation reason code for the given CRL entry. The reason code is
Expand Down
5 changes: 5 additions & 0 deletions src/lib/ffi/ffi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2297,6 +2297,7 @@ BOTAN_FFI_EXPORT(3, 11)
int botan_x509_cert_permitted_name_constraints(botan_x509_cert_t cert,
size_t index,
botan_x509_general_name_t* constraint);
BOTAN_FFI_EXPORT(3, 11) int botan_x509_cert_permitted_name_constraints_count(botan_x509_cert_t cert, size_t* count);

/**
* Extracts "excluded" name constraints from a given @p cert one-by-one.
Expand All @@ -2307,6 +2308,7 @@ BOTAN_FFI_EXPORT(3, 11)
int botan_x509_cert_excluded_name_constraints(botan_x509_cert_t cert,
size_t index,
botan_x509_general_name_t* constraint);
BOTAN_FFI_EXPORT(3, 11) int botan_x509_cert_excluded_name_constraints_count(botan_x509_cert_t cert, size_t* count);

/**
* Provides access to all "subject alternative names", where each entry is
Expand All @@ -2319,6 +2321,7 @@ BOTAN_FFI_EXPORT(3, 11)
int botan_x509_cert_subject_alternative_names(botan_x509_cert_t cert,
size_t index,
botan_x509_general_name_t* alt_name);
BOTAN_FFI_EXPORT(3, 11) int botan_x509_cert_subject_alternative_names_count(botan_x509_cert_t cert, size_t* count);

/**
* Provides access to all "issuer alternative names", where each entry is
Expand All @@ -2329,6 +2332,7 @@ int botan_x509_cert_subject_alternative_names(botan_x509_cert_t cert,
*/
BOTAN_FFI_EXPORT(3, 11)
int botan_x509_cert_issuer_alternative_names(botan_x509_cert_t cert, size_t index, botan_x509_general_name_t* alt_name);
BOTAN_FFI_EXPORT(3, 11) int botan_x509_cert_issuer_alternative_names_count(botan_x509_cert_t cert, size_t* count);

/**
* Check if the certificate matches the specified hostname via alternative name or CN match.
Expand Down Expand Up @@ -2396,6 +2400,7 @@ BOTAN_FFI_EXPORT(2, 13) int botan_x509_is_revoked(botan_x509_crl_t crl, botan_x5
*/
BOTAN_FFI_EXPORT(3, 11)
int botan_x509_crl_entries(botan_x509_crl_t crl, size_t index, botan_x509_crl_entry_t* entry);
BOTAN_FFI_EXPORT(3, 11) int botan_x509_crl_entries_count(botan_x509_crl_t crl, size_t* count);

/**
* Return the revocation reason code for the given CRL @p entry.
Expand Down
82 changes: 82 additions & 0 deletions src/lib/ffi/ffi_cert.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,19 @@ int botan_x509_cert_permitted_name_constraints(botan_x509_cert_t cert,
#endif
}

int botan_x509_cert_permitted_name_constraints_count(botan_x509_cert_t cert, size_t* count) {
#if defined(BOTAN_HAS_X509_CERTIFICATES)
if(Botan::any_null_pointers(count)) {
return BOTAN_FFI_ERROR_NULL_POINTER;
}

return BOTAN_FFI_VISIT(cert, [=](const auto& c) { *count = c.name_constraints().permitted().size(); });
#else
BOTAN_UNUSED(cert, count);
return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

int botan_x509_cert_excluded_name_constraints(botan_x509_cert_t cert,
size_t index,
botan_x509_general_name_t* constraint) {
Expand All @@ -469,6 +482,19 @@ int botan_x509_cert_excluded_name_constraints(botan_x509_cert_t cert,
return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

int botan_x509_cert_excluded_name_constraints_count(botan_x509_cert_t cert, size_t* count) {
#if defined(BOTAN_HAS_X509_CERTIFICATES)
if(Botan::any_null_pointers(count)) {
return BOTAN_FFI_ERROR_NULL_POINTER;
}

return BOTAN_FFI_VISIT(cert, [=](const auto& c) { *count = c.name_constraints().excluded().size(); });
#else
BOTAN_UNUSED(cert, count);
return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}
}

namespace {
Expand All @@ -478,6 +504,9 @@ namespace {
* collection of GeneralNames. This allows mapping a single entry of @p altnames
* to a GeneralName by its @p index. If the index is out of range, std::nullopt
* is returned.
*
* NOTE: if the set of alternative name types handled here is extended,
* count_general_names_in() must be updated accordingly!
*/
std::optional<Botan::GeneralName> extract_general_name_at(const Botan::AlternativeName& altnames, size_t index) {
if(index < altnames.email().size()) {
Expand Down Expand Up @@ -517,6 +546,18 @@ std::optional<Botan::GeneralName> extract_general_name_at(const Botan::Alternati
return std::nullopt;
}

/**
* Counts the total number of GeneralNames contained in the given
* AlternativeName @p alt_names.
*
* NOTE: if the set of alternative name types handled here is extended,
* extract_general_name_at() must be updated accordingly!
*/
size_t count_general_names_in(const Botan::AlternativeName& alt_names) {
return alt_names.email().size() + alt_names.dns().size() + alt_names.directory_names().size() +
alt_names.uris().size() + alt_names.ipv4_address().size();
}

} // namespace

extern "C" {
Expand Down Expand Up @@ -546,6 +587,20 @@ int botan_x509_cert_subject_alternative_names(botan_x509_cert_t cert,
#endif
}

int botan_x509_cert_subject_alternative_names_count(botan_x509_cert_t cert, size_t* count) {
#if defined(BOTAN_HAS_X509_CERTIFICATES)
if(Botan::any_null_pointers(count)) {
return BOTAN_FFI_ERROR_NULL_POINTER;
}

return BOTAN_FFI_VISIT(
cert, [=](const Botan::X509_Certificate& c) { *count = count_general_names_in(c.subject_alt_name()); });
#else
BOTAN_UNUSED(cert, count);
return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

int botan_x509_cert_issuer_alternative_names(botan_x509_cert_t cert,
size_t index,
botan_x509_general_name_t* alt_name) {
Expand All @@ -571,6 +626,20 @@ int botan_x509_cert_issuer_alternative_names(botan_x509_cert_t cert,
#endif
}

int botan_x509_cert_issuer_alternative_names_count(botan_x509_cert_t cert, size_t* count) {
#if defined(BOTAN_HAS_X509_CERTIFICATES)
if(Botan::any_null_pointers(count)) {
return BOTAN_FFI_ERROR_NULL_POINTER;
}

return BOTAN_FFI_VISIT(
cert, [=](const Botan::X509_Certificate& c) { *count = count_general_names_in(c.issuer_alt_name()); });
#else
BOTAN_UNUSED(cert, count);
return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

int botan_x509_cert_hostname_match(botan_x509_cert_t cert, const char* hostname) {
if(hostname == nullptr) {
return BOTAN_FFI_ERROR_NULL_POINTER;
Expand Down Expand Up @@ -780,6 +849,19 @@ int botan_x509_crl_entries(botan_x509_crl_t crl, size_t index, botan_x509_crl_en
#endif
}

int botan_x509_crl_entries_count(botan_x509_crl_t crl, size_t* count) {
#if defined(BOTAN_HAS_X509_CERTIFICATES)
if(Botan::any_null_pointers(count)) {
return BOTAN_FFI_ERROR_NULL_POINTER;
}

return BOTAN_FFI_VISIT(crl, [=](const Botan::X509_CRL& c) { *count = c.get_revoked().size(); });
#else
BOTAN_UNUSED(crl, count);
return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

int botan_x509_crl_entry_destroy(botan_x509_crl_entry_t entry) {
#if defined(BOTAN_HAS_X509_CERTIFICATES)
return BOTAN_FFI_CHECKED_DELETE(entry);
Expand Down
Loading
Loading