Botan 3.14.1
Crypto and TLS for C&
Botan::Path_Validation_Result Class Referencefinal

#include <x509path.h>

Public Types

typedef Certificate_Status_Code Code

Public Member Functions

const CertificatePathStatusCodes & all_statuses () const
const std::vector< X509_Certificate > & cert_path () const
bool no_warnings () const
 Path_Validation_Result (Certificate_Status_Code status)
 Path_Validation_Result (CertificatePathStatusCodes status, std::vector< X509_Certificate > &&cert_chain)
Certificate_Status_Code result () const
std::string result_string () const
bool successful_validation () const
const X509_Certificate & trust_root () const
CertificatePathStatusCodes warnings () const
std::string warnings_string () const

Static Public Member Functions

static const char * status_string (Certificate_Status_Code code)

Detailed Description

Represents the result of a PKIX path validation

Definition at line 200 of file x509path.h.

Member Typedef Documentation

◆ Code

Constructor & Destructor Documentation

◆ Path_Validation_Result() [1/2]

Botan::Path_Validation_Result::Path_Validation_Result ( CertificatePathStatusCodes status,
std::vector< X509_Certificate > && cert_chain )

Create a Path_Validation_Result

Parameters
statuslist of validation status codes
cert_chainthe certificate chain that was validated

Definition at line 1420 of file x509path.cpp.

1421 :
1422 m_all_status(std::move(status)),
1423 m_warnings(find_warnings(m_all_status)),
1424 m_cert_path(std::move(cert_chain)),
1425 m_overall(PKIX::overall_status(m_all_status)) {}
Certificate_Status_Code overall_status(const CertificatePathStatusCodes &cert_status)

◆ Path_Validation_Result() [2/2]

Botan::Path_Validation_Result::Path_Validation_Result ( Certificate_Status_Code status)
inlineexplicit

Create a Path_Validation_Result

Parameters
statusvalidation status code

Definition at line 268 of file x509path.h.

268: m_overall(status) {}

Member Function Documentation

◆ all_statuses()

const CertificatePathStatusCodes & Botan::Path_Validation_Result::all_statuses ( ) const
inline
Returns
a set of status codes for each certificate in the chain

Definition at line 234 of file x509path.h.

234{ return m_all_status; }

◆ cert_path()

const std::vector< X509_Certificate > & Botan::Path_Validation_Result::cert_path ( ) const
inline
Returns
the full path from subject to trust root This path may be empty

Definition at line 214 of file x509path.h.

214{ return m_cert_path; }

◆ no_warnings()

bool Botan::Path_Validation_Result::no_warnings ( ) const
Returns
true iff no warnings occurred during validation

Definition at line 1443 of file x509path.cpp.

1443 {
1444 for(const auto& status_set_i : m_warnings) {
1445 if(!status_set_i.empty()) {
1446 return false;
1447 }
1448 }
1449 return true;
1450}

◆ result()

Certificate_Status_Code Botan::Path_Validation_Result::result ( ) const
inline
Returns
overall validation result code

Definition at line 229 of file x509path.h.

229{ return m_overall; }

Referenced by result_string(), successful_validation(), and trust_root().

◆ result_string()

std::string Botan::Path_Validation_Result::result_string ( ) const
Returns
string representation of the validation result

Definition at line 1456 of file x509path.cpp.

1456 {
1457 return status_string(result());
1458}
Certificate_Status_Code result() const
Definition x509path.h:229
static const char * status_string(Certificate_Status_Code code)

References result(), and status_string().

Referenced by Botan::TLS::Callbacks::tls_verify_cert_chain().

◆ status_string()

const char * Botan::Path_Validation_Result::status_string ( Certificate_Status_Code code)
static
Parameters
codevalidation status code
Returns
corresponding validation status message

Definition at line 1460 of file x509path.cpp.

1460 {
1461 if(const char* s = to_string(code)) {
1462 return s;
1463 }
1464
1465 return "Unknown error";
1466}
std::string to_string(ErrorType type)
Convert an ErrorType to string.
Definition exceptn.cpp:13

References Botan::to_string().

Referenced by result_string(), and warnings_string().

◆ successful_validation()

bool Botan::Path_Validation_Result::successful_validation ( ) const

◆ trust_root()

const X509_Certificate & Botan::Path_Validation_Result::trust_root ( ) const
Returns
the trust root of the validation if successful throws an exception if the validation failed

Definition at line 1427 of file x509path.cpp.

1427 {
1428 if(m_cert_path.empty()) {
1429 throw Invalid_State("Path_Validation_Result::trust_root no path set");
1430 }
1432 throw Invalid_State("Path_Validation_Result::trust_root meaningless with invalid status");
1433 }
1434
1435 return m_cert_path[m_cert_path.size() - 1];
1436}

References result(), and Botan::VERIFIED.

◆ warnings()

CertificatePathStatusCodes Botan::Path_Validation_Result::warnings ( ) const
Returns
the subset of status codes that are warnings

Definition at line 1452 of file x509path.cpp.

1452 {
1453 return m_warnings;
1454}

◆ warnings_string()

std::string Botan::Path_Validation_Result::warnings_string ( ) const
Returns
string representation of the warnings

Definition at line 1468 of file x509path.cpp.

1468 {
1469 const std::string sep(", ");
1470 std::ostringstream oss;
1471 for(size_t i = 0; i < m_warnings.size(); i++) {
1472 for(const auto code : m_warnings[i]) {
1473 oss << "[" << std::to_string(i) << "] " << status_string(code) << sep;
1474 }
1475 }
1476
1477 std::string res = oss.str();
1478 // remove last sep
1479 if(res.size() >= sep.size()) {
1480 res = res.substr(0, res.size() - sep.size());
1481 }
1482 return res;
1483}

References status_string().


The documentation for this class was generated from the following files: