epan/dissectors/packet-tls.h

   1 /* packet-tls.h
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-or-later
   9  */
  10
  11 #ifndef __PACKET_TLS_H__
  12 #define __PACKET_TLS_H__
  13
  14 #include "ws_symbol_export.h"
  15 #include <epan/packet.h>
  16
  17 struct tlsinfo {
  18         uint32_t seq; /* The sequence number within the TLS stream. */
  19         bool is_reassembled;
  20         bool end_of_stream; /* TCP FIN, close_notify, etc. */
  21         /* The app handle for the session, set by heuristic dissectors
  22          * to be called in the future. */
  23         dissector_handle_t *app_handle;
  24 };
  25
  26 WS_DLL_PUBLIC void ssl_dissector_add(unsigned port, dissector_handle_t handle);
  27 WS_DLL_PUBLIC void ssl_dissector_delete(unsigned port, dissector_handle_t handle);
  28
  29 WS_DLL_PUBLIC void ssl_set_master_secret(uint32_t frame_num, address *addr_srv, address *addr_cli,
  30                                   port_type ptype, uint32_t port_srv, uint32_t port_cli,
  31                                   uint32_t version, int cipher, const unsigned char *_master_secret,
  32                                   const unsigned char *_client_random, const unsigned char *_server_random,
  33                                   uint32_t client_seq, uint32_t server_seq);
  34 /**
  35  * Retrieves Libgcrypt identifiers for the current TLS cipher. Only valid after
  36  * the Server Hello has been processed and if the current conversation has TLS.
  37  * Alternatively, this conversation lookup can be skipped if the current cipher
  38  * ('cipher_suite') is provided (non-zero).
  39  */
  40 extern bool
  41 tls_get_cipher_info(packet_info *pinfo, uint16_t cipher_suite, int *cipher_algo, int *cipher_mode, int *hash_algo);
  42
  43 /**
  44  * Computes the TLS 1.3 "TLS-Exporter(label, context_value, key_length)" value.
  45  * On success, the secret is in "out" (free with "wmem_free(NULL, out)").
  46  */
  47 bool
  48 tls13_exporter(packet_info *pinfo, bool is_early,
  49                const char *label, uint8_t *context,
  50                unsigned context_length, unsigned key_length, unsigned char **out);
  51
  52 int
  53 tls13_get_quic_secret(packet_info *pinfo, bool is_from_server, int type, unsigned secret_min_len, unsigned secret_max_len, uint8_t *secret_out);
  54
  55 /**
  56  * Returns the application-layer protocol name (ALPN) for the current TLS
  57  * session, or NULL if unavailable.
  58  */
  59 const char *
  60 tls_get_alpn(packet_info *pinfo);
  61
  62 /**
  63  * Returns the application-layer protocol name (ALPN) that the client wanted for
  64  * the current TLS session, or NULL if unavailable.
  65  */
  66 const char *
  67 tls_get_client_alpn(packet_info *pinfo);
  68
  69 #endif  /* __PACKET_TLS_H__ */