Botan  2.11.0
Crypto and TLS for C++11
Functions
Botan::PKIX Namespace Reference

Functions

Certificate_Status_Code build_all_certificate_paths (std::vector< std::vector< std::shared_ptr< const X509_Certificate >>> &cert_paths, const std::vector< Certificate_Store *> &trusted_certstores, const std::shared_ptr< const X509_Certificate > &end_entity, const std::vector< std::shared_ptr< const X509_Certificate >> &end_entity_extra)
 
Certificate_Status_Code build_certificate_path (std::vector< std::shared_ptr< const X509_Certificate >> &cert_path_out, const std::vector< Certificate_Store *> &trusted_certstores, const std::shared_ptr< const X509_Certificate > &end_entity, const std::vector< std::shared_ptr< const X509_Certificate >> &end_entity_extra)
 
CertificatePathStatusCodes check_chain (const std::vector< std::shared_ptr< const X509_Certificate >> &cert_path, std::chrono::system_clock::time_point ref_time, const std::string &hostname, Usage_Type usage, size_t min_signature_algo_strength, const std::set< std::string > &trusted_hashes)
 
CertificatePathStatusCodes check_crl (const std::vector< std::shared_ptr< const X509_Certificate >> &cert_path, const std::vector< std::shared_ptr< const X509_CRL >> &crls, std::chrono::system_clock::time_point ref_time)
 
CertificatePathStatusCodes check_crl (const std::vector< std::shared_ptr< const X509_Certificate >> &cert_path, const std::vector< Certificate_Store *> &certstores, std::chrono::system_clock::time_point ref_time)
 
CertificatePathStatusCodes check_ocsp (const std::vector< std::shared_ptr< const X509_Certificate >> &cert_path, const std::vector< std::shared_ptr< const OCSP::Response >> &ocsp_responses, const std::vector< Certificate_Store *> &certstores, std::chrono::system_clock::time_point ref_time, std::chrono::seconds max_ocsp_age=std::chrono::seconds::zero())
 
void merge_revocation_status (CertificatePathStatusCodes &chain_status, const CertificatePathStatusCodes &crl_status, const CertificatePathStatusCodes &ocsp_status, bool require_rev_on_end_entity, bool require_rev_on_intermediates)
 
Certificate_Status_Code overall_status (const CertificatePathStatusCodes &cert_status)
 

Detailed Description

namespace PKIX holds the building blocks that are called by x509_path_validate. This allows custom validation logic to be written by applications and makes for easier testing, but unless you're positive you know what you're doing you probably want to just call x509_path_validate instead.

Function Documentation

◆ build_all_certificate_paths()

Certificate_Status_Code Botan::PKIX::build_all_certificate_paths ( std::vector< std::vector< std::shared_ptr< const X509_Certificate >>> &  cert_paths_out,
const std::vector< Certificate_Store *> &  trusted_certstores,
const std::shared_ptr< const X509_Certificate > &  end_entity,
const std::vector< std::shared_ptr< const X509_Certificate >> &  end_entity_extra 
)

Build all possible certificate paths from the end certificate to self-signed trusted roots.

All potentially valid paths are put into the cert_paths vector. If no potentially valid paths are found, one of the encountered errors is returned arbitrarily.

todo add a path building function that returns detailed information on errors encountered while building the potentially numerous path candidates.

Basically, a DFS is performed starting from the end certificate. A stack (vector) serves to control the DFS. At the beginning of each iteration, a pair is popped from the stack that contains (1) the next certificate to add to the path (2) a bool that indicates if the certificate is part of a trusted certstore. Ideally, we follow the unique issuer of the current certificate until a trusted root is reached. However, the issuer DN + authority key id need not be unique among the certificates used for building the path. In such a case, we consider all the matching issuers by pushing <IssuerCert, trusted?> on the stack for each of them.

Definition at line 615 of file x509path.cpp.

References Botan::Certificate_Store_In_Memory::add_certificate(), Botan::CANNOT_ESTABLISH_TRUST, Botan::CERT_CHAIN_LOOP, Botan::CERT_ISSUER_NOT_FOUND, Botan::Certificate_Store_In_Memory::find_all_certs(), and Botan::OK.

