Added new API calls ndpi_set_proto_breed() and ndpi_set_proto_category() for overwriting nDPI protocol specifications
696 lines
22 KiB
C
696 lines
22 KiB
C
/*
|
|
* ndpi_api.h
|
|
*
|
|
* Copyright (C) 2011-17 - ntop.org
|
|
*
|
|
* This file is part of nDPI, an open source deep packet inspection
|
|
* library based on the OpenDPI and PACE technology by ipoque GmbH
|
|
*
|
|
* nDPI is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* nDPI 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with nDPI. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
|
|
#ifndef __NDPI_API_H__
|
|
#define __NDPI_API_H__
|
|
|
|
#include "ndpi_main.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define SIZEOF_ID_STRUCT (sizeof(struct ndpi_id_struct))
|
|
#define SIZEOF_FLOW_STRUCT (sizeof(struct ndpi_flow_struct))
|
|
|
|
#define NDPI_DETECTION_ONLY_IPV4 ( 1 << 0 )
|
|
#define NDPI_DETECTION_ONLY_IPV6 ( 1 << 1 )
|
|
|
|
#define ADD_TO_DETECTION_BITMASK 1
|
|
#define NO_ADD_TO_DETECTION_BITMASK 0
|
|
#define SAVE_DETECTION_BITMASK_AS_UNKNOWN 1
|
|
#define NO_SAVE_DETECTION_BITMASK_AS_UNKNOWN 0
|
|
|
|
|
|
/**
|
|
* Check if a string is encoded with punycode
|
|
* ( https://tools.ietf.org/html/rfc3492 )
|
|
*
|
|
* @par buff = pointer to the string to ckeck
|
|
* @par len = len of the string
|
|
* @return 1 if the string is punycoded;
|
|
* else 0
|
|
*
|
|
*/
|
|
int check_punycode_string(char * buff , int len);
|
|
|
|
|
|
/**
|
|
* Get the size of the flow struct
|
|
*
|
|
* @return the size of the flow struct
|
|
*
|
|
*/
|
|
u_int32_t ndpi_detection_get_sizeof_ndpi_flow_struct(void);
|
|
|
|
|
|
/**
|
|
* Get the size of the id struct
|
|
*
|
|
* @return the size of the id struct
|
|
*
|
|
*/
|
|
u_int32_t ndpi_detection_get_sizeof_ndpi_id_struct(void);
|
|
|
|
|
|
/**
|
|
* nDPI personal allocation and free functions
|
|
**/
|
|
void * ndpi_malloc(size_t size);
|
|
void * ndpi_calloc(unsigned long count, size_t size);
|
|
void * ndpi_realloc(void *ptr, size_t old_size, size_t new_size);
|
|
char * ndpi_strdup(const char *s);
|
|
void ndpi_free(void *ptr);
|
|
void * ndpi_flow_malloc(size_t size);
|
|
void ndpi_flow_free(void *ptr);
|
|
|
|
/**
|
|
* Search the first occurrence of substring -find- in -s-
|
|
* The search is limited to the first -slen- characters of the string
|
|
*
|
|
* @par s = string to parse
|
|
* @par find = string to match with -s-
|
|
* @par slen = max length to match between -s- and -find-
|
|
* @return a pointer to the beginning of the located substring;
|
|
* NULL if the substring is not found
|
|
*
|
|
*/
|
|
char* ndpi_strnstr(const char *s, const char *find, size_t slen);
|
|
|
|
/**
|
|
* Same as ndpi_strnstr but case insensitive
|
|
*
|
|
* @par s = string to parse
|
|
* @par find = string to match with -s-
|
|
* @par slen = max length to match between -s- and -find-
|
|
* @return a pointer to the beginning of the located substring;
|
|
* NULL if the substring is not found
|
|
*
|
|
*/
|
|
char* ndpi_strncasestr(const char *s, const char *find, size_t slen);
|
|
|
|
|
|
/**
|
|
* Returns the nDPI protocol id for IP-based protocol detection
|
|
*
|
|
* @par ndpi_struct = the struct created for the protocol detection
|
|
* @par pin = IP host address (MUST BE in network byte order):
|
|
* See man(7) ip for details
|
|
* @return the nDPI protocol ID
|
|
*
|
|
*/
|
|
u_int16_t ndpi_network_ptree_match(struct ndpi_detection_module_struct *ndpi_struct, struct in_addr *pin);
|
|
|
|
|
|
/**
|
|
* Init single protocol match
|
|
*
|
|
* @par ndpi_mod = the struct created for the protocol detection
|
|
* @par match = the struct passed to match the protocol
|
|
*
|
|
*/
|
|
void ndpi_init_protocol_match(struct ndpi_detection_module_struct *ndpi_mod, ndpi_protocol_match *match);
|
|
|
|
/**
|
|
* Returns a new initialized detection module
|
|
*
|
|
* @return the initialized detection module
|
|
*
|
|
*/
|
|
struct ndpi_detection_module_struct *ndpi_init_detection_module(void);
|
|
|
|
/**
|
|
* Frees the memory allocated in the specified flow
|
|
*
|
|
* @par flow = the flow to deallocate
|
|
*
|
|
*/
|
|
void ndpi_free_flow(struct ndpi_flow_struct *flow);
|
|
|
|
|
|
/**
|
|
* Enables cache support.
|
|
* In nDPI is used for some protocol (i.e. Skype)
|
|
*
|
|
* @par ndpi_mod = the struct created for the protocol detection
|
|
* @par host = string for the host name
|
|
* @par port = unsigned int for the port number
|
|
*
|
|
*/
|
|
void ndpi_enable_cache(struct ndpi_detection_module_struct *ndpi_mod, char* host, u_int port);
|
|
|
|
|
|
/**
|
|
* Destroys the detection module
|
|
*
|
|
* @par ndpi_struct = the struct to clearing for the detection module
|
|
*
|
|
*/
|
|
void ndpi_exit_detection_module(struct ndpi_detection_module_struct *ndpi_struct);
|
|
|
|
|
|
/**
|
|
* Sets a single protocol bitmask
|
|
* This function does not increment the index of the callback_buffer
|
|
*
|
|
* @par label = string for the protocol name
|
|
* @par ndpi_struct = the detection module
|
|
* @par detection_bitmask = the protocol bitmask
|
|
* @par idx = the index of the callback_buffer
|
|
* @par func = function pointer of the protocol search
|
|
* @par ndpi_selection_bitmask = the protocol selected bitmask
|
|
* @par b_save_bitmask_unknow = if set as "true" save the detection bitmask as unknow
|
|
* @par b_add_detection_bitmask = if set as "true" add the protocol bitmask to the detection bitmask
|
|
*
|
|
*/
|
|
void ndpi_set_bitmask_protocol_detection(char *label, struct ndpi_detection_module_struct *ndpi_struct,
|
|
const NDPI_PROTOCOL_BITMASK *detection_bitmask,
|
|
const u_int32_t idx,
|
|
u_int16_t ndpi_protocol_id,
|
|
void (*func) (struct ndpi_detection_module_struct *, struct ndpi_flow_struct *flow),
|
|
const NDPI_SELECTION_BITMASK_PROTOCOL_SIZE ndpi_selection_bitmask,
|
|
u_int8_t b_save_bitmask_unknow,
|
|
u_int8_t b_add_detection_bitmask);
|
|
|
|
|
|
/**
|
|
* Sets the protocol bitmask2
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par detection_bitmask = the protocol bitmask to set
|
|
*
|
|
*/
|
|
void ndpi_set_protocol_detection_bitmask2(struct ndpi_detection_module_struct *ndpi_struct,
|
|
const NDPI_PROTOCOL_BITMASK * detection_bitmask);
|
|
|
|
|
|
/**
|
|
* Function to be called before we give up with detection for a given flow.
|
|
* This function reduces the NDPI_UNKNOWN_PROTOCOL detection
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par flow = the flow given for the detection module
|
|
* @return the detected protocol even if the flow is not completed;
|
|
*
|
|
*/
|
|
ndpi_protocol ndpi_detection_giveup(struct ndpi_detection_module_struct *ndpi_struct,
|
|
struct ndpi_flow_struct *flow);
|
|
|
|
/**
|
|
* Processes an extra packet in order to get more information for a given protocol
|
|
* (like SSL getting both client and server certificate even if we already know after
|
|
* seeing the client certificate what the protocol is)
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par flow = pointer to the connection state machine
|
|
* @par packet = unsigned char pointer to the Layer 3 (IP header)
|
|
* @par packetlen = the length of the packet
|
|
* @par current_tick = the current timestamp for the packet
|
|
* @par src = pointer to the source subscriber state machine
|
|
* @par dst = pointer to the destination subscriber state machine
|
|
* @return void
|
|
*
|
|
*/
|
|
void ndpi_process_extra_packet(struct ndpi_detection_module_struct *ndpi_struct,
|
|
struct ndpi_flow_struct *flow,
|
|
const unsigned char *packet,
|
|
const unsigned short packetlen,
|
|
const u_int64_t current_tick,
|
|
struct ndpi_id_struct *src,
|
|
struct ndpi_id_struct *dst);
|
|
|
|
|
|
/**
|
|
* Processes one packet and returns the ID of the detected protocol.
|
|
* This is the MAIN PACKET PROCESSING FUNCTION.
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par flow = pointer to the connection state machine
|
|
* @par packet = unsigned char pointer to the Layer 3 (IP header)
|
|
* @par packetlen = the length of the packet
|
|
* @par current_tick = the current timestamp for the packet
|
|
* @par src = pointer to the source subscriber state machine
|
|
* @par dst = pointer to the destination subscriber state machine
|
|
* @return the detected ID of the protocol
|
|
*
|
|
*/
|
|
ndpi_protocol ndpi_detection_process_packet(struct ndpi_detection_module_struct *ndpi_struct,
|
|
struct ndpi_flow_struct *flow,
|
|
const unsigned char *packet,
|
|
const unsigned short packetlen,
|
|
const u_int64_t current_tick,
|
|
struct ndpi_id_struct *src,
|
|
struct ndpi_id_struct *dst);
|
|
|
|
|
|
/**
|
|
* Get the main protocol of the passed flows for the detected module
|
|
*
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par flow = the flow given for the detection module
|
|
* @return the ID of the master protocol detected
|
|
*
|
|
*/
|
|
u_int16_t ndpi_get_flow_masterprotocol(struct ndpi_detection_module_struct *ndpi_struct,
|
|
struct ndpi_flow_struct *flow);
|
|
|
|
|
|
/**
|
|
* Query the pointer to the layer 4 packet
|
|
*
|
|
* @par l3 = pointer to the layer 3 data
|
|
* @par l3_len = length of the layer 3 data
|
|
* @par l4_return = address to the pointer of the layer 4 data if return value == 0, else undefined
|
|
* @par l4_len_return = length of the layer 4 data if return value == 0, else undefined
|
|
* @par l4_protocol_return = protocol of the layer 4 data if return value == 0, undefined otherwise
|
|
* @par flags = limit operation on ipv4 or ipv6 packets. Possible values: NDPI_DETECTION_ONLY_IPV4 - NDPI_DETECTION_ONLY_IPV6 - 0 (any)
|
|
* @return 0 if layer 4 data could be found correctly;
|
|
else != 0
|
|
*
|
|
*/
|
|
u_int8_t ndpi_detection_get_l4(const u_int8_t *l3, u_int16_t l3_len, const u_int8_t **l4_return, u_int16_t *l4_len_return,
|
|
u_int8_t *l4_protocol_return, u_int32_t flags);
|
|
|
|
|
|
/**
|
|
* Search and return the protocol based on matched ports
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par shost = source address in host byte order
|
|
* @par sport = source port number
|
|
* @par dhost = destination address in host byte order
|
|
* @par dport = destination port number
|
|
* @return the struct ndpi_protocol that match the port base protocol
|
|
*
|
|
*/
|
|
ndpi_protocol ndpi_find_port_based_protocol(struct ndpi_detection_module_struct *ndpi_struct/* , u_int8_t proto */,
|
|
u_int32_t shost,
|
|
u_int16_t sport,
|
|
u_int32_t dhost,
|
|
u_int16_t dport);
|
|
|
|
|
|
/**
|
|
* Search and return the protocol guessed that is undetected
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par proto = the l4 protocol number
|
|
* @par shost = source address in host byte order
|
|
* @par sport = source port number
|
|
* @par dhost = destination address in host byte order
|
|
* @par dport = destination port number
|
|
* @return the struct ndpi_protocol that match the port base protocol
|
|
*
|
|
*/
|
|
ndpi_protocol ndpi_guess_undetected_protocol(struct ndpi_detection_module_struct *ndpi_struct,
|
|
u_int8_t proto,
|
|
u_int32_t shost,
|
|
u_int16_t sport,
|
|
u_int32_t dhost,
|
|
u_int16_t dport);
|
|
|
|
|
|
/**
|
|
* Check if the string passed match with a protocol
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par string_to_match = the string to match
|
|
* @par string_to_match_len = the length of the string
|
|
* @par is_host_match = value of the second field of struct ndpi_automa
|
|
* @return the ID of the matched subprotocol
|
|
*
|
|
*/
|
|
int ndpi_match_string_subprotocol(struct ndpi_detection_module_struct *ndpi_struct,
|
|
char *string_to_match,
|
|
u_int string_to_match_len,
|
|
u_int8_t is_host_match);
|
|
|
|
|
|
/**
|
|
* Check if the host passed match with a protocol
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par flow = the flow where match the host
|
|
* @par string_to_match = the string to match
|
|
* @par string_to_match_len = the length of the string
|
|
* @par master_protocol_id = value of the ID associated to the master protocol detected
|
|
* @return the ID of the matched subprotocol
|
|
*
|
|
*/
|
|
int ndpi_match_host_subprotocol(struct ndpi_detection_module_struct *ndpi_struct,
|
|
struct ndpi_flow_struct *flow,
|
|
char *string_to_match,
|
|
u_int string_to_match_len,
|
|
u_int16_t master_protocol_id);
|
|
|
|
|
|
/**
|
|
* Check if the string content passed match with a protocol
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par flow = the flow where match the host
|
|
* @par string_to_match = the string to match
|
|
* @par string_to_match_len = the length of the string
|
|
* @par master_protocol_id = value of the ID associated to the master protocol detected
|
|
* @return the ID of the matched subprotocol
|
|
*
|
|
*/
|
|
int ndpi_match_content_subprotocol(struct ndpi_detection_module_struct *ndpi_struct,
|
|
struct ndpi_flow_struct *flow,
|
|
char *string_to_match,
|
|
u_int string_to_match_len,
|
|
u_int16_t master_protocol_id);
|
|
|
|
|
|
/**
|
|
* Check if the string -bigram_to_match- match with a bigram of -automa-
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par automa = the struct ndpi_automa for the bigram
|
|
* @par bigram_to_match = the bigram string to match
|
|
* @return 0
|
|
*
|
|
*/
|
|
int ndpi_match_bigram(struct ndpi_detection_module_struct *ndpi_mod,
|
|
ndpi_automa *automa,
|
|
char *bigram_to_match);
|
|
|
|
/**
|
|
* Write the protocol name in the buffer -buf- as master_protocol.protocol
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par proto = the struct ndpi_protocol contain the protocols name
|
|
* @par buf = the buffer to write the name of the protocols
|
|
* @par buf_len = the length of the buffer
|
|
* @return the buffer contains the master_protocol and protocol name
|
|
*
|
|
*/
|
|
char* ndpi_protocol2name(struct ndpi_detection_module_struct *ndpi_mod, ndpi_protocol proto, char *buf, u_int buf_len);
|
|
|
|
/**
|
|
* Find out if a given category is custom/user-defined
|
|
*
|
|
* @par category = the category associated to the protocol
|
|
* @return 1 if this is a custom user category, 0 otherwise
|
|
*
|
|
*/
|
|
int ndpi_is_custom_category(ndpi_protocol_category_t category);
|
|
|
|
/**
|
|
* Overwrite a protocol category defined by nDPI with the custom category
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par protoId = the protocol identifier to overwrite
|
|
* @par breed = the breed to be associated to the protocol
|
|
*
|
|
*/
|
|
void ndpi_set_proto_breed(struct ndpi_detection_module_struct *ndpi_mod,
|
|
u_int16_t protoId, ndpi_protocol_breed_t breed);
|
|
|
|
/**
|
|
* Overwrite a protocol category defined by nDPI with the custom category
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par protoId = the protocol identifier to overwrite
|
|
* @par category = the category associated to the protocol
|
|
*
|
|
*/
|
|
void ndpi_set_proto_category(struct ndpi_detection_module_struct *ndpi_mod,
|
|
u_int16_t protoId, ndpi_protocol_category_t protoCategory);
|
|
|
|
/**
|
|
* Get protocol category as string
|
|
*
|
|
* @par category = the category associated to the protocol
|
|
* @return the string name of the category
|
|
*
|
|
*/
|
|
const char* ndpi_category_str(ndpi_protocol_category_t category);
|
|
|
|
/**
|
|
* Get protocol category
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par proto = the struct ndpi_protocol contain the protocols name
|
|
* @return the protocol category
|
|
*/
|
|
ndpi_protocol_category_t ndpi_get_proto_category(struct ndpi_detection_module_struct *ndpi_mod, ndpi_protocol proto);
|
|
|
|
/**
|
|
* Get the protocol name associated to the ID
|
|
*
|
|
* @par mod = the detection module
|
|
* @par proto_id = the ID of the protocol
|
|
* @return the buffer contains the master_protocol and protocol name
|
|
*
|
|
*/
|
|
char* ndpi_get_proto_name(struct ndpi_detection_module_struct *mod, u_int16_t proto_id);
|
|
|
|
|
|
/**
|
|
* Return the protocol breed ID associated to the protocol
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par proto = the ID of the protocol
|
|
* @return the breed ID associated to the protocol
|
|
*
|
|
*/
|
|
ndpi_protocol_breed_t ndpi_get_proto_breed(struct ndpi_detection_module_struct *ndpi_struct, u_int16_t proto);
|
|
|
|
|
|
/**
|
|
* Return the string name of the protocol breed
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par breed_id = the breed ID associated to the protocol
|
|
* @return the string name of the breed ID
|
|
*
|
|
*/
|
|
char* ndpi_get_proto_breed_name(struct ndpi_detection_module_struct *ndpi_struct, ndpi_protocol_breed_t breed_id);
|
|
|
|
|
|
/**
|
|
* Return the ID of the protocol
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par proto = the ID of the protocol
|
|
* @return the string name of the breed ID
|
|
*
|
|
*/
|
|
int ndpi_get_protocol_id(struct ndpi_detection_module_struct *ndpi_mod, char *proto);
|
|
|
|
|
|
/**
|
|
* Write the list of the supported protocols
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
*/
|
|
void ndpi_dump_protocols(struct ndpi_detection_module_struct *mod);
|
|
|
|
|
|
/**
|
|
* Read a file and load the protocols
|
|
*
|
|
* Format: <tcp|udp>:<port>,<tcp|udp>:<port>,.....@<proto>
|
|
*
|
|
* Example:
|
|
* tcp:80,tcp:3128@HTTP
|
|
* udp:139@NETBIOS
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par path = the path of the file
|
|
* @return 0 if the file is loaded correctly;
|
|
* -1 else
|
|
*
|
|
*/
|
|
int ndpi_load_protocols_file(struct ndpi_detection_module_struct *ndpi_mod, char* path);
|
|
|
|
|
|
/**
|
|
* Get the total number of the supported protocols
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @return the number of protocols
|
|
*
|
|
*/
|
|
u_int ndpi_get_num_supported_protocols(struct ndpi_detection_module_struct *ndpi_mod);
|
|
|
|
|
|
/**
|
|
* Get the nDPI version release
|
|
*
|
|
* @return the NDPI_GIT_RELEASE
|
|
*
|
|
*/
|
|
char* ndpi_revision(void);
|
|
|
|
|
|
/**
|
|
* Set the automa for the protocol search
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par automa = the automa to match
|
|
*
|
|
*/
|
|
void ndpi_set_automa(struct ndpi_detection_module_struct *ndpi_struct, void* automa);
|
|
|
|
|
|
#ifdef NDPI_PROTOCOL_HTTP
|
|
/**
|
|
* Retrieve information for HTTP flows
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par flow = the detected flow
|
|
* @return the HTTP method information about the flow
|
|
*
|
|
*/
|
|
ndpi_http_method ndpi_get_http_method(struct ndpi_detection_module_struct *ndpi_mod, struct ndpi_flow_struct *flow);
|
|
|
|
|
|
/**
|
|
* Get the HTTP url
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par flow = the detected flow
|
|
* @return the HTTP method information about the flow
|
|
*
|
|
*/
|
|
char* ndpi_get_http_url(struct ndpi_detection_module_struct *ndpi_mod, struct ndpi_flow_struct *flow);
|
|
|
|
|
|
/**
|
|
* Get the HTTP content-type
|
|
*
|
|
* @par ndpi_mod = the detection module
|
|
* @par flow = the detected flow
|
|
* @return the HTTP method information about the flow
|
|
*
|
|
*/
|
|
char* ndpi_get_http_content_type(struct ndpi_detection_module_struct *ndpi_mod, struct ndpi_flow_struct *flow);
|
|
#endif
|
|
|
|
|
|
#ifdef NDPI_PROTOCOL_TOR
|
|
/**
|
|
* Check if the flow could be detected as TOR protocol
|
|
*
|
|
* @par ndpi_struct = the detection module
|
|
* @par flow = the detected flow
|
|
* @par certificate = the ssl certificate
|
|
* @return 1 if the flow is TOR;
|
|
* 0 else
|
|
*
|
|
*/
|
|
int ndpi_is_ssl_tor(struct ndpi_detection_module_struct *ndpi_struct,
|
|
struct ndpi_flow_struct *flow, char *certificate);
|
|
#endif
|
|
|
|
/* Wrappers functions */
|
|
/**
|
|
* Init Aho-Corasick automata
|
|
*
|
|
* @return The requested automata, or NULL if an error occurred
|
|
*
|
|
*/
|
|
void* ndpi_init_automa(void);
|
|
|
|
|
|
/**
|
|
* Free Aho-Corasick automata allocated with ndpi_init_automa();
|
|
*
|
|
* @par The automata initialized with ndpi_init_automa();
|
|
*
|
|
*/
|
|
void ndpi_free_automa(void *_automa);
|
|
|
|
|
|
/**
|
|
* Add a string to match to an automata
|
|
*
|
|
* @par The automata initialized with ndpi_init_automa();
|
|
* @par The (sub)string to search
|
|
* @par The number associated with this string
|
|
* @return 0 in case of no error, or -1 if an error occurred.
|
|
*
|
|
*/
|
|
int ndpi_add_string_value_to_automa(void *_automa, char *str, unsigned long num);
|
|
|
|
|
|
/**
|
|
* Add a string to match to an automata. Same as ndpi_add_string_value_to_automa() with num set to 1
|
|
*
|
|
* @par The automata initialized with ndpi_init_automa();
|
|
* @par The (sub)string to search
|
|
* @return 0 in case of no error, or -1 if an error occurred.
|
|
*
|
|
*/
|
|
int ndpi_add_string_to_automa(void *_automa, char *str);
|
|
|
|
|
|
/**
|
|
* Finalize the automa (necessary before start searching)
|
|
*
|
|
* @par The automata initialized with ndpi_init_automa();
|
|
*
|
|
*/
|
|
void ndpi_finalize_automa(void *_automa);
|
|
|
|
|
|
/**
|
|
* Add a string to match to an automata
|
|
*
|
|
* @par The automata initialized with ndpi_init_automa();
|
|
* @par The (sub)string to search
|
|
* @return 0 in case of match, or -1 if no match, or -2 if an error occurred.
|
|
*
|
|
*/
|
|
int ndpi_match_string(void *_automa, char *string_to_match);
|
|
|
|
|
|
/**
|
|
* Add a string to match to an automata
|
|
*
|
|
* @par The automata initialized with ndpi_init_automa();
|
|
* @par The (sub)string to search
|
|
* @par The id associated with the matched string or 0 id not found.
|
|
* @return 0 in case of match, or -1 if no match, or -2 if an error occurred.
|
|
*
|
|
*/
|
|
int ndpi_match_string_id(void *_automa, char *string_to_match, unsigned long *id);
|
|
|
|
|
|
/* Utility functions to set ndpi malloc/free/print wrappers */
|
|
void set_ndpi_malloc(void* (*__ndpi_malloc)(size_t size));
|
|
void set_ndpi_free(void (*__ndpi_free)(void *ptr));
|
|
void set_ndpi_flow_malloc(void* (*__ndpi_flow_malloc)(size_t size));
|
|
void set_ndpi_flow_free(void (*__ndpi_flow_free)(void *ptr));
|
|
void set_ndpi_debug_function(struct ndpi_detection_module_struct *ndpi_str, ndpi_debug_function_ptr ndpi_debug_printf);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __NDPI_API_H__ */
|