Skip to content

Commit

Permalink
Update to 1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Schiffman committed Dec 2, 2016
1 parent cd6c4f1 commit e425e50
Show file tree
Hide file tree
Showing 15 changed files with 133 additions and 150 deletions.
30 changes: 15 additions & 15 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -37,32 +37,33 @@ sratunnel/sratunnel.1: sratunnel/sratunnel.man fwd.man srawatch.man watch.man
sratunnel/radtunnel.1: sratunnel/radtunnel.man fwd.man srawatch.man watch.man

EXTRA_DIST += \
sratool/sratool.man \
sratool/radtool.man \
sratunnel/sratunnel.man \
sratunnel/radtunnel.man \
fwd.man \
watch.man \
srawatch.man \
radwatch.man \
sratool/options.man \
sratool/cmds.man \
cert_tools/axa_link_certs.man \
cert_tools/axa_make_cert.man \
cert_tools/axa_server_cert.man \
README.md \
Doxyfile.in \
DoxygenLayout.xml
DoxygenLayout.xml \
json-schema.yaml \
debian/axa-doc.install \
debian/axa-tools.install \
debian/changelog \
debian/compat \
debian/control \
debian/gbp.conf \
debian/libaxa0.install \
debian/libaxa-dev.install \
debian/rules

dist_man_MANS = \
man_MANS = \
sratool/sratool.1 \
sratool/radtool.1 \
sratunnel/sratunnel.1 \
sratunnel/radtunnel.1 \
cert_tools/axa_link_certs.8 \
cert_tools/axa_make_cert.8 \
cert_tools/axa_server_cert.8
CLEANFILES += $(dist_man_MANS)
DISTCLEANFILES += $(man_MANS)

#
##
Expand Down Expand Up @@ -105,6 +106,7 @@ axa_libaxa_la_SOURCES = \
axa/strbuf.h \
axa/trie.h \
axa/wire.h \
axalib/bit_funcs.c \
axalib/client.c \
axalib/dns_walk.c \
axalib/domain_to_str.c \
Expand Down Expand Up @@ -148,8 +150,6 @@ axa_libaxa_la_CFLAGS = \
${yajl_CFLAGS}

pkgconfig_DATA = axa/libaxa.pc
EXTRA_DIST += axa/libaxa.pc.in
DISTCLEANFILES += axa/libaxa.pc


#
Expand Down Expand Up @@ -288,7 +288,7 @@ spotless: distclean
##
#

EXTRA_DIST += tests
EXTRA_DIST += tests/test-json.c

TESTS += tests/test-json
check_PROGRAMS += tests/test-json
Expand Down
39 changes: 13 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ program which will make the remote data available locally, and then use
as they would on an analysis server directly connected to SIE itself. An
example of how to do this is included later in this document.

The `radtool` and `radtunnel` programs are used to stream RAD watch hits from a
remote RAD server to the local network. They actually share code bases with
The `radtool` and `radtunnel` programs are used to stream RAD anomaly hits from
a remote RAD server to the local network. They actually share code bases with
their "sra-" counterparts and the program logic is such that it detects its
filename and invokes itself in RAD mode.