Referenced by Botan::x509_path_validate().

619  {
620  if(!cert_paths_out.empty())
621  {
622  throw Invalid_Argument("PKIX::build_all_certificate_paths: cert_paths_out must be empty");
623  }
624 
625  if(end_entity->is_self_signed())
626  {
627  return Certificate_Status_Code::CANNOT_ESTABLISH_TRUST;
628  }
629 
630  /*
631  * Pile up error messages
632  */
633  std::vector<Certificate_Status_Code> stats;
634 
635  Certificate_Store_In_Memory ee_extras;
636  for(size_t i = 0; i != end_entity_extra.size(); ++i)
637  {
638  ee_extras.add_certificate(end_entity_extra[i]);
639  }
640 
641  /*
642  * This is an inelegant but functional way of preventing path loops
643  * (where C1 -> C2 -> C3 -> C1). We store a set of all the certificate
644  * fingerprints in the path. If there is a duplicate, we error out.
645  * TODO: save fingerprints in result struct? Maybe useful for blacklists, etc.
646  */
647  std::set<std::string> certs_seen;
648 
649  // new certs are added and removed from the path during the DFS
650  // it is copied into cert_paths_out when we encounter a trusted root
651  std::vector<std::shared_ptr<const X509_Certificate>> path_so_far;
652 
653  // todo can we assume that the end certificate is not trusted?
654  std::vector<cert_maybe_trusted> stack = { {end_entity, false} };
655 
656  while(!stack.empty())
657  {
658  // found a deletion marker that guides the DFS, backtracing
659  if(stack.back().first == nullptr)
660  {
661  stack.pop_back();
662  std::string fprint = path_so_far.back()->fingerprint("SHA-256");
663  certs_seen.erase(fprint);
664  path_so_far.pop_back();
665  }
666  // process next cert on the path
667  else
668  {
669  std::shared_ptr<const X509_Certificate> last = stack.back().first;
670  bool trusted = stack.back().second;
671  stack.pop_back();
672 
673  // certificate already seen?
674  const std::string fprint = last->fingerprint("SHA-256");
675  if(certs_seen.count(fprint) == 1)
676  {
677  stats.push_back(Certificate_Status_Code::CERT_CHAIN_LOOP);
678  // the current path ended in a loop
679  continue;
680  }
681 
682  // the current path ends here
683  if(last->is_self_signed())
684  {
685  // found a trust anchor
686  if(trusted)
687  {
688  cert_paths_out.push_back(path_so_far);
689  cert_paths_out.back().push_back(last);
690 
691  continue;
692  }
693  // found an untrustworthy root
694  else
695  {
696  stats.push_back(Certificate_Status_Code::CANNOT_ESTABLISH_TRUST);
697  continue;
698  }
699  }
700 
701  const X509_DN issuer_dn = last->issuer_dn();
702  const std::vector<uint8_t> auth_key_id = last->authority_key_id();
703 
704  // search for trusted issuers
705  std::vector<std::shared_ptr<const X509_Certificate>> trusted_issuers;
706  for(Certificate_Store* store : trusted_certstores)
707  {
708  auto new_issuers = store->find_all_certs(issuer_dn, auth_key_id);
709  trusted_issuers.insert(trusted_issuers.end(), new_issuers.begin(), new_issuers.end());
710  }
711 
712  // search the supplemental certs
713  std::vector<std::shared_ptr<const X509_Certificate>> misc_issuers =
714  ee_extras.find_all_certs(issuer_dn, auth_key_id);
715 
716  // if we could not find any issuers, the current path ends here
717  if(trusted_issuers.size() + misc_issuers.size() == 0)
718  {
719  stats.push_back(Certificate_Status_Code::CERT_ISSUER_NOT_FOUND);
720  continue;
721  }
722 
723  // push the latest certificate onto the path_so_far
724  path_so_far.push_back(last);
725  certs_seen.emplace(fprint);
726 
727  // push a deletion marker on the stack for backtracing later
728  stack.push_back({std::shared_ptr<const X509_Certificate>(nullptr),false});
729 
730  for(const auto trusted_cert : trusted_issuers)
731  {
732  stack.push_back({trusted_cert,true});
733  }
734 
735  for(const auto misc : misc_issuers)
736  {
737  stack.push_back({misc,false});
738  }
739  }
740  }
741 
742  // could not construct any potentially valid path
743  if(cert_paths_out.empty())
744  {
745  if(stats.empty())
746  throw Internal_Error("X509 path building failed for unknown reasons");
747  else
748  // arbitrarily return the first error
749  return stats[0];
750  }
751  else
752  {
753  return Certificate_Status_Code::OK;
754  }
755  }

