Botan::Path_Validation_Result Class Reference

#include <x509path.h>

Public Types
typedef Certificate_Status_Code	Code

Public Member Functions
const CertificatePathStatusCodes &	all_statuses () const
const std::vector< std::shared_ptr< const X509_Certificate > > &	cert_path () const
bool	no_warnings () const
	Path_Validation_Result (CertificatePathStatusCodes status, std::vector< std::shared_ptr< const X509_Certificate >> &&cert_chain)
	Path_Validation_Result (Certificate_Status_Code status)
Certificate_Status_Code	result () const
std::string	result_string () const
bool	successful_validation () const
const X509_Certificate &	trust_root () const
std::set< std::string >	trusted_hashes () 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 110 of file x509path.h.

Member Typedef Documentation

Code

typedef Certificate_Status_Code Botan::Path_Validation_Result::Code

Definition at line 113 of file x509path.h.

Constructor & Destructor Documentation

Path_Validation_Result() [1/2]

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

Create a Path_Validation_Result

Parameters

status	list of validation status codes
cert_chain	the certificate chain that was validated

Definition at line 996 of file x509path.cpp.

                                                                                                              :
   m_all_status(status),
   m_warnings(find_warnings(m_all_status)),
   m_cert_path(cert_chain),
   m_overall(PKIX::overall_status(m_all_status))
   {
   }

Path_Validation_Result() [2/2]

Botan::Path_Validation_Result::Path_Validation_Result ( Certificate_Status_Code  status )

inlineexplicit

Create a Path_Validation_Result

Parameters

status

validation status code

Definition at line 187 of file x509path.h.

: 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 151 of file x509path.h.

         { return m_all_status; }

cert_path()

const std::vector<std::shared_ptr<const 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 131 of file x509path.h.

{ return m_cert_path; }

no_warnings()

bool Botan::Path_Validation_Result::no_warnings

(

)

const

Returns

true iff no warnings occured during validation

Definition at line 1030 of file x509path.cpp.

   {
   for(auto status_set_i : m_warnings) 
      if(!status_set_i.empty())
         return false;
   return true;
   }

result()

Certificate_Status_Code Botan::Path_Validation_Result::result ( ) const

inline

Returns

overall validation result code

Definition at line 146 of file x509path.h.

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

{ return m_overall; }

result_string()

std::string Botan::Path_Validation_Result::result_string

(

)

const

Returns

string representation of the validation result

Definition at line 1043 of file x509path.cpp.

References result(), and status_string().

   {
   return status_string(result());
   }

status_string()

const char * Botan::Path_Validation_Result::status_string ( Certificate_Status_Code  code )

static

Parameters

code	validation status code

Returns

corresponding validation status message

Definition at line 1048 of file x509path.cpp.

References Botan::to_string().

Referenced by result_string(), and warnings_string().

   {
   if(const char* s = to_string(code))
      return s;

   return "Unknown error";
   }

successful_validation()

bool Botan::Path_Validation_Result::successful_validation

(

)

const

Returns

true iff the validation was successful

Definition at line 1023 of file x509path.cpp.

References Botan::OCSP_RESPONSE_GOOD, result(), Botan::VALID_CRL_CHECKED, and Botan::VERIFIED.

   {
   return (result() == Certificate_Status_Code::VERIFIED ||
           result() == Certificate_Status_Code::OCSP_RESPONSE_GOOD ||
           result() == Certificate_Status_Code::VALID_CRL_CHECKED);
   }

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 1005 of file x509path.cpp.

References result(), and Botan::VERIFIED.

   {
   if(m_cert_path.empty())
      throw Invalid_State("Path_Validation_Result::trust_root no path set");
   if(result() != Certificate_Status_Code::VERIFIED)
      throw Invalid_State("Path_Validation_Result::trust_root meaningless with invalid status");

   return *m_cert_path[m_cert_path.size()-1];
   }

trusted_hashes()

std::set< std::string > Botan::Path_Validation_Result::trusted_hashes

(

)

const

Returns

the set of hash functions you are implicitly trusting by trusting this result.

Definition at line 1015 of file x509path.cpp.

   {
   std::set<std::string> hashes;
   for(size_t i = 0; i != m_cert_path.size(); ++i)
      hashes.insert(m_cert_path[i]->hash_used_for_signature());
   return hashes;
   }

warnings()

CertificatePathStatusCodes Botan::Path_Validation_Result::warnings

(

)

const

Returns

the subset of status codes that are warnings

Definition at line 1038 of file x509path.cpp.

   {
   return m_warnings;
   }

warnings_string()

std::string Botan::Path_Validation_Result::warnings_string

(

)

const

Returns

string representation of the warnings

Definition at line 1056 of file x509path.cpp.

References status_string(), and Botan::ASN1::to_string().

   {
   const std::string sep(", ");
   std::string res;
   for(size_t i = 0; i < m_warnings.size(); i++)
      {
      for(auto code : m_warnings[i])
         res += "[" + std::to_string(i) + "] " + status_string(code) + sep;
      }
   // remove last sep
   if(res.size() >= sep.size())
      res = res.substr(0, res.size() - sep.size());
   return res;
   }

---

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

• src/lib/x509/x509path.h
• src/lib/x509/x509path.cpp