353 lines
12 KiB
C
353 lines
12 KiB
C
/* sniffer.h
|
|
*
|
|
* Copyright (C) 2006-2023 wolfSSL Inc.
|
|
*
|
|
* This file is part of wolfSSL.
|
|
*
|
|
* wolfSSL is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* wolfSSL is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
|
|
*/
|
|
|
|
|
|
|
|
#ifndef WOLFSSL_SNIFFER_H
|
|
#define WOLFSSL_SNIFFER_H
|
|
|
|
#include <wolfssl/wolfcrypt/settings.h>
|
|
#include <wolfssl/wolfcrypt/asn_public.h>
|
|
|
|
#ifdef HAVE_WOLF_EVENT
|
|
#include <wolfssl/wolfcrypt/wolfevent.h>
|
|
#endif
|
|
|
|
|
|
#ifdef _WIN32
|
|
#ifdef SSL_SNIFFER_EXPORTS
|
|
#define SSL_SNIFFER_API __declspec(dllexport)
|
|
#else
|
|
#define SSL_SNIFFER_API __declspec(dllimport)
|
|
#endif
|
|
#else
|
|
#define SSL_SNIFFER_API
|
|
#endif /* _WIN32 */
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
typedef struct IpAddrInfo {
|
|
int version;
|
|
union {
|
|
word32 ip4;
|
|
byte ip6[16];
|
|
};
|
|
} IpAddrInfo;
|
|
|
|
typedef struct SnifferStreamInfo {
|
|
IpAddrInfo src; /* server address in network byte order */
|
|
IpAddrInfo dst; /* client address in network byte order */
|
|
word16 dstPort; /* server port */
|
|
word16 srcPort; /* client port */
|
|
} SnifferStreamInfo;
|
|
|
|
/* @param typeK: (formerly keyType) was shadowing a global declaration in
|
|
* wolfssl/wolfcrypt/asn.h line 175
|
|
*/
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetPrivateKey(const char* address, int port,
|
|
const char* keyFile, int typeK,
|
|
const char* password, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetPrivateKeyBuffer(const char* address, int port,
|
|
const char* keyBuf, int keySz,
|
|
int typeK, const char* password,
|
|
char* error);
|
|
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetNamedPrivateKey(const char* name,
|
|
const char* address, int port,
|
|
const char* keyFile, int typeK,
|
|
const char* password, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetNamedPrivateKeyBuffer(const char* name,
|
|
const char* address, int port,
|
|
const char* keyBuf, int keySz,
|
|
int typeK, const char* password,
|
|
char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetEphemeralKey(const char* address, int port,
|
|
const char* keyFile, int typeKey,
|
|
const char* password, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetEphemeralKeyBuffer(const char* address, int port,
|
|
const char* keyBuf, int keySz, int typeKey,
|
|
const char* password, char* error);
|
|
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetNamedEphemeralKey(const char* name,
|
|
const char* address, int port,
|
|
const char* keyFile, int typeKey,
|
|
const char* password, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetNamedEphemeralKeyBuffer(const char* name,
|
|
const char* address, int port,
|
|
const char* keyBuf, int keySz, int typeKey,
|
|
const char* password, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_DecodePacket(const unsigned char* packet, int length,
|
|
unsigned char** data, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_FreeDecodeBuffer(unsigned char** data, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_FreeZeroDecodeBuffer(unsigned char** data, int sz,
|
|
char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_Trace(const char* traceFile, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_EnableRecovery(int onOff, int maxMemory, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_GetSessionStats(unsigned int* active,
|
|
unsigned int* total,
|
|
unsigned int* peak,
|
|
unsigned int* maxSessions,
|
|
unsigned int* missedData,
|
|
unsigned int* reassemblyMemory,
|
|
char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API void ssl_InitSniffer(void);
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API void ssl_InitSniffer_ex(int devId);
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API void ssl_InitSniffer_ex2(int threadNum);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API void ssl_FreeSniffer(void);
|
|
|
|
|
|
/* ssl_SetPrivateKey typeKs */
|
|
enum {
|
|
FILETYPE_PEM = 1,
|
|
FILETYPE_DER = 2,
|
|
};
|
|
|
|
|
|
/*
|
|
* New Sniffer API that provides read-only access to the TLS and cipher
|
|
* information associated with the SSL session.
|
|
*/
|
|
|
|
typedef struct SSLInfo
|
|
{
|
|
unsigned char isValid;
|
|
/* indicates if the info in this struct is valid: 0 = no, 1 = yes */
|
|
unsigned char protocolVersionMajor; /* SSL Version: major */
|
|
unsigned char protocolVersionMinor; /* SSL Version: minor */
|
|
unsigned char serverCipherSuite0; /* first byte, normally 0 */
|
|
unsigned char serverCipherSuite; /* second byte, actual suite */
|
|
unsigned char serverCipherSuiteName[256];
|
|
/* cipher name, e.g., "TLS_RSA_..." */
|
|
unsigned char serverNameIndication[128];
|
|
unsigned int keySize;
|
|
} SSLInfo;
|
|
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_DecodePacketWithSessionInfo(
|
|
const unsigned char* packet, int length,
|
|
unsigned char** data, SSLInfo* sslInfo, char* error);
|
|
|
|
typedef void (*SSLConnCb)(const void* session, SSLInfo* info, void* ctx);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetConnectionCb(SSLConnCb cb);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetConnectionCtx(void* ctx);
|
|
|
|
|
|
typedef struct SSLStats
|
|
{
|
|
unsigned long int sslStandardConns; /* server_hello count not including resumed sessions */
|
|
unsigned long int sslClientAuthConns; /* client's who have presented certificates (mutual authentication) */
|
|
unsigned long int sslResumedConns; /* resumed connections */
|
|
unsigned long int sslEphemeralMisses; /* TLS v1.2 and older PFS / ephemeral connections missed (not able to decrypt) */
|
|
unsigned long int sslResumeMisses; /* Resumption sessions not found */
|
|
unsigned long int sslCiphersUnsupported; /* No cipher suite match found when compared to supported */
|
|
unsigned long int sslKeysUnmatched; /* Key callback failures (not found). Applies to WOLFSSL_SNIFFER_WATCH only */
|
|
unsigned long int sslKeyFails; /* Failures loading or using keys */
|
|
unsigned long int sslDecodeFails; /* Dropped packets (not application_data or match protocol version) */
|
|
unsigned long int sslAlerts; /* Number of decoded alert messages */
|
|
unsigned long int sslDecryptedBytes; /* Number of decrypted bytes */
|
|
unsigned long int sslEncryptedBytes; /* Number of encrypted bytes */
|
|
unsigned long int sslEncryptedPackets; /* Number of encrypted packets */
|
|
unsigned long int sslDecryptedPackets; /* Number of decrypted packets */
|
|
unsigned long int sslKeyMatches; /* Key callback successes (failures tracked in sslKeysUnmatched). Applies to WOLFSSL_SNIFFER_WATCH only. */
|
|
unsigned long int sslEncryptedConns; /* Number of created sniffer sessions */
|
|
unsigned long int sslResumptionInserts; /* Number of sessions reused with resumption */
|
|
} SSLStats;
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_ResetStatistics(void);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_ReadStatistics(SSLStats* stats);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_ReadResetStatistics(SSLStats* stats);
|
|
|
|
|
|
#if defined(WOLFSSL_STATIC_EPHEMERAL) && defined(WOLFSSL_TLS13)
|
|
/* macro indicating support for key callback */
|
|
#undef WOLFSSL_SNIFFER_KEY_CALLBACK
|
|
#define WOLFSSL_SNIFFER_KEY_CALLBACK
|
|
|
|
typedef int (*SSLKeyCb)(void* vSniffer, int namedGroup,
|
|
const unsigned char* srvPub, unsigned int srvPubSz,
|
|
const unsigned char* cliPub, unsigned int cliPubSz,
|
|
DerBuffer* privKey, void* cbCtx, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetKeyCallback(SSLKeyCb cb, void* cbCtx);
|
|
#endif
|
|
|
|
|
|
#ifdef WOLFSSL_SNIFFER_WATCH
|
|
typedef int (*SSLWatchCb)(void* vSniffer,
|
|
const unsigned char* certHash,
|
|
unsigned int certHashSz,
|
|
const unsigned char* certChain,
|
|
unsigned int certChainSz,
|
|
void* ctx, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetWatchKeyCallback(SSLWatchCb cb, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetWatchKeyCallback_ex(SSLWatchCb cb, int devId,
|
|
char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetWatchKeyCtx(void* ctx, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetWatchKey_buffer(void* vSniffer,
|
|
const unsigned char* key, unsigned int keySz,
|
|
int keyType, char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetWatchKey_file(void* vSniffer,
|
|
const char* keyFile, int keyType,
|
|
const char* password, char* error);
|
|
#endif
|
|
|
|
#ifdef WOLFSSL_SNIFFER_STORE_DATA_CB
|
|
typedef int (*SSLStoreDataCb)(const unsigned char* decryptBuf,
|
|
unsigned int decryptBufSz, unsigned int decryptBufOffset, void* ctx);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_SetStoreDataCallback(SSLStoreDataCb cb);
|
|
#endif
|
|
|
|
#ifdef WOLFSSL_SNIFFER_STORE_DATA_CB
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_DecodePacketWithSessionInfoStoreData(
|
|
const unsigned char* packet, int length, void* ctx,
|
|
SSLInfo* sslInfo, char* error);
|
|
#endif
|
|
|
|
#ifdef WOLFSSL_SNIFFER_CHAIN_INPUT
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_DecodePacketWithChain(void* vChain,
|
|
unsigned int chainSz, unsigned char** data, char* error);
|
|
#endif
|
|
|
|
#if defined(WOLFSSL_SNIFFER_CHAIN_INPUT) && \
|
|
defined(WOLFSSL_SNIFFER_STORE_DATA_CB)
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_DecodePacketWithChainSessionInfoStoreData(
|
|
void* vChain, unsigned int chainSz, void* ctx, SSLInfo* sslInfo,
|
|
char* error);
|
|
#endif
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_DecodePacket_GetStream(SnifferStreamInfo* info,
|
|
const byte* packet, int length, char* error);
|
|
|
|
#ifdef WOLFSSL_ASYNC_CRYPT
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_DecodePacketAsync(void* packet, unsigned int packetSz,
|
|
int isChain, unsigned char** data, char* error, SSLInfo* sslInfo,
|
|
void* userCtx);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_PollSniffer(WOLF_EVENT** events, int maxEvents,
|
|
WOLF_EVENT_FLAG flags, int* eventCount);
|
|
|
|
#endif /* WOLFSSL_ASYNC_CRYPT */
|
|
|
|
#ifdef WOLFSSL_SNIFFER_KEYLOGFILE
|
|
|
|
typedef enum {
|
|
SNIFFER_SECRET_TLS12_MASTER_SECRET,
|
|
#if defined(WOLFSSL_TLS13)
|
|
SNIFFER_SECRET_CLIENT_EARLY_TRAFFIC_SECRET,
|
|
SNIFFER_SECRET_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
|
|
SNIFFER_SECRET_SERVER_HANDSHAKE_TRAFFIC_SECRET,
|
|
SNIFFER_SECRET_CLIENT_TRAFFIC_SECRET,
|
|
SNIFFER_SECRET_SERVER_TRAFFIC_SECRET,
|
|
#endif /* WOLFSSL_TLS13 */
|
|
SNIFFER_SECRET_NUM_SECRET_TYPES
|
|
} SnifferSecretType;
|
|
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_CreateKeyLogSnifferServer(const char* address,
|
|
int port,
|
|
char* error);
|
|
|
|
WOLFSSL_API
|
|
SSL_SNIFFER_API int ssl_LoadSecretsFromKeyLogFile(const char* keylogfile,
|
|
char* error);
|
|
|
|
typedef int (*SSLSnifferSecretCb)(unsigned char* client_random,
|
|
int type,
|
|
unsigned char* output_secret);
|
|
|
|
#endif /* WOLFSSL_SNIFFER_KEYLOGFILE */
|
|
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* wolfSSL_SNIFFER_H */
|
|
|