◆ build_certificate_path()

Certificate_Status_Code Botan::PKIX::build_certificate_path ( std::vector< std::shared_ptr< const X509_Certificate >> &  cert_path_out,
const std::vector< Certificate_Store *> &  trusted_certstores,
const std::shared_ptr< const X509_Certificate > &  end_entity,
const std::vector< std::shared_ptr< const X509_Certificate >> &  end_entity_extra 
)

Build certificate path

Parameters
cert_path_outoutput parameter, cert_path will be appended to this vector
trusted_certstoreslist of certificate stores that contain trusted certificates
end_entitythe cert to be validated
end_entity_extraoptional list of additional untrusted certs for path building
Returns
result of the path building operation (OK or error)

Definition at line 510 of file x509path.cpp.

References Botan::Certificate_Store_In_Memory::add_certificate(), Botan::X509_Certificate::authority_key_id(), Botan::CANNOT_ESTABLISH_TRUST, Botan::CERT_CHAIN_LOOP, Botan::CERT_ISSUER_NOT_FOUND, Botan::Certificate_Store_In_Memory::find_cert(), Botan::X509_Certificate::issuer_dn(), and Botan::OK.

514  {
515  if(end_entity->is_self_signed())
516  {
517  return Certificate_Status_Code::CANNOT_ESTABLISH_TRUST;
518  }
519 
520  /*
521  * This is an inelegant but functional way of preventing path loops
522  * (where C1 -> C2 -> C3 -> C1). We store a set of all the certificate
523  * fingerprints in the path. If there is a duplicate, we error out.
524  * TODO: save fingerprints in result struct? Maybe useful for blacklists, etc.
525  */
526  std::set<std::string> certs_seen;
527 
528  cert_path.push_back(end_entity);
529  certs_seen.insert(end_entity->fingerprint("SHA-256"));
530 
531  Certificate_Store_In_Memory ee_extras;
532  for(size_t i = 0; i != end_entity_extra.size(); ++i)
533  ee_extras.add_certificate(end_entity_extra[i]);
534 
535  // iterate until we reach a root or cannot find the issuer
536  for(;;)
537  {
538  const X509_Certificate& last = *cert_path.back();
539  const X509_DN issuer_dn = last.issuer_dn();
540  const std::vector<uint8_t> auth_key_id = last.authority_key_id();
541 
542  std::shared_ptr<const X509_Certificate> issuer;
543  bool trusted_issuer = false;
544 
545  for(Certificate_Store* store : trusted_certstores)
546  {
547  issuer = store->find_cert(issuer_dn, auth_key_id);
548  if(issuer)
549  {
550  trusted_issuer = true;
551  break;
552  }
553  }
554 
555  if(!issuer)
556  {
557  // fall back to searching supplemental certs
558  issuer = ee_extras.find_cert(issuer_dn, auth_key_id);
559  }
560 
561  if(!issuer)
562  return Certificate_Status_Code::CERT_ISSUER_NOT_FOUND;
563 
564  const std::string fprint = issuer->fingerprint("SHA-256");
565 
566  if(certs_seen.count(fprint) > 0) // already seen?
567  {
568  return Certificate_Status_Code::CERT_CHAIN_LOOP;
569  }
570 
571  certs_seen.insert(fprint);
572  cert_path.push_back(issuer);
573 
574  if(issuer->is_self_signed())
575  {
576  if(trusted_issuer)
577  {
578  return Certificate_Status_Code::OK;
579  }
580  else
581  {
582  return Certificate_Status_Code::CANNOT_ESTABLISH_TRUST;
583  }
584  }
585  }
586  }

◆ check_chain()

