From 8fdd3b45c0c2b2a5751efd79e2be4cc0241af53e Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Fri, 22 Feb 2008 09:13:14 +0000 Subject: added some doc for imgssapi and imtcp input modules --- ChangeLog | 7 ++++--- doc/Makefile.am | 2 ++ doc/expression.html | 2 +- doc/imgssapi.html | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/imtcp.html | 51 +++++++++++++++++++++++++++++++++++++++++++++ doc/rsyslog_conf.html | 4 ++-- plugins/imtcp/imtcp.c | 2 +- 7 files changed, 118 insertions(+), 7 deletions(-) create mode 100644 doc/imgssapi.html create mode 100644 doc/imtcp.html diff --git a/ChangeLog b/ChangeLog index bc6a7d33..2d9894af 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,9 +1,10 @@ --------------------------------------------------------------------------- -Version 3.12.0 (rgerhards), 2008-02-?? -- gssapi input can now be build separately from plain tcp input - thanks to varmojfekoj for the patch +Version 3.11 5 (rgerhards), 2008-02-?? +- new imgssapi module, changed imtcp module - this enables to load/package + GSSAPI support separately - thanks to varmojfekoj for the patch - compatibility mode (the -c option series) is now at least partly completed - thanks to varmojfekoj for the patch +- documentation for imgssapi and imtcp added - duplicate $ModLoad's for the same module are now detected and rejected -- thanks to varmojfekoj for the patch --------------------------------------------------------------------------- diff --git a/doc/Makefile.am b/doc/Makefile.am index 901f1202..f03c9120 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -30,6 +30,8 @@ html_files = \ omsnmp.html \ omlibdbi.html \ imfile.html \ + imtcp.html \ + imgssapi.html \ professional_support.html \ queues.html \ queueWorkerLogic.dia \ diff --git a/doc/expression.html b/doc/expression.html index 3aecf298..6d187413 100644 --- a/doc/expression.html +++ b/doc/expression.html @@ -9,7 +9,7 @@ far, they are supported for filtering messages.

