1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/* secrets.h
* Secrets management and processing.
* Copyright 2018, Peter Wu <peter@lekensteyn.nl>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __SECRETS_H__
#define __SECRETS_H__
#include <glib.h>
#include "ws_symbol_export.h"
/**
* Interfaces for management and processing of secrets provided by external
* sources (wiretap, key files, HSMs, etc.). Dissectors can register themselves
* as consumers of these secrets.
*
* Future idea: provide helper functions to manage external files. Typically
* these secrets can be erased when the file is truncated or deleted+created.
* Additionally, these secrets are not tied to the lifetime of a capture file.
*
* Future idea: add a method for dissectors to mark secrets as "in use" such
* that unused entries can be removed when saving those secrets to file.
* Intended use case: read large TLS key log file (which is infrequently
* truncated by the user) and store only the bare minimum keys.
*/
void secrets_init(void);
void secrets_cleanup(void);
#if 0
/**
* Lifetime of provided secrets.
* HSM: tie information to epan scope? (but if disconnected, clear state?)
* wiretap pcang DSB: scoped to (capture) file.
* tls.keylog_file pref: epan-scoped (but if the file is deleted, clear it)
*/
enum secrets_scope {
SECRETS_SCOPE_EPAN,
SECRETS_SCOPE_FILE,
};
#endif
/**
* Callback for the wiretap secrets provider (wtap_new_secrets_callback_t).
*/
WS_DLL_PUBLIC void
secrets_wtap_callback(guint32 secrets_type, const void *secrets, guint size);
/**
* Receives a new block of secrets from an external source (wiretap or files).
*/
typedef void (*secrets_block_callback_t)(const void *secrets, guint size);
/**
* Registers a consumer for pcapng Decryption Secrets Block (DSB). Only one
* dissector can register a type.
*
* @param secrets_type A Secrets Type as defined in wiretap/secrets-types.h
* @param cb Callback to be invoked for new secrets.
*/
void secrets_register_type(guint32 secrets_type, secrets_block_callback_t cb);
#endif /* __SECRETS_H__ */
|
