mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00

This is so that people working from the current stable version can still start using git.
331 lines
No EOL
4.5 KiB
HTML
331 lines
No EOL
4.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>Broccoli: The Bro Client Communications Library</TITLE
|
|
><META
|
|
NAME="GENERATOR"
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
|
|
REL="NEXT"
|
|
TITLE="Introduction"
|
|
HREF="c20.html"><LINK
|
|
REL="STYLESHEET"
|
|
TYPE="text/css"
|
|
HREF="stylesheet.css"></HEAD
|
|
><BODY
|
|
CLASS="BOOK"
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#840084"
|
|
ALINK="#0000FF"
|
|
><DIV
|
|
CLASS="BOOK"
|
|
><DIV
|
|
CLASS="TITLEPAGE"
|
|
><H1
|
|
CLASS="TITLE"
|
|
><A
|
|
NAME="INDEX"
|
|
>Broccoli: The Bro Client Communications Library</A
|
|
></H1
|
|
><DIV
|
|
CLASS="MEDIAOBJECT"
|
|
><P
|
|
><IMG
|
|
SRC="images/logo.jpg"
|
|
ALIGN="CENTER"></P
|
|
></DIV
|
|
><DIV
|
|
><DIV
|
|
CLASS="ABSTRACT"
|
|
><P
|
|
></P
|
|
><A
|
|
NAME="AEN9"
|
|
></A
|
|
><P
|
|
> This is documentation for release <SPAN
|
|
CLASS="emphasis"
|
|
><B
|
|
CLASS="EMPHASIS"
|
|
>1.5.3</B
|
|
></SPAN
|
|
>
|
|
of Broccoli, compatible with Bro IDS releases of <SPAN
|
|
CLASS="emphasis"
|
|
><B
|
|
CLASS="EMPHASIS"
|
|
>1.5</B
|
|
></SPAN
|
|
>
|
|
or newer. Broccoli is free software under terms of the BSD license as given
|
|
in the <A
|
|
HREF="a3638.html#LICENSE"
|
|
>License</A
|
|
>
|
|
section. This documentation is always available on the web for download
|
|
and online browsing at
|
|
<A
|
|
HREF="http://www.icir.org/christian/broccoli"
|
|
TARGET="_top"
|
|
>http://www.icir.org/christian/broccoli</A
|
|
>.
|
|
</P
|
|
><P
|
|
>Feedback, patches and bug reports are all welcome, please
|
|
<A
|
|
HREF="http://mailman.icsi.berkeley.edu/mailman/listinfo/bro"
|
|
TARGET="_top"
|
|
>join the Bro mailing list</A
|
|
>.
|
|
</P
|
|
><P
|
|
> Yet Another SRG/ICIR Production —
|
|
<A
|
|
HREF="http://www.cl.cam.ac.uk/Research/SRG"
|
|
TARGET="_top"
|
|
>http://www.cl.cam.ac.uk/Research/SRG</A
|
|
> —
|
|
<A
|
|
HREF="http://www.icir.org"
|
|
TARGET="_top"
|
|
>http://www.icir.org</A
|
|
>
|
|
</P
|
|
><P
|
|
></P
|
|
></DIV
|
|
></DIV
|
|
></DIV
|
|
><DIV
|
|
CLASS="TOC"
|
|
><DL
|
|
><DT
|
|
><B
|
|
>Table of Contents</B
|
|
></DT
|
|
><DT
|
|
>1. <A
|
|
HREF="c20.html"
|
|
>Introduction</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>1.1. <A
|
|
HREF="c20.html#AEN23"
|
|
>What is Broccoli?</A
|
|
></DT
|
|
><DT
|
|
>1.2. <A
|
|
HREF="c20.html#AEN34"
|
|
>Why do I care?</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
><DT
|
|
>2. <A
|
|
HREF="c54.html"
|
|
>Installing Broccoli</A
|
|
></DT
|
|
><DT
|
|
>3. <A
|
|
HREF="c84.html"
|
|
>Using Broccoli</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>3.1. <A
|
|
HREF="c84.html#AEN87"
|
|
>Obtaining information about your build using <TT
|
|
CLASS="FILENAME"
|
|
>broccoli-config</TT
|
|
></A
|
|
></DT
|
|
><DT
|
|
>3.2. <A
|
|
HREF="c84.html#AEN121"
|
|
>Suggestions for instrumenting applications</A
|
|
></DT
|
|
><DT
|
|
>3.3. <A
|
|
HREF="c84.html#AEN134"
|
|
>The Broccoli API</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>3.3.1. <A
|
|
HREF="c84.html#AEN143"
|
|
>Initialization</A
|
|
></DT
|
|
><DT
|
|
>3.3.2. <A
|
|
HREF="c84.html#AEN167"
|
|
>Data types in Broccoli</A
|
|
></DT
|
|
><DT
|
|
>3.3.3. <A
|
|
HREF="c84.html#AEN226"
|
|
>Managing connections</A
|
|
></DT
|
|
><DT
|
|
>3.3.4. <A
|
|
HREF="c84.html#AEN286"
|
|
>Connection classes</A
|
|
></DT
|
|
><DT
|
|
>3.3.5. <A
|
|
HREF="c84.html#AEN300"
|
|
>Composing and sending events</A
|
|
></DT
|
|
><DT
|
|
>3.3.6. <A
|
|
HREF="c84.html#AEN461"
|
|
>Receiving events</A
|
|
></DT
|
|
><DT
|
|
>3.3.7. <A
|
|
HREF="c84.html#AEN554"
|
|
>Handling records</A
|
|
></DT
|
|
><DT
|
|
>3.3.8. <A
|
|
HREF="c84.html#AEN599"
|
|
>Handling tables</A
|
|
></DT
|
|
><DT
|
|
>3.3.9. <A
|
|
HREF="c84.html#AEN636"
|
|
>Handling sets</A
|
|
></DT
|
|
><DT
|
|
>3.3.10. <A
|
|
HREF="c84.html#AEN653"
|
|
>Associating data with connections</A
|
|
></DT
|
|
><DT
|
|
>3.3.11. <A
|
|
HREF="c84.html#AEN665"
|
|
>Configuration files</A
|
|
></DT
|
|
><DT
|
|
>3.3.12. <A
|
|
HREF="c84.html#AEN696"
|
|
>Using dynamic buffers</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
><DT
|
|
>3.4. <A
|
|
HREF="c84.html#AEN738"
|
|
>Configuring encrypted communication</A
|
|
></DT
|
|
><DT
|
|
>3.5. <A
|
|
HREF="c84.html#AEN785"
|
|
>Configuring event reception in Bro policies</A
|
|
></DT
|
|
><DT
|
|
>3.6. <A
|
|
HREF="c84.html#AEN819"
|
|
>Configuring debugging output</A
|
|
></DT
|
|
><DT
|
|
>3.7. <A
|
|
HREF="c84.html#AEN843"
|
|
>Test programs</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
><DT
|
|
>4. <A
|
|
HREF="api.html"
|
|
>Broccoli API Reference</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
><A
|
|
HREF="broccoli-broccoli.html"
|
|
>broccoli</A
|
|
> -- </DT
|
|
></DL
|
|
></DD
|
|
><DT
|
|
>A. <A
|
|
HREF="a3638.html"
|
|
>Appendix</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>A.1. <A
|
|
HREF="a3638.html#LICENSE"
|
|
>License</A
|
|
></DT
|
|
><DT
|
|
>A.2. <A
|
|
HREF="a3638.html#ABOUT"
|
|
>About this document</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
></DL
|
|
></DIV
|
|
></DIV
|
|
><DIV
|
|
CLASS="NAVFOOTER"
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"><TABLE
|
|
SUMMARY="Footer navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="c20.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>Introduction</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |