Files
asterisk/doc/tex
Russell Bryant 4cf8a968fd Add an API for reporting security events, and a security event logging module.
This commit introduces the security events API.  This API is to be used by
Asterisk components to report events that have security implications.
A simple example is when a connection is made but fails authentication.  These
events can be used by external tools manipulate firewall rules or something
similar after detecting unusual activity based on security events.

Inside of Asterisk, the events go through the ast_event API.  This means that
they have a binary encoding, and it is easy to write code to subscribe to these
events and do something with them.

One module is provided that is a subscriber to these events - res_security_log.
This module turns security events into a parseable text format and sends them
to the "security" logger level.  Using logger.conf, these log entries may be
sent to a file, or to syslog.

One service, AMI, has been fully updated for reporting security events.
AMI was chosen as it was a fairly straight forward service to convert.
The next target will be chan_sip.  That will be more complicated and will
be done as its own project as the next phase of security events work.

For more information on the security events framework, see the documentation
generated from doc/tex/.  "make asterisk.pdf"

Review: https://reviewboard.asterisk.org/r/273/


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@206021 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-07-11 19:15:03 +00:00
..
2008-07-31 16:37:08 +00:00
2009-01-21 22:04:16 +00:00
2008-07-31 16:37:08 +00:00

Asterisk Reference Documentation
--------------------------------

1) To generate a PDF from this documentation, you will need the rubber tool,
   and all of its dependencies.  The web site for this tool is:

      http://www.pps.jussieu.fr/~beffara/soft/rubber/

   Then, once this tool is installed, running "make pdf" will generate
   the PDF automatically using this tool.  The result will be asterisk.pdf.

   NOTE:  After installing rubber, you will need to re-run the top level
   configure script.  It checks to see if rubber is installed, so that the
   asterisk.pdf Makefile target can produce a useful error message when it is
   not installed.

2) To generate HTML from this documentation, you will need the latex2html tool,
   and all of its dependencies.  The web site for this tool is:

      http://www.latex2html.org/

   Then, once this tool is installed, running "make html" will generate the
   HTML documentation.  The result will be an asterisk directory full of
   HTML files.