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 
34 enum class tls_server_flags : unsigned int
35 {
36  none = 0,
37 
39  no_auto_ticket = 0x1,
40 
42  debug_no_tickets = 0x2
43 };
44 
45 inline bool operator&(tls_server_flags lhs, tls_server_flags rhs) {
46  return (static_cast<std::underlying_type_t<tls_server_flags>>(lhs) & static_cast<std::underlying_type_t<tls_server_flags>>(rhs)) != 0;
47 }
48 inline tls_server_flags operator|(tls_server_flags lhs, tls_server_flags rhs) {
49  return static_cast<tls_server_flags>(static_cast<std::underlying_type_t<tls_server_flags>>(lhs) | static_cast<std::underlying_type_t<tls_server_flags>>(rhs));
50 }
51 inline tls_server_flags& operator|=(tls_server_flags & lhs, tls_server_flags rhs) {
52  lhs = lhs | rhs;
53  return lhs;
54 }
55 
56 
57 enum class tls_client_flags : unsigned int
58 {
59  none = 0,
60 
62  debug_no_tickets = 0x1
63 };
64 
65 inline bool operator&(tls_client_flags lhs, tls_client_flags rhs) {
66  return (static_cast<std::underlying_type_t<tls_client_flags>>(lhs) & static_cast<std::underlying_type_t<tls_client_flags>>(rhs)) != 0;
67 }
68 inline tls_client_flags operator|(tls_client_flags lhs, tls_client_flags rhs) {
69  return static_cast<tls_client_flags>(static_cast<std::underlying_type_t<tls_client_flags>>(lhs) | static_cast<std::underlying_type_t<tls_client_flags>>(rhs));
70 }
71 inline tls_client_flags& operator|=(tls_client_flags & lhs, tls_client_flags rhs) {
72  lhs = lhs | rhs;
73  return lhs;
74 }
75 
76 
77 
90 class FZ_PUBLIC_SYMBOL tls_layer final : protected event_handler, public socket_layer
91 {
92 public:
93  tls_layer(event_loop& event_loop, event_handler* evt_handler, socket_interface& layer, tls_system_trust_store * system_trust_store, logger_interface& logger);
94  virtual ~tls_layer();
95 
107  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(), tls_client_flags flags = {});
108 
125  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(), tls_client_flags flags = {});
126 
142  bool server_handshake(std::vector<uint8_t> const& session_to_resume = {}, std::string_view const& preamble = {}, tls_server_flags flags = {});
143 
145  std::vector<uint8_t> get_session_parameters() const;
146 
148  std::vector<uint8_t> get_raw_certificate() const;
149 
155  void set_verification_result(bool trusted);
156 
157  std::string get_protocol() const;
158 
159  std::string get_key_exchange() const;
160  std::string get_cipher() const;
161  std::string get_mac() const;
162  int get_algorithm_warnings() const;
163 
165  bool resumed_session() const;
166 
168  static std::string list_tls_ciphers(std::string const& priority);
169 
178  bool set_certificate_file(native_string const& keyfile, native_string const& certsfile, native_string const& password, bool pem = true);
179 
188  bool set_certificate(std::string_view const& key, std::string_view const& certs, native_string const& password, bool pem = true);
189 
191  static std::string get_gnutls_version();
192 
194  enum class cert_type {
195  any,
196  client,
197  server,
198  ca
199  };
200 
209  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, cert_type type = cert_type::any, bool ecsda = true);
210 
212  static std::pair<std::string, std::string> generate_ca_certificate(native_string const& password, std::string const& distinguished_name, duration const& lifetime = {}, bool ecdsa = true);
213 
215  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, cert_type type = cert_type::any);
216 
222  static std::string generate_cert_from_csr(std::pair<std::string, std::string> const& issuer, native_string const& password, std::string const& csr, std::string const& distinguished_name = {}, std::vector<std::string> const& hostnames = {}, duration const& lifetime = {}, cert_type type = cert_type::any);
223 
236  bool set_alpn(std::string_view const& alpn);
237  bool set_alpn(std::vector<std::string> const& alpns, bool server_priority = false);
238 
241  void set_min_tls_ver(tls_ver ver);
242 
247  void set_max_tls_ver(tls_ver ver);
248 
250  std::string get_alpn() const;
251 
253  native_string get_hostname() const;
254 
255  bool is_server() const;
256 
265  int new_session_ticket();
266 
280  void set_unexpected_eof_cb(std::function<bool()> const& cb);
281  void set_unexpected_eof_cb(std::function<bool()> && cb);
282 
283  virtual socket_state get_state() const override;
284 
285  virtual int connect(native_string const& host, unsigned int port, address_type family = address_type::unknown) override;
286 
287  virtual int read(void *buffer, unsigned int size, int& error) override;
288  virtual int write(void const* buffer, unsigned int size, int& error) override;
289 
290  virtual int shutdown() override;
291 
292  virtual int shutdown_read() override;
293 
294  virtual void set_event_handler(event_handler* pEvtHandler, fz::socket_event_flag retrigger_block = socket_event_flag{}) override;
295 
296 private:
297  virtual void FZ_PRIVATE_SYMBOL operator()(event_base const& ev) override;
298 
299  friend class tls_layer_impl;
300  std::unique_ptr<tls_layer_impl> impl_;
301 };
302 }
303 
304 #endif
tls_client_flags
Definition: tls_layer.hpp:57
Data has become available.
tls_server_flags
Definition: tls_layer.hpp:34
A Transport Layer Security (TLS) layer.
Definition: tls_layer.hpp:90
Interface for sockets.
Definition: socket.hpp:374
Used in unit tests. Don't use in production.
Simple handler for asynchronous event processing.
Definition: event_handler.hpp:54
This is the recommended event class.
Definition: event.hpp:67
Opaque class to load the system trust store asynchronously.
Definition: tls_system_trust_store.hpp:29
cert_type
Type of certificate to create.
Definition: tls_layer.hpp:194
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:653
std::wstring native_string
A string in the system's native character type and encoding. Note: This typedef changes depending on...
Definition: string.hpp:34
socket_state
State transitions are monotonically increasing.
Definition: socket.hpp:342
The namespace used by libfilezilla.
Definition: apply.hpp:17
The duration class represents a time interval in milliseconds.
Definition: time.hpp:290
EC key type with P-256 as algorithm.
In TLS 1.3, do not automatically send PSKs after finishing handshake. Ignored if not TLS 1...
data can be written.
Abstract interface for logging strings.
Definition: logger.hpp:50
socket_event_flag
The type of a socket event.
Definition: socket.hpp:34
Operationf failed.