CertificatePathStatusCodes Botan::PKIX::check_chain ( const std::vector< std::shared_ptr< const X509_Certificate >> &  cert_path,
std::chrono::system_clock::time_point  ref_time,
const std::string &  hostname,
Usage_Type  usage,
size_t  min_signature_algo_strength,
const std::set< std::string > &  trusted_hashes 
)

Check the certificate chain, but not any revocation data

Parameters
cert_pathpath built by build_certificate_path with OK result
ref_timewhatever time you want to perform the validation against (normally current system clock)
hostnamethe hostname
usageend entity usage checks
min_signature_algo_strength80 or 110 typically Note 80 allows 1024 bit RSA and SHA-1. 110 allows 2048 bit RSA and SHA-2. Using 128 requires ECC (P-256) or ~3000 bit RSA keys.
trusted_hashesset of trusted hash functions, empty means accept any hash we have an OID for
Returns
vector of results on per certificate in the path, each containing a set of results. If all codes in the set are < Certificate_Status_Code::FIRST_ERROR_STATUS, then the result for that certificate is successful. If all results are

Definition at line 32 of file x509path.cpp.

References Botan::CA_CERT_NOT_FOR_CERT_ISSUER, Botan::CERT_CHAIN_TOO_LONG, Botan::CERT_HAS_EXPIRED, Botan::CERT_NAME_NOMATCH, Botan::CERT_NOT_YET_VALID, Botan::CERT_PUBKEY_INVALID, Botan::CERT_SERIAL_NEGATIVE, Botan::CHAIN_LACKS_TRUST_ROOT, Botan::CHAIN_NAME_MISMATCH, Botan::DN_TOO_LONG, Botan::DUPLICATE_CERT_EXTENSION, Botan::EXT_IN_V1_V2_CERT, Botan::Extensions::extensions(), Botan::Extensions::get_extension_oids(), Botan::INVALID_USAGE, Botan::KEY_CERT_SIGN, Botan::OIDS::lookup(), Botan::X509_DN::lookup_ub(), Botan::SIGNATURE_ALGO_UNKNOWN, Botan::SIGNATURE_METHOD_TOO_WEAK, Botan::UNTRUSTED_HASH, and Botan::VERIFIED.

Referenced by Botan::x509_path_validate().

