-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathparsers.py
290 lines (230 loc) · 8.38 KB
/
parsers.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
import abc
import logging
import time
from enum import IntEnum
from pyparsing import Optional, Literal, QuotedString, Word, Or, ZeroOrMore, OneOrMore, White, Group, Combine, Suppress
from pyparsing import nums, alphas, printables, restOfLine, lineEnd, ParseException, alphanums
from syslog_rfc5424_parser import SyslogMessage, ParseError
__author__ = 'Simon Esprit'
class RawSyslogData(object):
"""
Holds unparsed syslog data.
"""
def __init__(self, message, origin_ip):
self.message = message
self.origin_ip = str(origin_ip)
self.timestamp = time.time() * 1000
def parse_message(self, parser=None):
"""
Try to parse raw data to a SyslogMessage
:param parser: force usage of a specific Parser.
:return: SyslogMessage or None in case it could not be parsed.
"""
if parser is not None:
parsed = parser.parse_message(self.message)
if not parsed:
logging.warn("%s could not parse: %s" % (parser.__name__, self.message))
return parsed
else:
message = RFC5424Parser.parse_message(self.message)
if message is not None:
return message
# try all known NonRFC5424 parsers
for subclass in NonRFC5424Parser.__subclasses__():
message = subclass.parse_message(self.message)
if message is not None:
return message
return None
class Parser(object):
__metaclass__ = abc.ABCMeta
@abc.abstractmethod
def parse_message(self, data):
"""Parse message with class specific format """
@abc.abstractmethod
def name(self):
"""Name by which this parser can be selected from command line"""
class RFC5424Parser(Parser):
@staticmethod
def name():
return "rfc5424"
"""
Parses messages that conform to RFC5424 specification.
"""
@classmethod
def parse_message(cls, data):
try:
message = SyslogMessage.parse(data)
except ParseError as e:
message = None
logging.warning("%s - %s" % (cls.__name__, str(e)))
return message
class NonRFC5424Parser(Parser):
"""
Internal classes for use by non-RFC parser.
Contains class definitions and helper functions that can be used by implementers.
"""
class SyslogFacility(IntEnum):
kern = 0
user = 1
mail = 2
daemon = 3
auth = 4
syslog = 5
lpr = 6
news = 7
uucp = 8
cron = 9
authpriv = 10
ftp = 11
ntp = 12
audit = 13
alert = 14
clockd = 15
local0 = 16
local1 = 17
local2 = 18
local3 = 19
local4 = 20
local5 = 21
local6 = 22
local7 = 23
unknown = -1
class SyslogSeverity(IntEnum):
emerg = 0
alert = 1
crit = 2
err = 3
warning = 4
notice = 5
info = 6
debug = 7
@staticmethod
def name():
pass
@staticmethod
def _toInt(s, loc, toks):
return int(toks[0])
@classmethod
def parse_message(cls, data):
pass
class BusyboxParser(NonRFC5424Parser):
"""
Parses syslog messages sent by syslogd as found in Busybox.
This version is often found in embedded devices and is NOT RFC5424 compliant.
"""
@staticmethod
def name():
return "busybox"
@staticmethod
def _pyparse_message(string):
"""
Parse message string using pyparse.
"""
# pyparse variables
dash = Literal("-")
colon = Literal(":")
SP = Suppress(White(ws=' ', min=1, max=1))
pri = Combine(Suppress(Literal("<")) + Word(nums, min=1, max=3) + Suppress(Literal(">"))).setParseAction(NonRFC5424Parser._toInt)
rfc3164_date = Word(alphas, min=3, max=3) + SP + Word(nums, min=1, max=2)
rfc3164_time = Combine(Word(nums, min=2, max=2) + colon + Word(nums, min=2, max=2) + colon + Word(nums, min=2, max=2))
# not clear what this represents...
appname = Word(alphanums + "_-[].", min=1, max=48)
header = Group(
pri.setResultsName('pri') +
rfc3164_date.setResultsName('date') + SP +
rfc3164_time.setResultsName('time') + SP +
appname.setResultsName('appname') + colon
)
message = Combine(restOfLine + lineEnd)
syslog_message = header.setResultsName('header') + Optional(SP + message.setResultsName('message'))
return syslog_message.parseString(string)
@classmethod
def parse_message(cls, data):
try:
groups = BusyboxParser._pyparse_message(data)
except ParseException as e:
logging.debug("%s - %s" % (cls.__name__, str(e)))
return None
header = groups['header']
time = header['time']
date = header['date']
timestamp = "%s-%sT%s.00Z" % (date[0], date[1], time)
appname = header['appname']
if 'message' in groups:
message = groups['message']
else:
message = None
pri = int(header['pri'])
facility = pri >> 3
try:
facility = NonRFC5424Parser.SyslogFacility(facility)
except Exception:
facility = NonRFC5424Parser.SyslogFacility.unknown
severity = pri & 7
severity = NonRFC5424Parser.SyslogSeverity(severity)
return SyslogMessage(severity=severity, facility=facility, timestamp=timestamp, appname=appname, msg=message)
class OSXParser(NonRFC5424Parser):
"""
Parses syslog messages sent by syslogd as found in OSX (Apple).
Note that the default format is expected.
"""
@staticmethod
def name():
return "macosx"
@staticmethod
def _pyparse_message(string):
"""
Parse message string using pyparse.
"""
# pyparse variables
dash = Literal("-")
colon = Literal(":")
SP = Suppress(White(ws=' ', min=1, max=1))
pri = Combine(Suppress(Literal("<")) + Word(nums, min=1, max=3) + Suppress(Literal(">"))).setParseAction(NonRFC5424Parser._toInt)
rfc3164_date = Word(alphas, min=3, max=3) + SP + Word(nums, min=1, max=2)
rfc3164_time = Combine(Word(nums, min=2, max=2) + colon + Word(nums, min=2, max=2) + colon + Word(nums, min=2, max=2))
# hostname from originator - not sure how long this can be!
hostname = Word(printables, min=1, max=255)
# TODO must support apps which contain spaces on OSX
appname = Word(alphanums + "_-.:", min=1, max=48)
procid = Combine(Suppress(Literal("[")) + Word(alphanums, min=1, max=128) + Suppress(Literal("]"))).setParseAction(NonRFC5424Parser._toInt)
header = Group(
pri.setResultsName('pri') +
rfc3164_date.setResultsName('date') + SP +
rfc3164_time.setResultsName('time') + SP +
hostname.setResultsName('host') + SP +
appname.setResultsName('appname') +
procid.setResultsName('procid') + colon
)
message = Combine(restOfLine + lineEnd)
syslog_message = header.setResultsName('header') + Optional(SP + message.setResultsName('message'))
return syslog_message.parseString(string)
@classmethod
def parse_message(cls, data):
try:
groups = OSXParser._pyparse_message(data)
except ParseException as e:
logging.debug("%s - %s" % (cls.__name__, str(e)))
return None
header = groups['header']
time = header['time']
date = header['date']
timestamp = "%s-%sT%s.00Z" % (date[0], date[1], time)
host = header['host']
appname = header['appname']
procid = header['procid']
if 'message' in groups:
message = groups['message']
else:
message = None
pri = int(header['pri'])
facility = pri >> 3
try:
facility = NonRFC5424Parser.SyslogFacility(facility)
except Exception:
facility = NonRFC5424Parser.SyslogFacility.unknown
severity = pri & 7
severity = NonRFC5424Parser.SyslogSeverity(severity)
return SyslogMessage(severity=severity, facility=facility, timestamp=timestamp,
hostname=host, appname=appname, procid=procid,
msg=message)