From 8cb6ec4cee79d41c30d7df38b58ab1f198ac8581 Mon Sep 17 00:00:00 2001
From: Rainer Gerhards
Date: Wed, 21 May 2008 11:45:40 +0200
Subject: added some forgotten doc
---
doc/imtcp.html | 2 +-
doc/ns_gtls.html | 37 ++++++++++++++++++++++++++-----------
2 files changed, 27 insertions(+), 12 deletions(-)
diff --git a/doc/imtcp.html b/doc/imtcp.html
index 86c50dba..12f8020d 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -20,7 +20,7 @@ $InputTCPServerRun multiple times. This is not currently supported.
- $InputTCPServerRun <port>
Starts a TCP server on selected port
-- $InputTCPMaxSessions <number>
+ - $InputTCPMaxSessions <number>
Sets the maximum number of sessions supported- $InputTCPServerStreamDriverMode <number>
Sets the driver mode for the currently selected network stream driver. <number> is driver specifc. - $InputTCPServerStreamDriverAuthMode <mode-string>
Sets the authentication mode for the currently selected network stream driver. <mode-string> is driver specifc. - $InputTCPServerStreamDriverPermittedPeer <id-string>
diff --git a/doc/ns_gtls.html b/doc/ns_gtls.html
index ff5ed7c3..46e2e238 100644
--- a/doc/ns_gtls.html
+++ b/doc/ns_gtls.html
@@ -11,21 +11,36 @@ library.
- 0 - unencrypted trasmission (just like ptcp driver)
- 1 - TLS-protected operation
-
Note: mode 0 does not provide any benefit over the ptcp driver.
-This mode exists for technical reasons, but should not be used. It may
-be removed in the future.
-Supported Authentication Modes
+
+Note: mode 0 does not provide any benefit over the ptcp driver. This
+mode exists for technical reasons, but should not be used. It may be
+removed in the future.
+Supported Authentication
+Modes
-- anon - anonymous authentication as
+
- anon
+- anonymous authentication as
described in IETF's draft-ietf-syslog-transport-tls-12 Internet draft
-- x509/fingerprint - certificate fingerprint authentication as
-described in IETF's draft-ietf-syslog-transport-tls-12 Internet draft
- x509/name - certificate validation and subject name authentication as
-described in IETF's draft-ietf-syslog-transport-tls-12 Internet draft [NOT YET IMPLEMENTED]
-
Note: "anon" does not permit to authenticate the remote peer. As
-such, this mode is vulnerable to man in the middle attacks as well as
+x509/fingerprint
+- certificate fingerprint authentication as
+described in IETF's draft-ietf-syslog-transport-tls-12 Internet draft
+x509/name
+- certificate validation and subject name authentication as
+described in IETF's draft-ietf-syslog-transport-tls-12 Internet draft
+[NOT YET IMPLEMENTED]
+
+Note: "anon" does not permit to authenticate the remote peer. As such,
+this mode is vulnerable to man in the middle attacks as well as
unauthorized access. It is recommended NOT to use this mode.
-[rsyslog.conf overview]
+
+Known Problems
+Even in x509/fingerprint mode, both the client and sever
+certificate currently must be signed by the same root CA. This is an
+artifact of the underlying GnuTLS library and the way we use it. It is
+expected that we can resolve this issue in the future.
+[rsyslog.conf overview]
[manual index] [rsyslog site]
+
This documentation is part of the
rsyslog
project.
--
cgit v1.2.3