Giter VIP home page Giter VIP logo

parsnip's Introduction

Parsnip

*** NOTICE ***

Parsnip is currently in a beta release state and is intended for early adopters. Users may experience issues, bugs and missing features. Those experiencing difficulties with Parsnip should create a GitHub issue.

Overview

Parsnip is a program developed to assist in the parsing of protocols using the open source network security monitoring tool Zeek. Parsnip is specifically designed to be applied towards developing Industrial Control Systems (ICS) protocol parsers but can be applied to any protocol.

The Parsnip ecosystem consists of three parts:

  1. A GUI interface designed provide a visual representation of a protocol's packet structure
  2. JSON files in an intermediate language (IL) that is fed into the backend. This intermediate language is made up of a set of JSON structures using keywords for each key-value pair to indicate it's type.
  3. A backend that performs processing on the parsnip IL files and outputs the spicy, zeek and event files necessary for a parser

Project Structure

  • backend: folder containing the code for the backend; used for processing parsnip IL files to create zeek parsers
  • docs: folder containing project documentation
  • frontend: folder containing the code for the web frontend; used for creating parsnip IL files
  • LICENSE.txt: code license file
  • NOTICE.txt: code notice file
  • README.md: this file

Documentation

Please refer to docs/parsnip.md for more information on using Parsnip.

Known Limitations

  • Package creation may have some file permission issues. If a package does not install, check that the files in the testing/scripts directory are executable.
  • Choices actions can currently only point to objects, not other types such as integers.
  • Frontend functionality is limited. Specifically AND and OR conditionals, layer 2 parsing and the minus keyword need to be implemented in the intermediate language.
  • Self-recursive types with multiple switches are not properly handled. This will be fixed in a later release.
  • Zeek btest in the created package is limited to a basic availability test. Functionality for expanding btests has not been added.

parsnip's People

Contributors

nagilum2007 avatar piercema avatar melaniepierce avatar h-m-f-t avatar kkvarfordt avatar

parsnip's Issues

Y

U no working

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.