Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic Syslog UDP collector bot #1611

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions intelmq/bots/BOTS
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,16 @@
"rsync_path": "<path>"
}
},
"UDP": {
"description": "Receive UDP messages.",
"module": "intelmq.bots.collectors.udp.collector",
"parameters": {
"ip": "0.0.0.0",
"name": "UDP",
"port": 514,
"provider": "UDP"
}
},
"TCP": {
"description": "Receive events by opening a TCP port (ex: from TCP Output of another IntelMQ instance).",
"module": "intelmq.bots.collectors.tcp.collector",
Expand Down
Empty file.
59 changes: 59 additions & 0 deletions intelmq/bots/collectors/udp/collector.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# -*- coding: utf-8 -*-
"""Receive UDP messages

SPDX-FileCopyrightText: 2020 Linköping University <https://liu.se/>
SPDX-License-Identifier: AGPL-3.0-or-later

Creates one IntelMQ event per UDP packet.

Parameters:

ip: string, optional, bind IP (or wildcard, if not set)

name: string, optional, feed name, default "UDP"

port: integer, listen port

provider: string, optional, feed provider name, default "UDP"

"""

from intelmq.lib.bot import CollectorBot
from intelmq.lib.exceptions import ConfigurationError

import socketserver


class UDPCollectorBot(CollectorBot):

def init(self):
self.ip = getattr(self.parameters, 'ip', '0.0.0.0')
self.name = getattr(self.parameters, 'name', 'UDP')
self.port = int(getattr(self.parameters, 'port', 0))
if self.port == 0:
raise ConfigurationError('Listen port',
'No port specified')
self.provider = getattr(self.parameters, 'provider', 'UDP')

self.server = socketserver.UDPServer((self.ip, self.port), UDPServer)
self.server.logger = self.logger
self.server.send_message = self.send_message
self.server.new_report = self.new_report
self.logger.info("Listening on %s:%d/%s",
self.ip, self.port, self.protocol)

def process(self):
self.server.serve_forever()


class UDPServer(socketserver.BaseRequestHandler):
def handle(self):
line = self.request[0].strip()
self.server.logger.debug("Received event from %s", self.client_address)
report = self.server.new_report()
report.add('raw', line)
self.server.send_message(report)
self.finish()


BOT = UDPServer