Expand Down Expand Up @@ -97,20 +97,20 @@ The AXA suite has the following external dependencies:
* [zlib](http://www.zlib.net/)
* [nmsg](https://github.com/farsightsec/nmsg) (probably will want to configure
with `--without-libxs`, be sure to use version >= 0.11.2)
* [protobuf-c](https://github.com/protobuf-c/protobuf-c) (be sure to use 2.x.x)
* [protobuf-c](https://github.com/protobuf-c/protobuf-c) (be sure to use >= 1.2.1)
* [sie-nmsg](https://github.com/farsightsec/sie-nmsg)
* [wdns](https://github.com/farsightsec/wdns)
* [libedit](http://thrysoee.dk/editline/)
* [libbsd](http://libbsd.freedesktop.org/wiki/) (should already be installed
on BSDish systems)
* [libssl](http://openssl.org/) (recommended >= 1.0.2i)
* [check](http://check.sourceforge.net/doc/check_html/) (be sure to use >= 0.10.0)
* [yajl](https://lloyd.github.io/yajl/) (be sure to use >= 2.1.0)

Optional dependency:

* [doxygen](http://www.stack.nl/~dimitri/doxygen/) (be sure to use >= 1.8.3
that supports inlining markdown files)
* [check](http://check.sourceforge.net/doc/check_html/) (be sure to use >= 0.10.0)

After satisfying the above, build with something like:

Expand All @@ -124,33 +124,20 @@ html/index.html` should get you started.
Finally, to give the AXA suite a home, `sudo make install`.

### Debian package install
On Debian systems, the following packages should be installed:

* `pkg-config`
* `libpcap0.8-dev`
* `zlib1g-dev`
* `libbsd-dev`
* `libedit-dev`
* `libprotobuf-c0-dev (>= 1.0.1)`
* `protobuf-c-compiler`
* `libwdns-dev (>= 0.8.0)`
* `libnmsg-dev (>= 0.11.2)`
* `nmsg-msg-module-sie-dev (>= 1.0.0)`
* `check (>= 0.10.0)`
* `yajl (>= 2.1.0)`

The binary packages of AXA and its dependencies are available from
[a Debian package repository maintained by Farsight Security](https://archive.farsightsecurity.com/SIE_Software_Installation_Debian/). These packages should be
used instead of building from source on Debian-based systems.

On a clean Debian install, the following brings in everything "external"
that is needed and then install all of the AXA tools and `libaxa`:
To install the AXA Tools `sratool`, `radtool`, `sratunnel`, `radtunnel`:

~~~
# apt-get install axa-tools
~~~

To install AXA development files (if you wish to use the libaxa C API):

~~~
# apt-get install build-essential autoconf libpcap-dev \
zlib1g-dev libedit-dev libbsd-dev libtool \
libssl-dev pkg-config curl unzip
# apt-get install axa libaxa-dev
# apt-get install libaxa-dev
~~~

## SRA and RAD Server Encrypted Transport
Expand Down Expand Up @@ -214,7 +201,7 @@ of that document.

To setup TLS access for SRA and/or RAD, you need to do the following:

1. Install axa (as per above). Installed alongside the AXA tools are
1. Install axa-tools (as per above). Installed alongside the AXA tools are
three TLS helper scripts:
* axa_make_cert: Generate AXA certificate and private key files
* axa_server_cert: Retrieve the AXA server certificate fingerprint
Expand Down
14 changes: 10 additions & 4 deletions configure.ac
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
AC_PREREQ(2.60)
AC_INIT([axa], [1.3.4])
AC_INIT([axa], [1.4.0])
PACKAGE_DESCRIPTION="Farsight Security Advanced Exchange Access (AXA)"
AC_SUBST(PACKAGE_DESCRIPTION)
AC_CONFIG_SRCDIR([axa/axa.h])
Expand Down Expand Up @@ -76,19 +76,24 @@ else
use_yajl="false"
fi

PKG_CHECK_MODULES([check], [check])
PKG_CHECK_MODULES([check], [check >= 0.10.0],
[CHECK_MOD_MSG="yes"], [CHECK_MOD_MSG="no"])

AC_PATH_PROG([DOXYGEN], [doxygen])
AM_CONDITIONAL([HAVE_DOXYGEN], [test -n "$DOXYGEN"])
if test -n "$DOXYGEN"; then
DOC_HTML_MSG="yes, doxygen available: $DOXYGEN"
AC_MSG_CHECKING(doxygen version)
MY_CHECK_DOXYGEN
installed_version=`$DOXYGEN --version 2>/dev/null`
AS_VERSION_COMPARE($installed_version, "1.8.3",
DOXYGEN_version="oldish",
DOXYGEN_version="newish",
DOXYGEN_version="newish")
AC_MSG_RESULT($DOXYGEN_version)
AC_CONFIG_FILES([Doxyfile])
DOXYGEN_INPUT="${srcdir}/axa ${srcdir}/README.md"
AC_SUBST(DOXYGEN_INPUT)
if test $DOXYGEN_version == "oldish"; then
if test $DOXYGEN_version = "oldish"; then
AC_MSG_WARN(old Doxygen version found API documentation may not render as intended consider upgrading to version 1.8.3 or newer)
fi
else
Expand Down Expand Up @@ -146,4 +151,5 @@ AC_MSG_RESULT([
TLS ciphers: $TLS_CIPHERS
yajl support: ${use_yajl}
make check available: ${CHECK_MOD_MSG}
])
4 changes: 2 additions & 2 deletions debian/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
axa-doc
axa-dbg
axa
axa-tools-dbg
axa-tools
libaxa-dev
tmp
libaxa0
Expand Down
File renamed without changes.
19 changes: 19 additions & 0 deletions debian/changelog
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
axa (1.4.0) UNRELEASED; urgency=low

* Fix bug in sratunnel where pcap output could underflow a counter and crash
* Fix bug in sratool where 'get channels' would fail
* Fix bug in sratunnel where error messages would fail to emit
* Fix typos in manuals
* Fix nonportable doxygen version check
* Add missing files to EXTRA_DIST
* Update README (proper package versions, better install instructions)

-- Mike Schiffman <[email protected]> Fri, 02 Dec 2016 00:49:13 +0000

axa (1.3.5) UNRELEASED; urgency=low

* Fix package descriptions
* Require nmsg >= 0.11.2

-- Mike Schiffman <[email protected]> Mon, 15 Nov 2016 17:19:14 +0000

axa (1.3.4) UNRELEASED; urgency=low

* Update copyright for 2016 where missing
Expand Down
24 changes: 11 additions & 13 deletions debian/control
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,37 @@ Section: libs
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends},
nmsg-msg8-module-sie (>= 0.16)
Description: Advanced Exchange Access
Description: AXA C library

Package: libaxa0-dbg
Section: debug
Priority: extra
Architecture: any
Depends: libaxa0 (= ${binary:Version}), ${misc:Depends}
Description: Advanced Exchange Access (debug symbols)
Description: AXA C library (debug symbols)

Package: libaxa-dev
Section: libdevel
Architecture: any
Depends: libaxa0 (= ${binary:Version}), ${misc:Depends}
Description: Advanced Exchange Access (development files)
Description: AXA development files

Package: axa-doc
Section: doc
Architecture: all
Depends: ${misc:Depends}
Description: Advanced Exchange Access (documentation)
Description: AXA documentation

Package: axa
Package: axa-tools
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends},
libaxa0 (= ${binary:Version})
Description: AXA command line tools and C library
sratool, sratunnel, radtool, radtunnel as well as SRA protocol utility library
and headers
Description: AXA command line tools
sratool, sratunnel, radtool, and radtunnel

Package: axa-dbg
Package: axa-tools-dbg
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends},
axa (= ${binary:Version})
Description: AXA command line tools and C library (with debug symbols)
sratool, sratunnel, radtool, radtunnel as well as SRA protocol utility library
and headers
axa-tools (= ${binary:Version})
Description: AXA command line tools (debug symbols)
sratool, sratunnel, radtool, and radtunnel
2 changes: 1 addition & 1 deletion debian/rules
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

override_dh_strip:
dh_strip -p libaxa0 --dbg-package=libaxa0-dbg
dh_strip -p axa --dbg-package=axa-dbg
dh_strip -p axa-tools --dbg-package=axa-tools-dbg
dh_strip -a --remaining-packages

override_dh_shlibdeps:
Expand Down
46 changes: 16 additions & 30 deletions fwd.man
Original file line number Diff line number Diff line change
Expand Up @@ -5,54 +5,42 @@
.Bl -tag -width 4n
.It Xo
.Sm off
.No nmsg:
.Op tcp:|udp:
.Cm nmsg:
.Op Cm tcp: Ns | Ns Cm udp:
.Ar host,port
.Sm on \*(CT
.Xc
sends
.Em nmsg
messages to the
.Em tcp
or
.Em udp
sends NMSG messages to the UDP or optional TCP
host name and port number
.Ar host,port .
UDP is the default.
IP packets are converted to
.Em nmsg
messages.
IP packets are converted to NMSG messages.
.It Xo
.Sm off
.No nmsg:file:
.Cm nmsg:file:
.Ar path
.Sm on \*(CT
.Xc
sends
.Em nmsg
messages to the
.Ar file .
IP packets are converted to
.Em nmsg
messages.
sends NMSG messages to the file named
.Ar path .
IP packets are converted to NMSG messages.
.It Xo
.Sm off
.No pcap
.Op -fifo :
.Ar file
.Cm pcap
.Op Cm -fifo :
.Ar path
.Sm on \*(CT
.Xc
sends IP packets to a file or FIFO
sends IP packets to a file or FIFO named
.Ar path
for examination with
.Xr tcpdump 1
or another packet tracing tool.
An ordinary file is the default.
Only IP packets but not
.Em nmsg
messages are sent.
Only IP packets but not NMSG messages are sent.
.It Xo
.Sm off
.No pcap-if:
.Cm pcap-if:
.Op Ar dst /
.Ar ifname
.Sm on \*(CT
Expand All @@ -68,8 +56,6 @@ than all 0:0:0:0:0:0 default.
This output usually requires that
.Nm
be run by root.
Only IP packets but not
.Em nmsg
messages are sent.
Only IP packets but not NMSG messages are sent.
.El
.\" end of fwd.man
16 changes: 0 additions & 16 deletions m4/doxygen.m4

This file was deleted.

Loading

0 comments on commit e425e50

Please sign in to comment.