Skip to content

Commit 4a41a98

Browse files
committed
TCP input TLS - Update README.
1 parent ba9f654 commit 4a41a98

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/plugins/input/tcp/README.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ initial period of inability to interpret flow records does not apply here.
1212
Received IPFIX messages may be compressed using LZ4 stream compression. The compression is
1313
enabled on the exporter and the plugin detects it automatically.
1414

15+
Received IPFIX messages may be secured with TLS. The TLS decoder is enabled by specifying the
16+
certificateFile parameter. Inbound TLS messages are automatically detected.
17+
1518
Example configuration
1619
---------------------
1720

@@ -39,6 +42,18 @@ Mandatory parameters:
3942
multiple times (one IP address per occurrence) to manually select multiple interfaces.
4043
[default: empty]
4144

45+
Optional parameters:
46+
47+
:``certificateFile``:
48+
Path to a PEM file with certificate and private key. Specifying this path will enable TLS
49+
decoder for the inbound connections. If this parameter is omitted, TLS decoder is disabled. Path
50+
may be absolute or relative to cwd of ipfixcol2.
51+
52+
:``tlsVerifyPeer``:
53+
Boolean value. If true, ipfixcol as TLS server will verify its clients certificates. This has no
54+
effect if certificateFile is not set. Trusted certificates are set with OpenSSL environment
55+
variables SSL_CERT_DIR or SSL_CERT_FILE. [default: false]
56+
4257
Notes
4358
-----
4459
The LZ4 compression uses special format that compatible with

0 commit comments

Comments
 (0)