Skip to main content

Python CEF Parsing for Lizard People

Project description

https://img.shields.io/badge/license-Apache%202.0-blue.svg https://img.shields.io/badge/python-2.7,%203.6-blue.svg https://img.shields.io/badge/pypi-v0.1--beta6-green.svg

Pourover is the only chemicaly-altered CEF Log Parsing library for Python, ideal for consumption by Lizard People.

the requests guy does it so maybe it'll work for me

Some stuff we can do:

from datetime import datetime
import pourover


# Create log objects from a file
log = pourover.parse_file('test.log')

# useful properties like linecount and start_time
if log.linecount > 10:
    if log.has_syslog_prefix and log.start_time > datetime(year=2018, month=4, day=20):
        # perform some operations
        pass
    else:
        # perform some operations on a logfile that doesn't have syslog prefixes
        pass
else:
    # perform some operations on a really small log
    pass

# Find messages with a certain value in the header
search_results = log.search_headers('Specific Vendor')

for message in log:
    # iterate through each message in the log like you'd expect to be able to
    pass

# Logs can be indexed/sliced in the way you'd expect
first_message = log[0]
last_message = log[-1]

# Create message objects from a string
message = pourover.parse_line('Apr 15 22:11:20 testhost CEF:0|Test Vendor|Test Product|Test Version|100|Test Name|100|src=1.1.1.1 dst=1.1.1.2')

if message.has_syslog_prefix:
    if message.timestamp > datetime(year=2018, month=4, day=20):
        # perform an operation on logs from later than April 20th, 2018
        pass

if 'src' in message.extensions:
    # do something if it's got an extension called 'src'
    pass

if message.device_vendor == 'Some Vendor':
    # do something if the vendor is Some Vendor
    pass

# stick this message right onto that log (it'll even order the messages by timestamp - wow!)
log.append(message)

Installing :computer:

To install Pourover, simply run

$ pip install pourover
✨🐊✨

Features :crocodile:

- :dragon_face: Create CEF-formatted log lines from parameters with support for extensions and a syslog prefix
- :dragon_face: Create useful line objects from a string, or an entire log object from a file
- :dragon_face: Iterable log objects to manipulate collections of logs at once
- :dragon_face: Parse lines with or without syslog prefixes or extensions with ease
- :dragon_face: Search logs for messages with specific headers or extensions
- :dragon_face: And more to come…

Contributing :dragon:

:bug: Bugs:
Please create any issues you think I should check out! If there’s a bug you spot or a function you think is acting up, please let me know. This project will have tests eventually, but until then I’m sure there will be issues sprouting up from time to time!
:sparkles: New Features/PRs:
The project is still in it’s infancy, so PRs might have a rough time getting merged in while the codebase is in a constant state of flux, but I’d me more than happy to have a discussion with you about a new feature you’d like to see!

Get in Touch :snake:

If you’ve found a Bug or would like to make a feature request, please see the Contributing section above, thanks!

If you’d like to reach out, shoot me an email at zach@csh.rit.edu.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pourover-0.1b6-py2.py3-none-any.whl (17.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 May 12, 2018
pourover-0.1b6.tar.gz (13.3 kB) Copy SHA256 hash SHA256 Source None May 12, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page