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

#include <tls_extensions.h>

Inheritance diagram for Botan::TLS::Certificate_Status_Request:
Botan::TLS::Extension

Public Member Functions

 Certificate_Status_Request ()
 Certificate_Status_Request (std::vector< uint8_t > ocsp_responder_ids, std::vector< std::vector< uint8_t > > ocsp_key_ids)
 Certificate_Status_Request (std::vector< uint8_t > response)
 Certificate_Status_Request (TLS_Data_Reader &reader, uint16_t extension_size, Handshake_Type message_type, Connection_Side from)
bool empty () const override
const std::vector< uint8_t > & get_ocsp_response () const
const std::vector< uint8_t > & get_request_extensions () const
const std::vector< uint8_t > & get_responder_id_list () const
virtual bool is_implemented () const
std::vector< uint8_t > serialize (Connection_Side whoami) const override
Extension_Code type () const override
 ~Certificate_Status_Request () override

Static Public Member Functions

static Extension_Code static_type ()

Detailed Description

Certificate Status Request (RFC 6066)

Definition at line 369 of file tls_extensions.h.

Constructor & Destructor Documentation

◆ Certificate_Status_Request() [1/4]

Botan::TLS::Certificate_Status_Request::Certificate_Status_Request ( )

Definition at line 173 of file tls_extensions_cert_status_req.cpp.

173 :
174 m_impl(std::make_unique<Certificate_Status_Request_Internal>(RFC6066_Empty_Certificate_Status_Request())) {}

◆ Certificate_Status_Request() [2/4]

Botan::TLS::Certificate_Status_Request::Certificate_Status_Request ( std::vector< uint8_t > ocsp_responder_ids,
std::vector< std::vector< uint8_t > > ocsp_key_ids )

Definition at line 178 of file tls_extensions_cert_status_req.cpp.

179 :
180 m_impl(std::make_unique<Certificate_Status_Request_Internal>(
181 RFC6066_Certificate_Status_Request(std::move(ocsp_responder_ids)))) {
182 // The OCSPStatusRequest structure has no place to carry these
183 BOTAN_ARG_CHECK(ocsp_key_ids.empty(), "Certificate_Status_Request does not support OCSP key IDs");
184}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33

References BOTAN_ARG_CHECK.

◆ Certificate_Status_Request() [3/4]

Botan::TLS::Certificate_Status_Request::Certificate_Status_Request ( std::vector< uint8_t > response)
explicit

Definition at line 188 of file tls_extensions_cert_status_req.cpp.

188 :
189 m_impl(std::make_unique<Certificate_Status_Request_Internal>(Certificate_Status(std::move(response)))) {}

◆ Certificate_Status_Request() [4/4]

Botan::TLS::Certificate_Status_Request::Certificate_Status_Request ( TLS_Data_Reader & reader,
uint16_t extension_size,
Handshake_Type message_type,
Connection_Side from )

Definition at line 97 of file tls_extensions_cert_status_req.cpp.

100 {
101 // This parser needs to take TLS 1.2 and TLS 1.3 into account. The
102 // extension's content and structure is dependent on the context it
103 // was sent in (i.e. the enclosing handshake message). Below is a list
104 // of handshake messages this can appear in.
105 //
106 // TLS 1.2
107 // * Client Hello
108 // * Server Hello
109 //
110 // TLS 1.3
111 // * Client Hello
112 // * Certificate Request
113 // * Certificate (Entry)
114
115 // RFC 6066 8.
116 // In order to indicate their desire to receive certificate status
117 // information, clients MAY include an extension of type "status_request"
118 // in the (extended) client hello.
119 if(message_type == Handshake_Type::ClientHello) {
120 m_impl = std::make_unique<Certificate_Status_Request_Internal>(
121 RFC6066_Certificate_Status_Request(reader, extension_size));
122 }
123
124 // RFC 6066 8.
125 // If a server returns a "CertificateStatus" message, then the server MUST
126 // have included an extension of type "status_request" with empty
127 // "extension_data" in the extended server hello.
128 //
129 // RFC 8446 4.4.2.1
130 // A server MAY request that a client present an OCSP response with its
131 // certificate by sending an empty "status_request" extension in its
132 // CertificateRequest message.
133 else if(message_type == Handshake_Type::ServerHello || message_type == Handshake_Type::CertificateRequest) {
134 m_impl = std::make_unique<Certificate_Status_Request_Internal>(
135 RFC6066_Empty_Certificate_Status_Request(extension_size));
136 }
137
138 // RFC 8446 4.4.2.1
139 // In TLS 1.3, the server's OCSP information is carried in an extension
140 // in the CertificateEntry [in a Certificate handshake message] [...].
141 // Specifically, the body of the "status_request" extension from the
142 // server MUST be a CertificateStatus structure as defined in [RFC6066]
143 // [...].
144 //
145 // RFC 8446 4.4.2.1
146 // If the client opts to send an OCSP response, the body of its
147 // "status_request" extension MUST be a CertificateStatus structure as
148 // defined in [RFC6066].
149 else if(message_type == Handshake_Type::Certificate) {
150 m_impl = std::make_unique<Certificate_Status_Request_Internal>(
151 Certificate_Status(reader.get_fixed<uint8_t>(extension_size), from));
152 }
153
154 // all other contexts are not allowed for this extension
155 else {
156 throw TLS_Exception(Alert::UnsupportedExtension,
157 "Server sent a Certificate_Status_Request extension in an unsupported context");
158 }
159}