38  {
39  if(cert_path.empty())
40  throw Invalid_Argument("PKIX::check_chain cert_path empty");
41 
42  const bool self_signed_ee_cert = (cert_path.size() == 1);
43 
44  X509_Time validation_time(ref_time);
45 
46  CertificatePathStatusCodes cert_status(cert_path.size());
47 
48  if(!hostname.empty() && !cert_path[0]->matches_dns_name(hostname))
49  cert_status[0].insert(Certificate_Status_Code::CERT_NAME_NOMATCH);
50 
51  if(!cert_path[0]->allowed_usage(usage))
52  cert_status[0].insert(Certificate_Status_Code::INVALID_USAGE);
53 
54  if(cert_path[0]->is_CA_cert() == false &&
55  cert_path[0]->has_constraints(KEY_CERT_SIGN))
56  {
57  /*
58  "If the keyCertSign bit is asserted, then the cA bit in the
59  basic constraints extension (Section 4.2.1.9) MUST also be
60  asserted." - RFC 5280
61 
62  We don't bother doing this check on the rest of the path since they
63  must have the cA bit asserted or the validation will fail anyway.
64  */
65  cert_status[0].insert(Certificate_Status_Code::INVALID_USAGE);
66  }
67 
68  for(size_t i = 0; i != cert_path.size(); ++i)
69  {
70  std::set<Certificate_Status_Code>& status = cert_status.at(i);
71 
72  const bool at_self_signed_root = (i == cert_path.size() - 1);
73 
74  const std::shared_ptr<const X509_Certificate>& subject = cert_path[i];
75 
76  const std::shared_ptr<const X509_Certificate>& issuer = cert_path[at_self_signed_root ? (i) : (i + 1)];
77 
78  if(at_self_signed_root && (issuer->is_self_signed() == false))
79  {
80  status.insert(Certificate_Status_Code::CHAIN_LACKS_TRUST_ROOT);
81  }
82 
83  if(subject->issuer_dn() != issuer->subject_dn())
84  {
85  status.insert(Certificate_Status_Code::CHAIN_NAME_MISMATCH);
86  }
87 
88  // Check the serial number
89  if(subject->is_serial_negative())
90  {
91  status.insert(Certificate_Status_Code::CERT_SERIAL_NEGATIVE);
92  }
93 
94  // Check the subject's DN components' length
95 
96  for(const auto& dn_pair : subject->subject_dn().dn_info())
97  {
98  const size_t dn_ub = X509_DN::lookup_ub(dn_pair.first);
99  // dn_pair = <OID,str>
100  if(dn_ub > 0 && dn_pair.second.size() > dn_ub)
101  {
102  status.insert(Certificate_Status_Code::DN_TOO_LONG);
103  }
104  }
105 
106  // Check all certs for valid time range
107  if(validation_time < subject->not_before())
108  status.insert(Certificate_Status_Code::CERT_NOT_YET_VALID);
109 
110  if(validation_time > subject->not_after())
111  status.insert(Certificate_Status_Code::CERT_HAS_EXPIRED);
112 
113  // Check issuer constraints
114  if(!issuer->is_CA_cert() && !self_signed_ee_cert)
115  status.insert(Certificate_Status_Code::CA_CERT_NOT_FOR_CERT_ISSUER);
116 
117  std::unique_ptr<Public_Key> issuer_key(issuer->subject_public_key());
118 
119  // Check the signature algorithm
120  if(OIDS::lookup(subject->signature_algorithm().oid).empty())
121  {
122  status.insert(Certificate_Status_Code::SIGNATURE_ALGO_UNKNOWN);
123  }
124  // only perform the following checks if the signature algorithm is known
125  else
126  {
127  if(!issuer_key)
128  {
129  status.insert(Certificate_Status_Code::CERT_PUBKEY_INVALID);
130  }
131  else
132  {
133  const Certificate_Status_Code sig_status = subject->verify_signature(*issuer_key);
134 
135  if(sig_status != Certificate_Status_Code::VERIFIED)
136  status.insert(sig_status);
137 
138  if(issuer_key->estimated_strength() < min_signature_algo_strength)
139  status.insert(Certificate_Status_Code::SIGNATURE_METHOD_TOO_WEAK);
140  }
141 
142  // Ignore untrusted hashes on self-signed roots
143  if(trusted_hashes.size() > 0 && !at_self_signed_root)
144  {
145  if(trusted_hashes.count(subject->hash_used_for_signature()) == 0)
146  status.insert(Certificate_Status_Code::UNTRUSTED_HASH);
147  }
148  }
149 
150  // Check cert extensions
151  Extensions extensions = subject->v3_extensions();
152  const auto& extensions_vec = extensions.extensions();
153  if(subject->x509_version() < 3 && !extensions_vec.empty())
154  {
155  status.insert(Certificate_Status_Code::EXT_IN_V1_V2_CERT);
156  }
157  for(auto& extension : extensions_vec)
158  {
159  extension.first->validate(*subject, *issuer, cert_path, cert_status, i);
160  }
161  if(extensions.extensions().size() != extensions.get_extension_oids().size())
162  {
163  status.insert(Certificate_Status_Code::DUPLICATE_CERT_EXTENSION);
164  }
165  }
166 
167  // path len check
168  size_t max_path_length = cert_path.size();
169  for(size_t i = cert_path.size() - 1; i > 0 ; --i)
170  {
171  std::set<Certificate_Status_Code>& status = cert_status.at(i);
172  const std::shared_ptr<const X509_Certificate>& subject = cert_path[i];
173 
174  /*
175  * If the certificate was not self-issued, verify that max_path_length is
176  * greater than zero and decrement max_path_length by 1.
177  */
178  if(subject->subject_dn() != subject->issuer_dn())
179  {
180  if(max_path_length > 0)
181  {
182  --max_path_length;
183  }
184  else
185  {
186  status.insert(Certificate_Status_Code::CERT_CHAIN_TOO_LONG);
187  }
188  }
189 
190  /*
191  * If pathLenConstraint is present in the certificate and is less than max_path_length,
192  * set max_path_length to the value of pathLenConstraint.
193  */
194  if(subject->path_limit() != Cert_Extension::NO_CERT_PATH_LIMIT && subject->path_limit() < max_path_length)
195  {
196  max_path_length = subject->path_limit();
197  }
198  }
199 
200  return cert_status;
201  }
std::vector< std::set< Certificate_Status_Code > > CertificatePathStatusCodes
Definition: x509path.h:29
Certificate_Status_Code
Definition: cert_status.h:19
std::string lookup(const OID &oid)
Definition: oids.cpp:113

