libfilezilla
tls_layer.hpp
Go to the documentation of this file.
1 #ifndef LIBFILEZILLA_TLS_LAYER_HEADER
2 #define LIBFILEZILLA_TLS_LAYER_HEADER
3 
8 #include "socket.hpp"
9 
10 namespace fz {
11 class logger_interface;
12 class tls_system_trust_store;
13 class tls_session_info;
14 
15 class tls_layer;
16 class tls_layer_impl;
17 
18 struct certificate_verification_event_type;
19 
25 
26 enum class tls_ver
27 {
28  v1_0,
29  v1_1,
30  v1_2,
31  v1_3
32 };
33 
46 class FZ_PUBLIC_SYMBOL tls_layer final : protected event_handler, public socket_layer
47 {
48 public:
49  tls_layer(event_loop& event_loop, event_handler* evt_handler, socket_interface& layer, tls_system_trust_store * system_trust_store, logger_interface& logger);
50  virtual ~tls_layer();
51 
63  bool client_handshake(std::vector<uint8_t> const& required_certificate, std::vector<uint8_t> const& session_to_resume = std::vector<uint8_t>(), native_string const& session_hostname = native_string());
64 
81  bool client_handshake(event_handler *const verification_handler, std::vector<uint8_t> const& session_to_resume = std::vector<uint8_t>(), native_string const& session_hostname = native_string());
82 
98  bool server_handshake(std::vector<uint8_t> const& session_to_resume = {}, std::string_view const& preamble = {});
99 
101  std::vector<uint8_t> get_session_parameters() const;
102 
104  std::vector<uint8_t> get_raw_certificate() const;
105 
111  void set_verification_result(bool trusted);
112 
113  std::string get_protocol() const;
114 
115  std::string get_key_exchange() const;
116  std::string get_cipher() const;
117  std::string get_mac() const;
118  int get_algorithm_warnings() const;
119 
121  bool resumed_session() const;
122 
124  static std::string list_tls_ciphers(std::string const& priority);
125 
134  bool set_certificate_file(native_string const& keyfile, native_string const& certsfile, native_string const& password, bool pem = true);
135 
144  bool set_certificate(std::string_view const& key, std::string_view const& certs, native_string const& password, bool pem = true);
145 
147  static std::string get_gnutls_version();
148 
157  static std::pair<std::string, std::string> generate_selfsigned_certificate(native_string const& password, std::string const& distinguished_name, std::vector<std::string> const& hostnames);
158  static std::pair<std::string, std::string> generate_csr(native_string const& password, std::string const& distinguished_name, std::vector<std::string> const& hostnames, bool csr_as_pem = true);
159 
167  bool set_alpn(std::string_view const& alpn);
168  bool set_alpn(std::vector<std::string> const& alpns);
169 
172  void set_min_tls_ver(tls_ver ver);
173 
178  void set_max_tls_ver(tls_ver ver);
179 
181  std::string get_alpn() const;
182 
184  native_string get_hostname() const;
185 
186  bool is_server() const;
187 
188  virtual socket_state get_state() const override;
189 
190  virtual int connect(native_string const& host, unsigned int port, address_type family = address_type::unknown) override;
191 
192  virtual int read(void *buffer, unsigned int size, int& error) override;
193  virtual int write(void const* buffer, unsigned int size, int& error) override;
194 
195  virtual int shutdown() override;
196 
197  virtual int shutdown_read() override;
198 
199  virtual void set_event_handler(event_handler* pEvtHandler, fz::socket_event_flag retrigger_block = socket_event_flag{}) override;
200 
201 private:
202  virtual void FZ_PRIVATE_SYMBOL operator()(event_base const& ev) override;
203 
204  friend class tls_layer_impl;
205  std::unique_ptr<tls_layer_impl> impl_;
206 };
207 }
208 
209 #endif
A Transport Layer Security (TLS) layer.
Definition: tls_layer.hpp:46
Interface for sockets.
Definition: socket.hpp:358
Simple handler for asynchronous event processing.
Definition: event_handler.hpp:54
This is the recommended event class.
Definition: event.hpp:65
Opaque class to load the system trust store asynchronously.
Definition: tls_system_trust_store.hpp:29
simple_event< certificate_verification_event_type, tls_layer *, tls_session_info > certificate_verification_event
This event gets sent during the handshake with details about the session and the used certificate...
Definition: tls_layer.hpp:18
Socket classes for networking.
A threaded event loop that supports sending events and timers.
Definition: event_loop.hpp:33
A base class for socket layers.
Definition: socket.hpp:605
std::wstring native_string
A string in the system's native character type and encoding. Note: This typedef changes depending on...
Definition: string.hpp:33
socket_state
State transitions are monotonically increasing.
Definition: socket.hpp:326
The namespace used by libfilezilla.
Definition: apply.hpp:17
The buffer class is a simple buffer where data can be appended at the end and consumed at the front...
Definition: buffer.hpp:25
Abstract interface for logging strings.
Definition: logger.hpp:49
Common base class for all events.
Definition: event.hpp:22
socket_event_flag
The type of a socket event.
Definition: socket.hpp:33