private.h

Go to the documentation of this file.

/*
 *  Copyright 2006-2023 Carnegie Mellon University
 *  See license information in LICENSE.txt.
 */
/*
 *  ------------------------------------------------------------------------
 *  Authors: Brian Trammell
 *  ------------------------------------------------------------------------
 */
 
#ifndef _FB_PRIVATE_H_
#define _FB_PRIVATE_H_
#include <fixbuf/public.h>
 
 
#define IPFIX_ENTERPRISE_BIT    0x8000
 
#define FB_MSGLEN_MAX       65535
 
#define FB_SSL_ERR_BUFSIZ   512
 
typedef struct fbUDPConnSpec_st {
    fbSession_t              *session;
    void                     *ctx;
    union {
        struct sockaddr       so;
        struct sockaddr_in    ip4;
        struct sockaddr_in6   ip6;
    } peer;
    size_t                    peerlen;
    struct fbUDPConnSpec_st  *next;
    struct fbUDPConnSpec_st  *prev;
    time_t                    last_seen;
    uint32_t                  obdomain;
    gboolean                  reject;
} fbUDPConnSpec_t;
 
 
/* TODO...add a way to say if this field is this value, it highlights these
 * records...thus removing app label spec...or screw it and leave it specific
 */
typedef struct fbTemplateInfoRecord_st {
    uint16_t              tid;
    uint16_t              appLabel;
    uint16_t              parentTid;
    uint8_t               padding[2];
    fbVarfield_t          name;
    fbVarfield_t          description;
    fbSubTemplateList_t   blInfoList;
} fbTemplateInfoRecord_t;
 
 
typedef struct fbElementPositions_st {
    uint16_t   count;
    uint16_t  *positions;
} fbElementPositions_t;
 
struct fbTemplate_st {
    fbInfoModel_t         *model;
    fbTemplateField_t    **ie_ary;
    GHashTable            *indices;
    uint16_t              *off_cache;
    int                    ref_count;
    uint16_t               ie_count;
    uint16_t               scope_count;
    uint16_t               ie_len;
    uint16_t               ie_internal_len;
    uint16_t               tmpl_len;
    gboolean               is_varlen;
    gboolean               contains_list;
    gboolean               active;
    gboolean               default_length;
    void                  *tmpl_ctx;
    fbTemplateCtxFree_fn   ctx_free;
    void                  *app_ctx;
 
    fbElementPositions_t   bl;
    fbElementPositions_t   stl;
    fbElementPositions_t   stml;
};
 
void
fBufRewind(
    fBuf_t  *fbuf);
 
gboolean
fBufAppendTemplate(
    fBuf_t              *fbuf,
    uint16_t             tmpl_id,
    const fbTemplate_t  *tmpl,
    gboolean             revoked,
    GError             **err);
 
void
fBufRemoveTemplateTcplan(
    fBuf_t              *fbuf,
    const fbTemplate_t  *tmpl);
 
void
fBufSetSession(
    fBuf_t       *fbuf,
    fbSession_t  *session);
 
uint16_t
fBufGetExportTemplate(
    const fBuf_t  *fbuf);
 
 
uint16_t
fBufGetInternalTemplate(
    const fBuf_t  *fbuf);
 
uint32_t
fbInfoElementHash(
    const fbInfoElement_t  *ie);
 
gboolean
fbInfoElementEqual(
    const fbInfoElement_t  *a,
    const fbInfoElement_t  *b);
 
void
fbInfoElementDebug(
    gboolean                tmpl,
    const fbInfoElement_t  *ie);
 
const fbInfoElement_t *
fbInfoModelGetElement(
    const fbInfoModel_t    *model,
    const fbInfoElement_t  *ex_ie);
 
gboolean
fbInfoElementCopyToTemplate(
    fbInfoModel_t          *model,
    const fbInfoElement_t  *ex_ie,
    fbTemplateField_t      *tmpl_ie,
    GError                **err);
 
gboolean
fbInfoElementCopyToTemplateByName(
    const fbInfoModel_t        *model,
    const fbInfoElementSpec_t  *spec,
    fbTemplateField_t          *tmpl_ie,
    GError                    **err);
 
gboolean
fbInfoElementCopyToTemplateByIdent(
    const fbInfoModel_t          *model,
    const fbInfoElementSpecId_t  *spec,
    fbTemplateField_t            *tmpl_ie,
    GError                      **err);
 
const fbInfoElement_t *
fbInfoModelAddAlienElement(
    fbInfoModel_t          *model,
    const fbInfoElement_t  *ex_ie);
 
fbTemplate_t *
fbInfoElementAllocTypeTemplate2(
    fbInfoModel_t  *model,
    gboolean        internal,
    GError        **err);
 
gboolean
fbInfoModelIsTemplateElementType(
    const fbTemplate_t  *tmpl);
 
 
void
fbTemplateRetain(
    fbTemplate_t  *tmpl);
 
void
fbTemplateRelease(
    fbTemplate_t  *tmpl);
 
void
fbTemplateDebug(
    const char          *label,
    uint16_t             tid,
    const fbTemplate_t  *tmpl);
 
fbTemplateInfo_t *
fbTemplateInfoCreateFromRecord(
    const fbTemplateInfoRecord_t  *mdRec,
    unsigned int                   mdRecVersion,
    GError                       **err);
 
void
fbTemplateInfoFillRecord(
    const fbTemplateInfo_t  *mdInfo,
    fbTemplateInfoRecord_t  *mdRec,
    const fbTemplate_t      *stlTemplate,
    uint16_t                 stlTid);
 
void
fbTemplateInfoSetTemplateId(
    fbTemplateInfo_t  *mdInfo,
    uint16_t           tid);
 