References Botan::TLS::Certificate, Botan::TLS::CertificateRequest, Botan::TLS::ClientHello, Botan::TLS::TLS_Data_Reader::get_fixed(), and Botan::TLS::ServerHello.

◆ ~Certificate_Status_Request()

Botan::TLS::Certificate_Status_Request::~Certificate_Status_Request ( )
overridedefault

Member Function Documentation

◆ empty()

bool Botan::TLS::Certificate_Status_Request::empty ( ) const
inlineoverridevirtual

Predicate if a TLS extension should be included or not

Returns
true if this extension should be encoded, otherwise false

Implements Botan::TLS::Extension.

Definition at line 377 of file tls_extensions.h.

377{ return false; }

◆ get_ocsp_response()

const std::vector< uint8_t > & Botan::TLS::Certificate_Status_Request::get_ocsp_response ( ) const

Definition at line 205 of file tls_extensions_cert_status_req.cpp.

205 {
206 BOTAN_ASSERT_NONNULL(m_impl);
207 BOTAN_STATE_CHECK(std::holds_alternative<Certificate_Status>(m_impl->content));
208 return std::get<Certificate_Status>(m_impl->content).response();
209}
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:49
#define BOTAN_ASSERT_NONNULL(ptr)
Definition assert.h:121

References BOTAN_ASSERT_NONNULL, and BOTAN_STATE_CHECK.

◆ get_request_extensions()

const std::vector< uint8_t > & Botan::TLS::Certificate_Status_Request::get_request_extensions ( ) const

Definition at line 199 of file tls_extensions_cert_status_req.cpp.

199 {
200 BOTAN_ASSERT_NONNULL(m_impl);
201 BOTAN_STATE_CHECK(std::holds_alternative<RFC6066_Certificate_Status_Request>(m_impl->content));
202 return std::get<RFC6066_Certificate_Status_Request>(m_impl->content).extension_bytes;
203}

References BOTAN_ASSERT_NONNULL, and BOTAN_STATE_CHECK.

◆ get_responder_id_list()

const std::vector< uint8_t > & Botan::TLS::Certificate_Status_Request::get_responder_id_list ( ) const

Definition at line 193 of file tls_extensions_cert_status_req.cpp.

193 {
194 BOTAN_ASSERT_NONNULL(m_impl);
195 BOTAN_STATE_CHECK(std::holds_alternative<RFC6066_Certificate_Status_Request>(m_impl->content));
196 return std::get<RFC6066_Certificate_Status_Request>(m_impl->content).ocsp_names;
197}

References BOTAN_ASSERT_NONNULL, and BOTAN_STATE_CHECK.

◆ is_implemented()

virtual bool Botan::TLS::Extension::is_implemented ( ) const
inlinevirtualinherited

Predicate if the extension is known/implemented

Note
this exists primarily to support unknown extension handling and doesn't need to be overridden even in the custom extension case.
Returns
true if this extension is known

Reimplemented in Botan::TLS::Unknown_Extension.

Definition at line 113 of file tls_extensions.h.

113{ return true; }

◆ serialize()

std::vector< uint8_t > Botan::TLS::Certificate_Status_Request::serialize ( Connection_Side whoami) const
overridevirtual

Serialize a TLS extension

Parameters
whoamiwhich peer we are acting as in the protocol
Returns
serialized binary for the extension

Implements Botan::TLS::Extension.

Definition at line 211 of file tls_extensions_cert_status_req.cpp.

211 {
212 BOTAN_ASSERT_NONNULL(m_impl);
213 return std::visit([](const auto& c) { return c.serialize(); }, m_impl->content);
214}

References BOTAN_ASSERT_NONNULL.

◆ static_type()

Extension_Code Botan::TLS::Certificate_Status_Request::static_type ( )
inlinestatic

◆ type()

Extension_Code Botan::TLS::Certificate_Status_Request::type ( ) const
inlineoverridevirtual

Return TLS extension code

Returns
code number of the extension

Implements Botan::TLS::Extension.

Definition at line 373 of file tls_extensions.h.

373{ return static_type(); }

References static_type().


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