◆ check_crl() [1/2]

CertificatePathStatusCodes Botan::PKIX::check_crl ( const std::vector< std::shared_ptr< const X509_Certificate >> &  cert_path,
const std::vector< std::shared_ptr< const X509_CRL >> &  crls,
std::chrono::system_clock::time_point  ref_time 
)

Check CRLs for revocation information

Parameters
cert_pathpath already validated by check_chain
crlsthe list of CRLs to check, it is assumed that crls[i] (if not null) is the associated CRL for the subject in cert_path[i].
ref_timewhatever time you want to perform the validation against (normally current system clock)
Returns
revocation status

Definition at line 254 of file x509path.cpp.

References Botan::CA_CERT_NOT_FOR_CRL_ISSUER, Botan::CERT_IS_REVOKED, Botan::CRL_BAD_SIGNATURE, Botan::CRL_HAS_EXPIRED, Botan::CRL_NOT_YET_VALID, Botan::CRL_SIGN, Botan::OIDS::lookup(), Botan::NO_MATCHING_CRLDP, and Botan::VALID_CRL_CHECKED.

Referenced by check_crl(), and Botan::x509_path_validate().

257  {
258  if(cert_path.empty())
259  throw Invalid_Argument("PKIX::check_crl cert_path empty");
260 
261  CertificatePathStatusCodes cert_status(cert_path.size());
262  const X509_Time validation_time(ref_time);
263 
264  for(size_t i = 0; i != cert_path.size() - 1; ++i)
265  {
266  std::set<Certificate_Status_Code>& status = cert_status.at(i);
267 
268  if(i < crls.size() && crls.at(i))
269  {
270  std::shared_ptr<const X509_Certificate> subject = cert_path.at(i);
271  std::shared_ptr<const X509_Certificate> ca = cert_path.at(i+1);
272 
273  if(!ca->allowed_usage(CRL_SIGN))
274  status.insert(Certificate_Status_Code::CA_CERT_NOT_FOR_CRL_ISSUER);
275 
276  if(validation_time < crls[i]->this_update())
277  status.insert(Certificate_Status_Code::CRL_NOT_YET_VALID);
278 
279  if(validation_time > crls[i]->next_update())
280  status.insert(Certificate_Status_Code::CRL_HAS_EXPIRED);
281 
282  if(crls[i]->check_signature(ca->subject_public_key()) == false)
283  status.insert(Certificate_Status_Code::CRL_BAD_SIGNATURE);
284 
285  status.insert(Certificate_Status_Code::VALID_CRL_CHECKED);
286 
287  if(crls[i]->is_revoked(*subject))
288  status.insert(Certificate_Status_Code::CERT_IS_REVOKED);
289 
290  std::string dp = subject->crl_distribution_point();
291  if(!dp.empty())
292  {
293  if(dp != crls[i]->crl_issuing_distribution_point())
294  {
295  status.insert(Certificate_Status_Code::NO_MATCHING_CRLDP);
296  }
297  }
298 
299  for(const auto& extension : crls[i]->extensions().extensions())
300  {
301  // is the extension critical and unknown?
302  if(extension.second && OIDS::lookup(extension.first->oid_of()) == "")
303  {
304  /* NIST Certificate Path Valiadation Testing document: "When an implementation does not recognize a critical extension in the
305  * crlExtensions field, it shall assume that identified certificates have been revoked and are no longer valid"
306  */
307  status.insert(Certificate_Status_Code::CERT_IS_REVOKED);
308  }
309  }
310 
311  }
312  }
313 
314  while(cert_status.size() > 0 && cert_status.back().empty())
315  cert_status.pop_back();
316 
317  return cert_status;
318  }
Definition: ffi.h:1532
std::vector< std::set< Certificate_Status_Code > > CertificatePathStatusCodes
Definition: x509path.h:29
std::string lookup(const OID &oid)
Definition: oids.cpp:113

