Skip to content

Added Apache error log normalizer #5

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.

Sign up for GitHub

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

Open
ukolka wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added Apache error log normalizer #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
201 changes: 201 additions & 0 deletions normalizers/apache_error.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
<!-- -->
<!-- pylogparser - Logs parsers python library -->
<!-- Copyright (C) 2011 Wallix Inc. -->
<!-- -->
<!--++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
<!-- -->
<!-- This package is free software; you can redistribute -->
<!-- it and/or modify it under the terms of the GNU Lesser -->
<!-- General Public License as published by the Free Software -->
<!-- Foundation; either version 2.1 of the License, or (at -->
<!-- your option) any later version. -->
<!-- -->
<!-- This package is distributed in the hope that it will be -->
<!-- useful, but WITHOUT ANY WARRANTY; without even the implied -->
<!-- warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR -->
<!-- PURPOSE. See the GNU Lesser General Public License for -->
<!-- more details. -->
<!-- -->
<!-- You should have received a copy of the GNU Lesser General -->
<!-- Public License along with this package; if not, write -->
<!-- to the Free Software Foundation, Inc., 59 Temple Place, -->
<!-- Suite 330, Boston, MA 02111-1307 USA -->
<!-- -->
<!--++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
<!DOCTYPE normalizer SYSTEM "normalizer.dtd">
<normalizer name="apache_error"
version="0.99"
unicode="yes"
ignorecase="yes"
matchtype="match"
appliedTo="body"
taxonomy="web server">
<description>
<localized_desc language="en">Apache error log normalizer. http://httpd.apache.org/docs/2.2/logs.html#errorlog</localized_desc>
</description>
<authors>
<author>kolkabes@gmail.com</author>
</authors>
<tagTypes>
<tagType name="CommonTimeFormat" type="datetime">
<description>
<localized_desc language="en">Matches apache's error log common time format.</localized_desc>
</description>
<regexp>\[\w{3}\s\w{3}\s\d{2}\s\d{2}:\d{2}:\d{2}\s\d{4}\]</regexp>
</tagType>
<tagType name="ApacheWord" type="basestring">
<description>
<localized_desc language="en">status, ...</localized_desc>
</description>
<regexp>[\w.-]+</regexp>
</tagType>
</tagTypes>
<patterns>
<pattern name="apache-error-001">
<description>
<localized_desc language="en">
Apache error log format with referer.
</localized_desc>
</description>
<text>%t \[%s\] \[client %h\] %m, referer: %u</text>
<tags>
<tag name="source_ip" tagType="IP">
<description>
<localized_desc language="en">the remote host initiating the request</localized_desc>
</description>
<substitute>%h</substitute>
</tag>
<tag name="status" tagType="ApacheWord">
<description>
<localized_desc language="en">error status level (error, warn, info, ...)</localized_desc>
</description>
<substitute>%s</substitute>
</tag>
<tag name="__date" tagType="CommonTimeFormat">
<description>
<localized_desc language="en">the date on which entry was made - please note that the timezone information is not carried over</localized_desc>
</description>
<substitute>%t</substitute>
<callbacks>
<callback>DDD MMM dd hh:mm:ss YYYY</callback>
</callbacks>
</tag>
<tag name="message" tagType="Anything">
<description>
<localized_desc language="en">error message</localized_desc>
</description>
<substitute>%m</substitute>
</tag>
<tag name="url" tagType="URL">
<description>
<localized_desc language="en">HTTP referer, URL that was visited whenever error occured</localized_desc>
</description>
<substitute>%u</substitute>
</tag>
</tags>
<examples>
<example>
<text>[Wed Oct 11 14:32:52 2000] [error] [client 127.0.0.1] PHP Parse error: syntax error, unexpected '=' in /var/www/foo.php on line 70, referer: http://example.com/foo</text>
<expectedTags>
<expectedTag name="source_ip">127.0.0.1</expectedTag>
<expectedTag name="status">error</expectedTag>
<expectedTag name="url">http://example.com/foo</expectedTag>
<expectedTag name="message">PHP Parse error: syntax error, unexpected '=' in /var/www/foo.php on line 70</expectedTag>
<expectedTag name="taxonomy">web server</expectedTag>
</expectedTags>
</example>
</examples>
</pattern>
<pattern name="apache-error-002">
<description>
<localized_desc language="en">Apache error log format. More general format.</localized_desc>
</description>
<text>%t \[%s\] \[client %h\] %m</text>
<tags>
<tag name="source_ip" tagType="IP">
<description>
<localized_desc language="en">the remote host initiating the request</localized_desc>
</description>
<substitute>%h</substitute>
</tag>
<tag name="status" tagType="ApacheWord">
<description>
<localized_desc language="en">error status level (error, warn, info, ...)</localized_desc>
</description>
<substitute>%s</substitute>
</tag>
<tag name="__date" tagType="CommonTimeFormat">
<description>
<localized_desc language="en">the date on which error occured - please note that the timezone information is not carried over</localized_desc>
</description>
<substitute>%t</substitute>
<callbacks>
<callback>DDD MMM dd hh:mm:ss YYYY</callback>
</callbacks>
</tag>
<tag name="message" tagType="Anything">
<description>
<localized_desc language="en">error message</localized_desc>
</description>
<substitute>%m</substitute>
</tag>
</tags>
<examples>
<example>
<text>[Wed Oct 11 14:32:52 2000] [error] [client 127.0.0.1] client denied by server configuration: /export/home/live/ap/htdocs/test</text>
<expectedTags>
<expectedTag name="source_ip">127.0.0.1</expectedTag>
<expectedTag name="status">error</expectedTag>
<expectedTag name="message">client denied by server configuration: /export/home/live/ap/htdocs/test</expectedTag>
<expectedTag name="taxonomy">web server</expectedTag>
</expectedTags>
</example>
</examples>
</pattern>
<pattern name="apache-error-003">
<description>
<localized_desc language="en">Apache error log format. Without [client *ip*] part.</localized_desc>
</description>
<text>%t \[%s\] %m</text>
<tags>
<tag name="status" tagType="ApacheWord">
<description>
<localized_desc language="en">error status level (error, warn, info, ...)</localized_desc>
</description>
<substitute>%s</substitute>
</tag>
<tag name="__date" tagType="CommonTimeFormat">
<description>
<localized_desc language="en">the date on which error occured - please note that the timezone information is not carried over</localized_desc>
</description>
<substitute>%t</substitute>
<callbacks>
<callback>DDD MMM dd hh:mm:ss YYYY</callback>
</callbacks>
</tag>
<tag name="message" tagType="Anything">
<description>
<localized_desc language="en">error message</localized_desc>
</description>
<substitute>%m</substitute>
</tag>
</tags>
<examples>
<example>
<text>[Wed Oct 11 14:32:52 2000] [notice] mod_python: Creating 8 session mutexes based on 150 max processes and 0 max threads.</text>
<expectedTags>
<expectedTag name="status">notice</expectedTag>
<expectedTag name="message">mod_python: Creating 8 session mutexes based on 150 max processes and 0 max threads.</expectedTag>
<expectedTag name="taxonomy">web server</expectedTag>
</expectedTags>
</example>
</examples>
</pattern>
</patterns>
<commonTags>
<commonTag name="program">apache</commonTag>
</commonTags>
</normalizer>

