Botan 3.14.1
Crypto and TLS for C&
Botan::TLS::Certificate_13::Certificate_Entry Class Reference

#include <tls_messages_13.h>

Public Member Functions

const X509_Certificate & certificate () const
 Certificate_Entry (Certificate_Entry &&other) noexcept
 Certificate_Entry (const Certificate_Entry &other)=delete
 Certificate_Entry (const X509_Certificate &cert)
 Certificate_Entry (std::shared_ptr< Public_Key > raw_public_key)
 Certificate_Entry (TLS_Data_Reader &reader, Connection_Side side, Certificate_Type cert_type, bool is_leaf)
Extensions & extensions ()
const Extensions & extensions () const
bool has_certificate () const
Certificate_Entry & operator= (Certificate_Entry &&other) noexcept
Certificate_Entry & operator= (const Certificate_Entry &other)=delete
std::shared_ptr< const Public_Key > public_key () const
std::vector< uint8_t > serialize () const
 ~Certificate_Entry ()

Detailed Description

Definition at line 186 of file tls_messages_13.h.

Constructor & Destructor Documentation

◆ Certificate_Entry() [1/5]

Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry ( TLS_Data_Reader & reader,
Connection_Side side,
Certificate_Type cert_type,
bool is_leaf )

Definition at line 320 of file msg_certificate_13.cpp.

323 {
324 if(cert_type == Certificate_Type::X509) {
325 // RFC 8446 4.2.2
326 // [...] each CertificateEntry contains a DER-encoded X.509
327 // certificate.
328 const auto cert_bytes = reader.get_tls_length_value(3);
329 try {
330 m_certificate = std::make_unique<X509_Certificate>(cert_bytes);
331
332 // We only need the public key for the leaf
333 if(is_leaf) {
334 m_raw_public_key = m_certificate->subject_public_key();
335 }
336 } catch(Exception& e) {
337 // bad_certificate would make more sense but BoGo expects decoding_error
338 throw TLS_Exception(Alert::DecodeError, e.what());
339 }
340 } else if(cert_type == Certificate_Type::RawPublicKey) {
341 // RFC 7250 3.
342 // This specification uses raw public keys whereby the already
343 // available encoding used in a PKIX certificate in the form of a
344 // SubjectPublicKeyInfo structure is reused.
345 try {
346 m_raw_public_key = decode_raw_public_key(reader.get_tls_length_value(3));
347 } catch(Exception& e) {
348 throw TLS_Exception(Alert::DecodeError, e.what());
349 }
350 } else {
351 throw TLS_Exception(Alert::InternalError, "Unknown certificate type");
352 }
353
354 // Extensions are simply tacked at the end of the certificate entry. This
355 // is a departure from the typical "tag-length-value" in a sense that the
356 // Extensions deserializer needs the length value of the extensions.
357 const size_t extensions_length = reader.peek_uint16_t();
358 const auto exts_buf = reader.get_fixed<uint8_t>(extensions_length + 2);
359 TLS_Data_Reader exts_reader("extensions reader", exts_buf);
360 m_extensions.deserialize(exts_reader, side, Handshake_Type::Certificate);
361
362 if(cert_type == Certificate_Type::X509) {
363 // RFC 8446 4.4.2
364 // Valid extensions for server certificates at present include the
365 // OCSP Status extension [RFC6066] and the SignedCertificateTimestamp
366 // extension [RFC6962]; future extensions may be defined for this
367 // message as well.
368 //
369 // RFC 8446 4.4.2.1
370 // A server MAY request that a client present an OCSP response with its
371 // certificate by sending an empty "status_request" extension in its
372 // CertificateRequest message.
373 if(m_extensions.contains_implemented_extensions_other_than({
374 Extension_Code::CertificateStatusRequest,
375 // Extension_Code::SignedCertificateTimestamp
376 })) {
377 throw TLS_Exception(Alert::IllegalParameter, "Certificate Entry contained an extension that is not allowed");
378 }
379 } else if(m_extensions.contains_implemented_extensions_other_than({})) {
380 throw TLS_Exception(
381 Alert::IllegalParameter,
382 "Certificate Entry holding something else than a certificate contained unexpected extensions");
383 }
384}