C-like comments (/* some c

Formal Definition

Below is the formal definition of expression format (in ABNF, RFC 2234):
-

; The stuff immediately below here is a quick shot at how the config
; file ABNF *at whole* may look like. That is not really related to
; expressions, but for the time being I put it here. It will later be
; moved to a more appropriate place. -- rgerhards, 2008-02-22
?line?   := cfsysline / cfli
cfsysline:= BOL "$" *char EOL ; how to handle the first line? (no EOL in front!)
BOL      := ; Begin of Line - implicitely set on file beginning and after each EOL
EOL       := 0x0a ;LF
if_stmt  := "if" expr "then"
old_filter:= BOL facility "." severity
facility := "*" / "auth" / "authpriv" / "cron" / "daemon" / "kern" / "lpr" / 
            "mail" / "mark" / "news" / "security" / "syslog" / "user" / "uucp" / 
            "local0" .. "local7" / "mark"
	   ; The keyword security should not be used anymore
	   ; mark is just internal
severity := 

; and now the actual expression
expr     := e_and *("or" e_and)
e_and    := e_cmp *("and" e_cmp)
e_cmp    := val 0*1(cmp_op val)
val      := term *(("+" / "-") term)
term     := factor *(("*" / "/" / "%") factor)
factor   := ["not"] ["-"] terminal
terminal := var / constant / function / ( "(" expr ")" )
function := name "(" *("," expr) ")"
var      := "$" varname
varname  := msgvar / sysvar
msgvar   := name
sysvar   := "$" name
name     := alpha *(alnum)
constant := string / number
string   := simpstr / tplstr ; tplstr will be implemented in next phase
simpstr  := "'" *char "'"    ; use your imagination for char ;)
tplstr   := '"' template '"' ; not initially implemented
number   := ["-"] 1*digit ; 0nn = octal, 0xnn = hex, nn = decimal
cmp_op   := "==" / "!=" / "<>" / "<" / ">" / "<=" / ">=" / "contains" / "startswith"
digit    := %x30-39
alpha    := "a" ... "z" # all letters
alnum    :* alpha / digit / "_"
+

; The stuff immediately below here is a quick shot at how the config
; file ABNF *at whole* may look like. That is not really related to
; expressions, but for the time being I put it here. It will later be
; moved to a more appropriate place. -- rgerhards, 2008-02-22
?line?   := cfsysline / cfli
cfsysline:= BOL "$" *char EOL ; how to handle the first line? (no EOL in front!)
BOL      := ; Begin of Line - implicitely set on file beginning and after each EOL
EOL       := 0x0a ;LF
if_stmt  := "if" expr "then"
old_filter:= BOL facility "." severity ; no whitespace allowed between BOL and facility!
facility := "*" / "auth" / "authpriv" / "cron" / "daemon" / "kern" / "lpr" / 
            "mail" / "mark" / "news" / "security" / "syslog" / "user" / "uucp" / 
            "local0" .. "local7" / "mark"
	   ; The keyword security should not be used anymore
	   ; mark is just internal
severity := TBD ; not really relevant in this context

; and now the actual expression
expr     := e_and *("or" e_and)
e_and    := e_cmp *("and" e_cmp)
e_cmp    := val 0*1(cmp_op val)
val      := term *(("+" / "-") term)
term     := factor *(("*" / "/" / "%") factor)
factor   := ["not"] ["-"] terminal
terminal := var / constant / function / ( "(" expr ")" )
function := name "(" *("," expr) ")"
var      := "$" varname
varname  := msgvar / sysvar
msgvar   := name
sysvar   := "$" name
name     := alpha *(alnum)
constant := string / number
string   := simpstr / tplstr ; tplstr will be implemented in next phase
simpstr  := "'" *char "'"    ; use your imagination for char ;)
tplstr   := '"' template '"' ; not initially implemented
number   := ["-"] 1*digit ; 0nn = octal, 0xnn = hex, nn = decimal
cmp_op   := "==" / "!=" / "<>" / "<" / ">" / "<=" / ">=" / "contains" / "startswith"
digit    := %x30-39
alpha    := "a" ... "z" # all letters
alnum    :* alpha / digit / "_"

[rsyslog.conf overview] [manual index] [rsyslog site]

This documentation is part of the diff --git a/doc/imgssapi.html b/doc/imgssapi.html new file mode 100644 index 00000000..8e6b7d87 --- /dev/null +++ b/doc/imgssapi.html @@ -0,0 +1,57 @@ + + +GSSAPI Syslog Input Module + + + +

GSSAPI Syslog Input Module

+

Module Name:    imtcp

+

Author: varmojfekoj +<email address here? which?>

+

Description:

+

Provides the ability to receive syslog messages from the +network protected via Kerberos 5 encryption and authentication. This +module also contains the functionality found in imtcp, +which can not be used if imgssapi is used.

+

Configuration Directives:

+ +Caveats/Known Bugs: + +

Sample:

+

This sets up a TCP server on port 514 and a GSSAPI protected +syslog server at port 1514:
+

+ +

[rsyslog.conf overview] +[manual index] [rsyslog site]

+

This documentation is part of the +rsyslog +project.
+Copyright © 2008 by Rainer +Gerhards and +Adiscon. +Released under the GNU GPL version 3 or higher.

+ \ No newline at end of file diff --git a/doc/imtcp.html b/doc/imtcp.html new file mode 100644 index 00000000..b2c6d21d --- /dev/null +++ b/doc/imtcp.html @@ -0,0 +1,51 @@ + + +TCP Syslog Input Module + + + +

TCP Syslog Input Module

+

Module Name:    imtcp

+

Author: Rainer Gerhards +<rgerhards@adiscon.com>

+

Description:

+

Provides the ability to receive syslog messages via TCP. +Encryption can be provided by using stunnel +(an alternative is the use +the imgssapi +modul).

+

In the future, multiple receivers may be configured by +specifying +$InputTCPServerRun multiple times. This is not currently supported. +

+

Configuration Directives:

+ +Caveats/Known Bugs: + +

Sample:

+

This sets up a TCP server on port 514:
+

+ +

[rsyslog.conf overview] +[manual index] [rsyslog site]

+

This documentation is part of the +rsyslog +project.
+Copyright © 2008 by Rainer +Gerhards and +Adiscon. +Released under the GNU GPL version 3 or higher.

+ \ No newline at end of file diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html index 977d37f0..60e2e7ac 100644 --- a/doc/rsyslog_conf.html +++ b/doc/rsyslog_conf.html @@ -36,7 +36,7 @@ SQLLite, Ingres, Oracle, mSQL)
  • imfile -  input module for text files
  • imudp - udp syslog message input
    • -
  • imtcp - input plugin for plain tcp and GSS-enable syslog
    • +
  • imtcp - input plugin for plain tcp syslog
  • imgssapi - input plugin for plain tcp and GSS-enable syslog
  • immark - support for mark messages
  • imklog - kernel logging
    • @@ -1064,7 +1064,7 @@ Please note the colon in fron

    Rsyslogd uses a slightly different syntax for its configuration file than the original BSD sources. Originally all messages of a specific priority and above were forwarded to the log -file. The modifiers "='', "!'' and "-'' were added to make rsyslogd +file. The modifiers "='', "!'' and "!-'' were added to make rsyslogd more flexible and to use it in a more intuitive manner.

    The original BSD syslogd doesn't understand spaces as separators diff --git a/plugins/imtcp/imtcp.c b/plugins/imtcp/imtcp.c index dc005af8..c3f5e138 100644 --- a/plugins/imtcp/imtcp.c +++ b/plugins/imtcp/imtcp.c @@ -1287,7 +1287,7 @@ CODEmodInit_QueryRegCFSLineHdlr #if defined(USE_GSSAPI) CHKiRet(omsdRegCFSLineHdlr((uchar *)"inputgssserverrun", 0, eCmdHdlrGetWord, addGSSListener, NULL, STD_LOADABLE_MODULE_ID)); - CHKiRet(omsdRegCFSLineHdlr((uchar *)"inputgsslistenservicename", 0, eCmdHdlrGetWord, + CHKiRet(omsdRegCFSLineHdlr((uchar *)"inputgssserverservicename", 0, eCmdHdlrGetWord, NULL, &gss_listen_service_name, STD_LOADABLE_MODULE_ID)); #endif CHKiRet(omsdRegCFSLineHdlr((uchar *)"resetconfigvariables", 1, eCmdHdlrCustomHandler, -- cgit