32 changes: 32 additions & 0 deletions tests/test_log_samples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,38 @@ def test_apache(self):
# Test "vhost_combined" log format "%v:%p %h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\""
#TODO: Update apache normalizer to handle this format.

def test_apache_error(self):
"""Test Apache error log normalization.
The format of the error log is relatively free-form and descriptive"""
# Test Apache error log format with referer included
# %t \[%s\] \[client %h\] %m, referer: %u
self.aS("""[Wed Oct 11 14:32:52 2000] [error] [client 127.0.0.1] PHP Parse error: syntax error, unexpected '=' in /var/www/foo.php on line 70, referer: http://example.com/foo""",
{'program' : "apache",
'source_ip' : "127.0.0.1",
'status': 'error',
'message': 'PHP Parse error: syntax error, unexpected \'=\' in /var/www/foo.php on line 70',
'date' : datetime(2000, 10, 11, 14, 32, 52),
'body' : '[Wed Oct 11 14:32:52 2000] [error] [client 127.0.0.1] PHP Parse error: syntax error, unexpected \'=\' in /var/www/foo.php on line 70, referer: http://example.com/foo'})

# Test Apache error log format without referer
# %t \[%s\] \[client %h\] %m
self.aS('[Wed Oct 11 14:32:52 2000] [error] [client 127.0.0.1] client denied by server configuration: /export/home/live/ap/htdocs/test',
{'program' : "apache",
'source_ip' : "127.0.0.1",
'status': 'error',
'message': 'client denied by server configuration: /export/home/live/ap/htdocs/test',
'date' : datetime(2000, 10, 11, 14, 32, 52),
'body' : '[Wed Oct 11 14:32:52 2000] [error] [client 127.0.0.1] client denied by server configuration: /export/home/live/ap/htdocs/test'})

# Test Apache error log format without client ip
# %t \[%s\] %m
self.aS('[Wed Oct 11 14:32:52 2000] [notice] mod_python: Creating 8 session mutexes based on 150 max processes and 0 max threads.',
{'program' : "apache",
'date' : datetime(2000, 10, 11, 14, 32, 52),
'status': 'notice',
'message': 'mod_python: Creating 8 session mutexes based on 150 max processes and 0 max threads.',
'body' : '[Wed Oct 11 14:32:52 2000] [notice] mod_python: Creating 8 session mutexes based on 150 max processes and 0 max threads.'})


def test_bind9(self):
"""Test Bind9 normalization"""
Expand Down
3 changes: 3 additions & 0 deletions tests/test_normalizer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,9 @@ def test_normalize_samples_036_eventlogW2008(self):
self.normalize_samples('eventlog_security_audit_windows2008_en_3.xml', 'EventLog-Security-Windows2008[EN]_3', 0.99)
self.normalize_samples('eventlog_security_audit_windows2008_fr_3.xml', 'EventLog-Security-Windows2008[FR]_3', 0.99)

def test_normalize_samples_037_apache(self):
self.normalize_samples('apache_error.xml', 'apache_error', 0.99)

class TestCSVPattern(unittest.TestCase):
"""Test CSVPattern behaviour"""
normalizer_path = os.environ['NORMALIZERS_PATH']
Expand Down