References Botan::TLS::Certificate, Certificate_Entry(), Botan::TLS::TLS_Data_Reader::get_fixed(), Botan::TLS::TLS_Data_Reader::get_tls_length_value(), Botan::TLS::TLS_Data_Reader::peek_uint16_t(), Botan::TLS::RawPublicKey, Botan::Exception::what(), and Botan::TLS::X509.

Referenced by Certificate_Entry(), Certificate_Entry(), Certificate_Entry(), Certificate_Entry(), operator=(), and operator=().

◆ Certificate_Entry() [2/5]

Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry ( const X509_Certificate & cert)
explicit

Definition at line 392 of file msg_certificate_13.cpp.

392 :
393 m_certificate(std::make_unique<X509_Certificate>(cert)), m_raw_public_key(m_certificate->subject_public_key()) {}

References Certificate_Entry().

◆ Certificate_Entry() [3/5]

Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry ( std::shared_ptr< Public_Key > raw_public_key)
explicit

Definition at line 395 of file msg_certificate_13.cpp.

395 :
396 m_raw_public_key(std::move(raw_public_key)) {
397 BOTAN_ASSERT_NONNULL(m_raw_public_key);
398}
#define BOTAN_ASSERT_NONNULL(ptr)
Definition assert.h:121

References BOTAN_ASSERT_NONNULL.

◆ Certificate_Entry() [4/5]

Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry ( const Certificate_Entry & other)
delete

References Certificate_Entry().

◆ Certificate_Entry() [5/5]

Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry ( Certificate_Entry && other)
defaultnoexcept

References Certificate_Entry().

◆ ~Certificate_Entry()

Botan::TLS::Certificate_13::Certificate_Entry::~Certificate_Entry ( )
default

Member Function Documentation

◆ certificate()

const X509_Certificate & Botan::TLS::Certificate_13::Certificate_Entry::certificate ( ) const

Definition at line 400 of file msg_certificate_13.cpp.

400 {
402 return *m_certificate;
403}
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:49
bool has_certificate() const

References BOTAN_STATE_CHECK, and has_certificate().

◆ extensions() [1/2]

Extensions & Botan::TLS::Certificate_13::Certificate_Entry::extensions ( )
inline

Definition at line 199 of file tls_messages_13.h.

199{ return m_extensions; }

◆ extensions() [2/2]

const Extensions & Botan::TLS::Certificate_13::Certificate_Entry::extensions ( ) const
inline

Definition at line 201 of file tls_messages_13.h.

201{ return m_extensions; }

◆ has_certificate()

bool Botan::TLS::Certificate_13::Certificate_Entry::has_certificate ( ) const
inline

Definition at line 192 of file tls_messages_13.h.

192{ return m_certificate != nullptr; }

Referenced by certificate(), and serialize().

◆ operator=() [1/2]

Certificate_13::Certificate_Entry & Botan::TLS::Certificate_13::Certificate_Entry::operator= ( Certificate_Entry && other)
defaultnoexcept

References Certificate_Entry().

◆ operator=() [2/2]

Certificate_Entry & Botan::TLS::Certificate_13::Certificate_Entry::operator= ( const Certificate_Entry & other)
delete

References Certificate_Entry().

◆ public_key()

std::shared_ptr< const Public_Key > Botan::TLS::Certificate_13::Certificate_Entry::public_key ( ) const

Definition at line 405 of file msg_certificate_13.cpp.

405 {
406 BOTAN_ASSERT_NONNULL(m_raw_public_key);
407 return m_raw_public_key;
408}

References BOTAN_ASSERT_NONNULL.

◆ serialize()

std::vector< uint8_t > Botan::TLS::Certificate_13::Certificate_Entry::serialize ( ) const

Definition at line 410 of file msg_certificate_13.cpp.

410 {
411 return (has_certificate()) ? m_certificate->BER_encode() : X509::BER_encode(*m_raw_public_key);
412}
std::vector< uint8_t > BER_encode(const Public_Key &key)
Definition x509_key.h:24

References Botan::X509::BER_encode(), and has_certificate().


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