void
fbTemplateInfoRecordInit(
    fbTemplateInfoRecord_t  *mdRec);
 
void
fbTemplateInfoRecordClear(
    fbTemplateInfoRecord_t  *mdRec);
 
gboolean
fbTemplateAllocTemplateInfoTemplates(
    fbInfoModel_t  *model,
    fbTemplate_t  **tmplinfo_v3_tmpl,
    fbTemplate_t  **bl_ie_metadata_tmpl,
    GError        **err);
 
fbNewTemplateCallback_fn
fbSessionGetNewTemplateCallback(
    const fbSession_t  *session);
 
void *
fbSessionGetNewTemplateCallbackAppCtx(
    const fbSession_t  *session);
 
fbSession_t *
fbSessionClone(
    const fbSession_t  *base);
 
uint32_t
fbSessionGetSequence(
    const fbSession_t  *session);
 
void
fbSessionSetSequence(
    fbSession_t  *session,
    uint32_t      sequence);
 
void
fbSessionSetTemplateBuffer(
    fbSession_t  *session,
    fBuf_t       *fbuf);
 
gboolean
fbSessionGetTemplatePair(
    const fbSession_t  *session,
    uint16_t            ext_tid,
    uint16_t           *int_tid,
    fbTemplate_t      **ext_tmpl,
    fbTemplate_t      **int_tmpl,
    GError            **err);
 
void
fbSessionSetTemplatePairsDisabled(
    fbSession_t  *session,
    gboolean      disabled);
 
void
fbSessionSetCollector(
    fbSession_t    *session,
    fbCollector_t  *collector);
 
void
fbSessionClearIntTmplTableFlag(
    fbSession_t  *session);
 
void
fbSessionClearExtTmplTableFlag(
    fbSession_t  *session);
 
int
fbSessionIntTmplTableFlagIsSet(
    fbSession_t  *session);
 
int
fbSessionExtTmplTableFlagIsSet(
    fbSession_t  *session);
 
void
fbSessionSaveTemplateInfo(
    fbSession_t       *session,
    fbTemplateInfo_t  *mdInfo);
 
gboolean
fbSessionAddInternalRfc5610Template(
    fbSession_t  *session,
    GError      **err);
 
fbTemplate_t *
fbSessionGetInternalRfc5610Template(
    fbSession_t  *session,
    uint16_t     *tid,
    GError      **err);
 
gboolean
fbSessionAddInternalTemplateInfoTemplate(
    fbSession_t  *session,
    GError      **err);
 
fbTemplate_t *
fbSessionGetInternalTemplateInfoTemplate(
    fbSession_t  *session,
    uint16_t     *tid,
    GError      **err);
 
gboolean
fbConnSpecLookupAI(
    fbConnSpec_t  *spec,
    gboolean       passive,
    GError       **err);
 
gboolean
fbConnSpecInitTLS(
    fbConnSpec_t  *spec,
    gboolean       passive,
    GError       **err);
 
fbConnSpec_t *
fbConnSpecCopy(
    const fbConnSpec_t  *spec);
 
void
fbConnSpecFree(
    fbConnSpec_t  *spec);
 
uint16_t
fbExporterGetMTU(
    const fbExporter_t  *exporter);
 
gboolean
fbExportMessage(
    fbExporter_t  *exporter,
    uint8_t       *msgbase,
    size_t         msglen,
    GError       **err);
 
void
fbExporterFree(
    fbExporter_t  *exporter);
 
void
fbCollectorRemoveListenerLastBuf(
    fBuf_t         *fbuf,
    fbCollector_t  *collector);
 
fbCollector_t *
fbCollectorAllocSocket(
    fbListener_t     *listener,
    void             *ctx,
    int               fd,
    struct sockaddr  *peer,
    size_t            peerlen,
    GError          **err);
 
fbCollector_t *
fbCollectorAllocTLS(
    fbListener_t     *listener,
    void             *ctx,
    int               fd,
    struct sockaddr  *peer,
    size_t            peerlen,
    GError          **err);
 
gboolean
fbCollectMessage(
    fbCollector_t  *collector,
    uint8_t        *msgbase,
    size_t         *msglen,
    GError        **err);
 
int
fbCollectorGetFD(
    const fbCollector_t  *collector);
 
void
fbCollectorSetFD(
    fbCollector_t  *collector,
    int             fd);
 
void
fbCollectorFree(
    fbCollector_t  *collector);
 
gboolean
fbCollectorHasTranslator(
    fbCollector_t  *collector);
 
 
gboolean
fbCollectMessageBuffer(
    uint8_t  *hdr,
    size_t    b_len,
    size_t   *m_len,
    GError  **err);
 
void
fbListenerAppFree(
    fbListener_t  *listener,
    void          *ctx);
 
void
fbListenerRemoveLastBuf(
    fBuf_t        *fbuf,
    fbListener_t  *listener);
 
void
fbListenerRemove(
    fbListener_t  *listener,
    int            fd);
 
fbConnSpec_t *
fbListenerGetConnSpec(
    const fbListener_t  *listener);
 
void
fbCollectorInterruptSocket(
    fbCollector_t  *collector);
 
gboolean
fbListenerCallAppInit(
    fbListener_t     *listener,
    fbUDPConnSpec_t  *spec,
    GError          **err);
 
fbSession_t *
fbListenerSetPeerSession(
    fbListener_t  *listener,
    fbSession_t   *session);
 
 
#endif  /* _FB_PRIVATE_H_ */
 
/*
 *  @DISTRIBUTION_STATEMENT_BEGIN@
 *  @DISTRIBUTION_STATEMENT_END@
 */