logcliasst 0.1.1

Generate client-side configuration for rsyslog

Rsyslog Configuration Generator

This Python application generates client-side configuration for rsyslog using RainerScript. The configuration includes defining a ruleset and applying it to monitor log files.

Overview

This application provides two main functions:

1. client_ruleset_config: Generates an rsyslog RainerScript configuration string to define a ruleset with disk queue settings.
2. apply_ruleset_client: Generates an rsyslog RainerScript configuration string to apply a previously defined ruleset to monitor a log file using the imfile module.

Prerequisites

• Python 3.x
• Basic understanding of rsyslog and RainerScript

Functions

client_ruleset_config(rule_name, server_ip, port, protocol)

apply_ruleset_client(log_file, tag, facility, severity, rule_name)

Generates a RainerScript configuration string to define a ruleset and apply the rule.

Arguments:

• rule_name (str): Name of the ruleset.
• server_ip (str): IP address or hostname of the rsyslog server.
• port (int): Port number to send logs to.
• protocol (str): Protocol to use ('tcp' or 'udp').
• log_file (str): Log file name where the rule should be applicable.
• tag (str): tag of the log events.
• facility (str): Facilities of the log events('local0' to 'local6', 'authpriv','mail' etc.).
• severity (str): Log criticality('info','warn','crit' etc.).

Returns:

• str: RainerScript configuration string defining the ruleset.

Examples:

config = client_ruleset_config("myRuleset", "192.168.1.100", 514, "tcp")
print(config)

apply = apply_ruleset_client("/var/log/message", "message_log", "local3", "info", "myRuleset")
print(apply)

rsyslog Configuration Template Generator

This Python script generates rsyslog configuration templates with TLS settings and disk queue configuration. The generated configuration can be used to securely forward logs to a remote rsyslog server while ensuring reliable buffering.

Overview

The script creates an rsyslog configuration snippet based on user-provided parameters. This includes:

• TLS settings for secure communication.
• Disk queue settings for log buffering.

Function: generate_rsyslog_template

This function generates an rsyslog configuration template.

Arguments

• cert_file (str): Path to the CA certificate file.
• target_host (str): IP address or hostname of the remote rsyslog server.
• protocol (str): Protocol to use for communication (e.g., tcp).
• port (str): Port number on the remote server.
• rule_name (str): Name of the ruleset.

Returns

• str: The generated rsyslog configuration template as a string.

Usage:

client_tls_template(cert_file, target_host, protocol, port, rule_name)