Botan::TLS::Alert Class Reference

#include <tls_alert.h>

Public Types
typedef AlertType	Type

Public Member Functions
	Alert ()
	Alert (const secure_vector< uint8_t > &buf)
	Alert (Type type_code, bool fatal=false)
bool	is_fatal () const
bool	is_valid () const
std::vector< uint8_t >	serialize () const
Type	type () const
std::string	type_string () const

Detailed Description

SSL/TLS Alert Message

Definition at line 69 of file tls_alert.h.

Member Typedef Documentation

Type

AlertType Botan::TLS::Alert::Type

Definition at line 71 of file tls_alert.h.

Constructor & Destructor Documentation

Alert() [1/3]

Botan::TLS::Alert::Alert ( const secure_vector< uint8_t > & buf )

explicit

Deserialize an Alert message

Parameters

buf	the serialized alert

Definition at line 14 of file tls_alert.cpp.

                                              {
   if(buf.size() != 2) {
      throw Decoding_Error("Bad size (" + std::to_string(buf.size()) + ") for TLS alert message");
   }
 
   if(buf[0] == 1) {
      m_fatal = false;
   } else if(buf[0] == 2) {
      m_fatal = true;
   } else {
      throw TLS_Exception(Alert::IllegalParameter, "Bad code for TLS alert level");
   }
 
   const uint8_t dc = buf[1];
 
   m_type_code = static_cast<Type>(dc);
}

Alert() [2/3]

Botan::TLS::Alert::Alert ( Type type_code, bool fatal = false )

inline

Create a new Alert

Parameters

type_code	the type of alert
fatal	specifies if this is a fatal alert

Definition at line 124 of file tls_alert.h.

: m_fatal(fatal), m_type_code(type_code) {}

Alert() [3/3]

Botan::TLS::Alert::Alert ( )

inline

Definition at line 126 of file tls_alert.h.

: m_fatal(false), m_type_code(AlertType::None) {}

Member Function Documentation

is_fatal()

bool Botan::TLS::Alert::is_fatal ( ) const

inline

Return true if this alert is fatal. A fatal alert causes the connection to be immediately disconnected. Otherwise, the alert is a warning and the connection remains valid.

Note: RFC 8446 6. In TLS 1.3, the severity is implicit in the type of alert being sent, and the "level" field can safely be ignored. Everything is considered fatal except for UserCanceled and CloseNotify (RFC 8446 6.1)

Returns

if this alert is fatal or not

Definition at line 92 of file tls_alert.h.

{ return m_fatal; }

Referenced by Botan::TLS::Channel_Impl_12::send_alert(), and serialize().

is_valid()

bool Botan::TLS::Alert::is_valid ( ) const

inline

Returns

true iff this alert is non-empty

Definition at line 77 of file tls_alert.h.

{ return (m_type_code != AlertType::None); }

Referenced by Botan::TLS::Channel_Impl_12::send_alert(), and Botan::TLS::Channel_Impl_13::send_alert().

serialize()

std::vector< uint8_t > Botan::TLS::Alert::serialize

(

)

const

Serialize an alert

Definition at line 32 of file tls_alert.cpp.

                                          {
   return std::vector<uint8_t>({static_cast<uint8_t>(is_fatal() ? 2 : 1), static_cast<uint8_t>(type())});
}

References is_fatal(), and type().

Referenced by Botan::TLS::Channel_Impl_12::send_alert(), and Botan::TLS::Channel_Impl_13::send_alert().

type()

Type Botan::TLS::Alert::type ( ) const

inline

Returns the type of the alert as an enum

Returns

type of alert

Definition at line 99 of file tls_alert.h.

{ return m_type_code; }

Referenced by Botan::TLS::Channel_Impl_12::send_alert(), serialize(), and type_string().

type_string()

std::string Botan::TLS::Alert::type_string

(

)

const

Returns the type of the alert as a string

Returns

type of alert

Definition at line 118 of file tls_alert.cpp.

                                   {
   if(const char* known_alert = alert_type_to_string(type())) {
      return std::string(known_alert);
   }
 
   return "unrecognized_alert_" + std::to_string(static_cast<size_t>(type()));
}

References type().

---

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

• src/lib/tls/tls_alert.h
• src/lib/tls/tls_alert.cpp