diff --git a/logprep/abc/component.py b/logprep/abc/component.py index 317fd3912..a7d83387a 100644 --- a/logprep/abc/component.py +++ b/logprep/abc/component.py @@ -1,4 +1,4 @@ -""" abstract module for components""" +"""abstract module for components""" import functools import inspect diff --git a/logprep/abc/connector.py b/logprep/abc/connector.py index 92bb8a17f..7c54f5eda 100644 --- a/logprep/abc/connector.py +++ b/logprep/abc/connector.py @@ -1,4 +1,4 @@ -""" abstract module for connectors""" +"""abstract module for connectors""" from attrs import define, field diff --git a/logprep/abc/exceptions.py b/logprep/abc/exceptions.py index 3e1dbb919..1bd4106cc 100644 --- a/logprep/abc/exceptions.py +++ b/logprep/abc/exceptions.py @@ -1,4 +1,4 @@ -""" abstract module for exceptions""" +"""abstract module for exceptions""" class LogprepException(Exception): diff --git a/logprep/configuration.py b/logprep/configuration.py index b2af1c2fe..8143fad8a 100644 --- a/logprep/configuration.py +++ b/logprep/configuration.py @@ -1,4 +1,4 @@ -"""module for component configuration """ +"""module for component configuration""" from typing import TYPE_CHECKING, Any, Mapping diff --git a/logprep/framework/rule_tree/rule_tagger.py b/logprep/framework/rule_tree/rule_tagger.py index f71722b7a..b813fe3ca 100644 --- a/logprep/framework/rule_tree/rule_tagger.py +++ b/logprep/framework/rule_tree/rule_tagger.py @@ -1,4 +1,4 @@ -""" This module implements functionality to add tags to filter expressions. """ +"""This module implements functionality to add tags to filter expressions.""" from typing import Union, List diff --git a/logprep/generator/kafka/configuration.py b/logprep/generator/kafka/configuration.py index ed353f152..c3fd1ca9b 100644 --- a/logprep/generator/kafka/configuration.py +++ b/logprep/generator/kafka/configuration.py @@ -1,4 +1,4 @@ -""" Contains configuration class with configuration validation """ +"""Contains configuration class with configuration validation""" # pylint: disable=too-few-public-methods import sys diff --git a/logprep/processor/pre_detector/rule.py b/logprep/processor/pre_detector/rule.py index 6e63ddafd..54d1c2ee2 100644 --- a/logprep/processor/pre_detector/rule.py +++ b/logprep/processor/pre_detector/rule.py @@ -88,7 +88,7 @@ ip_fields: - some_ip_field -The pre_detector also has the option to normalize the timestamp. +The pre_detector also has the option to normalize the timestamp. To configure this the following parameters can be set in the rule configuration. .. code-block:: yaml @@ -110,7 +110,7 @@ target_timezone: description: Some malicious event. -All of these new parameters are configurable and default to +All of these new parameters are configurable and default to standard values if not explicitly set. .. autoclass:: logprep.processor.pre_detector.rule.PreDetectorRule.Config diff --git a/logprep/processor/timestamper/rule.py b/logprep/processor/timestamper/rule.py index f7f9db8f1..c11ed7389 100644 --- a/logprep/processor/timestamper/rule.py +++ b/logprep/processor/timestamper/rule.py @@ -9,7 +9,7 @@ :caption: Given timestamper rule filter: "winlog.event_id: 123456789" - timestamper: + timestamper: source_fields: ["winlog.event_data.some_timestamp_utc"] target_field: "@timestamp" source_format: UNIX diff --git a/logprep/registry.py b/logprep/registry.py index 9bd6eedb1..cb9b5e3de 100644 --- a/logprep/registry.py +++ b/logprep/registry.py @@ -1,6 +1,6 @@ """module for processor registry - it is used to check if a processor is known to the system. - you have to register new processors here by import them and add to `ProcessorRegistry.mapping` +it is used to check if a processor is known to the system. +you have to register new processors here by import them and add to `ProcessorRegistry.mapping` """ from logprep.connector.confluent_kafka.input import ConfluentKafkaInput diff --git a/logprep/util/credentials.py b/logprep/util/credentials.py index 0ce425d17..932302253 100644 --- a/logprep/util/credentials.py +++ b/logprep/util/credentials.py @@ -10,8 +10,8 @@ filled with the correct values that correspond to the method you want to use. .. code-block:: yaml - :caption: Example for credentials file - + :caption: Example for credentials file + getter: "http://target.url": # example for token given directly via file @@ -71,11 +71,11 @@ /second*: username: password: - + Options for the credentials file are: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - + .. autoclass:: logprep.util.credentials.BasicAuthCredentials :members: username, password :no-index: @@ -88,7 +88,7 @@ .. autoclass:: logprep.util.credentials.MTLSCredentials :members: client_key, cert, ca_cert :no-index: - + Authentication Process: ^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: ../_images/Credentials.svg diff --git a/logprep/util/grok/grok.py b/logprep/util/grok/grok.py index 25da7b774..b17343100 100644 --- a/logprep/util/grok/grok.py +++ b/logprep/util/grok/grok.py @@ -2,7 +2,7 @@ original code from https://github.com/garyelephant/pygrok released under MIT Licence The MIT License (MIT) -Copyright (c) 2014 +Copyright (c) 2014 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/logprep/util/json_handling.py b/logprep/util/json_handling.py index 694b006b4..4a1352bc2 100644 --- a/logprep/util/json_handling.py +++ b/logprep/util/json_handling.py @@ -1,4 +1,4 @@ -""" module for json handling helper methods""" +"""module for json handling helper methods""" import json import os diff --git a/logprep/util/url/url.py b/logprep/util/url/url.py index 564c6c927..88770ac98 100644 --- a/logprep/util/url/url.py +++ b/logprep/util/url/url.py @@ -1,4 +1,4 @@ -""" helper functions for URL extraction and validation. +"""helper functions for URL extraction and validation. Code is inspired by django url validation: https://docs.djangoproject.com/en/4.1/_modules/django/core/validators/ """ diff --git a/logprep/util/validators.py b/logprep/util/validators.py index 1dd6f8185..794765c02 100644 --- a/logprep/util/validators.py +++ b/logprep/util/validators.py @@ -1,4 +1,4 @@ -""" validators to use with `attrs` fields""" +"""validators to use with `attrs` fields""" import os import typing