◆ check_crl() [2/2]

CertificatePathStatusCodes Botan::PKIX::check_crl ( const std::vector< std::shared_ptr< const X509_Certificate >> &  cert_path,
const std::vector< Certificate_Store *> &  certstores,
std::chrono::system_clock::time_point  ref_time 
)

Check CRLs for revocation information

Parameters
cert_pathpath already validated by check_chain
certstoresa list of certificate stores to query for the CRL
ref_timewhatever time you want to perform the validation against (normally current system clock)
Returns
revocation status

Definition at line 321 of file x509path.cpp.

References BOTAN_ASSERT_NONNULL, and check_crl().

324  {
325  if(cert_path.empty())
326  throw Invalid_Argument("PKIX::check_crl cert_path empty");
327 
328  if(certstores.empty())
329  throw Invalid_Argument("PKIX::check_crl certstores empty");
330 
331  std::vector<std::shared_ptr<const X509_CRL>> crls(cert_path.size());
332 
333  for(size_t i = 0; i != cert_path.size(); ++i)
334  {
335  BOTAN_ASSERT_NONNULL(cert_path[i]);
336  for(size_t c = 0; c != certstores.size(); ++c)
337  {
338  crls[i] = certstores[c]->find_crl_for(*cert_path[i]);
339  if(crls[i])
340  break;
341  }
342  }
343 
344  return PKIX::check_crl(cert_path, crls, ref_time);
345  }
#define BOTAN_ASSERT_NONNULL(ptr)
Definition: assert.h:107
CertificatePathStatusCodes check_crl(const std::vector< std::shared_ptr< const X509_Certificate >> &cert_path, const std::vector< std::shared_ptr< const X509_CRL >> &crls, std::chrono::system_clock::time_point ref_time)
Definition: x509path.cpp:254

◆ check_ocsp()

CertificatePathStatusCodes Botan::PKIX::check_ocsp ( const std::vector< std::shared_ptr< const X509_Certificate >> &  cert_path,
const std::vector< std::shared_ptr< const OCSP::Response >> &  ocsp_responses,
const std::vector< Certificate_Store *> &  certstores,
std::chrono::system_clock::time_point  ref_time,
std::chrono::seconds  max_ocsp_age = std::chrono::seconds::zero() 
)

Check OCSP responses for revocation information

Parameters
cert_pathpath already validated by check_chain
ocsp_responsesthe OCSP responses to consider
certstorestrusted roots
ref_timewhatever time you want to perform the validation against (normally current system clock)
max_ocsp_agemaximum age of OCSP responses w/o next_update. If zero, there is no maximum age
Returns
revocation status

Definition at line 204 of file x509path.cpp.

References Botan::OCSP_RESPONSE_INVALID, and Botan::OCSP_SIGNATURE_OK.

Referenced by Botan::x509_path_validate().

209  {
210  if(cert_path.empty())
211  throw Invalid_Argument("PKIX::check_ocsp cert_path empty");
212 
213  CertificatePathStatusCodes cert_status(cert_path.size() - 1);
214 
215  for(size_t i = 0; i != cert_path.size() - 1; ++i)
216  {
217  std::set<Certificate_Status_Code>& status = cert_status.at(i);
218 
219  std::shared_ptr<const X509_Certificate> subject = cert_path.at(i);
220  std::shared_ptr<const X509_Certificate> ca = cert_path.at(i+1);
221 
222  if(i < ocsp_responses.size() && (ocsp_responses.at(i) != nullptr))
223  {
224  try
225  {
226  Certificate_Status_Code ocsp_signature_status = ocsp_responses.at(i)->check_signature(trusted_certstores, cert_path);
227 
228  if(ocsp_signature_status == Certificate_Status_Code::OCSP_SIGNATURE_OK)
229  {
230  // Signature ok, so check the claimed status
231  Certificate_Status_Code ocsp_status = ocsp_responses.at(i)->status_for(*ca, *subject, ref_time, max_ocsp_age);
232  status.insert(ocsp_status);
233  }
234  else
235  {
236  // Some signature problem
237  status.insert(ocsp_signature_status);
238  }
239  }
240  catch(Exception&)
241  {
242  status.insert(Certificate_Status_Code::OCSP_RESPONSE_INVALID);
243  }
244  }
245  }
246 
247  while(cert_status.size() > 0 && cert_status.back().empty())
248  cert_status.pop_back();
249 
250  return cert_status;
251  }
std::vector< std::set< Certificate_Status_Code > > CertificatePathStatusCodes
Definition: x509path.h:29
Certificate_Status_Code
Definition: cert_status.h:19

