public.h
Go to the documentation of this file.
1 /*
2  ** public.h
3  ** fixbuf IPFIX Implementation Public Interface
4  **
5  ** ------------------------------------------------------------------------
6  ** Copyright (C) 2006-2019 Carnegie Mellon University. All Rights Reserved.
7  ** ------------------------------------------------------------------------
8  ** Authors: Brian Trammell, Dan Ruef
9  ** ------------------------------------------------------------------------
10  ** @OPENSOURCE_LICENSE_START@
11  ** libfixbuf 2.0
12  **
13  ** Copyright 2018-2019 Carnegie Mellon University. All Rights Reserved.
14  **
15  ** NO WARRANTY. THIS CARNEGIE MELLON UNIVERSITY AND SOFTWARE
16  ** ENGINEERING INSTITUTE MATERIAL IS FURNISHED ON AN "AS-IS"
17  ** BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND,
18  ** EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT
19  ** LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY,
20  ** EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE
21  ** MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF
22  ** ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR
23  ** COPYRIGHT INFRINGEMENT.
24  **
25  ** Released under a GNU-Lesser GPL 3.0-style license, please see
26  ** LICENSE.txt or contact permission@sei.cmu.edu for full terms.
27  **
28  ** [DISTRIBUTION STATEMENT A] This material has been approved for
29  ** public release and unlimited distribution. Please see Copyright
30  ** notice for non-US Government use and distribution.
31  **
32  ** Carnegie Mellon(R) and CERT(R) are registered in the U.S. Patent
33  ** and Trademark Office by Carnegie Mellon University.
34  **
35  ** DM18-0325
36  ** @OPENSOURCE_LICENSE_END@
37  **
38  ** ------------------------------------------------------------------------
39  */
40 
975 #ifndef _FB_PUBLIC_H_
976 #define _FB_PUBLIC_H_
977 #include <fixbuf/autoinc.h>
978 #include <fixbuf/version.h>
979 
980 #ifdef __cplusplus
981 extern "C" {
982 #endif
983 
984 
989 #define FIXBUF_CHECK_VERSION(major, minor, release) \
990  (FIXBUF_VERSION_MAJOR > (major) || \
991  (FIXBUF_VERSION_MAJOR == (major) && FIXBUF_VERSION_MINOR > (minor)) || \
992  (FIXBUF_VERSION_MAJOR == (major) && FIXBUF_VERSION_MINOR == (minor) && \
993  FIXBUF_VERSION_RELEASE >= (release)))
994 
995 /*
996  * Error Handling Definitions
997  */
998 
1000 #define FB_ERROR_DOMAIN g_quark_from_string("fixbufError")
1001 
1002 #define FB_ERROR_TMPL 1
1003 
1007 #define FB_ERROR_EOM 2
1008 
1013 #define FB_ERROR_EOF 3
1014 
1018 #define FB_ERROR_IPFIX 4
1019 
1024 #define FB_ERROR_BUFSZ 5
1025 
1026 #define FB_ERROR_IMPL 6
1027 
1028 #define FB_ERROR_IO 7
1029 
1033 #define FB_ERROR_NLREAD 8
1034 
1039 #define FB_ERROR_NLWRITE 9
1040 
1043 #define FB_ERROR_NOELEMENT 10
1044 
1047 #define FB_ERROR_CONN 11
1048 
1052 #define FB_ERROR_NETFLOWV9 12
1053 
1056 #define FB_ERROR_TRANSMISC 13
1057 
1060 #define FB_ERROR_SFLOW 14
1061 
1064 #define FB_ERROR_SETUP 15
1065 
1068 #define FB_ERROR_LAXSIZE 16
1069 
1070 /*
1071  * Public Datatypes and Constants
1072  */
1073 
1079 typedef struct fBuf_st fBuf_t;
1080 
1087 typedef struct fbVarfield_st {
1089  size_t len;
1096  uint8_t *buf;
1097 } fbVarfield_t;
1098 
1099 
1104 typedef struct fbInfoModel_st fbInfoModel_t;
1105 
1109 typedef GHashTableIter fbInfoModelIter_t;
1110 
1116 #define FB_IE_INIT_FULL(_name_, _ent_, _num_, _len_, _flags_, _min_, _max_, _type_, _desc_)\
1117  { {(const struct fbInfoElement_st*)_name_}, 0, _ent_, _num_, _len_, _flags_, _min_, _max_, _type_, _desc_ }
1118 
1125 #define FB_IE_INIT(_name_, _ent_, _num_, _len_, _flags_) \
1126  FB_IE_INIT_FULL(_name_, _ent_, _num_, _len_, _flags_, 0, 0, 0, (char*)NULL)
1127 
1128 
1134 #define FB_IE_NULL FB_IE_INIT(NULL, 0, 0, 0, 0)
1135 
1142 #define FB_IE_SEMANTIC(flags) ((flags & 0x0000ff00) >> 8)
1143 
1149 #define FB_IE_UNITS(flags) ((flags & 0xFFFF0000) >> 16)
1150 
1155 #define FB_IE_F_NONE 0x00000000
1156 
1162 #define FB_IE_F_ENDIAN 0x00000001
1163 
1175 #define FB_IE_F_REVERSIBLE 0x00000040
1176 
1185 #define FB_IE_F_ALIEN 0x00000080
1186 
1191 #define FB_IE_QUANTITY 0x00000100
1192 
1198 #define FB_IE_TOTALCOUNTER 0x00000200
1199 
1204 #define FB_IE_DELTACOUNTER 0x00000300
1205 
1210 #define FB_IE_IDENTIFIER 0x00000400
1211 
1216 #define FB_IE_FLAGS 0x00000500
1217 
1223 #define FB_IE_LIST 0x00000600
1224 
1230 #define FB_IE_SNMPCOUNTER 0x00000700
1231 
1237 #define FB_IE_SNMPGAUGE 0x00000800
1238 
1244 #define FB_IE_DEFAULT 0x00000000
1245 
1256 #define FB_UNITS_BITS 0x00010000
1257 
1262 #define FB_UNITS_OCTETS 0x00020000
1263 
1268 #define FB_UNITS_PACKETS 0x00030000
1269 
1274 #define FB_UNITS_FLOWS 0x00040000
1275 
1280 #define FB_UNITS_SECONDS 0x00050000
1281 
1286 #define FB_UNITS_MILLISECONDS 0x00060000
1287 
1292 #define FB_UNITS_MICROSECONDS 0x00070000
1293 
1298 #define FB_UNITS_NANOSECONDS 0x00080000
1299 
1304 #define FB_UNITS_WORDS 0x00090000
1305 
1310 #define FB_UNITS_MESSAGES 0x000A0000
1311 
1316 #define FB_UNITS_HOPS 0x000B0000
1317 
1322 #define FB_UNITS_ENTRIES 0x000C0000
1323 
1328 #define FB_UNITS_FRAMES 0x000D0000
1329 
1334 #define FB_UNITS_PORTS 0x000E0000
1335 
1340 #define FB_UNITS_INFERRED 0x000F0000
1341 
1345 #define FB_IE_VARLEN 65535
1346 
1355 #define FB_IE_BASIC_LIST 291
1356 
1364 #define FB_IE_SUBTEMPLATE_LIST 292
1365 
1373 #define FB_IE_SUBTEMPLATE_MULTILIST 293
1374 
1383 #define FB_IE_PEN_REVERSE 29305
1384 
1393 #define FB_IE_VENDOR_BIT_REVERSE 0x4000
1394 
1400 #define FB_CISCO_GENERIC 9999
1401 
1408 #define FB_CISCO_ASA_EVENT_ID 9998
1409 
1418 #define FB_CISCO_ASA_EVENT_XTRA 9997
1419 
1424 #define FB_IE_REVERSE_STR "reverse"
1425 
1427 #define FB_IE_REVERSE_STRLEN 7
1428 
1510 
1519 typedef struct fbInfoElement_st {
1521  union {
1527  const struct fbInfoElement_st *canon;
1532  const char *name;
1533  } ref;
1534 
1540  uint32_t midx;
1542  uint32_t ent;
1547  uint16_t num;
1549  uint16_t len;
1552  uint32_t flags;
1554  uint64_t min;
1556  uint64_t max;
1558  uint8_t type;
1560  const char *description;
1561 } fbInfoElement_t;
1562 
1587 typedef struct fbInfoElementOptRec_st {
1589  uint32_t ie_pen;
1591  uint16_t ie_id;
1593  uint8_t ie_type;
1595  uint8_t ie_semantic;
1597  uint16_t ie_units;
1599  uint8_t padding[6];
1601  uint64_t ie_range_begin;
1603  uint64_t ie_range_end;
1609 
1610 
1623 #define FB_TID_AUTO 0
1624 
1628 #define FB_TID_TS 2
1629 
1633 #define FB_TID_OTS 3
1634 
1638 #define FB_TID_MIN_DATA 256
1639 
1646 
1652 #define FB_IESPEC_NULL { NULL, 0, 0 }
1653 
1660 typedef struct fbInfoElementSpec_st {
1662  char *name;
1674  uint16_t len_override;
1681  uint32_t flags;
1683 
1690 typedef struct fbSession_st fbSession_t;
1691 
1693 typedef enum fbTransport_en {
1720 } fbTransport_t;
1721 
1726 typedef struct fbConnSpec_st {
1730  char *host;
1732  char *svc;
1745  void *vai;
1750  void *vssl_ctx;
1751 } fbConnSpec_t;
1752 
1756 #define FB_CONNSPEC_INIT { FB_SCTP, NULL, NULL, \
1757  NULL, NULL, NULL, NULL, \
1758  NULL, NULL }
1759 
1760 #if HAVE_SPREAD
1761 
1765 #define FB_SPREADPARAMS_INIT { 0, 0, 0 }
1766 
1772 typedef struct fbSpreadParams_st {
1778  char * daemon;
1781  char ** groups;
1783 
1784 #endif /* HAVE_SPREAD */
1785 
1791 typedef struct fbExporter_st fbExporter_t;
1792 
1800 typedef struct fbCollector_st fbCollector_t;
1801 
1808 typedef struct fbListener_st fbListener_t;
1809 
1810 /*
1811  * ListenerGroup and associated data type definitions
1812  */
1813 
1817 typedef struct fbListenerGroup_st fbListenerGroup_t;
1818 
1822 typedef struct fbListenerEntry_st {
1830 
1844 
1856 typedef void (*fbTemplateCtxFree_fn)(
1857  void *tmpl_ctx,
1858  void *app_ctx);
1859 
1883 typedef void (*fbNewTemplateCallback_fn) (
1884  fbSession_t *session,
1885  uint16_t tid,
1886  fbTemplate_t *tmpl,
1887  void *app_ctx,
1888  void **tmpl_ctx,
1889  fbTemplateCtxFree_fn *tmpl_ctx_free_fn);
1890 
1891 
1899 #define FB_LIST_SEM_UNDEFINED 0xFF
1900 
1903 #define FB_LIST_SEM_NONE_OF 0x00
1904 
1907 #define FB_LIST_SEM_EXACTLY_ONE_OF 0x01
1908 
1911 #define FB_LIST_SEM_ONE_OR_MORE_OF 0x02
1912 
1915 #define FB_LIST_SEM_ALL_OF 0x03
1916 
1919 #define FB_LIST_SEM_ORDERED 0x04
1920 
1928 gboolean fbListValidSemantic(
1929  uint8_t semantic);
1930 
1931 /****** BASICLIST FUNCTIONS AND STRUCTS *******/
1937 typedef struct fbBasicList_st {
1941  uint8_t *dataPtr;
1943  uint16_t numElements;
1945  uint16_t dataLength;
1947  uint8_t semantic;
1948 } fbBasicList_t;
1949 
1950 
1957  void);
1958 
1971 void* fbBasicListInit(
1972  fbBasicList_t *basicList,
1973  uint8_t semantic,
1974  const fbInfoElement_t *infoElement,
1975  uint16_t numElements);
1976 
1992  fbBasicList_t *basicList,
1993  uint8_t semantic,
1994  const fbInfoElement_t *infoElement,
1995  uint16_t numElements,
1996  uint16_t dataLength,
1997  uint8_t *dataPtr);
1998 
2012  fbBasicList_t *basicList);
2013 
2020 uint16_t fbBasicListCountElements(
2021  const fbBasicList_t *basicList);
2022 
2030 uint8_t fbBasicListGetSemantic(
2031  fbBasicList_t *basicList);
2032 
2042  fbBasicList_t *basicList,
2043  uint8_t semantic);
2044 
2053  fbBasicList_t *basicList);
2054 
2060 void* fbBasicListGetDataPtr(
2061  fbBasicList_t *basicList);
2062 
2073  fbBasicList_t *basicList,
2074  uint16_t index);
2075 
2087 void* fbBasicListGetNextPtr(
2088  fbBasicList_t *basicList,
2089  void *currentPtr);
2090 
2104 void* fbBasicListRealloc(
2105  fbBasicList_t *basicList,
2106  uint16_t newNumElements);
2107 
2116  fbBasicList_t *basicList,
2117  uint16_t numNewElements);
2118 
2127 void fbBasicListClear(
2128  fbBasicList_t *basicList);
2129 
2138  fbBasicList_t *basicList);
2139 
2147 void fbBasicListFree(
2148  fbBasicList_t *basicList);
2149 
2150 
2151 /******* END OF BASICLIST ********/
2152 
2153 
2154 
2155 /******* SUBTEMPLATELIST FUNCTIONS ****/
2156 
2164 typedef struct fbSubTemplateList_st {
2167  union {
2168  size_t length;
2169  uint64_t extra;
2170  } dataLength;
2174  uint8_t *dataPtr;
2176  uint16_t tmplID;
2178  uint16_t numElements;
2180  uint8_t semantic;
2182 
2190  void);
2191 
2209 void* fbSubTemplateListInit(
2210  fbSubTemplateList_t *sTL,
2211  uint8_t semantic,
2212  uint16_t tmplID,
2213  const fbTemplate_t *tmpl,
2214  uint16_t numElements);
2215 
2232  fbSubTemplateList_t *subTemplateList,
2233  uint8_t semantic,
2234  uint16_t tmplID,
2235  const fbTemplate_t *tmpl,
2236  uint16_t numElements,
2237  uint16_t dataLength,
2238  uint8_t *dataPtr);
2239 
2255  fbSubTemplateList_t *STL);
2256 
2263  const fbSubTemplateList_t *subTemplateList);
2264 
2275  const fbSubTemplateList_t *subTemplateList,
2276  uint16_t index);
2277 
2290  const fbSubTemplateList_t *subTemplateList,
2291  void *currentPtr);
2292 
2300  const fbSubTemplateList_t *subTemplateList);
2301 
2309  fbSubTemplateList_t *subTemplateList,
2310  uint8_t semantic);
2311 
2318  fbSubTemplateList_t *subTemplateList);
2319 
2326  fbSubTemplateList_t *subTemplateList);
2327 
2334  fbSubTemplateList_t *subTemplateList);
2335 
2352  fbSubTemplateList_t *subTemplateList,
2353  uint16_t newNumElements);
2354 
2365  fbSubTemplateList_t *subTemplateList,
2366  uint16_t numNewElements);
2367 
2384  fbSubTemplateList_t *subTemplateList);
2385 
2395  fbSubTemplateList_t *subTemplateList);
2396 
2406  fbSubTemplateList_t *subTemplateList);
2407 
2408 /********* END OF SUBTEMPLATELIST **********/
2430  uint8_t *dataPtr;
2432  size_t dataLength;
2434  uint16_t tmplID;
2436  uint16_t numElements;
2438 
2447  uint16_t numElements;
2449  uint8_t semantic;
2451 
2452 
2461  void);
2462 
2463 
2475  uint8_t semantic,
2476  uint16_t numElements);
2477 
2486  const fbSubTemplateMultiList_t *STML);
2487 
2496  uint8_t semantic);
2497 
2504  fbSubTemplateMultiList_t *STML);
2505 
2515  fbSubTemplateMultiList_t *STML);
2516 
2532  fbSubTemplateMultiList_t *STML);
2533 
2542  fbSubTemplateMultiList_t *STML);
2543 
2560  uint16_t newNumEntries);
2561 
2572  uint16_t numNewEntries);
2573 
2580  fbSubTemplateMultiList_t *STML);
2581 
2592  uint16_t index);
2593 
2607  fbSubTemplateMultiListEntry_t *currentEntry);
2608 
2625  uint16_t tmplID,
2626  fbTemplate_t *tmpl,
2627  uint16_t numElements);
2628 
2648  uint16_t newNumElements);
2649 
2661  uint16_t numNewElements);
2662 
2674 
2683 
2697  void *currentPtr);
2698 
2711  uint16_t index);
2712 
2721  const fbSubTemplateMultiListEntry_t *entry);
2722 
2731 
2740 
2741 /************** END OF STML FUNCTIONS *********** */
2742 
2759 void fBufListFree(
2760  fbTemplate_t *tmpl,
2761  uint8_t *record);
2762 
2763 
2773  void);
2774 
2781 void fbListenerGroupFree(
2782  fbListenerGroup_t *group);
2783 
2794  fbListenerGroup_t *group,
2795  const fbListener_t *listener);
2796 
2807  fbListenerGroup_t *group,
2808  const fbListener_t *listener);
2809 
2823  fbListenerGroup_t *group,
2824  GError **err);
2825 
2832  fbListenerGroupResult_t *result);
2833 
2847  fbListener_t *listener,
2848  int sock,
2849  GError **err);
2850 
2861  fbListener_t *listener,
2862  int sock,
2863  GError **err);
2864 
2870 void fBufInterruptSocket(
2871  fBuf_t *fbuf);
2872 
2873 
2895 typedef gboolean (*fbListenerAppInit_fn) (
2896  fbListener_t *listener,
2897  void **ctx,
2898  int fd,
2899  struct sockaddr *peer,
2900  size_t peerlen,
2901  GError **err);
2902 
2912 typedef void (*fbListenerAppFree_fn) (
2913  void *ctx);
2914 
2915 /*
2916  * Public Function Calls. These calls will remain available and retain
2917  * their functionality in all subsequent versions of libfixbuf.
2918  */
2919 
2920 
2937 gboolean fBufSetInternalTemplate(
2938  fBuf_t *fbuf,
2939  uint16_t int_tid,
2940  GError **err);
2941 
2959 gboolean fBufSetExportTemplate(
2960  fBuf_t *fbuf,
2961  uint16_t ext_tid,
2962  GError **err);
2963 
2964 #if HAVE_SPREAD
2965 
2981  fBuf_t *fbuf,
2982  char **groups,
2983  int num_groups,
2984  GError **err);
2985 #endif /* HAVE_SPREAD */
2986 
3009  fBuf_t *fbuf,
3010  gboolean automatic);
3011 
3032 gboolean fBufSetAutomaticInsert(
3033  fBuf_t *fbuf,
3034  GError **err);
3035 
3036 
3045  fBuf_t *fbuf);
3046 
3055 void fBufFree(
3056  fBuf_t *fbuf);
3057 
3071  fbSession_t *session,
3072  fbExporter_t *exporter);
3073 
3084  fBuf_t *fbuf);
3085 
3096 void fBufSetExporter(
3097  fBuf_t *fbuf,
3098  fbExporter_t *exporter);
3099 
3100 
3112 size_t fBufRemaining(
3113  fBuf_t *fbuf);
3114 
3115 
3128 void fBufSetBuffer(
3129  fBuf_t *fbuf,
3130  uint8_t *buf,
3131  size_t buflen);
3132 
3133 
3157 gboolean fBufAppend(
3158  fBuf_t *fbuf,
3159  uint8_t *recbase,
3160  size_t recsize,
3161  GError **err);
3162 
3172 gboolean fBufEmit(
3173  fBuf_t *fbuf,
3174  GError **err);
3175 
3187 void fBufSetExportTime(
3188  fBuf_t *fbuf,
3189  uint32_t extime);
3190 
3208  fbSession_t *session,
3209  fbCollector_t *collector);
3210 
3221  fBuf_t *fbuf);
3222 
3233 void fBufSetCollector(
3234  fBuf_t *fbuf,
3235  fbCollector_t *collector);
3236 
3266 gboolean fBufNext(
3267  fBuf_t *fbuf,
3268  uint8_t *recbase,
3269  size_t *recsize,
3270  GError **err);
3271 
3284 gboolean fBufNextMessage(
3285  fBuf_t *fbuf,
3286  GError **err);
3287 
3295 uint32_t fBufGetExportTime(
3296  fBuf_t *fbuf);
3297 
3318  fBuf_t *fbuf,
3319  uint16_t *ext_tid);
3320 
3340  fBuf_t *fbuf,
3341  uint16_t *ext_tid,
3342  GError **err);
3343 
3359  void);
3360 
3369 void fbInfoModelFree(
3370  fbInfoModel_t *model);
3371 
3387  fbInfoModel_t *model,
3388  fbInfoElement_t *ie);
3389 
3409  fbInfoModel_t *model,
3410  fbInfoElement_t *ie);
3411 
3443 gboolean fbInfoModelReadXMLFile(
3444  fbInfoModel_t *model,
3445  const gchar *filename,
3446  GError **err);
3447 
3480 gboolean fbInfoModelReadXMLData(
3481  fbInfoModel_t *model,
3482  const gchar *xml_data,
3483  gssize xml_data_len,
3484  GError **err);
3485 
3498  fbInfoModel_t *model,
3499  const char *name);
3500 
3515  fbInfoModel_t *model,
3516  uint16_t id,
3517  uint32_t ent);
3518 
3527  const fbInfoModel_t *model);
3528 
3538 void fbInfoModelIterInit(
3539  fbInfoModelIter_t *iter,
3540  const fbInfoModel_t *model);
3541 
3553  fbInfoModelIter_t *iter);
3554 
3569  fbInfoModel_t *model,
3570  GError **err);
3571 
3587  fBuf_t *fbuf,
3588  const fbInfoElement_t *model_ie,
3589  uint16_t itid,
3590  uint16_t etid,
3591  GError **err);
3592 
3605  fbInfoModel_t *model,
3606  fbInfoElementOptRec_t *rec);
3607 
3616 gboolean fbInfoModelTypeInfoRecord(
3617  fbTemplate_t *tmpl);
3618 
3637  fbInfoModel_t *model);
3638 
3656 gboolean fbTemplateAppend(
3657  fbTemplate_t *tmpl,
3658  fbInfoElement_t *ex_ie,
3659  GError **err);
3660 
3678 gboolean fbTemplateAppendSpec(
3679  fbTemplate_t *tmpl,
3680  fbInfoElementSpec_t *spec,
3681  uint32_t flags,
3682  GError **err);
3683 
3699 gboolean fbTemplateAppendSpecArray(
3700  fbTemplate_t *tmpl,
3701  fbInfoElementSpec_t *spec,
3702  uint32_t flags,
3703  GError **err);
3704 
3712 uint32_t fbTemplateCountElements(
3713  fbTemplate_t *tmpl);
3714 
3730  fbTemplate_t *tmpl,
3731  uint16_t scope_count);
3732 
3740 uint32_t fbTemplateGetOptionsScope(
3741  fbTemplate_t *tmpl);
3742 
3756 gboolean fbTemplateContainsElement(
3757  fbTemplate_t *tmpl,
3758  const fbInfoElement_t *ex_ie);
3759 
3772  fbTemplate_t *tmpl,
3773  fbInfoElementSpec_t *spec);
3774 
3787  fbTemplate_t *tmpl,
3788  fbInfoElementSpec_t *spec);
3789 
3805  fbTemplate_t *tmpl,
3806  fbInfoElementSpec_t *spec,
3807  uint32_t flags);
3808 
3818  fbTemplate_t *tmpl,
3819  uint32_t IEindex);
3820 
3821 
3830  fbTemplate_t *tmpl);
3831 
3840  fbTemplate_t *tmpl);
3841 
3849 void *fbTemplateGetContext(
3850  fbTemplate_t *tmpl);
3851 
3859  fbTemplate_t *tmpl);
3860 
3879  fbInfoModel_t *model);
3880 
3895  fbSession_t *session,
3896  gboolean enabled,
3897  GError **err);
3898 
3919  fbSession_t *session,
3920  gboolean enabled,
3921  uint16_t tid,
3922  GError **err);
3923 
3939  fbSession_t *session,
3940  gboolean enabled,
3941  GError **err);
3942 
3961  fbSession_t *session,
3962  gboolean enabled,
3963  uint16_t tid,
3964  GError **err);
3965 
3984  fbSession_t *session,
3985  gboolean internal,
3986  uint16_t tid,
3987  fbTemplate_t *tmpl,
3988  const char *name,
3989  const char *description,
3990  GError **err);
3991 
3999  fbSession_t *session);
4000 
4031  fbSession_t *session,
4032  fbNewTemplateCallback_fn callback,
4033  void *app_ctx);
4034 
4059  fbSession_t *session,
4060  uint16_t ent_tid,
4061  uint16_t int_tid);
4062 
4073  fbSession_t *session,
4074  uint16_t ext_tid);
4075 
4085  fbSession_t *session,
4086  uint16_t ext_tid);
4087 
4097 void fbSessionFree(
4098  fbSession_t *session);
4099 
4113  fbSession_t *session);
4114 
4130 void fbSessionSetDomain(
4131  fbSession_t *session,
4132  uint32_t domain);
4133 
4141 uint32_t fbSessionGetDomain(
4142  fbSession_t *session);
4143 
4155  fbSession_t *session);
4156 
4165  fbSession_t *session);
4166 
4167 #if HAVE_SPREAD
4168 
4191  fbSession_t *session,
4192  char **groups,
4193  gboolean internal,
4194  uint16_t tid,
4195  fbTemplate_t *tmpl,
4196  GError **err);
4197 
4222  fbSession_t *session,
4223  char **groups,
4224  gboolean internal,
4225  uint16_t tid,
4226  fbTemplate_t *tmpl,
4227  char *name,
4228  char *description,
4229  GError **err);
4230 
4231 
4248  fbSession_t *session,
4249  char **groups,
4250  gboolean enabled,
4251  GError **err);
4252 
4273  fbSession_t *session,
4274  char **groups,
4275  gboolean enabled,
4276  uint16_t tid,
4277  GError **err);
4278 
4296  fbSession_t *session,
4297  char **groups,
4298  gboolean enabled,
4299  GError **err);
4300 
4320  fbSession_t *session,
4321  char **groups,
4322  gboolean enabled,
4323  uint16_t tid,
4324  GError **err);
4325 #endif /* HAVE_SPREAD */
4326 
4339 gboolean fbSessionExportTemplate(
4340  fbSession_t *session,
4341  uint16_t tid,
4342  GError **err);
4343 
4355 gboolean fbSessionExportTemplates(
4356  fbSession_t *session,
4357  GError **err);
4358 
4379 uint16_t fbSessionAddTemplate(
4380  fbSession_t *session,
4381  gboolean internal,
4382  uint16_t tid,
4383  fbTemplate_t *tmpl,
4384  GError **err);
4385 
4398 gboolean fbSessionRemoveTemplate(
4399  fbSession_t *session,
4400  gboolean internal,
4401  uint16_t tid,
4402  GError **err);
4403 
4416  fbSession_t *session,
4417  gboolean internal,
4418  uint16_t tid,
4419  GError **err);
4420 
4434  fbConnSpec_t *spec);
4435 
4436 #if HAVE_SPREAD
4437 
4447  fbCollector_t *collector,
4448  char *groups[]);
4449 
4464  fbSpreadParams_t *params);
4465 
4466 #endif /* HAVE_SPREAD */
4467 
4480  const char *path);
4481 
4492  uint8_t *buf,
4493  uint16_t bufsize);
4494 
4495 
4505  FILE *fp);
4506 
4519 void fbExporterSetStream(
4520  fbExporter_t *exporter,
4521  int sctp_stream);
4522 
4536  fbExporter_t *exporter);
4537 
4545 void fbExporterClose(
4546  fbExporter_t *exporter);
4547 
4554 size_t fbExporterGetMsgLen(
4555  fbExporter_t *exporter);
4556 
4570  void *ctx,
4571  const char *path,
4572  GError **err);
4573 
4585  void *ctx,
4586  FILE *fp);
4587 
4588 
4589 #if HAVE_SPREAD
4590 
4601  void *ctx,
4602  fbSpreadParams_t *params,
4603  GError **err);
4604 
4605 #endif /* HAVE_SPREAD */
4606 
4617 void *fbCollectorGetContext(
4618  fbCollector_t *collector);
4619 
4630 void fbCollectorClose(
4631  fbCollector_t *collector);
4632 
4633 
4646  fbCollector_t *collector,
4647  struct sockaddr *address,
4648  size_t address_length);
4649 
4679  fbConnSpec_t *spec,
4680  fbSession_t *session,
4681  fbListenerAppInit_fn appinit,
4682  fbListenerAppFree_fn appfree,
4683  GError **err);
4684 
4692 void fbListenerFree(
4693  fbListener_t *listener);
4694 
4718  fbListener_t *listener,
4719  GError **err);
4720 
4732  fbListener_t *listener,
4733  GError **err);
4734 
4742 void fbListenerInterrupt(
4743  fbListener_t *listener);
4744 
4745 
4756 gboolean fbListenerGetCollector(
4757  fbListener_t *listener,
4758  fbCollector_t **collector,
4759  GError **err);
4760 
4761 
4762 
4763 
4776  fbCollector_t *collector,
4777  GError **err);
4778 
4779 
4792  fbCollector_t *collector,
4793  GError **err);
4794 
4795 
4808  fbCollector_t *collector,
4809  GError **err);
4810 
4830  fbCollector_t *collector,
4831  struct sockaddr *peer,
4832  size_t peerlen,
4833  uint32_t obdomain);
4834 
4850 uint32_t fbCollectorGetSFlowMissed(
4851  fbCollector_t *collector,
4852  struct sockaddr *peer,
4853  size_t peerlen,
4854  uint32_t obdomain);
4855 
4862 struct sockaddr* fbCollectorGetPeer(
4863  fbCollector_t *collector);
4864 
4875  fbCollector_t *collector);
4876 
4900  fbCollector_t *collector,
4901  gboolean multi_session);
4902 
4903 
4904 #ifdef __cplusplus
4905 } /* extern "C" */
4906 #endif
4907 
4908 #endif /* _FB_PUBLIC_H_ */
uint32_t flags
Flags.
Definition: public.h:1552
The "dateTimeMilliseconds" data type: An unsigned 64-bit integer containing the number of millisecond...
Definition: public.h:1485
fbInfoElement_t * fbTemplateGetIndexedIE(fbTemplate_t *tmpl, uint32_t IEindex)
Returns the information element in the template referenced by the index.
void * fbBasicListGetIndexedDataPtr(fbBasicList_t *basicList, uint16_t index)
Retrieves the element at position index in the basic list or returns NULL if index is out of range...
struct fbSubTemplateMultiListEntry_st fbSubTemplateMultiListEntry_t
Entries contain the same type of information at SubTemplateLists: template ID and template pointers t...
void * vssl_ctx
Pointer to SSL context cache.
Definition: public.h:1750
fbSubTemplateMultiListEntry_t * firstEntry
pointer to the first entry in the multi list
Definition: public.h:2445
fbExporter_t * fbExporterAllocFile(const char *path)
Allocates an exporting process endpoint for a named file.
uint8_t ie_type
ie data type
Definition: public.h:1593
uint16_t fbBasicListCountElements(const fbBasicList_t *basicList)
Returns the number of elements the basic list is capable of holding.
uint16_t tmplID
ID of the template used to structure the data.
Definition: public.h:2176
The "dateTimeMicroseconds" data type: Two 32-bit fields where the first is the number seconds since t...
Definition: public.h:1490
void fbTemplateFreeUnused(fbTemplate_t *tmpl)
Frees a template if it is not currently in use by any Session.
uint32_t ie_pen
private enterprise number
Definition: public.h:1589
uint16_t fbSessionSetMetadataExportElements(fbSession_t *session, gboolean enabled, uint16_t tid, GError **err)
Configures a session to export type information for enterprise-specific information elements as optio...
fbExporter_t * fbExporterAllocBuffer(uint8_t *buf, uint16_t bufsize)
Allocates an exporting process for a buffer.
size_t dataLength
length of the buffer used to hold the data in this entry
Definition: public.h:2432
void * fbBasicListGetDataPtr(fbBasicList_t *basicList)
Gets a pointer to the data buffer for the basic list.
uint16_t fbSubTemplateMultiListEntryCountElements(const fbSubTemplateMultiListEntry_t *entry)
Returns the number of entries the sub template multi list entry is capable of holding.
void fbSubTemplateMultiListClearEntries(fbSubTemplateMultiList_t *STML)
Clears the memory used by all the entries of a sub template multi list.
void fbBasicListClearWithoutFree(fbBasicList_t *basicList)
Clears the parameters of the basic list, but does not free the buffer.
uint32_t fbTemplateGetOptionsScope(fbTemplate_t *tmpl)
Determines number of scope information elements in a template.
void * fbSubTemplateMultiListEntryAddNewElements(fbSubTemplateMultiListEntry_t *entry, uint16_t numNewElements)
Allocates space for numNewEntries additional elements in the sub template multi list entry...
fbExporter_t * fbExporterAllocFP(FILE *fp)
Allocates an exporting process endpoint for an opened ANSI C file pointer.
gboolean fBufAppend(fBuf_t *fbuf, uint8_t *recbase, size_t recsize, GError **err)
Appends a record to a buffer.
Partially reliable datagram transport via SCTP.
Definition: public.h:1698
void fBufListFree(fbTemplate_t *tmpl, uint8_t *record)
Clears all of the memory that fixbuf allocated during transcode of this record.
The "unsigned32" data type: A non-negative integer value in the range of 0 to 4_294_967_295 (0xFFFFFF...
Definition: public.h:1447
The "subTemplateList" data type: A structured data element as described in RFC6313, Section 4.5.2.
Definition: public.h:1505
The "signed16" data type: An integer value in the range of -32768 to 32767.
Definition: public.h:1457
struct fbListenerGroupResult_st * next
Pointer to the next listener group result.
Definition: public.h:1838
uint8_t semantic
value used to describe the list of sub templates
Definition: public.h:2449
uint16_t fbSubTemplateListGetTemplateID(fbSubTemplateList_t *subTemplateList)
Gets the template ID for the template used by the list.
void fbBasicListFree(fbBasicList_t *basicList)
Clears the basic list (fbBasicListClear()), then frees the basic list itself.
uint16_t fbSessionAddTemplatesMulticastWithMetadata(fbSession_t *session, char **groups, gboolean internal, uint16_t tid, fbTemplate_t *tmpl, char *name, char *description, GError **err)
Sets and sends templates for 1 or more groups.
const fbInfoElement_t * fbInfoModelGetElementByName(fbInfoModel_t *model, const char *name)
Returns a pointer to the canonical information element within an information model given the informat...
void fbExporterClose(fbExporter_t *exporter)
Forces the file or socket underlying an exporting process endpoint to close.
gboolean fbSessionEnableTypeMetadata(fbSession_t *session, gboolean enabled, GError **err)
Configures a session to export type information for enterprise-specific information elements as optio...
char * host
Hostname to connect/listen to.
Definition: public.h:1730
void fbSessionSetDomain(fbSession_t *session, uint32_t domain)
Sets the current observation domain on a session.
fbCollector_t * fbSessionGetCollector(fbSession_t *session)
Retrieves the collector that was created with the session.
fbCollector_t * fbCollectorAllocSpread(void *ctx, fbSpreadParams_t *params, GError **err)
Allocates a collecting process endpoint for the Spread transport.
uint16_t numElements
number of elements in the list
Definition: public.h:2178
struct fbSpreadParams_st fbSpreadParams_t
Spread connection parameters.
fBuf_t * fbListenerWait(fbListener_t *listener, GError **err)
Waits on a listener.
const fbInfoElement_t * infoElement
pointer to the information element that is repeated in the list
Definition: public.h:1939
The "float64" data type: An IEEE double-precision 64-bit floating point type.
Definition: public.h:1469
uint64_t ie_range_end
ie range max
Definition: public.h:1603
const char * description
description
Definition: public.h:1560
struct fbConnSpec_st fbConnSpec_t
Connection specifier.
void * fbBasicListInitWithOwnBuffer(fbBasicList_t *basicList, uint8_t semantic, const fbInfoElement_t *infoElement, uint16_t numElements, uint16_t dataLength, uint8_t *dataPtr)
use this function to initialize the basic list, but it gets the pointer to a buffer and its length al...
void fBufSetAutomaticMode(fBuf_t *fbuf, gboolean automatic)
Sets the automatic (read/write) mode flag on a buffer.
void * fbSubTemplateMultiListEntryRealloc(fbSubTemplateMultiListEntry_t *entry, uint16_t newNumElements)
Potentially reallocates the entry&#39;s internal buffer and returns a handle to it.
uint64_t min
range min
Definition: public.h:1554
An IPFIX template or options template structure.
Definition: private.h:199
struct fbCollector_st fbCollector_t
IPFIX Collecting Process endpoint.
Definition: public.h:1800
struct fbExporter_st fbExporter_t
IPFIX Exporting Process endpoint.
Definition: public.h:1791
fbSubTemplateMultiList_t * fbSubTemplateMultiListAlloc(void)
Allocates and returns an empty subTemplateMultiList structure.
Secure, reliable stream transport via TLS over TCP.
Definition: public.h:1713
void fbBasicListSetSemantic(fbBasicList_t *basicList, uint8_t semantic)
Sets the semantic for describing a basic list.
void fbSubTemplateMultiListSetSemantic(fbSubTemplateMultiList_t *STML, uint8_t semantic)
Sets the semantic field for the multi list.
struct fbSession_st fbSession_t
An IPFIX Transport Session state container.
Definition: public.h:1690
fbSubTemplateMultiListEntry_t * fbSubTemplateMultiListInit(fbSubTemplateMultiList_t *STML, uint8_t semantic, uint16_t numElements)
Initializes the multi list with the list semantic and allocates memory to store numElements entries...
uint16_t fbSessionSpreadSetMetadataExportElements(fbSession_t *session, char **groups, gboolean enabled, uint16_t tid, GError **err)
Enables RFC 5610 information element metadata export for Spread Sessions.
void fbSessionRemoveTemplatePair(fbSession_t *session, uint16_t ext_tid)
Removes a template pair from the list this is called by fixbuf when a template is revoked from the se...
int fbCollectorGetSpreadReturnGroups(fbCollector_t *collector, char *groups[])
This function is useful if need to know what groups were set on the message.
struct fbListenerGroup_st fbListenerGroup_t
Structure that represents a group of listeners.
Definition: public.h:1817
void * fbSubTemplateListInit(fbSubTemplateList_t *sTL, uint8_t semantic, uint16_t tmplID, const fbTemplate_t *tmpl, uint16_t numElements)
Initializes a subTemplateList structure and allocates the internal buffer to a size capable of holdin...
struct fbListener_st fbListener_t
IPFIX Collecting Process session listener.
Definition: public.h:1808
Unreliable datagram transport via UDP.
Definition: public.h:1702
fbVarfield_t ie_desc
information element description
Definition: public.h:1607
uint16_t fbSessionSetMetadataExportTemplates(fbSession_t *session, gboolean enabled, uint16_t tid, GError **err)
Configures a session to export template metadata as options records.
The "unsigned8" data type: A non-negative integer value in the range of 0 to 255 (0xFF).
Definition: public.h:1441
void fbSubTemplateListClearWithoutFree(fbSubTemplateList_t *subTemplateList)
Clears the sub template list parameters but does not free the data ptr.
uint32_t fbCollectorGetNetflowMissed(fbCollector_t *collector, struct sockaddr *peer, size_t peerlen, uint32_t obdomain)
Returns the number of potential missed export packets of the Netflow v9 session that is currently set...
gboolean fbTemplateAppendSpecArray(fbTemplate_t *tmpl, fbInfoElementSpec_t *spec, uint32_t flags, GError **err)
Appends information elements described by a specifier array to a template.
fbTemplate_t * tmpl
pointer to the template used to structure the data in this entry
Definition: public.h:2428
fbSubTemplateList_t * fbSubTemplateListAlloc(void)
Allocates and returns an empty subTemplateList structure.
The "octetArray" data type: A finite-length string of octets.
Definition: public.h:1438
gboolean fbCollectorSetNetflowV9Translator(fbCollector_t *collector, GError **err)
Sets the collector input translator to convert NetFlowV9 into IPFIX for the given collector...
void * fbSubTemplateListGetIndexedDataPtr(const fbSubTemplateList_t *subTemplateList, uint16_t index)
Returns the data for the record at position index in the sub template list, or returns NULL if index ...
struct sockaddr * fbCollectorGetPeer(fbCollector_t *collector)
Retrieves information about the node connected to this collector.
gboolean fbSessionSpreadEnableTemplateMetadata(fbSession_t *session, char **groups, gboolean enabled, GError **err)
Enables template metadata export for Spread Sessions.
void fBufSetSpreadExportGroup(fBuf_t *fbuf, char **groups, int num_groups, GError **err)
This function checks to see if the groups you are setting on the buffer are different than the groups...
gboolean fbTemplateAppend(fbTemplate_t *tmpl, fbInfoElement_t *ex_ie, GError **err)
Appends an information element to a template.
gboolean fBufEmit(fBuf_t *fbuf, GError **err)
Emits the message currently in a buffer using the associated exporting process endpoint.
uint16_t ie_id
information element id
Definition: public.h:1591
uint16_t numElements
number of elements in this entry
Definition: public.h:2436
struct fbInfoElement_st fbInfoElement_t
A single IPFIX Information Element definition.
struct fbBasicList_st fbBasicList_t
A basic list element in a template which structure represents a basic list on the internal side...
fbCollector_t * fbCollectorAllocFP(void *ctx, FILE *fp)
Allocates a collecting process endpoint for an open file.
void fBufInterruptSocket(fBuf_t *fbuf)
Interrupts the select call of a specific collector by way of its fBuf.
fbExporter_t * fbExporterAllocNet(fbConnSpec_t *spec)
Allocates an exporting process endpoint for a network connection.
void fBufSetCollector(fBuf_t *fbuf, fbCollector_t *collector)
Associates an collecting process endpoint with a buffer.
void fbSubTemplateListFree(fbSubTemplateList_t *subTemplateList)
Clears the sub template list (fbSubTemplateListClear()) then frees the subTemplateList itself...
gboolean fbTemplateContainsAllElementsByName(fbTemplate_t *tmpl, fbInfoElementSpec_t *spec)
Determines if a template contains at least one instance of each fbInfoElement_t in a given informatio...
fbSubTemplateMultiListEntry_t * fbSubTemplateMultiListRealloc(fbSubTemplateMultiList_t *STML, uint16_t newNumEntries)
Potentially reallocates the list&#39;s internal buffer for entries and returns a handle to it...
void fbSessionAddTemplatePair(fbSession_t *session, uint16_t ent_tid, uint16_t int_tid)
Adds an external-internal template pair to the session.
gboolean fBufNext(fBuf_t *fbuf, uint8_t *recbase, size_t *recsize, GError **err)
Retrieves a record from a buffer.
fBuf_t * fBufAllocForCollection(fbSession_t *session, fbCollector_t *collector)
Allocates a new buffer for collection.
gboolean fbTemplateContainsAllFlaggedElementsByName(fbTemplate_t *tmpl, fbInfoElementSpec_t *spec, uint32_t flags)
Determines if a template contains at least one instance of each information element in a given inform...
char * ssl_ca_file
Path to certificate authority file.
Definition: public.h:1734
union fbInfoElement_st::@1 ref
Information element name.
void fBufFree(fBuf_t *fbuf)
Frees a buffer.
gboolean fbSessionEnableTemplateMetadata(fbSession_t *session, gboolean enabled, GError **err)
Configures a session to export template metadata as options records.
Structure used to hold information of a sub template list.
Definition: public.h:2164
uint32_t flags
Application flags word.
Definition: public.h:1681
Entries contain the same type of information at SubTemplateLists: template ID and template pointers t...
Definition: public.h:2426
void fbSubTemplateListCollectorInit(fbSubTemplateList_t *STL)
Initializes a sub template list variable on a fbCollector_t.
uint16_t tmplID
ID of the template used to structure the data in this entry.
Definition: public.h:2434
fbVarfield_t ie_name
information element name
Definition: public.h:1605
uint8_t semantic
semantic field to describe the list
Definition: public.h:1947
void fBufSetBuffer(fBuf_t *fbuf, uint8_t *buf, size_t buflen)
Sets a buffer on an fBuf for collection.
The "signed32" data type: An integer value in the range of -2_147_483_648 to 2_147_483_647.
Definition: public.h:1460
fbSession_t * fbSessionAlloc(fbInfoModel_t *model)
Allocates a transport session state container.
fBuf_t * fbListenerWaitNoCollectors(fbListener_t *listener, GError **err)
Waits for an incoming connection, just like fbListenerWait(), except that this function doesn&#39;t monit...
fbListener_t * listener
pointer to the listener to add to the list
Definition: public.h:1828
void * fbBasicListGetNextPtr(fbBasicList_t *basicList, void *currentPtr)
Retrieves a pointer to the data element in the basicList that follows the one at currentPtr.
Connection specifier.
Definition: public.h:1726
uint16_t fbSessionLookupTemplatePair(fbSession_t *session, uint16_t ext_tid)
Function to find a pair, uniquely identified by the external ID, and return the associated internal t...
struct fbInfoElementOptRec_st fbInfoElementOptRec_t
The corresponding C struct for a record whose template is the RFC5610 Information Element Type Option...
void(* fbTemplateCtxFree_fn)(void *tmpl_ctx, void *app_ctx)
A callback function that is called when a template is freed.
Definition: public.h:1856
fbExporter_t * fBufGetExporter(fBuf_t *fbuf)
Retrieves the exporting process endpoint associated with a buffer.
uint16_t fbTemplateGetIELenOfMemBuffer(fbTemplate_t *tmpl)
Gets the length required for a buffer to store a data record described by this template.
struct fbSubTemplateList_st fbSubTemplateList_t
Structure used to hold information of a sub template list.
void fbSessionAddNewTemplateCallback(fbSession_t *session, fbNewTemplateCallback_fn callback, void *app_ctx)
This function sets the callback that allows the application to set its own context variable with a ne...
fbTemplate_t * fbInfoElementAllocTypeTemplate(fbInfoModel_t *model, GError **err)
Allocates and returns the Options Template that will be used to define Information Element Type Recor...
void fbSubTemplateMultiListFree(fbSubTemplateMultiList_t *STML)
Clears the multi list (fbSubTemplateMultiListClear()), then frees the STML itself.
void fbSubTemplateMultiListClear(fbSubTemplateMultiList_t *STML)
Clears all of the fbSubTemplateMultiListEntry_t objects on this STML (see fbSubTemplateMultiListClear...
struct fbInfoElementSpec_st fbInfoElementSpec_t
A single IPFIX Information Element specification.
uint16_t len
Information element length in octets.
Definition: public.h:1549
A ListenerGroupResult contains the fbListener whose listening socket got a new connection (cf...
Definition: public.h:1836
fBuf_t * fBufAllocForExport(fbSession_t *session, fbExporter_t *exporter)
Allocates a new buffer for export.
const fbInfoElement_t * fbBasicListGetInfoElement(fbBasicList_t *basicList)
Returns a pointer to the information element used in the basic list.
gboolean fbTemplateContainsElement(fbTemplate_t *tmpl, const fbInfoElement_t *ex_ie)
Determines if a template contains a given information element.
void * fbSubTemplateListGetNextPtr(const fbSubTemplateList_t *subTemplateList, void *currentPtr)
Retrieves a pointer to the data record in the sub template list that follows the one at currentPtr...
void fbBasicListClear(fbBasicList_t *basicList)
Clears the parameters of the basic list and frees the data buffer.
void * fbSubTemplateMultiListEntryGetDataPtr(fbSubTemplateMultiListEntry_t *entry)
Retrieves the data pointer for this entry.
fbSession_t * session
pointer to the session, this MUST be set to a valid session before the spec is passed to fbExporterAl...
Definition: public.h:1775
void * vai
Pointer to address info cache.
Definition: public.h:1745
fBuf_t * fbuf
pointer to the fbuf created for that new connection
Definition: public.h:1842
struct fbListenerEntry_st * prev
pointer to the previous listener entry in the linked list
Definition: public.h:1826
fbListenerGroup_t * fbListenerGroupAlloc(void)
Allocates and returns an empty listenerGroup.
uint8_t * dataPtr
pointer to the memory that stores the elements in the list
Definition: public.h:1941
Spread connection parameters.
Definition: public.h:1772
struct fbListenerGroupResult_st fbListenerGroupResult_t
A ListenerGroupResult contains the fbListener whose listening socket got a new connection (cf...
enum fbTransport_en fbTransport_t
Transport protocol for connection specifier.
char * ssl_key_pass
Private key decryption password.
Definition: public.h:1740
uint8_t fbBasicListGetSemantic(fbBasicList_t *basicList)
Gets the Semantic field for Basic List.
fbInfoModel_t * fbInfoModelAlloc(void)
Allocates a new information model.
char * ssl_cert_file
Path to certificate file.
Definition: public.h:1736
void fbCollectorSetAcceptOnly(fbCollector_t *collector, struct sockaddr *address, size_t address_length)
Sets the collector to only receive from the given IP address over UDP.
The "subTemplateMultiList" data type: A structured data element as described in RFC6313, Section 4.5.3.
Definition: public.h:1508
uint8_t fbSubTemplateMultiListGetSemantic(fbSubTemplateMultiList_t *STML)
Gets the semantic paramter from the multi list.
uint8_t * dataPtr
pointer to the buffer used to hold the data
Definition: public.h:2174
uint16_t num
Information Element number.
Definition: public.h:1547
char * daemon
pointer to the daemon host address, in Spread format.
Definition: public.h:1778
uint16_t numElements
number of elements in the list
Definition: public.h:1943
void fBufSetExportTime(fBuf_t *fbuf, uint32_t extime)
Sets the export time on the message currently in a buffer.
The "unsigned16" data type: A non-negative integer value in the range of 0 to 65535 (0xFFFF)...
Definition: public.h:1444
size_t fbExporterGetMsgLen(fbExporter_t *exporter)
Gets the (transcoded) message length that was copied to the exporting buffer upon fBufEmit()...
uint8_t ie_semantic
ie semantic
Definition: public.h:1595
gboolean fbSessionExportTemplates(fbSession_t *session, GError **err)
Exports all external templates in the current domain of a given session.
struct fbListenerEntry_st * next
pointer to the next listener entry in the linked list
Definition: public.h:1824
fbTemplate_t * fBufNextCollectionTemplate(fBuf_t *fbuf, uint16_t *ext_tid, GError **err)
Retrieves the external template that will be used to read the next record from the buffer...
uint16_t fbSessionGetLargestInternalTemplateSize(fbSession_t *session)
Gets the largest decoded size of an internal template in the session.
uint16_t numElements
number of sub template lists in the multi list
Definition: public.h:2447
uint16_t dataLength
length of the buffer used to store the elements in the list
Definition: public.h:1945
ListenerEntry&#39;s make up an fbListenerGroup_t as a linked list.
Definition: public.h:1822
uint32_t fbCollectorGetSFlowMissed(fbCollector_t *collector, struct sockaddr *peer, size_t peerlen, uint32_t obdomain)
Returns the number of potential missed export packets of the SFlow session that is identified with th...
void fbInfoModelFree(fbInfoModel_t *model)
Frees an information model.
void * fbBasicListInit(fbBasicList_t *basicList, uint8_t semantic, const fbInfoElement_t *infoElement, uint16_t numElements)
Initializes the basic list structure based on the parameters.
fbTemplate_t * fBufGetCollectionTemplate(fBuf_t *fbuf, uint16_t *ext_tid)
Retrieves the external template used to read the last record from the buffer.
uint16_t fbSubTemplateListCountElements(const fbSubTemplateList_t *subTemplateList)
Returns the number of elements the sub template list is capable of holding.
The "macAddress" data type: A MAC-48 address as a string of 6 octets.
Definition: public.h:1474
gboolean fbInfoModelReadXMLFile(fbInfoModel_t *model, const gchar *filename, GError **err)
Adds information specified in the given XML file to the information model.
fbCollector_t * fBufGetCollector(fBuf_t *fbuf)
Retrieves the collecting process endpoint associated with a buffer.
A variable-length field value.
Definition: public.h:1087
A single IPFIX Information Element definition.
Definition: public.h:1519
gboolean fbSessionSpreadEnableTypeMetadata(fbSession_t *session, char **groups, gboolean enabled, GError **err)
Enables RFC 5610 information element metadata export for Spread Sessions.
char * name
Information element name.
Definition: public.h:1662
void * fbCollectorGetContext(fbCollector_t *collector)
Retrieves the application context associated with a collector.
gboolean fBufSetExportTemplate(fBuf_t *fbuf, uint16_t ext_tid, GError **err)
Sets the external template for export on a buffer to the given template ID.
void * fbBasicListRealloc(fbBasicList_t *basicList, uint16_t newNumElements)
Potentially reallocates the list&#39;s internal buffer and returns a handle to it.
Secure, unreliable datagram transport via DTLS over UDP.
Definition: public.h:1719
void fbExporterSetStream(fbExporter_t *exporter, int sctp_stream)
Sets the SCTP stream for the next message exported.
void * fbSubTemplateMultiListEntryNextDataPtr(fbSubTemplateMultiListEntry_t *entry, void *currentPtr)
Retrieves a pointer to the data record in this entry that follows the one at currentPtr.
uint16_t fbSessionSpreadSetMetadataExportTemplates(fbSession_t *session, char **groups, gboolean enabled, uint16_t tid, GError **err)
Enables template metadata export for Spread Sessions.
struct fbInfoModel_st fbInfoModel_t
An IPFIX information model.
Definition: public.h:1104
void * fbSubTemplateMultiListEntryGetIndexedPtr(fbSubTemplateMultiListEntry_t *entry, uint16_t index)
Retrieves a pointer to the data element in the entry at position index, or returns NULL when index is...
gboolean fbInfoElementAddOptRecElement(fbInfoModel_t *model, fbInfoElementOptRec_t *rec)
Adds an element that we received via an RFC 5610 Options Record to the given info model...
The corresponding C struct for a record whose template is the RFC5610 Information Element Type Option...
Definition: public.h:1587
gboolean fbTemplateContainsElementByName(fbTemplate_t *tmpl, fbInfoElementSpec_t *spec)
Determines if a template contains at least one instance of a given information element, specified by name in the template&#39;s information model.
Reliable stream transport via TCP.
Definition: public.h:1700
void fbInfoModelAddElement(fbInfoModel_t *model, fbInfoElement_t *ie)
Adds a single information element to an information model.
uint64_t ie_range_begin
ie range min
Definition: public.h:1601
uint32_t fbSessionGetDomain(fbSession_t *session)
Retrieves the current domain on a session.
uint8_t * buf
Content buffer.
Definition: public.h:1096
void * fbBasicListAddNewElements(fbBasicList_t *basicList, uint16_t numNewElements)
Allocates numNewElements additional element(s) into the basic list.
char * ssl_key_file
Path to private key file.
Definition: public.h:1738
gboolean(* fbListenerAppInit_fn)(fbListener_t *listener, void **ctx, int fd, struct sockaddr *peer, size_t peerlen, GError **err)
Application context initialization function type for fbListener_t.
Definition: public.h:2895
uint32_t midx
Multiple IE index.
Definition: public.h:1540
int fbListenerGroupAddListener(fbListenerGroup_t *group, const fbListener_t *listener)
Adds a previously allocated listener to the previously allocated group.
gboolean fbInfoModelTypeInfoRecord(fbTemplate_t *tmpl)
Checks to see if a template contains all of the elements required by RFC 5610 for describing an infor...
gboolean fbInfoElementWriteOptionsRecord(fBuf_t *fbuf, const fbInfoElement_t *model_ie, uint16_t itid, uint16_t etid, GError **err)
Exports an options record to the given fbuf with information element type information about the given...
gboolean fBufSetAutomaticInsert(fBuf_t *fbuf, GError **err)
Enables automatic insertion of RFC 5610 elements on a buffer.
Multilists just contain the semantic to describe the sub lists, the number of sub lists...
Definition: public.h:2443
uint8_t semantic
value used to describe the contents of the list, all-of, one-of, etc
Definition: public.h:2180
void fbExporterAutoStream(fbExporter_t *exporter)
Enables automatic SCTP stream selection for the next message exported.
struct fbVarfield_st fbVarfield_t
A variable-length field value.
fbInfoModel_t * fbSessionGetInfoModel(fbSession_t *session)
Gets the info model for the session.
guint fbInfoModelCountElements(const fbInfoModel_t *model)
Returns the number of information elements in the information model.
Fixbuf&#39;s version information.
enum fbInfoElementDataType_en fbInfoElementDataType_t
From RFC 5610: A description of the abstract data type of an IPFIX information element as registered ...
fbTransport_t transport
Transport protocol to use.
Definition: public.h:1728
void fbSubTemplateMultiListEntryClear(fbSubTemplateMultiListEntry_t *entry)
Frees the memory holding the records&#39; data used by this entry.
const fbTemplate_t * fbSubTemplateMultiListEntryGetTemplate(fbSubTemplateMultiListEntry_t *entry)
Retrieves the template pointer used to structure the data elements.
void fbCollectorSetUDPMultiSession(fbCollector_t *collector, gboolean multi_session)
Enables or disables multi-session mode for a fbCollector_t associated with a UDP fbListener_t.
void * fbSubTemplateListGetDataPtr(const fbSubTemplateList_t *subTemplateList)
Returns a pointer to the buffer that contains the data for the list.
fbListener_t * fbListenerAlloc(fbConnSpec_t *spec, fbSession_t *session, fbListenerAppInit_fn appinit, fbListenerAppFree_fn appfree, GError **err)
Allocates a listener.
void fbBasicListCollectorInit(fbBasicList_t *basicList)
Initializes a basic list structure for collection.
const fbInfoElement_t * fbInfoModelGetElementByID(fbInfoModel_t *model, uint16_t id, uint32_t ent)
Returns a pointer to the canonical information element within an information model given the informat...
size_t len
Length of content in buffer.
Definition: public.h:1089
uint16_t fbSubTemplateMultiListCountElements(const fbSubTemplateMultiList_t *STML)
Returns the number of entries the sub template multi list is capable of holding.
uint16_t len_override
The size of the information element in bytes.
Definition: public.h:1674
gboolean fBufNextMessage(fBuf_t *fbuf, GError **err)
Reads a new message into a buffer using the associated collecting process endpoint.
fbExporter_t * fbExporterAllocSpread(fbSpreadParams_t *params)
Allocates an exporting process endpoint for a Spread connection.
The "dateTimeMicroseconds" data type: Two 32-bit fields where the first is the number seconds since t...
Definition: public.h:1495
fbInfoElementDataType_en
From RFC 5610: A description of the abstract data type of an IPFIX information element as registered ...
Definition: public.h:1435
The "signed64" data type: An integer value in the range of -9_223_372_036_854_775_808 to 9_223_372_03...
Definition: public.h:1463
uint64_t max
range max
Definition: public.h:1556
uint8_t * dataPtr
pointer to the buffer used to hold the data in this entry
Definition: public.h:2430
GHashTableIter fbInfoModelIter_t
An iterator over the information elements in an information model.
Definition: public.h:1109
fbSubTemplateMultiListEntry_t * fbSubTemplateMultiListGetNextEntry(fbSubTemplateMultiList_t *STML, fbSubTemplateMultiListEntry_t *currentEntry)
Retrieves a pointer to the entry in the mutli list that follows the one at currentEntry.
const fbTemplate_t * fbSubTemplateListGetTemplate(fbSubTemplateList_t *subTemplateList)
Gets the template pointer from the list structure.
uint32_t fBufGetExportTime(fBuf_t *fbuf)
Retrieves the export time on the message currently in a buffer.
void * fbSubTemplateListInitWithOwnBuffer(fbSubTemplateList_t *subTemplateList, uint8_t semantic, uint16_t tmplID, const fbTemplate_t *tmpl, uint16_t numElements, uint16_t dataLength, uint8_t *dataPtr)
Initializes the subTemplateList but does not allocate a buffer.
fbListenerGroupResult_t * fbListenerGroupWait(fbListenerGroup_t *group, GError **err)
Accepts connections for multiple listeners.
fbBasicList_t * fbBasicListAlloc(void)
Allocates and returns an empty Basic List Structure.
A basic list element in a template which structure represents a basic list on the internal side...
Definition: public.h:1937
The "ipv6Address" data type: A value of an IPv6 address.
Definition: public.h:1499
fbTransport_en
Transport protocol for connection specifier.
Definition: public.h:1693
const fbInfoElement_t * fbInfoModelIterNext(fbInfoModelIter_t *iter)
Returns a pointer to the next information element in the information model.
The "basicList" data type: A structured data element as described in RFC6313, Section 4...
Definition: public.h:1502
void * fbSubTemplateListRealloc(fbSubTemplateList_t *subTemplateList, uint16_t newNumElements)
Potentially reallocates the list&#39;s internal buffer and returns a handle to it.
void fBufSetExporter(fBuf_t *fbuf, fbExporter_t *exporter)
Associates an exporting process endpoint with a buffer.
The "boolean" data type: A binary value: "true" or "false".
Definition: public.h:1471
The "dateTimeSeconds" data type: An unsigned 32-bit integer containing the number of seconds since th...
Definition: public.h:1481
fbSubTemplateMultiListEntry_t * fbSubTemplateMultiListGetFirstEntry(fbSubTemplateMultiList_t *STML)
Retrieves the first entry in the multi list.
void(* fbListenerAppFree_fn)(void *ctx)
Application context free function type for fbListener_t.
Definition: public.h:2912
void * fbTemplateGetContext(fbTemplate_t *tmpl)
Gets the ctx pointer associated with a Template.
char ** groups
pointer to array of group names, must have at least one, and must be null term array ...
Definition: public.h:1781
uint16_t ie_units
ie units
Definition: public.h:1597
fbTemplate_t * fbTemplateAlloc(fbInfoModel_t *model)
Allocates a new empty template.
fbCollector_t * fbCollectorAllocFile(void *ctx, const char *path, GError **err)
Allocates a collecting process endpoint for a named file.
struct fbSubTemplateMultiList_st fbSubTemplateMultiList_t
Multilists just contain the semantic to describe the sub lists, the number of sub lists...
fbSession_t * fBufGetSession(fBuf_t *fbuf)
Retrieves the session associated with a buffer.
uint32_t ent
Private Enterprise Number.
Definition: public.h:1542
void fbListenerFreeGroupResult(fbListenerGroupResult_t *result)
Frees the listener group result returned from fbListenerGroupWait().
Secure, partially reliable datagram transport via DTLS over SCTP.
Definition: public.h:1708
uint8_t type
Data Type.
Definition: public.h:1558
The "ipv4Address" data type: A value of an IPv4 address.
Definition: public.h:1497
uint32_t fbTemplateCountElements(fbTemplate_t *tmpl)
Determines number of information elements in a template.
uint16_t fbSessionAddTemplateWithMetadata(fbSession_t *session, gboolean internal, uint16_t tid, fbTemplate_t *tmpl, const char *name, const char *description, GError **err)
Adds a template to the session, as fbSessionAddTemplate(), with the provided metadata.
uint32_t fbCollectorGetObservationDomain(fbCollector_t *collector)
Retrieves the observation domain of the node connected to the UDP collector.
size_t fBufRemaining(fBuf_t *fbuf)
Retrieves the length of the buffer that is remaining after processing.
void fbCollectorClose(fbCollector_t *collector)
Closes the file or socket underlying a collecting process endpoint.
void fbListenerGroupFree(fbListenerGroup_t *group)
Frees a listener group.
fBuf_t * fbListenerOwnSocketCollectorTCP(fbListener_t *listener, int sock, GError **err)
Returns an fBuf wrapped around an independently managed socket and a properly created listener for TC...
fbInfoModel_t * fbTemplateGetInfoModel(fbTemplate_t *tmpl)
Returns the information model, as understood by the template.
struct fbListenerEntry_st fbListenerEntry_t
ListenerEntry&#39;s make up an fbListenerGroup_t as a linked list.
The "float32" data type: An IEEE single-precision 32-bit floating point type.
Definition: public.h:1466
The "string" data type: A finite-length string of valid characters from the Unicode character encodin...
Definition: public.h:1477
struct fBuf_st fBuf_t
An IPFIX message buffer.
Definition: public.h:1079
void(* fbNewTemplateCallback_fn)(fbSession_t *session, uint16_t tid, fbTemplate_t *tmpl, void *app_ctx, void **tmpl_ctx, fbTemplateCtxFree_fn *tmpl_ctx_free_fn)
A callback function that will be called when the session receives a new external template.
Definition: public.h:1883
void fbSubTemplateListSetSemantic(fbSubTemplateList_t *subTemplateList, uint8_t semantic)
Sets the semantic parameter of a subTemplateList.
fbTemplate_t * fbSessionGetTemplate(fbSession_t *session, gboolean internal, uint16_t tid, GError **err)
Retrieves a template from a session by ID.
A single IPFIX Information Element specification.
Definition: public.h:1660
uint8_t padding[6]
padding to align with template
Definition: public.h:1599
gboolean fbSessionExportTemplate(fbSession_t *session, uint16_t tid, GError **err)
Exports a single external template in the current domain of a given session.
void fbSubTemplateListClear(fbSubTemplateList_t *subTemplateList)
Clears a subTemplateList structure, notably freeing the internal buffer and setting it to NULL...
uint16_t fbSessionAddTemplate(fbSession_t *session, gboolean internal, uint16_t tid, fbTemplate_t *tmpl, GError **err)
Adds a template to a session.
fbSubTemplateMultiListEntry_t * fbSubTemplateMultiListAddNewEntries(fbSubTemplateMultiList_t *STML, uint16_t numNewEntries)
Adds numNewElements entries to the multi list of entries.
union fbSubTemplateList_st::@2 dataLength
length of the allocated buffer used to hold the data
void * fbSubTemplateListAddNewElements(fbSubTemplateList_t *subTemplateList, uint16_t numNewElements)
Allocates space for numNewElements additional element in the subTemplateList.
gboolean fbTemplateAppendSpec(fbTemplate_t *tmpl, fbInfoElementSpec_t *spec, uint32_t flags, GError **err)
Appends an information element described by specifier to a template.
int fbListenerGroupDeleteListener(fbListenerGroup_t *group, const fbListener_t *listener)
Removes the listener from the group.
char * svc
Service name or port number to connect/listen to.
Definition: public.h:1732
gboolean fbSessionRemoveTemplate(fbSession_t *session, gboolean internal, uint16_t tid, GError **err)
Removes a template from a session.
The "signed8" data type: An integer value in the range of -128 to 127.
Definition: public.h:1454
void fbInfoModelIterInit(fbInfoModelIter_t *iter, const fbInfoModel_t *model)
Initializes an information model iterator for iteration over the information elements (fbInfoElement_...
void fbSessionResetExternal(fbSession_t *session)
Resets the external state (sequence numbers and templates) in a session state container.
uint16_t fbSubTemplateMultiListEntryGetTemplateID(fbSubTemplateMultiListEntry_t *entry)
Retrieves the template ID for the template used to structure the data.
gboolean fbListenerGetCollector(fbListener_t *listener, fbCollector_t **collector, GError **err)
If a collector is associated with the listener class, this will return a handle to the collector stat...
The "unsigned64" data type: A non-negative integer value in the range of 0 to 18_446_744_073_709_551_...
Definition: public.h:1451
gboolean fbCollectorSetSFlowTranslator(fbCollector_t *collector, GError **err)
Sets the collector input translator to convert SFlow into IPFIX for the given collector.
gboolean fbInfoModelReadXMLData(fbInfoModel_t *model, const gchar *xml_data, gssize xml_data_len, GError **err)
Adds information specified in the given XML data to the information model.
void fbListenerInterrupt(fbListener_t *listener)
Causes the current or next call to fbListenerWait() to unblock and return.
fBuf_t * fbListenerOwnSocketCollectorTLS(fbListener_t *listener, int sock, GError **err)
Same as fbListenerOwnSocketCollectorTCP() but for TLS (not tested)
fbSubTemplateMultiListEntry_t * fbSubTemplateMultiListGetIndexedEntry(fbSubTemplateMultiList_t *STML, uint16_t index)
Retrieves a pointer to the entry at a specific index, or returns NULL if index is out of range...
gboolean fbCollectorClearTranslator(fbCollector_t *collector, GError **err)
Removes an input translator from a given collector such that it will operate on IPFIX protocol again...
uint8_t fbSubTemplateListGetSemantic(fbSubTemplateList_t *subTemplateList)
Gets the semantic value from a sub template list.
fbListener_t * listener
pointer to the listener that received a new connection
Definition: public.h:1840
void fbInfoModelAddElementArray(fbInfoModel_t *model, fbInfoElement_t *ie)
Adds multiple information elements in an array to an information model.
gboolean fBufSetInternalTemplate(fBuf_t *fbuf, uint16_t int_tid, GError **err)
Sets the internal template on a buffer to the given template ID.
void * fbSubTemplateMultiListEntryInit(fbSubTemplateMultiListEntry_t *entry, uint16_t tmplID, fbTemplate_t *tmpl, uint16_t numElements)
Initializes the multi list entry with the template values, and allocates the memory used by the entry...
void fbListenerFree(fbListener_t *listener)
Frees a listener.
uint16_t fbSessionAddTemplatesMulticast(fbSession_t *session, char **groups, gboolean internal, uint16_t tid, fbTemplate_t *tmpl, GError **err)
Sets and sends templates for 1 or more groups.
gboolean fbListValidSemantic(uint8_t semantic)
Validates the value of a structured data types semantic field, as defined in RFC 6313 and listed at I...
void fbSessionFree(fbSession_t *session)
Frees a transport session state container.
void fbTemplateSetOptionsScope(fbTemplate_t *tmpl, uint16_t scope_count)
Sets the number of information elements in a template that are scope.
const fbTemplate_t * tmpl
pointer to the template used to structure the data
Definition: public.h:2172