◆ merge_revocation_status()

void Botan::PKIX::merge_revocation_status ( CertificatePathStatusCodes chain_status,
const CertificatePathStatusCodes crl_status,
const CertificatePathStatusCodes ocsp_status,
bool  require_rev_on_end_entity,
bool  require_rev_on_intermediates 
)

Merge the results from CRL and/or OCSP checks into chain_status

Parameters
chain_statusthe certificate status
crl_statusresults from check_crl
ocsp_statusresults from check_ocsp
require_rev_on_end_entityrequire valid CRL or OCSP on end-entity cert
require_rev_on_intermediatesrequire valid CRL or OCSP on all intermediate certificates

Definition at line 758 of file x509path.cpp.

References Botan::NO_REVOCATION_DATA, Botan::OCSP_RESPONSE_GOOD, Botan::OSCP_NO_REVOCATION_URL, Botan::OSCP_SERVER_NOT_AVAILABLE, and Botan::VALID_CRL_CHECKED.

Referenced by Botan::x509_path_validate().

763  {
764  if(chain_status.empty())
765  throw Invalid_Argument("PKIX::merge_revocation_status chain_status was empty");
766 
767  for(size_t i = 0; i != chain_status.size() - 1; ++i)
768  {
769  bool had_crl = false, had_ocsp = false;
770 
771  if(i < crl.size() && crl[i].size() > 0)
772  {
773  for(auto&& code : crl[i])
774  {
775  if(code == Certificate_Status_Code::VALID_CRL_CHECKED)
776  {
777  had_crl = true;
778  }
779  chain_status[i].insert(code);
780  }
781  }
782 
783  if(i < ocsp.size() && ocsp[i].size() > 0)
784  {
785  for(auto&& code : ocsp[i])
786  {
787  if(code == Certificate_Status_Code::OCSP_RESPONSE_GOOD ||
788  code == Certificate_Status_Code::OSCP_NO_REVOCATION_URL || // softfail
789  code == Certificate_Status_Code::OSCP_SERVER_NOT_AVAILABLE) // softfail
790  {
791  had_ocsp = true;
792  }
793 
794  chain_status[i].insert(code);
795  }
796  }
797 
798  if(had_crl == false && had_ocsp == false)
799  {
800  if((require_rev_on_end_entity && i == 0) ||
801  (require_rev_on_intermediates && i > 0))
802  {
803  chain_status[i].insert(Certificate_Status_Code::NO_REVOCATION_DATA);
804  }
805  }
806  }
807  }

◆ overall_status()

Certificate_Status_Code Botan::PKIX::overall_status ( const CertificatePathStatusCodes cert_status)

Find overall status (OK, error) of a validation

Parameters
cert_statusresult of merge_revocation_status or check_chain

Definition at line 809 of file x509path.cpp.

References Botan::FIRST_ERROR_STATUS, and Botan::OK.

810  {
811  if(cert_status.empty())
812  throw Invalid_Argument("PKIX::overall_status empty cert status");
813 
814  Certificate_Status_Code overall_status = Certificate_Status_Code::OK;
815 
816  // take the "worst" error as overall
817  for(const std::set<Certificate_Status_Code>& s : cert_status)
818  {
819  if(!s.empty())
820  {
821  auto worst = *s.rbegin();
822  // Leave informative OCSP/CRL confirmations on cert-level status only
823  if(worst >= Certificate_Status_Code::FIRST_ERROR_STATUS && worst > overall_status)
824  {
825  overall_status = worst;
826  }
827  }
828  }
829  return overall_status;
830  }
Certificate_Status_Code overall_status(const CertificatePathStatusCodes &cert_status)
Definition: x509path.cpp:809
Certificate_Status_Code
Definition: cert_status.h:19