├── .gitignore
├── LICENSE.txt
├── NOTICE.txt
├── README.md
├── backend
    ├── Dockerfile
    ├── bitfields.py
    ├── config.py
    ├── customtypes.py
    ├── enums.py
    ├── events.py
    ├── generation_utils.py
    ├── graphing.py
    ├── inputs.py
    ├── json_processing.py
    ├── main.py
    ├── objects.py
    ├── requirements.txt
    ├── run_container.sh
    ├── switches.py
    ├── templates
    │   ├── FindSpicyPlugin.cmake.in
    │   ├── README.md.in
    │   ├── __load__.zeek.in
    │   ├── analyzer_CMakeLists.txt.in
    │   ├── availability.zeek.in
    │   ├── btest.cfg.in
    │   ├── conversion.cc.in
    │   ├── conversion.spicy.in
    │   ├── diff-remove-timestamps.in
    │   ├── enum.spicy.in
    │   ├── events.evt.in
    │   ├── generateid.cc.in
    │   ├── generateid.spicy.in
    │   ├── get-zeek-env.in
    │   ├── gitignore.in
    │   ├── main.zeek.in
    │   ├── random.seed.in
    │   ├── root_CMakeLists.txt.in
    │   ├── scope.spicy.in
    │   ├── standalone.spicy.in
    │   ├── zeekConfirmationFile.spicy.in
    │   ├── zeek_enum.zeek.in
    │   ├── zeek_processing.zeek.in
    │   ├── zeek_types.zeek.in
    │   └── zkg.meta.in
    ├── utils.py
    └── zeektypes.py
├── docs
    ├── images
    │   ├── add_port.png
    │   ├── bitfields_navigation.png
    │   ├── body_data_info.png
    │   ├── body_info.png
    │   ├── config_before_update.png
    │   ├── empty_config.png
    │   ├── empty_ports.png
    │   ├── enums_navigation.png
    │   ├── finalize_config.png
    │   ├── front.png
    │   ├── headerBits_info_1.png
    │   ├── headerBits_info_2.png
    │   ├── header_headerBits_info.png
    │   ├── header_info.png
    │   ├── header_length_info.png
    │   ├── messageType_info_1.png
    │   ├── messageType_info_2.png
    │   ├── message_body_info.png
    │   ├── message_header_info.png
    │   ├── message_info.png
    │   ├── objects_navigation.png
    │   ├── partial_config.png
    │   ├── port_added.png
    │   ├── review_page.png
    │   ├── updated_bitfields_page.png
    │   ├── updated_body_fields.png
    │   ├── updated_enum_page.png
    │   ├── updated_header_fields.png
    │   ├── updated_message_fields.png
    │   └── updated_objects_page.png
    ├── parsnip.md
    ├── parsnip_files
    │   ├── intermediate_language
    │   │   └── general
    │   │   │   ├── bitfields.json
    │   │   │   ├── config.json
    │   │   │   ├── enums.json
    │   │   │   └── objects.json
    │   └── snapshot
    │   │   └── MySimpleProtocol.json
    ├── syntax.md
    └── traces
    │   └── MySimpleProtocol.pcapng
└── frontend
    ├── Dockerfile
    ├── README.md
    ├── app
        ├── app.py
        └── parsnip
        │   ├── __init__.py
        │   ├── config.py
        │   ├── errors
        │       ├── __init__.py
        │       └── handlers.py
        │   ├── main
        │       ├── __init__.py
        │       ├── checkForDuplicates.py
        │       ├── checkForMissingDependencies.py
        │       ├── convert.py
        │       ├── forms.py
        │       ├── routes.py
        │       └── utils.py
        │   └── web
        │       ├── static
        │           ├── css
        │           │   ├── images
        │           │   │   ├── ui-bg_glass_100_f5f0e5_1x400.png
        │           │   │   ├── ui-bg_glass_25_cb842e_1x400.png
        │           │   │   ├── ui-bg_glass_70_ede4d4_1x400.png
        │           │   │   ├── ui-bg_highlight-hard_100_f4f0ec_1x100.png
        │           │   │   ├── ui-bg_highlight-hard_65_fee4bd_1x100.png
        │           │   │   ├── ui-bg_highlight-hard_75_f5f5b5_1x100.png
        │           │   │   ├── ui-bg_inset-soft_100_f4f0ec_1x100.png
        │           │   │   ├── ui-icons_c47a23_256x240.png
        │           │   │   ├── ui-icons_cb672b_256x240.png
        │           │   │   ├── ui-icons_f08000_256x240.png
        │           │   │   ├── ui-icons_f35f07_256x240.png
        │           │   │   ├── ui-icons_ff7519_256x240.png
        │           │   │   └── ui-icons_ffffff_256x240.png
        │           │   ├── jquery-confirm.min.css
        │           │   ├── jquery-ui.css
        │           │   ├── sm-core-css.css
        │           │   ├── sm-custom.css
        │           │   ├── styles.css
        │           │   ├── theme.css
        │           │   └── view.css
        │           └── js
        │           │   ├── jquery-confirm.min.js
        │           │   └── jquery.smartmenus.js
        │       └── templates
        │           ├── bitfields.html
        │           ├── config.html
        │           ├── enums.html
        │           ├── error.html
        │           ├── fields.html
        │           ├── index.html
        │           ├── layout.base
        │           ├── macros.j2
        │           ├── notice.html
        │           ├── objects.html
        │           ├── review.html
        │           └── switches.html
    ├── removeSessions.sh
    ├── requirements.txt
    └── start_webServer.sh


/.gitignore:
--------------------------------------------------------------------------------
 1 | *.out
 2 | *.bak
 3 | .DS_Store
 4 | .devcontainer
 5 | .vscode
 6 | *.pyc
 7 | __pycache__
 8 | /backend/*output*
 9 | /backend/output_no_dependencies.svg
10 | /backend/output_with_dependencies.svg
11 | /backend/unexpected_top_nodes.txt
12 | /backend/paths*.json
13 | /backend/cycles.txt
14 | /frontend/app/flask_session
15 | *.hlto
16 | *.log
17 | .venv/
18 | objects.json
19 | bitfields.json
20 | switches.json
21 | config.json
22 | enums.json
23 | transfer/
24 | 


--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
 1 | 
 2 |                                  3-Clause BSD License
 3 |                  URL: https://opensource.org/licenses/BSD-3-Clause
 4 |                          
 5 | 
 6 | Copyright 2024, Battelle Energy Alliance, LLC
 7 | 
 8 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 9 | 
10 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
11 | 
12 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
13 | 
14 | 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
15 | 
16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


--------------------------------------------------------------------------------
/NOTICE.txt:
--------------------------------------------------------------------------------
 1 | This project contains code from Idaho National Laboratory's Industrial Control System Tradecraft & Capabilities.
 2 | 
 3 | Licensed under BSD-3
 4 | 
 5 | 
 6 | © 2024 Battelle Energy Alliance, LLC
 7 | ALL RIGHTS RESERVED
 8 | 
 9 | Prepared by Battelle Energy Alliance, LLC
10 | Under Contract No. DE-AC07-05ID14517
11 | With the U. S. Department of Energy
12 | 
13 | NOTICE:  This computer software was prepared by Battelle Energy
14 | Alliance, LLC, hereinafter the Contractor, under Contract
15 | No. AC07-05ID14517 with the United States (U. S.) Department of
16 | Energy (DOE).  This software was developed with funding from the Cybersecurity and 
17 | Infrastructure Security Agency of the U.S. Department of Homeland Security. 
18 | The Government is granted for itself and others acting on
19 | its behalf a nonexclusive, paid-up, irrevocable worldwide license in this
20 | data to reproduce, prepare derivative works, and perform publicly and
21 | display publicly, by or on behalf of the Government. There is provision for
22 | the possible extension of the term of this license.  Subsequent to that
23 | period or any extension granted, the Government is granted for itself and
24 | others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide
25 | license in this data to reproduce, prepare derivative works, distribute
26 | copies to the public, perform publicly and display publicly, and to permit
27 | others to do so.  The specific term of the license can be identified by
28 | inquiry made to Contractor or DOE.  NEITHER THE UNITED STATES NOR THE UNITED
29 | STATES DEPARTMENT OF ENERGY, NOR CONTRACTOR MAKES ANY WARRANTY, EXPRESS OR
30 | IMPLIED, OR ASSUMES ANY LIABILITY OR RESPONSIBILITY FOR THE USE, ACCURACY,
31 | COMPLETENESS, OR USEFULNESS OR ANY INFORMATION, APPARATUS, PRODUCT, OR
32 | PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY
33 | OWNED RIGHTS.
34 | 
35 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Parsnip
 2 | 
 3 | ## \*\*\* NOTICE \*\*\*
 4 | 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.
 5 | 
 6 | ## Overview
 7 | Parsnip is a program developed to assist in the parsing of protocols using the open source network security monitoring tool [Zeek](https://github.com/zeek/zeek.git). Parsnip is specifically designed to be applied towards developing Industrial Control Systems (ICS) protocol parsers but can be applied to any protocol.
 8 | 
 9 | The Parsnip ecosystem consists of three parts:
10 | 1. A GUI interface designed provide a visual representation of a protocol's packet structure
11 | 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. 
12 | 3. A backend that performs processing on the parsnip IL files and outputs the spicy, zeek and event files necessary for a parser
13 | 
14 | ## Project Structure
15 | 
16 | * backend: folder containing the code for the backend; used for processing parsnip IL files to create zeek parsers
17 | * docs: folder containing project documentation
18 | * frontend: folder containing the code for the web frontend; used for creating parsnip IL files
19 | * LICENSE.txt: code license file
20 | * NOTICE.txt: code notice file
21 | * README.md: this file
22 | 
23 | ## Documentation
24 | 
25 | Please refer to [docs/parsnip.md](docs/parsnip.md) for more information on using Parsnip.
26 | 
27 | ## Known Limitations
28 | * 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.
29 | * Choices actions can currently only point to objects, not other types such as integers.
30 | * Frontend functionality is limited. Specifically AND and OR conditionals, layer 2 parsing and the minus keyword need to be implemented in the intermediate language.
31 | * Self-recursive types with multiple switches are not properly handled. This will be fixed in a later release.
32 | * Zeek btest in the created package is limited to a basic availability test. Functionality for expanding btests has not been added.
33 | 


--------------------------------------------------------------------------------
/backend/Dockerfile:
--------------------------------------------------------------------------------
 1 | # Use an official Python runtime as a parent image
 2 | FROM python:3.9-slim-buster
 3 | 
 4 | # Set the working directory to /opt
 5 | WORKDIR /opt
 6 | 
 7 | RUN apt update
 8 | RUN apt install -y build-essential libgraphviz-dev
 9 | 
10 | # Copy the current directory contents into the container at /opt
11 | ADD ./requirements.txt /opt/requirements.txt
12 | 
13 | # Install any needed packages specified in requirements.txt
14 | RUN pip install --trusted-host pypi.python.org -r /opt/requirements.txt
15 | 
16 | # Run a terminal when the container starts
17 | CMD ["/bin/bash"]
18 | 


--------------------------------------------------------------------------------
/backend/bitfields.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | import utils
 4 | from math import ceil
 5 | 
 6 | class BitfieldField:
 7 |     # enumFields are different options inside an enumeration
 8 |     def __init__(self, name, description, fieldType, bits, scope = ""):
 9 |         self.name = name
10 |         self.description = description
11 |         self.notes = ""
12 |         self.type = fieldType
13 |         self.bits = bits
14 |         self.referenceType = ""
15 |         self.scope = utils.normalizedScope(scope, fieldType)
16 | 
17 | class Bitfield:
18 |     def __init__(self, name, reference, notes, size):
19 |         self.name = name
20 |         self.reference = reference
21 |         self.notes = notes
22 |         self.size = size
23 |         self.fields = []
24 |         self.column = 0
25 |         self.scope = ""
26 |         self.longestField = 0
27 |         self.endianness = "big"
28 |         
29 |     def addField(self, field):
30 |         # Adds a field into the enum structure 
31 |         for existingField in self.fields:
32 |             if existingField.name == field.name:
33 |                 return
34 |         if (ceil((len(field.name) + 1)/4) * 4) > self.column:
35 |             self.column = (ceil((len(field.name) + 1)/4) * 4)
36 |         if (len(field.name) > self.longestField):
37 |             self.longestField = len(field.name)
38 |         self.fields.append(field)
39 |         
40 | 


--------------------------------------------------------------------------------
/backend/config.py:
--------------------------------------------------------------------------------
 1 | import os
 2 | import customtypes
 3 | import json
 4 | import base64
 5 | 
 6 | class Config:
 7 |     def __init__(self):
 8 |         self.protocol = ""
 9 |         self.scopes = []
10 |         self.entryPoint = ""
11 |         self.usesTCP = False
12 |         self.usesUDP = False
13 |         self.usesLayer2 = False
14 |         self.ethernetProtocolNumber = 0
15 |         self.ports = []
16 |         self.customFieldTypes = {}
17 |         self.signatureFile = None
18 |         self.conversionFile = None
19 |         self.gitignoreFile = None
20 |         self.shortDescription = ""
21 |         self.longDescription = ""
22 |         
23 | def loadConfig(configFilePath):
24 |     config = Config()
25 |     if not (os.path.isfile(configFilePath)):
26 |         return (False, config)
27 |     
28 |     with open(configFilePath, "r+") as file:
29 |         configObject = json.load(file)
30 | 
31 |     config.protocol = configObject["Protocol"]
32 |     config.scopes = configObject["Scopes"]
33 |     config.entryPoint = configObject["EntryPoint"]
34 | 
35 |     if "usesTCP" in configObject and configObject["usesTCP"] == True:
36 |         config.usesTCP = True
37 | 
38 |     if "usesUDP" in configObject and configObject["usesUDP"] == True:
39 |         config.usesUDP = True
40 |         
41 |     if "usesLayer2" in configObject and configObject["usesLayer2"] == True:
42 |         config.usesLayer2 = True
43 |         
44 |     if "ethernetProtocolNumber" in configObject:
45 |         config.ethernetProtocolNumber = configObject["ethernetProtocolNumber"]
46 |     
47 |     if "Ports" in configObject:
48 |         config.ports = configObject["Ports"]
49 | 
50 |     if "CustomFieldTypes" in configObject:
51 |         for item in configObject["CustomFieldTypes"]:
52 |             config.customFieldTypes[item.get("name")] = customtypes.CustomType(item.get("name"), item.get("interpretingFunction"), item.get("returnType"))
53 |             
54 |     if "signatureFile" in configObject and "" != configObject.get("signatureFile"):
55 |         config.signatureFile = base64.b64decode(configObject.get("signatureFile")).decode()
56 |         
57 |     if "conversionFile" in configObject and "" != configObject.get("conversionFile"):
58 |         config.conversionFile = base64.b64decode(configObject.get("conversionFile")).decode()
59 | 
60 |     if "gitignoreFile" in configObject and "" != configObject.get("gitignoreFile"):
61 |         config.gitignoreFile = base64.b64decode(configObject.get("gitignoreFile")).decode()
62 | 
63 |     if "protocolShortDescription" in configObject and "" != configObject.get("protocolShortDescription"):
64 |         config.shortDescription = configObject["protocolShortDescription"]
65 | 
66 |     if "protocolLongDescription" in configObject and "" != configObject.get("protocolLongDescription"):
67 |         config.longDescription = configObject["protocolLongDescription"]
68 |     
69 |     return (True, config)                        
70 | 


--------------------------------------------------------------------------------
/backend/customtypes.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | import utils
 4 | 
 5 | class CustomType:
 6 |     def __init__(self, name, interpretingFunction, returnType):
 7 |         self.name = name
 8 |         self.interpretingFunction = interpretingFunction
 9 |         self.returnType = returnType
10 | 


--------------------------------------------------------------------------------
/backend/enums.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | import utils
 4 | from math import ceil 
 5 | class EnumField:
 6 |     # enumFields are different options inside an enumeration
 7 |     def __init__(self, name, loggingValue, value):
 8 |         self.name = name
 9 |         self.loggingValue = loggingValue
10 |         self.value = value
11 |         self.notes = ""
12 | 
13 | class Enums:
14 |     def __init__(self, name, reference, size):
15 |         self.name = name
16 |         self.reference = reference
17 |         self.notes = ""
18 |         self.size = size
19 |         self.fields = []
20 |         self.column = 0
21 |         self.scope = ""
22 |         self.longestField = 0
23 |         self.endianness = "big"
24 |     
25 |     def addField(self, field):
26 |         # Adds a field into the enum structure 
27 |         for existingField in self.fields:
28 |             if existingField.name == field.name:
29 |                 return
30 |         tempColumn = utils.calculateColumn(len(field.name))
31 |         if tempColumn > self.column:
32 |             self.column = tempColumn
33 |         if (len(field.name) > self.longestField):
34 |             self.longestField = len(field.name)
35 |         self.fields.append(field)
36 | 
37 |     def createSpicyEnumString(self):
38 |         # Create spicy-side structures
39 |         if self.reference != "":
40 |             enumString = "# {0}\n".format(self.reference)
41 |         else:
42 |             enumString = ""
43 |         enumString += "public type {0} = enum {{\n".format(self.name)
44 |         for index, field in enumerate(self.fields):
45 |             padding_size = self.column - len(field.name)
46 |             padding = " " * padding_size
47 |             commaString=","
48 |             if index == len(self.fields) - 1:
49 |                 commaString = ""
50 |             enumString += "{0}{1}{2}= {3}{4}\n".format(utils.SINGLE_TAB, field.name, padding, field.value, commaString)
51 |         enumString += "};\n"
52 |         return enumString
53 | 
54 |     def createZeekEnumString(self, enumScope):
55 |         # This function creates the zeek structure to change an enum into a human readable string
56 |         zeekString = "{}const {} = {{\n".format(utils.SINGLE_TAB, utils.commandNameToConst(self.name).upper())
57 |         scopingValue = "[{}::{}_".format(enumScope, self.name) #Indicates the exported zeek name for zeek-side enums
58 |         for i, field in enumerate(self.fields):
59 |             longestValue = len(scopingValue) + 1 + self.longestField #Scope + longest field + closing ]
60 |             zeekColumn = ceil((longestValue + 1)/4) * 4
61 |             padding_size = zeekColumn - (len(field.name) + len(scopingValue) + 1)
62 |             padding = " " * padding_size
63 |             lineEnd = ","
64 |             if len(self.fields) - 1 == i:
65 |                 lineEnd = ""
66 |             zeekString += "{}{}{}]{}= \"{}\"{}\n".format(utils.DOUBLE_TAB, scopingValue, field.name, padding, field.loggingValue, lineEnd)
67 |         zeekString += "{}}}".format(utils.SINGLE_TAB)
68 |         zeekString += " &default=function(i: {}::{}):string".format(enumScope, self.name)
69 |         zeekString += "{return fmt(\"unknown-0x%x\", i); } &redef;\n\n"
70 |         return zeekString
71 | 


--------------------------------------------------------------------------------
/backend/events.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  2 | 
  3 | import utils
  4 | 
  5 | DEFAULT_ARGUMENTS = ["$conn", "$is_orig"]
  6 | 
  7 | class SpicyEvent:
  8 |     def __new__(cls, *args, **kwargs):
  9 |         return super().__new__(cls)
 10 | 
 11 | 
 12 |     def __init__(self, includedFields=[], linkFields=[]):
 13 |         self.name = ""
 14 |         self.trigger = "on"
 15 |         self.scope = ""
 16 |         if utils.USES_LAYER_2:
 17 |             self.arguments = []
 18 |         else:
 19 |             self.arguments = DEFAULT_ARGUMENTS
 20 |         self.eventFields = includedFields
 21 |         self.relatedBitfields = {}
 22 |         self.linkFields = linkFields
 23 | 
 24 |     def generateExport(self):
 25 |         fullScopeExport = "export {}::{};\n".format(self.scope, self.name)
 26 |         return fullScopeExport
 27 |     
 28 |     def generateEvent(self, allBitfields):
 29 |         basicEvent =  "on {}::{} -> event {}::{}Evt (\n".format(self.scope, self.name, self.scope, self.name)
 30 |         scopedArguments = []
 31 |         # for link in self.linkFields:
 32 |         #     basicEvent += "{}{},\n".format(utils.SINGLE_TAB, link.name)
 33 |         for item in self.arguments:
 34 |             scopedArguments.append(item)
 35 |         for link in self.linkFields:
 36 |             #basicEvent += "{}self.{},\n".format(utils.SINGLE_TAB, link.name)
 37 |             scopedArguments.append("self.{}".format(link.name))
 38 |         if self.eventFields != []:
 39 |             for field in self.eventFields:
 40 |                 if field.type == "bits":
 41 |                     referencedBitfield = allBitfields[utils.normalizedScope(field.scope, "bitfield")][field.referenceType]
 42 |                     for bitField in referencedBitfield.fields:
 43 |                         scopedArguments.append("self.{}.{}".format(field.name, bitField.name))
 44 |                     self.relatedBitfields[field.name] = self.relatedBitfields
 45 |                 else:
 46 |                     scopedArguments.append("self.{}".format(field.name))
 47 |         else:
 48 |             scopedArguments.append("self".format(self.scope, self.name))
 49 |         for argument in scopedArguments:
 50 |             if argument != scopedArguments[-1]:
 51 |                 basicEvent += "{}{},\n".format(utils.SINGLE_TAB, argument)
 52 |             else:
 53 |                 basicEvent += "{}{}\n);\n\n".format(utils.SINGLE_TAB, argument)
 54 |         return basicEvent
 55 | 
 56 |     def getEventFunctionName(self, allBitfields):
 57 |         eventName = ""
 58 |         if utils.USES_LAYER_2:
 59 |             eventName += "event {}::{}Evt (".format(self.scope, self.name)
 60 |         else:
 61 |             eventName += "event {}::{}Evt (c: connection, is_orig: bool, ".format(self.scope, self.name)
 62 |         for link in self.linkFields:
 63 |             eventName += "{}: string, ".format(link.name)
 64 |         if self.eventFields != []:
 65 |             for field in self.eventFields:
 66 |                 if field.type == "enum":
 67 |                     if field.scope != "":
 68 |                         eventName += "{}: {}::{}".format(field.name, field.scope, field.referenceType)
 69 |                     else:
 70 |                         print("Enum field: {} has no scope".format(field.name))
 71 |                 elif field.type in utils.spicyToZeek:
 72 |                     eventName += "{}: {}".format(field.name, utils.spicyToZeek[field.type])
 73 |                 elif field.type in utils.customFieldTypes:
 74 |                     eventName += "{}: {}".format(field.name, utils.zeekTypeMapping(utils.customFieldTypes[field.type].returnType))
 75 |                 elif field.type == "bits":
 76 |                     referencedBitfield = allBitfields[utils.normalizedScope(field.scope, "bitfield")][field.referenceType]
 77 |                     for bitField in referencedBitfield.fields:
 78 |                         if bitField.type == "enum":
 79 |                             if field.scope != "":
 80 |                                 eventName += "{}: {}::{}".format(bitField.name, bitField.scope, bitField.referenceType)
 81 |                             else:
 82 |                                 print("Enum field: {} has no scope".format(bitField.name))
 83 |                         elif bitField.type in utils.spicyToZeek:
 84 |                             eventName += "{}: {}".format(bitField.name, utils.spicyToZeek[bitField.type])
 85 |                         elif bitField.type in utils.customFieldTypes:
 86 |                             eventName += "{}: {},".format(bitField.name, utils.zeekTypeMapping(utils.customFieldTypes[bitField.type].returnType))
 87 |                         elif bitField.type == "enum":
 88 |                             if field.scope != "":
 89 |                                 eventName += "{}: {}::{}".format(bitField.name, bitField.scope, bitField.referenceType)
 90 |                             else:
 91 |                                 print("Enum field: {} has no scope".format(bitField.name))
 92 |                         else:
 93 |                             print("Unknown Bitfield Option: {}".format(field.name))
 94 |                         if bitField != referencedBitfield.fields[-1]:
 95 |                             eventName += ","
 96 |                 elif field.type == "object":
 97 |                     eventName += "{}: {}::{}".format(field.name,  utils.normalizedScope(field.scope), field.referenceType)
 98 |                 elif field.type == "list":
 99 |                     if field.elementType in utils.spicyToZeek:
100 |                         zeekType = "vector of {}".format(utils.spicyToZeek[field.elementType])
101 |                         eventName += "{}: {}".format(field.name,  zeekType)
102 |                 elif "linking" in field.type:
103 |                    continue
104 |                 else:
105 |                     print("Unknown {}".format(field.type))
106 |                 if field != self.eventFields[-1]:
107 |                     eventName += ", "
108 |         else:
109 |             eventName += "{}: {}::{}".format(self.name.lower(), self.scope, self.name)
110 |         eventName += ") {\n"
111 |         return eventName
112 | 


--------------------------------------------------------------------------------
/backend/graphing.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python3
  2 | 
  3 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  4 | 
  5 | # Local Imports
  6 | import utils
  7 | 
  8 | # Standard Library Imports
  9 | import json
 10 | 
 11 | ################################################################################
 12 | # Type Declarations
 13 | ################################################################################
 14 | 
 15 | languageTypes = [
 16 |     ("addr", [32, 128]), # Passthrough Spicy Type
 17 |     ("uint", [8, 16, 24, 32, 64]), # Spicy built in for sizes 8, 16, 32, and 64; 24 we added
 18 |     ("int", [8, 16, 24, 32, 64]), # Spicy built in for sizes 8, 16, 32, and 64; 24 we added
 19 |     ("void", None), # Spicy type used to denote no fields
 20 |     ("bytes", None), # Passthrough Spicy Type, size will be converted to bytes from bits
 21 |     ("float", [32, 64]), # Maps to spicy "real" type with either float or double flag
 22 |     ("time", None),
 23 |     ("date", None)
 24 | ]
 25 | 
 26 | bitfieldSpecificTypes = ["bool", "uint", "enum"]
 27 | 
 28 | structureTypes = {
 29 |     "bits": "Bitfields", # Maps to bitfield structures
 30 |     "enum": "Enums", # Maps to enum structures
 31 |     "object": "Objects", # Maps to object structures
 32 |     "switch": "Switches" # Maps to switches structures
 33 | }
 34 | 
 35 | otherReferenceTypes = {
 36 |     "list" # A list of other types
 37 | }
 38 | 
 39 | ################################################################################
 40 | # Function Declarations
 41 | ################################################################################
 42 | 
 43 | def loadFile(filePath):
 44 |     with open(filePath, "r") as file:
 45 |         contents = json.load(file)
 46 |     return contents
 47 |     
 48 | def normalizedKey3(value1, value2, value3):
 49 |     return "{}.{}.{}".format(value1, value2, value3)
 50 |     
 51 | def normalizedType(itemType, referenceScope, referenceType, elementType,
 52 |                    itemSize, isReference, userDefinedTypes):
 53 |     returnValue = ""
 54 |     denoteReference = False
 55 |     isList = False
 56 |     returnReference = None
 57 |     if None == itemType:
 58 |         returnValue = None
 59 |     elif "object" == itemType:
 60 |         returnValue = "Object"
 61 |         denoteReference = isReference
 62 |         if isReference:
 63 |             #returnReference = normalizedKey3(utils.normalizedScope(referenceScope, itemType), itemType, referenceType)
 64 |             returnReference = normalizedKey3(referenceScope, itemType, referenceType)
 65 |     elif "bits" == itemType:
 66 |         returnValue = "Bitfield"
 67 |         denoteReference = isReference
 68 |         if isReference:
 69 |             #returnReference = normalizedKey3(utils.normalizedScope(referenceScope, itemType), itemType, referenceType)
 70 |             returnReference = normalizedKey3(referenceScope, itemType, referenceType)
 71 |     elif "enum" == itemType:
 72 |         returnValue = "Enum"
 73 |         denoteReference = isReference
 74 |         if isReference:
 75 |             returnReference = normalizedKey3(referenceScope, itemType, referenceType)
 76 |     elif "switch" == itemType:
 77 |         returnValue = "Switch"
 78 |         denoteReference = isReference
 79 |         if isReference:
 80 |             #returnReference = normalizedKey3(utils.normalizedScope(referenceScope, itemType), itemType, referenceType)
 81 |             returnReference = normalizedKey3(referenceScope, itemType, referenceType)
 82 |     elif "user" == itemType:
 83 |         returnValue = "UserType"
 84 |         denoteReference = isReference
 85 |     elif "list" == itemType:
 86 |         returnValue, returnReference, isList = \
 87 |             normalizedType(elementType, referenceScope, referenceType, None,
 88 |                            itemSize, isReference, userDefinedTypes)
 89 |         returnValue += "[]"
 90 |         isList = True
 91 |     elif itemType in userDefinedTypes:
 92 |         returnValue = itemType + "(" + str(itemSize) + ")"
 93 |         returnReference = itemType
 94 |     elif itemType in bitfieldSpecificTypes:
 95 |         returnValue = itemType
 96 |     else:
 97 |         typeIndex = next((index for index, value in enumerate(languageTypes) if value[0] == itemType), -1)
 98 |         if typeIndex != -1:
 99 |             returnValue = itemType
100 |             # This is a known type
101 |             if itemSize is not None:
102 |                 returnValue += str(itemSize)
103 |         else:
104 |             print("Unhandled Type: {} {} {}".format(itemType, elementType,
105 |                                                     itemSize))
106 | 
107 |     if denoteReference:
108 |         returnValue += "Reference"
109 |     return (returnValue, returnReference, isList)
110 |     
111 | def normalizedLabel(itemType, referenceScope, referenceType, elementType,
112 |                     itemSize, itemName, isReference, userDefinedTypes):
113 |     returnType, returnReference, isList = \
114 |         normalizedType(itemType, referenceScope, referenceType, elementType, itemSize,
115 |                        isReference, userDefinedTypes)
116 |     preString = ""
117 |     if returnType is not None:
118 |         preString = "{}:".format(returnType)
119 |     return ('"{}{}"'.format(preString, itemName), returnReference, isList)
120 |     
121 | def addUserTypeNode(userType, nodeInformation, metaData, userDefinedTypes):
122 |     label, _, _ = normalizedLabel("user", None, None, None, None, userType, False,
123 |                                   userDefinedTypes)
124 |     nodeInformation[userType] = (label, metaData)
125 |     
126 | def _valueOrDefault(item, key, default):
127 |     if hasattr(item, key):
128 |         return getattr(item, key)
129 |     #if key in item:
130 |     #    return item.get(key)
131 |     return default
132 |     
133 | def getItemName(itemScope, item, itemType):
134 |     return item.name
135 |     
136 | def addItemNode(itemScope, item, itemType, nodeInformation, metaData, userDefinedTypes):
137 |     name = getItemName(itemScope, item, itemType)
138 |     if metaData is None:
139 |         metaData = {}
140 |     metaData["logIndependently"] = _valueOrDefault(item, "logIndependently", False)
141 |     metaData["logWithParent"] = _valueOrDefault(item, "logWithParent", False)
142 |     label, _, _ = normalizedLabel(itemType, None, None, None, None, name, False,
143 |                                   userDefinedTypes)
144 |     nodeReference = normalizedKey3(itemScope, itemType, name)
145 |     nodeInformation[nodeReference] = (label, metaData)
146 |     return name
147 |     
148 | def normalizedKey2(value1, value2):
149 |     return "{}.{}".format(value1, value2)
150 |     
151 | def normalizedKey4(value1, value2, value3, value4):
152 |     return "{}.{}.{}.{}".format(value1, value2, value3, value4)
153 |     
154 | def _addNodeItem(parentScope, parentType, parentName, item, storage,
155 |                  userDefinedTypes):
156 |     labelName = normalizedKey2(parentName, item.name)
157 |     parentKeyName = normalizedKey3(parentScope, parentType, parentName)
158 |     keyName = normalizedKey4(parentScope, parentType, parentName,
159 |                              item.name)
160 |     label, referenceType, isList = \
161 |         normalizedLabel(_valueOrDefault(item, "type", None),
162 |                         _valueOrDefault(item, "scope", None),
163 |                         _valueOrDefault(item, "referenceType", None),
164 |                         _valueOrDefault(item, "elementType", None),
165 |                         _valueOrDefault(item, "size", None), labelName, True,
166 |                         userDefinedTypes)
167 |     metaData = {"isList": isList}
168 |     storage[keyName] = (label, metaData)
169 |     return (parentKeyName, keyName, referenceType)
170 |     
171 | def _addConnection(source, destination, label, storage):
172 |     storage.append((source, destination, label))
173 |     
174 | def _addReferenceConnection(itemKey, referenceType, storage):
175 |     if referenceType is not None:
176 |         _addConnection(itemKey, referenceType, "reference", storage)
177 |     
178 | def addFieldNode(itemScope, itemType, itemName, field, fieldNameType,
179 |                  nodeInformation, referenceInformation, fieldsInformation,
180 |                  userDefinedTypes):
181 |     parentKey, keyName, referenceType = _addNodeItem(itemScope, itemType,
182 |                                                      itemName, field,
183 |                                                      nodeInformation,
184 |                                                      userDefinedTypes)
185 | 
186 |     _addReferenceConnection(keyName, referenceType, referenceInformation)
187 |     _addConnection(parentKey, keyName, fieldNameType, fieldsInformation)
188 |     
189 | def addDependencyNode(itemScope, itemType, itemName, dependency,
190 |                       dependencyNodeInformation, depedencyReferenceInformation,
191 |                       dependencyInformation, userDefinedTypes):
192 |     parentKey, keyName, referenceType = _addNodeItem(itemScope, itemType,
193 |                                                      itemName, dependency,
194 |                                                      dependencyNodeInformation,
195 |                                                      userDefinedTypes)
196 |     _addReferenceConnection(keyName, referenceType,
197 |                             depedencyReferenceInformation)
198 |     _addConnection(parentKey, keyName, "dependency", dependencyInformation)
199 | 


--------------------------------------------------------------------------------
/backend/inputs.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | import utils
 4 | 
 5 | class Input:
 6 |     def __init__(self, source, minus=""):
 7 |         self.source = source
 8 |         self.minus = minus
 9 |         self.minusInUse = True if "" != self.minus else False
10 | 
11 |     def equal(self, other):
12 |         return self.source == other.source and \
13 |                self.minus == other.minus
14 |     
15 |     def getString(self):
16 |         outputString = self.source
17 |         if self.minusInUse:
18 |             outputString += " - " + str(self.minus)
19 |         return outputString
20 | 
21 | class Dependency:
22 |     def __init__(self, name, type, size="", referenceType = "", scope = ""):
23 |         self.name = name
24 |         self.type = type
25 |         self.size = size
26 |         self.referenceType = referenceType
27 |         self.scope = utils.normalizedScope(scope, type)
28 |     
29 |     def equal(self, other):
30 |         return self.name == other.name and \
31 |                self.type == other.type and \
32 |                self.size == other.size and \
33 |                self.referenceType == other.referenceType and \
34 |                self.scope == other.scope
35 | 


--------------------------------------------------------------------------------
/backend/main.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  2 | 
  3 | import argparse
  4 | 
  5 | import utils
  6 | import json_processing as processing
  7 | import graphing
  8 | 
  9 | import generation_utils
 10 | import config
 11 | 
 12 | def _updateUtilValues(configuration):
 13 |     utils.PROTOCOL_NAME = configuration.protocol
 14 |     utils.USES_LAYER_2 = configuration.usesLayer2
 15 |     utils.customFieldTypes = configuration.customFieldTypes
 16 |     
 17 | def _parseArgs():
 18 |     parser = argparse.ArgumentParser()
 19 |     parser.add_argument("inputRootDirectory", type=str, help="Path to folder with '{0}' folder".format(utils.DEFAULT_SCOPE))
 20 |     parser.add_argument("outputRootDirectory", type=str, help="Root output directory")
 21 | 
 22 |     args = parser.parse_args()
 23 | 
 24 |     return (args.inputRootDirectory, args.outputRootDirectory)
 25 |     
 26 | def _generateData(inRootFolder, configuration, entryPointScope, entryPointName, entryPointKey):
 27 |     ############################################################################
 28 |     # Process the data files
 29 |     ############################################################################    
 30 |     objects, switches, bitfields, enums = processing.loadFiles(inRootFolder, configuration.scopes)
 31 |                
 32 |     ############################################################################
 33 |     # Use some Graph Theory to our advantage
 34 |     ############################################################################                       
 35 |     generation_utils.createAndUseGraphInformation(configuration, objects, switches, bitfields, enums, entryPointScope, entryPointName, entryPointKey)
 36 |         
 37 |     ############################################################################
 38 |     # Work with the loaded data
 39 |     ############################################################################
 40 |     zeekTypes, zeekMainFileObject = processing.createZeekObjects(configuration.scopes, configuration.customFieldTypes, bitfields, objects, switches)
 41 |     
 42 |     # Determine import requirements
 43 |     # currentScope -> dependentScope[] -> ["enum"/"object"/"custom"] -> referenceType[]
 44 |     crossScopeItems = generation_utils.determineInterScopeDependencies(configuration, bitfields, objects, switches)
 45 |     
 46 |     return (zeekTypes, zeekMainFileObject, crossScopeItems, bitfields, enums, objects, switches)
 47 |     
 48 | def determineEntryPointInformation(configuration):
 49 |     entryPointParts = configuration.entryPoint.split(".")
 50 |     if 2 != len(entryPointParts):
 51 |         return (False, "", "", "")
 52 | 
 53 |     entryPointScope = entryPointParts[0]
 54 |     entryPointName = entryPointParts[1]
 55 |     entryPointKey = graphing.normalizedKey3(utils.normalizedScope(entryPointScope, "object"), "object", entryPointName)
 56 |     
 57 |     return (True, entryPointScope, entryPointName, entryPointKey)
 58 |     
 59 | if __name__ == "__main__":
 60 |     import os
 61 |     
 62 |     ############################################################################
 63 |     # Parse Command Line Arguments
 64 |     ############################################################################
 65 |     inRootFolder, outRootFolder = _parseArgs()
 66 | 
 67 |     ############################################################################
 68 |     # Load the configuration file
 69 |     ############################################################################    
 70 |     configPath = os.path.join(inRootFolder, utils.DEFAULT_SCOPE, "config.json")
 71 |     
 72 |     loadSuccessful, configuration = config.loadConfig(configPath)
 73 |     if not loadSuccessful:
 74 |         print(configPath + " is a required file")
 75 |         exit(1)
 76 |         
 77 |     _updateUtilValues(configuration)
 78 |     
 79 |     entryPointParsingSuccessful, entryPointScope, entryPointName, entryPointKey = determineEntryPointInformation(configuration)
 80 |     
 81 |     if not entryPointParsingSuccessful:
 82 |         print("EntryPoint must have scope and object name")
 83 |         exit(2)
 84 |     
 85 |     print(entryPointScope + " ---> " + entryPointName)
 86 | 
 87 |     ############################################################################
 88 |     # Load and work with data
 89 |     ############################################################################
 90 |     zeekTypes, zeekMainFileObject, crossScopeItems, bitfields, enums, objects, switches = _generateData(inRootFolder, configuration, entryPointScope, entryPointName, entryPointKey)
 91 | 
 92 |     ############################################################################
 93 |     # Generate output
 94 |     ############################################################################
 95 |     generation_utils.writeParserFiles(configuration, outRootFolder,
 96 |                                       zeekTypes, zeekMainFileObject,
 97 |                                       crossScopeItems,
 98 |                                       bitfields, enums,
 99 |                                       objects, switches,
100 |                                       entryPointScope, entryPointName)
101 | 


--------------------------------------------------------------------------------
/backend/requirements.txt:
--------------------------------------------------------------------------------
1 | rustworkx
2 | matplotlib
3 | pygraphviz
4 | pydot
5 | 


--------------------------------------------------------------------------------
/backend/run_container.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # Copyright 2024, Battelle Energy Alliance, LLC All Rights Reserved
 4 | 
 5 | # Routine Build
 6 | docker build -t parsnip_backend .
 7 | # Build that forces everything to be new
 8 | #docker build --force-rm --rm --no-cache -t parsnip_backend .
 9 | mkdir -p transfer
10 | docker run -t -i -P --rm --entrypoint=/bin/bash  -v $(pwd):/opt/parsnip:rw -w /opt/parsnip parsnip_backend
11 | 


--------------------------------------------------------------------------------
/backend/switches.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | import utils
 4 |         
 5 | class SwitchAction:
 6 |     def __init__(self, name, type, referenceType, scope=""):
 7 |         self.name = name
 8 |         self.type = type
 9 |         self.referenceType = referenceType
10 |         self.elementType = ""
11 |         self.inputs = []
12 |         self.scope = utils.normalizedScope(scope, type)
13 |         self.size = 0
14 |         self.until = None
15 |     
16 |     def addInput(self, input):
17 |         for existingInput in self.inputs:
18 |             if existingInput.equal(input):
19 |                 return
20 |         if input not in self.inputs:
21 |             self.inputs.append(input)
22 | 
23 | class SwitchOption:
24 |     def __init__(self, value):
25 |         self.value = value
26 |         self.action = None
27 | 
28 | class Switch:
29 |     def __init__(self, name, referenceCount):
30 |         self.name = name
31 |         self.dependsOn = None
32 |         self.additionalDependsOn = []
33 |         self.options = []
34 |         self.default = None
35 |         self.referenceCount = referenceCount
36 |         self.column = 0
37 |         self.longestOption = 0
38 |         self.actionColumn = 0
39 |         self.longestAction = 0
40 |     
41 |     def addAdditionalDependsOn(self, dependency):
42 |         for existingDependency in self.additionalDependsOn:
43 |             if existingDependency.equal(dependency):
44 |                 return
45 |         if self.dependsOn.equal(dependency):
46 |             return
47 |         self.additionalDependsOn.append(dependency)
48 |     
49 |     def addOption(self, option):
50 |         if option not in self.options:
51 |             tempColumn = utils.calculateColumn(len(str(option.value)))
52 |             if tempColumn > self.column:
53 |                 self.column = tempColumn
54 |             if len(str(option.value)) > self.longestOption:
55 |                 self.longestOption = len(str(option.value))
56 |             tempColumn = utils.calculateColumn(len(option.action.name))
57 |             if tempColumn > self.actionColumn:
58 |                 self.actionColumn = tempColumn
59 |             if len(option.action.name) > self.longestAction:
60 |                 self.longestAction = len(option.action.name)
61 |             self.options.append(option)
62 | 


--------------------------------------------------------------------------------
/backend/templates/FindSpicyPlugin.cmake.in:
--------------------------------------------------------------------------------
 1 | # Warning! This is an automatically generated file!
 2 | #
 3 | # Find the Spicy plugin to get access to the infrastructure it provides.
 4 | #
 5 | # While most of the actual CMake logic for building analyzers comes with the Spicy
 6 | # plugin for Zeek, this code bootstraps us by asking "spicyz" for the plugin's
 7 | # location. Either make sure that "spicyz" is in PATH, set the environment
 8 | # variable SPICYZ to point to its location, or set variable ZEEK_SPICY_ROOT
 9 | # in either CMake or environment to point to its installation or build
10 | # directory.
11 | #
12 | # This exports:
13 | #
14 | #     SPICY_PLUGIN_FOUND            True if plugin and all dependencies were found
15 | #     SPICYZ                        Path to spicyz
16 | #     SPICY_PLUGIN_VERSION          Version string of plugin
17 | #     SPICY_PLUGIN_VERSION_NUMBER   Numerical version number of plugin
18 | 
19 | # Runs `spicyz` with the flags given as second argument and stores the output in the variable named
20 | # by the first argument.
21 | function (run_spicycz output)
22 |     execute_process(COMMAND "${SPICYZ}" ${ARGN} OUTPUT_VARIABLE output_
23 |                     OUTPUT_STRIP_TRAILING_WHITESPACE)
24 | 
25 |     string(STRIP "${output_}" output_)
26 |     set(${output} "${output_}" PARENT_SCOPE)
27 | endfunction ()
28 | 
29 | # Checks that the Spicy plugin version it at least the given version.
30 | function (spicy_plugin_require_version version)
31 |     string(REGEX MATCH "([0-9]*)\.([0-9]*)\.([0-9]*).*" _ ${version})
32 |     math(EXPR version_number "${CMAKE_MATCH_1} * 10000 + ${CMAKE_MATCH_2} * 100 + ${CMAKE_MATCH_3}")
33 | 
34 |     if ("${SPICY_PLUGIN_VERSION_NUMBER}" LESS "${version_number}")
35 |         message(FATAL_ERROR "Package requires at least Spicy plugin version ${version}, "
36 |                             "have ${SPICY_PLUGIN_VERSION}")
37 |     endif ()
38 | endfunction ()
39 | 
40 | ###
41 | ### Main
42 | ###
43 | 
44 | if (NOT SPICYZ)
45 |     set(SPICYZ "$ENV{SPICYZ}")
46 | endif ()
47 | 
48 | if (NOT SPICYZ)
49 |     # Support an in-tree Spicy build.
50 |     find_program(
51 |         spicyz spicyz
52 |         HINTS ${ZEEK_SPICY_ROOT}/bin ${ZEEK_SPICY_ROOT}/build/bin $ENV{ZEEK_SPICY_ROOT}/bin
53 |               $ENV{ZEEK_SPICY_ROOT}/build/bin ${PROJECT_SOURCE_DIR}/../../build/bin)
54 |     set(SPICYZ "${spicyz}")
55 | endif ()
56 | 
57 | message(STATUS "spicyz: ${SPICYZ}")
58 | 
59 | if (SPICYZ)
60 |     set(SPICYZ "${SPICYZ}" CACHE PATH "" FORCE) # make sure it's in the cache
61 | 
62 |     run_spicycz(SPICY_PLUGIN_VERSION "--version")
63 |     run_spicycz(SPICY_PLUGIN_VERSION_NUMBER "--version-number")
64 |     message(STATUS "Zeek plugin version: ${SPICY_PLUGIN_VERSION}")
65 | 
66 |     run_spicycz(spicy_plugin_path "--print-plugin-path")
67 |     set(spicy_plugin_cmake_path "${spicy_plugin_path}/cmake")
68 |     message(STATUS "Zeek plugin CMake path: ${spicy_plugin_cmake_path}")
69 | 
70 |     list(PREPEND CMAKE_MODULE_PATH "${spicy_plugin_cmake_path}")
71 |     find_package(Zeek REQUIRED)
72 |     find_package(Spicy REQUIRED)
73 |     zeek_print_summary()
74 |     spicy_print_summary()
75 | 
76 |     include(ZeekSpicyAnalyzerSupport)
77 | endif ()
78 | 
79 | include(FindPackageHandleStandardArgs)
80 | find_package_handle_standard_args(SpicyPlugin DEFAULT_MSG SPICYZ ZEEK_FOUND)
81 | 


--------------------------------------------------------------------------------
/backend/templates/README.md.in:
--------------------------------------------------------------------------------
 1 | # ${protocolName}
 2 | 
 3 | ## Overview
 4 | 
 5 | ${protocolName} is a Zeek plugin (written in [Spicy](https://docs.zeek.org/projects/spicy/en/latest/)) for parsing and logging fields used by the ${protocolName} protocol.
 6 | 
 7 | ${protocolDescription}
 8 | 
 9 | ## Installation
10 | 
11 | ### Package Manager (Remote Repository)
12 | This script is available as a package for [Zeek Package Manger](https://docs.zeek.org/projects/package-manager/en/stable/index.html)
13 | 
14 | ```bash
15 | zkg refresh
16 | zkg install ${outputFolder}
17 | ```
18 | 
19 | If ZKG is configured to load packages (see @load packages in quickstart guide), this script will automatically be loaded and ready to go.
20 | [ZKG Quickstart Guide](https://docs.zeek.org/projects/package-manager/en/stable/quickstart.html)
21 | 
22 | If users are not using site/local.zeek or another site installation of Zeek and want to run this script on a packet capture, they can add `${outputFolder}` to the command to run this script on the packet capture from a cloned version of this repository:
23 | 
24 | ```bash
25 | zeek -Cr <path_to_pcap> ${outputFolder}
26 | ```
27 | 
28 | ### Package Manager (Local Folder)
29 | To install from a local version of the repository, navigate to a clean locally cloned version of the repository and run the following commands:
30 | 
31 | ```bash
32 | zkg install .
33 | zeek -Cr <path_to_pcap> local
34 | ```
35 | 
36 | 


--------------------------------------------------------------------------------
/backend/templates/__load__.zeek.in:
--------------------------------------------------------------------------------
1 | ${enumString}
2 | ${typesString}
3 | @load ./main
4 | ${processingString}
5 | ${sigsString}
6 | 


--------------------------------------------------------------------------------
/backend/templates/analyzer_CMakeLists.txt.in:
--------------------------------------------------------------------------------
1 | spicy_add_analyzer(
2 |     NAME ${protocolName}
3 |     PACKAGE_NAME ${protocolName}
4 |     SOURCES ${sources}
5 |     SCRIPTS ${scripts}
6 | )
7 | 


--------------------------------------------------------------------------------
/backend/templates/availability.zeek.in:
--------------------------------------------------------------------------------
1 | # Warning! This is an automatically generated file!
2 | #
3 | # @TEST-DOC: Check that the ${protocolName} analyzer is available.
4 | #
5 | # @TEST-EXEC: zeek -NN | grep -Eqi 'ANALYZER_SPICY_${protocolNameUpper}'
6 | 


--------------------------------------------------------------------------------
/backend/templates/btest.cfg.in:
--------------------------------------------------------------------------------
 1 | [btest]
 2 | TestDirs    = tests
 3 | TmpDir      = %(testbase)s/.tmp
 4 | BaselineDir = %(testbase)s/baseline
 5 | IgnoreDirs  = .tmp traces
 6 | IgnoreFiles = *.tmp .*.swp *.swp *.trace .DS_Store *.pcap *.pcapng
 7 | 
 8 | [environment]
 9 | DIST=%(testbase)s/..
10 | PATH=`%(testbase)s/scripts/get-zeek-env path`
11 | ZEEKPATH=`%(testbase)s/scripts/get-zeek-env zeekpath`
12 | ZEEK_PLUGIN_PATH=`%(testbase)s/scripts/get-zeek-env zeek_plugin_path`
13 | ZEEK_SEED_FILE=%(testbase)s/files/random.seed
14 | PACKAGE=%(testbase)s/../scripts
15 | TZ=UTC
16 | LC_ALL=C
17 | TRACES=%(testbase)s/traces
18 | TMPDIR=%(testbase)s/.tmp
19 | TEST_DIFF_CANONIFIER=%(testbase)s/scripts/diff-remove-timestamps
20 | # Set compilation-related variables to well-defined state.
21 | CC=
22 | CXX=
23 | CFLAGS=
24 | CPPFLAGS=
25 | CXXFLAGS=
26 | LDFLAGS=
27 | DYLDFLAGS=
28 | 


--------------------------------------------------------------------------------
/backend/templates/conversion.cc.in:
--------------------------------------------------------------------------------
 1 | #include <string>
 2 | #include <hilti/rt/libhilti.h>
 3 | #include <spicy/rt/libspicy.h>
 4 | 
 5 | namespace ${scope}
 6 | {
 7 | ${functions}
 8 | }
 9 | 
10 | 


--------------------------------------------------------------------------------
/backend/templates/conversion.spicy.in:
--------------------------------------------------------------------------------
1 | module ${scope};
2 | 
3 | ${functions}
4 | 


--------------------------------------------------------------------------------
/backend/templates/diff-remove-timestamps.in:
--------------------------------------------------------------------------------
 1 | #! /usr/bin/env bash
 2 | #
 3 | # Replace anything which looks like timestamps with XXXs (including the #start/end markers in logs).
 4 | 
 5 | # Get us "modern" regexps with sed.
 6 | if [ "$(uname)" == "Linux" ]; then
 7 |     sed="sed -r"
 8 | else
 9 |     sed="sed -E"
10 | fi
11 | 
12 | $sed 's/(0\.000000)|([0-9]{9,10}\.[0-9]{2,8})/XXXXXXXXXX.XXXXXX/g' |
13 |     $sed 's/^ *#(open|close).(19|20)..-..-..-..-..-..$/#\1 XXXX-XX-XX-XX-XX-XX/g'
14 | 


--------------------------------------------------------------------------------
/backend/templates/enum.spicy.in:
--------------------------------------------------------------------------------
1 | module ${scope};
2 | 
3 | ${contents}
4 | # vim: ai si tabstop=4 shiftwidth=4 softtabstop=4 expandtab colorcolumn=101 syntax=spicy
5 | 
6 | 


--------------------------------------------------------------------------------
/backend/templates/events.evt.in:
--------------------------------------------------------------------------------
1 | import ${scope};
2 | ${additionalScopes}import Zeek_${protocolName};
3 | 
4 | ${protocolEvents}${entryPointEvent}${exportString}${objectEvents}
5 | 


--------------------------------------------------------------------------------
/backend/templates/generateid.cc.in:
--------------------------------------------------------------------------------
 1 | #include <string>
 2 | #include <iostream>
 3 | #include <algorithm>
 4 | #include <random>
 5 | #include <hilti/rt/libhilti.h>
 6 | #include <spicy/rt/libspicy.h>
 7 | 
 8 | namespace ${scope}
 9 | {
10 |     #define ID_LEN 9
11 |     
12 |     std::string generateId() {
13 |         std::stringstream ss;
14 |         for (auto i = 0; i < ID_LEN; i++) {
15 |             // Generate a random char
16 |             std::random_device rd;
17 |             std::mt19937 gen(rd());
18 |             std::uniform_int_distribution<> dis(0, 255);
19 |             const auto rc = dis(gen);
20 | 
21 |             // Hex representaton of random char
22 |             std::stringstream hexstream;
23 |             hexstream << std::hex << rc;
24 |             auto hex = hexstream.str();
25 |             ss << (hex.length() < 2 ? '0' + hex : hex);
26 |         }
27 |         return ss.str();
28 |     }
29 | }
30 | 
31 | 


--------------------------------------------------------------------------------
/backend/templates/generateid.spicy.in:
--------------------------------------------------------------------------------
1 | module ${scope};
2 | 
3 | public function generateId() : string &cxxname="${scope}::generateId";
4 | 


--------------------------------------------------------------------------------
/backend/templates/get-zeek-env.in:
--------------------------------------------------------------------------------
 1 | #! /bin/sh
 2 | #
 3 | # BTest helper for getting values for Zeek-related environment variables.
 4 | 
 5 | # shellcheck disable=SC2002
 6 | base="$(dirname "$0")"
 7 | zeek_dist=$(cat "${base}/../../build/CMakeCache.txt" 2>/dev/null | grep ZEEK_DIST | cut -d = -f 2)
 8 | 
 9 | if [ -n "${zeek_dist}" ]; then
10 |     if [ "$1" = "zeekpath" ]; then
11 |         "${zeek_dist}/build/zeek-path-dev"
12 |     elif [ "$1" = "zeek_plugin_path" ]; then
13 |         (cd "${base}/../.." && pwd)
14 |     elif [ "$1" = "path" ]; then
15 |         echo "${zeek_dist}/build/src:${zeek_dist}/aux/btest:${base}/:${zeek_dist}/aux/zeek-cut:$PATH"
16 |     else
17 |         echo "usage: $(basename "$0") <var>" >&2
18 |         exit 1
19 |     fi
20 | else
21 |     # Use Zeek installation for testing. In this case zeek-config must be in PATH.
22 |     if ! which zeek-config >/dev/null 2>&1; then
23 |         echo "zeek-config not found" >&2
24 |         exit 1
25 |     fi
26 | 
27 |     if [ "$1" = "zeekpath" ]; then
28 |         zeek-config --zeekpath
29 |     elif [ "$1" = "zeek_plugin_path" ]; then
30 |         # Combine the local tree and the system-wide path. This allows
31 |         # us to test on a local build or an installation made via zkg,
32 |         # which squirrels away the build.
33 |         echo "$(cd "${base}/../.." && pwd)/build:$(zeek-config --plugin_dir)"
34 |     elif [ "$1" = "path" ]; then
35 |         echo "${PATH}"
36 |     else
37 |         echo "usage: $(basename "$0") <var>" >&2
38 |         exit 1
39 |     fi
40 | fi
41 | 


--------------------------------------------------------------------------------
/backend/templates/gitignore.in:
--------------------------------------------------------------------------------
 1 | # Development Machine Files
 2 | .*.swp
 3 | *~
 4 | *.bak
 5 | *.DS_Store
 6 | .~lock.*#
 7 | 
 8 | # Parsnip/Zeek Output Files
 9 | *.svg
10 | *cycles.txt
11 | *.log
12 | 
13 | # Zeek Test Files
14 | testing/.tmp/
15 | testing/.btest.failed.dat
16 | 
17 | # Don't ignore baseline log files
18 | !testing/baseline/*/*.log
19 | 


--------------------------------------------------------------------------------
/backend/templates/main.zeek.in:
--------------------------------------------------------------------------------
 1 | ##! main.zeek
 2 | ##!
 3 | ##! ICSNPP-${protocolName}
 4 | ##!
 5 | ##! Zeek script type/record definitions describing the information
 6 | ##! that will be written to the log files.
 7 | ##!
 8 | 
 9 | module ${protocolName};
10 | 
11 | ${mainContents}
12 | ${loggingFunctions}
13 | 


--------------------------------------------------------------------------------
/backend/templates/random.seed.in:
--------------------------------------------------------------------------------
 1 | 2983378351
 2 | 1299727368
 3 | 0
 4 | 310447
 5 | 0
 6 | 1409073626
 7 | 3975311262
 8 | 34130240
 9 | 1450515018
10 | 1466150520
11 | 1342286698
12 | 1193956778
13 | 2188527278
14 | 3361989254
15 | 3912865238
16 | 3596260151
17 | 517973768
18 | 1462428821
19 | 0
20 | 2278350848
21 | 32767


--------------------------------------------------------------------------------
/backend/templates/root_CMakeLists.txt.in:
--------------------------------------------------------------------------------
 1 | # Warning! This is an automatically generated file!
 2 | #
 3 | cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
 4 | 
 5 | project(${protocol} LANGUAGES C)
 6 | 
 7 | list(PREPEND CMAKE_MODULE_PATH "$${PROJECT_SOURCE_DIR}/cmake")
 8 | find_package(SpicyPlugin REQUIRED)
 9 | 
10 | # Set minimum versions that this plugin needs.
11 | #spicy_required_version("1.2.0")
12 | #zeek_required_version("6.0.0")
13 | 
14 | if(NOT CMAKE_BUILD_TYPE)
15 |     # Default to the release build
16 |     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "")
17 | endif(NOT CMAKE_BUILD_TYPE)
18 | 
19 | add_subdirectory(analyzer)
20 | 


--------------------------------------------------------------------------------
/backend/templates/scope.spicy.in:
--------------------------------------------------------------------------------
1 | module ${scope};
2 | 
3 | import spicy;
4 | 
5 | ${additionalScopes}
6 | ${entryPoint}${objectsString}# vim: ai si tabstop=4 shiftwidth=4 softtabstop=4 expandtab colorcolumn=101 syntax=spicy
7 | 


--------------------------------------------------------------------------------
/backend/templates/standalone.spicy.in:
--------------------------------------------------------------------------------
 1 | # Warning! This is an automatically generated file!
 2 | #
 3 | # @TEST-DOC: Test parsing behavior of ${protocolName}.
 4 | #
 5 | # @TEST-EXEC: spicyc $${DIST}/analyzer/${protocolNameLower}.spicy -j -d -o ${protocolNameLower}.hlto
 6 | #
 7 | # TODO: Add/adapt standalone parsing tests here.
 8 | # @TEST-EXEC: printf "test string" | spicy-dump -p ${scope}::${entryPointName} ${protocolNameLower}.hlto > output 2>&1
 9 | # @TEST-EXEC: TEST_DIFF_CANONIFIER= btest-diff output
10 | 


--------------------------------------------------------------------------------
/backend/templates/zeekConfirmationFile.spicy.in:
--------------------------------------------------------------------------------
 1 | module Zeek_${protocolName};
 2 | 
 3 | import ${scope};
 4 | import spicy;
 5 | 
 6 | on ${scope}::${entryPoint}::%done {
 7 | ${tab}spicy::accept_input();
 8 | }
 9 | 
10 | on ${scope}::${entryPoint}::%error {
11 | ${tab}spicy::decline_input("error parsing ${protocolName} message");
12 | }
13 | 
14 | 


--------------------------------------------------------------------------------
/backend/templates/zeek_enum.zeek.in:
--------------------------------------------------------------------------------
1 | module ${scope};
2 | 
3 | export {
4 | ${contents}}
5 | 


--------------------------------------------------------------------------------
/backend/templates/zeek_processing.zeek.in:
--------------------------------------------------------------------------------
1 | module ${scope};
2 | 
3 | ${eventString}${functionString}
4 | 


--------------------------------------------------------------------------------
/backend/templates/zeek_types.zeek.in:
--------------------------------------------------------------------------------
1 | module ${scope};
2 | 
3 | export {
4 | ${contents}}
5 | 


--------------------------------------------------------------------------------
/backend/templates/zkg.meta.in:
--------------------------------------------------------------------------------
 1 | [package]
 2 | script_dir = scripts
 3 | test_command = cd testing && btest -c btest.cfg
 4 | summary = ${protocolSummary}
 5 | description = ${protocolDescription}
 6 | depends = 
 7 |     zeek >=6.1.0
 8 | build_command = mkdir -p build && cd build && SPICYZ=$$(command -v spicyz || echo %(package_base)s/spicy-plugin/build/bin/spicyz) cmake .. && cmake --build .
 9 | 
10 | [template]
11 | source = https://github.com/zeek/package-template
12 | version = v3.1.0
13 | zkg_version = 2.13.0-46
14 | features = spicy-${analyzerType}-analyzer
15 | 
16 | [template_vars]
17 | name = spicy-${protocolName}
18 | analyzer = ${protocolNameUpper}${transportProtocolInformation}
19 | unit_orig = ${entryPoint}s
20 | unit_resp = ${entryPoint}s
21 | 


--------------------------------------------------------------------------------
/backend/utils.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  2 | 
  3 | import re
  4 | from math import ceil
  5 | TAB_SIZE = 4
  6 | SINGLE_TAB = " " * TAB_SIZE
  7 | DOUBLE_TAB = SINGLE_TAB * 2
  8 | PROTOCOL_NAME = ""
  9 | DEFAULT_SCOPE = "general"
 10 | CONVERSION_SCOPE = "conversion"
 11 | ID_SCOPE = "generateid"
 12 | USES_LAYER_2 = False
 13 | 
 14 | scopesHaveCrossScopeLinks = {}
 15 | 
 16 | def getTabString(tabSize):
 17 |     return SINGLE_TAB * tabSize
 18 | 
 19 | spicyToZeek = {
 20 |     "addr"      : "addr", 
 21 |     "uint"      : "count",
 22 |     "uint8"     : "count", 
 23 |     "uint16"    : "count",
 24 |     "uint32"    : "count",
 25 |     "uint64"    : "count",
 26 |     "int8"      : "int",
 27 |     "int16"     : "int", 
 28 |     "int32"     : "int", 
 29 |     "int64"     : "int", 
 30 |     "int"       : "int",
 31 |     "bool"      : "bool", 
 32 |     "real"      : "double",
 33 |     "string"    : "string",
 34 |     "enum"      : "string",
 35 |     "float"     : "double",
 36 |     "bytes"     : "string"
 37 | }
 38 | customFieldTypes = {}
 39 | 
 40 | def zeekTypeMapping(spicyType):
 41 |     if spicyType in spicyToZeek:
 42 |         return spicyToZeek[spicyType]
 43 |     else:
 44 |         print("Unknown type {0}".format(spicyType))
 45 |         return spicyType
 46 | 
 47 | def commandNameToConst(commandName):
 48 |     name = re.sub(r'(.)([A-Z][a-z]+)', r'\1_\2', commandName)
 49 |     return re.sub(r'([a-z0-9])([A-Z])', r'\1_\2', name)
 50 |     
 51 | def calculateColumn(nameLength):
 52 |     return ceil((nameLength + 1) / TAB_SIZE) * TAB_SIZE
 53 |     
 54 | def endingSpace(columns, nameLength):
 55 |     return " " * (columns - nameLength)
 56 |     
 57 | def normalizedScope(scope, itemType):
 58 |     if scope == "general" or PROTOCOL_NAME.upper() == scope:
 59 |         if "enum" == itemType:
 60 |             return PROTOCOL_NAME.upper() + "_ENUM"
 61 |         else:
 62 |             return PROTOCOL_NAME.upper()
 63 |     elif scope != "":
 64 |         if "enum" == itemType:
 65 |             scope = scope + "_enum"
 66 |         return PROTOCOL_NAME.upper() + "_" + scope.upper()
 67 |     else:
 68 |         return ""
 69 |         
 70 | def loggingParentScope(scope):
 71 |     if scope == "general" or PROTOCOL_NAME.upper() == scope:
 72 |         return "general"
 73 |     elif scope.startswith(PROTOCOL_NAME.upper()):
 74 |         temp = scope[len(PROTOCOL_NAME.upper()) + 1:]
 75 |         return temp.lower()
 76 |     else:
 77 |         print("Unexepected scope: {}".format(scope))
 78 |         return scope
 79 |         
 80 | def determineSpicyStringForAction(action, switch, inputs, actionColumn, customTypes, bitfields, switches, enums):
 81 |     if "void" == action.type:
 82 |         return "{0} : void".format(endingSpace(actionColumn, 0))
 83 |     mappedUntilValue = None
 84 |     if action.until is not None:
 85 |         mappedUntilValue = action.until
 86 |         if mappedUntilValue.get("indicator") is not None:
 87 |             if switch.dependsOn is not None and switch.dependsOn.name == mappedUntilValue.get("indicator"):
 88 |                 mappedUntilValue["indicator"] = inputs[0].source
 89 |             else:
 90 |                 for dependencyIndex in range(len(switch.additionalDependsOn)):
 91 |                     if switch.additionalDependsOn[dependencyIndex].name == mappedUntilValue.get("indicator"):
 92 |                         mappedUntilValue["indicator"] = inputs[1 + dependencyIndex].source
 93 |                         if inputs[1 + dependencyIndex].minusInUse:
 94 |                             mappedUntilValue["minus"] = inputs[1 + dependencyIndex].minus
 95 |                         elif "minus" in mappedUntilValue:
 96 |                             # TODO: Figure out how mappedUntilValue is holding onto old data
 97 |                             del mappedUntilValue["minus"]
 98 |                         break
 99 |     tempInputs = []
100 |     for input in action.inputs:
101 |         if switch.dependsOn is not None and switch.dependsOn.name == input.source:
102 |             tempInputs.append(inputs[0])
103 |         else:
104 |             for dependencyIndex in range(len(switch.additionalDependsOn)):
105 |                 if switch.additionalDependsOn[dependencyIndex].name == input.source:
106 |                     tempInputs.append(inputs[1 + dependencyIndex])
107 |                     break
108 |     _, typeString = determineSpicyStringForType(action.name, action.type, action.elementType, action.referenceType, action.scope, action.size, tempInputs, mappedUntilValue, actionColumn, customTypes, bitfields, switches, enums)
109 |     return "{0}{1} : {2}".format(action.name, endingSpace(actionColumn, len(action.name)), typeString)
110 |     
111 | def _returnIntegerType(itemType, size, columns, itemName):
112 |     if size in [8, 16, 32, 64]:
113 |         return ("", itemType + str(size))
114 |     elif 24 == size:
115 |         sizeInBytes = int(ceil(size / 8))
116 |         returnString = "bytes &size={0} {{\n".format(sizeInBytes)
117 |         returnString += "{0}{1}   self.{2} = $$.to_uint(spicy::ByteOrder::Big);\n".format(DOUBLE_TAB, endingSpace(columns, 0), itemName)
118 |         returnString += "{0}{1}   }}".format(SINGLE_TAB, endingSpace(columns, 0))
119 |         
120 |         return (itemType + "64", returnString)
121 |     else:
122 |         print("Current unsupported (u)int size {0}".format(size))
123 |         return ("","")
124 |         
125 | def _returnSpicyObjectType(itemType, enums, scope, referenceType, inputs):
126 |     outputString = ""
127 |     if "enum" == itemType:
128 |         reference = enums[scope][referenceType]
129 |         outputString += "uint{0}".format(reference.size)
130 |         if "little" == reference.endianness:
131 |             outputString += " &byte-order=spicy::ByteOrder::Little"
132 |         outputString += " &convert="
133 |     outputString += "{0}::{1}".format(scope, referenceType)
134 |     
135 |     if "enum" == itemType:
136 |         outputString += "($$)"
137 |     elif 0 < len(inputs):
138 |         outputString += "("
139 |         for index, value in enumerate(inputs):
140 |             outputString += value.getString()
141 |             if index < len(inputs) - 1:
142 |                 outputString += ", "
143 |         outputString += ")"
144 |     return ("", outputString)
145 |     
146 | def _returnFloatType(size):
147 |     if 32 == size:
148 |         return ("", "real &type=spicy::RealType::IEEE754_Single")
149 |     elif 64 == size:
150 |         return ("", "real &type=spicy::RealType::IEEE754_Double")
151 |     else:
152 |         print("Currently unknown float size {0}".format(size))
153 |         return ("", "")
154 |         
155 | def _returnAddrType(size):
156 |     if size == 32:
157 |         return ("", "addr &ipv4")
158 |     elif size == 128:
159 |         return ("", "addr &ipv6")
160 |         
161 | def _returnBitsType(bitfields, scope, referenceType, columns):
162 |     # Have to get size from the reference
163 |     reference = bitfields[scope][referenceType]
164 |     outputString = "bitfield({0}) {{\n".format(reference.size)
165 |     for field in reference.fields:
166 |         if field.notes is not None and "" != field.notes:
167 |             outputString += "{0}{1}   # {2}\n".format(DOUBLE_TAB, endingSpace(columns, 0), field.notes)
168 |         conversionString = ""
169 |         if "enum" == field.type:
170 |             conversionString = " &convert={0}::{1}($$)".format(field.scope, field.referenceType)
171 |         elif "bool" == field.type:
172 |             conversionString = " &convert=cast<bool>($$)"
173 |         outputString += "{0}{1}   {2}{3} : {4}{5};\n".format(DOUBLE_TAB, endingSpace(columns, 0), field.name, endingSpace(reference.column, len(field.name)), field.bits, conversionString)
174 |     outputString += "{0}{1}   }}".format(SINGLE_TAB, endingSpace(columns, 0))
175 |     if "little" == reference.endianness:
176 |         outputString += " &byte-order=spicy::ByteOrder::Little"
177 |     return ("", outputString)
178 |     
179 | def _returnListType(itemName, elementType, referenceType, scope, size, inputs, customTypes, bitfields, switches, enums, until):
180 |     varString, typeString = determineSpicyStringForType(itemName, elementType, None, referenceType, scope, size, inputs, None, 0, customTypes, bitfields, switches, enums)
181 |     sizeString = ""
182 |     conditionString = ""
183 |     if until is not None and until.get("conditionType") is not None:
184 |         conditionType = until.get("conditionType")
185 |         if "ENDOFDATA" == conditionType:
186 |             conditionString = " &eod"
187 |         elif "COUNT" == conditionType:
188 |             sizeString = until.get("indicator")
189 |             if until.get("minus") is not None:
190 |                 sizeString = "({} - {})".format(sizeString, until.get("minus"))
191 |         elif "BYTECOUNT" == conditionType:
192 |             conditionString = " &until="
193 |             indicator = until.get("indicator")
194 |             if until.get("minus") is None:
195 |                 conditionString += indicator
196 |             else:
197 |                 conditionString += "({} - {})".format(indicator, until.get("minus"))
198 |         else:
199 |             print("Unknown list condition type of {0}".format(conditionType))
200 |     typeString = "({0})[{1}]{2}".format(typeString, sizeString, conditionString)
201 |     
202 |     return (varString, typeString)
203 |     
204 | def _returnSwitchType(scope, referenceType, inputs, customTypes, bitfields, switches, enums):
205 |     reference = switches[scope][referenceType]
206 |     outputString = "switch({0}) {{\n".format(inputs[0].getString())
207 |     for option in reference.options:
208 |         if option.action.type != "void":
209 |             preString = ""
210 |             if "enum" == reference.dependsOn.type:
211 |                 preString = "{0}::{1}::".format(reference.dependsOn.scope, reference.dependsOn.referenceType)
212 |             outputString += "{0}{1}{2}{3} -> {4};\n".format(DOUBLE_TAB, preString, option.value, endingSpace(reference.column, len(str(option.value))), determineSpicyStringForAction(option.action, reference, inputs, reference.actionColumn, customTypes, bitfields, switches, enums))
213 |     defaultActionString = "{0} : void".format(endingSpace(reference.actionColumn, 0))
214 |     if reference.default is not None:
215 |         defaultActionString = determineSpicyStringForAction(reference.default, reference, inputs, reference.actionColumn, customTypes, bitfields, switches, enums)
216 |     outputString += "{0}*{1}{2} -> {3};\n".format(DOUBLE_TAB, " "*len(preString), endingSpace(reference.column, 1), defaultActionString)
217 |     outputString += "{0}}}".format(SINGLE_TAB)
218 |     return ("", outputString)
219 |         
220 | def determineSpicyStringForType(itemName, itemType, elementType, referenceType, scope, size, inputs, until, columns, customTypes, bitfields, switches, enums):
221 |     if itemType in ["uint", "int"]:
222 |         return _returnIntegerType(itemType, size, columns, itemName)
223 |     elif itemType in ["object", "enum"]:
224 |         return _returnSpicyObjectType(itemType, enums, scope, referenceType, inputs)
225 |     elif "bytes" == itemType:
226 |         return ("", "bytes &size={0}".format(int(ceil(size / 8))))
227 |     elif "float" == itemType:
228 |         return _returnFloatType(size)
229 |     elif "addr" == itemType:
230 |         return _returnAddrType(size)
231 |     elif "bits" == itemType:
232 |         return _returnBitsType(bitfields, scope, referenceType, columns)
233 |     elif "list" == itemType:
234 |         return _returnListType(itemName, elementType, referenceType, scope, size, inputs, customTypes, bitfields, switches, enums, until)
235 |     elif "string" == itemType:
236 |         return ("", "string")
237 |     elif "switch" == itemType:
238 |         return _returnSwitchType(scope, referenceType, inputs, customTypes, bitfields, switches, enums)
239 |     elif itemType in customTypes:
240 |         # See if it's custom type
241 |         sizeInBytes = int(ceil(size / 8))
242 |         return ("", "bytes &size={0} &convert={1}::{2}($$)".format(sizeInBytes, normalizedScope(CONVERSION_SCOPE, ""), customTypes[itemType].interpretingFunction))
243 |     else:
244 |         # Otherwise we don't know...
245 |         print("Currently unknown itemType of {0}".format(itemType))
246 |         return ("", "")
247 | 
248 | def getObject(referenceType, scopes, allObjects):
249 |     referencedObject = None
250 |     objectScope = None
251 |     for scope in scopes:
252 |         if referenceType in allObjects[normalizedScope(scope, "object")]:
253 |                 referencedObject = allObjects[normalizedScope(scope, "object")][referenceType]
254 |                 objectScope = scope
255 |                 break
256 |     return referencedObject, objectScope
257 | 
258 | 


--------------------------------------------------------------------------------
/docs/images/add_port.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/add_port.png


--------------------------------------------------------------------------------
/docs/images/bitfields_navigation.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/bitfields_navigation.png


--------------------------------------------------------------------------------
/docs/images/body_data_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/body_data_info.png


--------------------------------------------------------------------------------
/docs/images/body_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/body_info.png


--------------------------------------------------------------------------------
/docs/images/config_before_update.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/config_before_update.png


--------------------------------------------------------------------------------
/docs/images/empty_config.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/empty_config.png


--------------------------------------------------------------------------------
/docs/images/empty_ports.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/empty_ports.png


--------------------------------------------------------------------------------
/docs/images/enums_navigation.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/enums_navigation.png


--------------------------------------------------------------------------------
/docs/images/finalize_config.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/finalize_config.png


--------------------------------------------------------------------------------
/docs/images/front.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/front.png


--------------------------------------------------------------------------------
/docs/images/headerBits_info_1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/headerBits_info_1.png


--------------------------------------------------------------------------------
/docs/images/headerBits_info_2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/headerBits_info_2.png


--------------------------------------------------------------------------------
/docs/images/header_headerBits_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/header_headerBits_info.png


--------------------------------------------------------------------------------
/docs/images/header_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/header_info.png


--------------------------------------------------------------------------------
/docs/images/header_length_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/header_length_info.png


--------------------------------------------------------------------------------
/docs/images/messageType_info_1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/messageType_info_1.png


--------------------------------------------------------------------------------
/docs/images/messageType_info_2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/messageType_info_2.png


--------------------------------------------------------------------------------
/docs/images/message_body_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/message_body_info.png


--------------------------------------------------------------------------------
/docs/images/message_header_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/message_header_info.png


--------------------------------------------------------------------------------
/docs/images/message_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/message_info.png


--------------------------------------------------------------------------------
/docs/images/objects_navigation.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/objects_navigation.png


--------------------------------------------------------------------------------
/docs/images/partial_config.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/partial_config.png


--------------------------------------------------------------------------------
/docs/images/port_added.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/port_added.png


--------------------------------------------------------------------------------
/docs/images/review_page.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/review_page.png


--------------------------------------------------------------------------------
/docs/images/updated_bitfields_page.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/updated_bitfields_page.png


--------------------------------------------------------------------------------
/docs/images/updated_body_fields.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/updated_body_fields.png


--------------------------------------------------------------------------------
/docs/images/updated_enum_page.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/updated_enum_page.png


--------------------------------------------------------------------------------
/docs/images/updated_header_fields.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/updated_header_fields.png


--------------------------------------------------------------------------------
/docs/images/updated_message_fields.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/updated_message_fields.png


--------------------------------------------------------------------------------
/docs/images/updated_objects_page.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/images/updated_objects_page.png


--------------------------------------------------------------------------------
/docs/parsnip.md:
--------------------------------------------------------------------------------
  1 | # Parsnip
  2 | 
  3 | ## Background
  4 | 
  5 | [Zeek](https://github.com/zeek/zeek.git) is an open source network security monitoring tool. It is highly customizable and users can introduce custom scripts and protocol parsers to enhance the data they receive from Zeek. CISA publishes several Zeek packages for ICS protocol parsing. These can be found [here](https://github.com/zeek/zeek.git).
  6 | 
  7 | These packages are written in one of two languages: BinPAC or Spicy. These languages are used only for Zeek parser development thus creating a steep learning curve for anyone interested in developing a parser. Parsnip seeks to lower the barrier of entry for parser creation by leveraging more familiar structures such as a Graphical User Interface(GUI) and JSON.
  8 | 
  9 | ## Introduction
 10 | Parsnip is specifically designed to be applied towards developing Industrial Control Systems (ICS) protocol parsers but can be applied to any protocol.
 11 | 
 12 | The Parsnip ecosystem consists of three parts:
 13 | 1. A GUI interface designed provide a visual representation of a protocol's packet structure
 14 | 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.
 15 | 3. A backend that performs processing on the parsnip IL files and outputs the spicy, zeek and event files necessary for a parser
 16 | 
 17 | ## Setup
 18 | Parsnip has been tested with Ubuntu 22.04 and 24.04.
 19 | 
 20 | ### GUI
 21 | Install Prerequisites:
 22 | 
 23 | **Method 1**
 24 | 
 25 | ```bash
 26 | sudo apt update
 27 | sudo apt install docker.io
 28 | ```
 29 | 
 30 | Add the current user to the docker group:
 31 | 
 32 | ```bash
 33 | sudo usermod -a -G docker $USER
 34 | ```
 35 | 
 36 | **Restart your computer to activate docker and set up the user within the docker group.**
 37 | 
 38 | **Method 2**
 39 | 
 40 | ```bash
 41 | #!/bin/bash
 42 | 
 43 | # Install Docker Key
 44 | sudo apt update
 45 | sudo apt install ca-certificates curl
 46 | sudo install -m 0755 -d /etc/apt/keyrings
 47 | sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
 48 | sudo chmod a+r /etc/apt/keyrings/docker.asc
 49 | 
 50 | # Add the repository to sources
 51 | # Note: need to change VERSION_CODENAME to UBUNTU_CODENAME if running an Ubuntu derivative
 52 | echo \
 53 |     "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
 54 |     $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
 55 |     sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
 56 | 
 57 | sudo apt update
 58 | sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
 59 | ```
 60 | 
 61 | Allow a non-root user to use Docker
 62 | 
 63 | ```bash
 64 | sudo apt install uidmap
 65 | dockerd-rootless-setuptool.sh install
 66 | ```
 67 | 
 68 | ### Backend
 69 | Install Prerequisites:
 70 | 
 71 | #### Ubuntu 22.04
 72 | 
 73 | ```bash
 74 | sudo apt install python3 python3-pip graphviz-dev
 75 | ```
 76 | 
 77 | ```bash
 78 | pip3 install rustworkx matplotlib pygraphviz pydot
 79 | ```
 80 | 
 81 | #### Ubuntu 24.04
 82 | 
 83 | ```bash
 84 | sudo apt install python3 python3-pip graphviz-dev python3-matplotlib python3-pygraphviz python3-pydot
 85 | ```
 86 | 
 87 | Install Rustworkx as system package:
 88 | 
 89 | ```bash
 90 | sudo pip3 install rustworkx --break-system-packages
 91 | ```
 92 | 
 93 | #### Zeek
 94 | Zeek (version &geq; 6.1.0):
 95 | The easiest way is to use the following docker container: ghcr.io/mmguero/zeek:master. Refer to [the repository](https://github.com/mmguero/zeek-docker/pkgs/container/zeek) for more information on usage.
 96 | 
 97 | ## Getting Started
 98 | ### Running the GUI
 99 | 
100 | From the parsnip/frontend folder:
101 | ```bash
102 | ./start_webServer.sh
103 | ```
104 | 
105 | This will drop the user into a bash session running within a docker container.
106 | 
107 | From there run:
108 | ```bash
109 | cd app
110 | python3 app.py
111 | ```
112 | 
113 | Users should now be able to access the frontend in a web browser at: http://127.0.0.1:5000.
114 | 
115 | Refer to the documentation in the parsnip/docs folder and the next section for more information on the GUI.
116 | 
117 | ### Basic Example
118 | This example shows how to implement a simple protocol using Parsnip.
119 | 
120 | #### Protocol Information
121 | The MySimpleProtocol protocol runs over TCP port 8888.
122 | 
123 | A protocol message for our simple protocol consists of a two byte header and a variable length body.
124 | The first byte of the header consists of two 4-bit bitfields. The first four bits represent the protocol version. The last four bits represent the message type. A message type of 0 represents a message for the server. A message type of 1 represents a message for the client. The second byte of the header consists of the length of the packet as an unsigned 8-bit integer. The body consists of a series a bytes where the length of the body is specified by the length field.
125 | 
126 | A test PCAP of MySimpleProtocol is available in the docs/traces folder of this repository.
127 | 
128 | #### Constructing the Protocol in Parsnip
129 | When users navigate to the Parsnip frontend using a browser, they will be greeted by the following page:
130 | 
131 | ![Parsnip front page](./images/front.png)
132 | 
133 | ##### Protocol Configuration
134 | 
135 | Begin by going to the Parser Configuration Page:
136 | 
137 | ![Parser configuration page](./images/empty_config.png)
138 | 
139 | Press the "Edit Parser Configuration" button and enter the information shown:
140 | 
141 | ![Parser configuration partial](./images/partial_config.png)
142 | 
143 | Users will need to return to this screen later to specify the Entry Point Structure. After users press the "Save Configuration" button, they should navigate to the "Protocol Ports" tab as shown:
144 | 
145 | ![Parser protocol ports page](./images/empty_ports.png)
146 | 
147 | Press the "Add Port" button and enter the information shown:
148 | 
149 | ![Add TCP Port](./images/add_port.png)
150 | 
151 | After a user presses the "Add Port" the port should now be listed as a protocol port as shown:
152 | 
153 | ![TCP Port added](./images/port_added.png)
154 | 
155 | ##### Adding Structures
156 | When working within the frontend, it is best to take a bottom-up approach to defining structures.
157 | 
158 | For MySimpleProtocol, start by defining the message type enumeration.
159 | 
160 | First, navigate to the Enums page through the "View/Edit Components" menu as shown:
161 | 
162 | ![Enums Navigation](./images/enums_navigation.png)
163 | 
164 | Next, press the "Add Enum" button and enter the information shown in the next two images:
165 | 
166 | ![messageType information part 1](./images/messageType_info_1.png)
167 | 
168 | ![messageType information part 2](./images/messageType_info_2.png)
169 | 
170 | Press the "Add Enum" button to save the enum. The updated information should appear as shown:
171 | 
172 | ![Updated Enum information](./images/updated_enum_page.png)
173 | 
174 | Next, navigate to the Bitfields page through the "View/Edit Components" menu as shown:
175 | 
176 | ![Enums Navigation](./images/bitfields_navigation.png)
177 | 
178 | Press the "Add Bitfield" button and enter the information shown in the next two images:
179 | 
180 | ![messageType information part 1](./images/headerBits_info_1.png)
181 | 
182 | ![messageType information part 2](./images/headerBits_info_2.png)
183 | 
184 | Press the "Add Bitfield Structure" to save the bitfield. The updated information should appear as shown:
185 | 
186 | ![Updated Bitfield Information](./images/updated_bitfields_page.png)
187 | 
188 | Finally, build the "Object" structures. Navigate to the Objects page through the "View/Edit Components" menu as shown:
189 | 
190 | ![Objects Navigation](./images/objects_navigation.png)
191 | 
192 | First, press the "Add Object" button and enter the information shown:
193 | 
194 | ![Body Information](./images/body_info.png)
195 | 
196 | Press the "Add Object" button to save the object. Next, press the "View Fields" link for the Body object. Then press the "Add Field" button and enter the information shown:
197 | 
198 | ![Body Field Information](./images/body_data_info.png)
199 | 
200 | Press the "Add Field" button to save the information. The updated information should appear as shown:
201 | 
202 | ![Updated Body Information](./images/updated_body_fields.png)
203 | 
204 | Navigate back to the Objects page again. Press the "Add Object" button on the Object page again and enter the information shown:
205 | 
206 | ![Header Information](./images/header_info.png)
207 | 
208 | Press the "Add Object" button to save the object. Next, press the "View Fields" link for the Header object. Then press the "Add Field" button and enter the information shown:
209 | 
210 | ![Header Bits Information](./images/header_headerBits_info.png)
211 | 
212 | Press the "Add Field" button to save the information. Press the "Add Field" button again on the Header Fields page and enter the information shown:
213 | 
214 | ![Header Length Information](./images/header_length_info.png)
215 | 
216 | Press the "Add Field" button to save the information. The updated information should appear as shown:
217 | 
218 | ![Updated Body Information](./images/updated_header_fields.png)
219 | 
220 | Navigate back to the Objects page again. Press the "Add Object" button on the Object page again and enter the information shown:
221 | 
222 | ![Message Information](./images/message_info.png)
223 | 
224 | Press the "Add Object" button to save the object. The updated information should appear as shown:
225 | 
226 | ![Updated Objects](./images/updated_objects_page.png)
227 | 
228 | Next, press the "View Fields" link for the Message object. Then press the "Add Field" button and enter the information shown:
229 | 
230 | ![Message Header Information](./images/message_header_info.png)
231 | 
232 | Press the "Add Field" button to save the information. Press the "Add Field" button again on the Message Fields page and enter the information shown:
233 | 
234 | ![Message Body Information](./images/message_body_info.png)
235 | 
236 | Press the "Add Field" button to save the information. The updated information should appear as shown:
237 | 
238 | ![Updated Message](./images/updated_message_fields.png)
239 | 
240 | That is the end of adding structures. Next users should update the configuration with the entry point.
241 | 
242 | ##### Update Configuration
243 | 
244 | Now that the entry point object is defined, return to the Parser Configuration Page as shown:
245 | 
246 | ![Configuration update](./images/config_before_update.png)
247 | 
248 | Press the "Edit Parser Configuration" button and set the Parser Entry Point value to the "Message" object as shown:
249 | 
250 | ![Updating Entry Point](./images/finalize_config.png)
251 | 
252 | Press the "Save Configuration" button to save the updated configuration.
253 | 
254 | ##### Review
255 | Use the frontend to review the parser and look for potential issues. Navigate to the Review page. The page automatically runs checks when loaded. The output should appear as shown:
256 | 
257 | ![Review Results](./images/review_page.png)
258 | 
259 | As the screenshot shows, there are now Switch/Choice types in the parser, but no other errors or warnings are present.
260 | 
261 | ##### Download the Parsnil files
262 | Press the "Export Parsnip Files" link to download a zip file with the Parsnip Intermediate Language files.
263 | 
264 | ### Running the Backend
265 | Once the Parsnip IL files have been generated by the frontend, users should receive a zip file called "parsnip.zip" which contains a folder with a random string of characters for its name (e.g., 08f4789d-6915-4067-8939-4994c55acbae). Unzip the folder into its own folder. Once that zip file has been unzipped, copy the path to the random string folder as the "input_folder" for the following command.
266 | 
267 | To build the parser, run from the parsnip/backend folder, replacing input_folder and output_folder as appropriate:
268 | ```bash
269 | python3 main.py input_folder output_folder
270 | ```
271 | 
272 | For example,
273 | ```bash
274 | python3 main.py ~/Downloads/parsnip/08f4789d-6915-4067-8939-4994c55acbae ~/MyParser
275 | ```
276 | 
277 | The parser code files should now be located in the output_folder directory.
278 | 
279 | Compile and package as usual. At minimum, Zeek version 6.1.0 is required to take full advantage of all features.
280 | 
281 | As listed as a current limitation, the user will need to manually update the permissions on the testing/scripts/get-zeek-env file in the output folder to add execution permissions.
282 | 
283 | ### Running the Parser with Zeek
284 | 
285 | There are multiple ways to run the resulting parser using Zeek. Below is an example of one way to do it.
286 | 
287 | #### Zkg Install for Testing with a Zeek docker container
288 | 
289 | ##### Initiating a git Repository
290 | In order to use the zkg utility the parser must be part of an up to date (i.e., not dirty) git repository.
291 | 
292 | The following commands can be used to initialize the repository, replacing output_folder as appropriate:
293 | ```bash
294 | cd output_folder
295 | echo "*.log" > .gitignore
296 | git init .
297 | git add -A
298 | git commit -m "Initial Commit"
299 | ```
300 | 
301 | For example,
302 | ```bash
303 | cd ~/MyParser
304 | echo "*.log" > .gitignore
305 | git init .
306 | git add -A
307 | git commit -m "Initial Commit"
308 | ```
309 | 
310 | ##### Running the Zeek Docker Container
311 | Next, start the zeek container with the parser folder mounted, replacing output_folder and mount_folder (specified by full path) as appropriate:
312 | ```bash
313 | docker run -t -i -P --rm -v output_folder:mount_folder:rw --entrypoint /bin/bash ghcr.io/mmguero/zeek:master
314 | ```
315 | 
316 | For example,
317 | ```bash
318 | docker run -t -i -P --rm -v $HOME/MyParser:/root/MyParser:rw --entrypoint /bin/bash ghcr.io/mmguero/zeek:master
319 | ```
320 | 
321 | ##### Installing the parser
322 | Inside the docker container, navigate to the mounted folder (specified in the previous command) and run the following:
323 | ```bash
324 | zkg install .
325 | ```
326 | 
327 | ##### Running the parser
328 | Assuming the parser has installed via the previous step, the parser can be run using the following command, replacing pcap_path with the path to a pcap file to test:
329 | ```bash
330 | zeek -Cr pcap_path local
331 | ```
332 | 
333 | For example:
334 | ```bash
335 | zeek -Cr /root/MyParser/example/test.pcapng local
336 | ```
337 | 
338 | ## Syntax Information
339 | Refer to [syntax.md](syntax.md) for more information about writing a parser using Parsnip.
340 | 


--------------------------------------------------------------------------------
/docs/parsnip_files/intermediate_language/general/bitfields.json:
--------------------------------------------------------------------------------
 1 | [
 2 |     {
 3 |         "name": "HeaderBits",
 4 |         "reference": "",
 5 |         "notes": "",
 6 |         "size": 8,
 7 |         "fields": [
 8 |             {
 9 |                 "name": "version",
10 |                 "description": "Protocol Version",
11 |                 "notes": "",
12 |                 "type": "uint",
13 |                 "referenceType": null,
14 |                 "bits": "4..7"
15 |             },
16 |             {
17 |                 "name": "messageType",
18 |                 "description": "Message Type",
19 |                 "notes": "",
20 |                 "type": "enum",
21 |                 "referenceType": "MessageType",
22 |                 "bits": "0..3",
23 |                 "scope": "general"
24 |             }
25 |         ],
26 |         "referenceCount": 1
27 |     }
28 | ]


--------------------------------------------------------------------------------
/docs/parsnip_files/intermediate_language/general/config.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "ParsnipVersion": "1.0",
 3 |     "Protocol": "MySimpleProtocol",
 4 |     "protocolShortDescription": "TODO: A summary of protocol in one line",
 5 |     "protocolLongDescription": "TODO: A more detailed description of protocol.\n    It can span multiple lines, with this indentation.",
 6 |     "Ports": [
 7 |         {
 8 |             "protocol": "tcp",
 9 |             "port": 8888
10 |         }
11 |     ],
12 |     "usesTCP": true,
13 |     "usesUDP": false,
14 |     "usesLayer2": false,
15 |     "CustomFieldTypes": [],
16 |     "EntryPoint": "general.Message",
17 |     "Scopes": [
18 |         "general"
19 |     ]
20 | }


--------------------------------------------------------------------------------
/docs/parsnip_files/intermediate_language/general/enums.json:
--------------------------------------------------------------------------------
 1 | [
 2 |     {
 3 |         "name": "MessageType",
 4 |         "reference": "",
 5 |         "notes": "",
 6 |         "scope": "",
 7 |         "size": 8,
 8 |         "fields": [
 9 |             {
10 |                 "name": "ServerMessage",
11 |                 "loggingValue": "Server Message",
12 |                 "value": 0,
13 |                 "notes": "Message to Server"
14 |             },
15 |             {
16 |                 "name": "ClientMessage",
17 |                 "loggingValue": "Client Message",
18 |                 "value": 1,
19 |                 "notes": "Message to Client"
20 |             }
21 |         ],
22 |         "referenceCount": 1
23 |     }
24 | ]


--------------------------------------------------------------------------------
/docs/parsnip_files/intermediate_language/general/objects.json:
--------------------------------------------------------------------------------
 1 | [
 2 |     {
 3 |         "name": "Message",
 4 |         "reference": "",
 5 |         "notes": "Top Level Element",
 6 |         "scope": "",
 7 |         "logIndependently": false,
 8 |         "logWithParent": false,
 9 |         "dependsOn": [],
10 |         "fields": [
11 |             {
12 |                 "name": "header",
13 |                 "description": "",
14 |                 "notes": "",
15 |                 "type": "object",
16 |                 "referenceType": "Header",
17 |                 "scope": "general"
18 |             },
19 |             {
20 |                 "name": "body",
21 |                 "description": "",
22 |                 "notes": "",
23 |                 "type": "object",
24 |                 "referenceType": "Body",
25 |                 "inputs": [
26 |                     {
27 |                         "source": "self.header.length"
28 |                     }
29 |                 ],
30 |                 "scope": "general"
31 |             }
32 |         ],
33 |         "referenceCount": 0
34 |     },
35 |     {
36 |         "name": "Header",
37 |         "reference": "",
38 |         "notes": "2 Byte Header",
39 |         "scope": "",
40 |         "logIndependently": false,
41 |         "logWithParent": true,
42 |         "dependsOn": [],
43 |         "fields": [
44 |             {
45 |                 "name": "headerBits",
46 |                 "description": "",
47 |                 "notes": "",
48 |                 "type": "bits",
49 |                 "referenceType": "HeaderBits",
50 |                 "scope": "general"
51 |             },
52 |             {
53 |                 "name": "length",
54 |                 "description": "",
55 |                 "notes": "",
56 |                 "type": "uint",
57 |                 "size": 8
58 |             }
59 |         ],
60 |         "referenceCount": 1
61 |     },
62 |     {
63 |         "name": "Body",
64 |         "reference": "",
65 |         "notes": "",
66 |         "scope": "",
67 |         "logIndependently": false,
68 |         "logWithParent": true,
69 |         "dependsOn": [
70 |             {
71 |                 "name": "length",
72 |                 "type": "uint",
73 |                 "size": 8
74 |             }
75 |         ],
76 |         "fields": [
77 |             {
78 |                 "name": "data",
79 |                 "description": "",
80 |                 "notes": "",
81 |                 "type": "list",
82 |                 "elementType": "uint",
83 |                 "until": {
84 |                     "conditionType": "COUNT",
85 |                     "indicator": "length"
86 |                 },
87 |                 "size": 8
88 |             }
89 |         ],
90 |         "referenceCount": 1
91 |     }
92 | ]


--------------------------------------------------------------------------------
/docs/parsnip_files/snapshot/MySimpleProtocol.json:
--------------------------------------------------------------------------------
  1 | {
  2 |     "version": "1.0",
  3 |     "Protocol": "MySimpleProtocol",
  4 |     "EntryPoint": "Message",
  5 |     "usesTCP": true,
  6 |     "usesUDP": false,
  7 |     "Ports": [
  8 |         {
  9 |             "protocol": "tcp",
 10 |             "port": 8888
 11 |         }
 12 |     ],
 13 |     "Structures": {
 14 |         "Objects": [
 15 |             {
 16 |                 "name": "Message",
 17 |                 "reference": "",
 18 |                 "notes": "Top Level Element",
 19 |                 "scope": "",
 20 |                 "logIndependently": false,
 21 |                 "logWithParent": true,
 22 |                 "dependsOn": [],
 23 |                 "fields": [
 24 |                     {
 25 |                         "name": "header",
 26 |                         "description": "",
 27 |                         "notes": "",
 28 |                         "type": "object",
 29 |                         "referenceType": "Header"
 30 |                     },
 31 |                     {
 32 |                         "name": "body",
 33 |                         "description": "",
 34 |                         "notes": "",
 35 |                         "type": "object",
 36 |                         "referenceType": "Body",
 37 |                         "inputs": [
 38 |                             {
 39 |                                 "source": "self.header.length"
 40 |                             }
 41 |                         ]
 42 |                     }
 43 |                 ]
 44 |             },
 45 |             {
 46 |                 "name": "Header",
 47 |                 "reference": "",
 48 |                 "notes": "2 Byte Header",
 49 |                 "scope": "",
 50 |                 "logIndependently": false,
 51 |                 "logWithParent": true,
 52 |                 "dependsOn": [],
 53 |                 "fields": [
 54 |                     {
 55 |                         "name": "headerBits",
 56 |                         "description": "",
 57 |                         "notes": "",
 58 |                         "type": "bits",
 59 |                         "referenceType": "HeaderBits"
 60 |                     },
 61 |                     {
 62 |                         "name": "length",
 63 |                         "description": "",
 64 |                         "notes": "",
 65 |                         "type": "uint",
 66 |                         "size": 8
 67 |                     }
 68 |                 ]
 69 |             },
 70 |             {
 71 |                 "name": "Body",
 72 |                 "reference": "",
 73 |                 "notes": "",
 74 |                 "scope": "",
 75 |                 "logIndependently": false,
 76 |                 "logWithParent": true,
 77 |                 "dependsOn": [
 78 |                     {
 79 |                         "name": "length",
 80 |                         "type": "uint",
 81 |                         "size": 8
 82 |                     }
 83 |                 ],
 84 |                 "fields": [
 85 |                     {
 86 |                         "name": "data",
 87 |                         "description": "",
 88 |                         "notes": "",
 89 |                         "type": "list",
 90 |                         "elementType": "uint",
 91 |                         "until": {
 92 |                             "conditionType": "COUNT",
 93 |                             "indicator": "length"
 94 |                         },
 95 |                         "size": 8
 96 |                     }
 97 |                 ]
 98 |             }
 99 |         ],
100 |         "Enums": [
101 |             {
102 |                 "name": "MessageType",
103 |                 "reference": "",
104 |                 "notes": "",
105 |                 "scope": "",
106 |                 "size": 8,
107 |                 "fields": [
108 |                     {
109 |                         "name": "ServerMessage",
110 |                         "loggingValue": "Server Message",
111 |                         "value": 0,
112 |                         "notes": "Message to Server"
113 |                     },
114 |                     {
115 |                         "name": "ClientMessage",
116 |                         "loggingValue": "Client Message",
117 |                         "value": 1,
118 |                         "notes": "Message to Client"
119 |                     }
120 |                 ]
121 |             }
122 |         ],
123 |         "Bitfields": [
124 |             {
125 |                 "name": "HeaderBits",
126 |                 "reference": "",
127 |                 "notes": "",
128 |                 "size": 8,
129 |                 "fields": [
130 |                     {
131 |                         "name": "version",
132 |                         "description": "Protocol Version",
133 |                         "notes": "",
134 |                         "type": "uint",
135 |                         "referenceType": null,
136 |                         "bits": "4..7"
137 |                     },
138 |                     {
139 |                         "name": "messageType",
140 |                         "description": "Message Type",
141 |                         "notes": "",
142 |                         "type": "enum",
143 |                         "referenceType": "MessageType",
144 |                         "bits": "0..3"
145 |                     }
146 |                 ]
147 |             }
148 |         ]
149 |     }
150 | }


--------------------------------------------------------------------------------
/docs/traces/MySimpleProtocol.pcapng:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/docs/traces/MySimpleProtocol.pcapng


--------------------------------------------------------------------------------
/frontend/Dockerfile:
--------------------------------------------------------------------------------
 1 | # Use an official Python runtime as a parent image
 2 | FROM python:3.9-slim-buster
 3 | 
 4 | # Set the working directory to /opt
 5 | WORKDIR /opt
 6 | 
 7 | # Copy the current directory contents into the container at /opt
 8 | ADD ./requirements.txt /opt/requirements.txt
 9 | 
10 | # Install any needed packages specified in requirements.txt
11 | RUN pip install --trusted-host pypi.python.org -r /opt/requirements.txt
12 | 
13 | # Make port 80 available to the world outside this container
14 | EXPOSE 80
15 | 
16 | # Run app.py when the container launches
17 | #CMD ["python", "app.py"]
18 | CMD ["/bin/bash"]
19 | 


--------------------------------------------------------------------------------
/frontend/README.md:
--------------------------------------------------------------------------------
  1 | # Running Parsnip
  2 | 
  3 | ## Assumptions
  4 | * Docker and Bash (/bin/bash) already installed
  5 | * Current directory of the terminal is the frontend directory of this repository
  6 | 
  7 | ## Steps (in the terminal)
  8 | 1. Run `./start_webServer.sh`
  9 | 2. In the docker container prompt that appears:
 10 |     1. `cd app`
 11 |     2. `python3 app.py`
 12 | 
 13 | 
 14 | # Folder and File Structure
 15 | 
 16 | ## Folder Structure
 17 |  * [&lt;root&gt;](#dir_root)
 18 |     - [app](#dir_app)
 19 |         * [flask_session](#dir_flask_session) \*
 20 |         * [parsnip](#dir_parsnip)
 21 |             - [errors](#dir_errors)
 22 |             - [main](#dir_main)
 23 |             - [web](#dir_web)
 24 |                 * [static](#dir_static)
 25 |                     - [css](#dir_css)
 26 |                         * [images](#dir_images)
 27 |                     - [js](#dir_js)
 28 |                 * [templates](#dir_templates)
 29 | 
 30 | \* denotes folders created by the server at runtime
 31 | 
 32 | ## File Information
 33 | 
 34 | ### <a name="dir_root"></a>&lt;root&gt;
 35 | * Dockerfile
 36 |     - Docker container configuration file
 37 | * README.md
 38 |     - This file.
 39 | * requirements.txt
 40 |     - Required python packages to be installed in the docker container
 41 | * removeSessions.sh
 42 |     - Removes stored flask sessions that might prevent the app from starting
 43 | * start_webServer.sh
 44 |     - Script to start the docker container
 45 | 
 46 | ### <a name="dir_app"></a>&lt;root&gt;/app
 47 | * app.py
 48 |     - Web Server initiation and program main function file
 49 | 
 50 | ### <a name="dir_flask_session"></a>&lt;root&gt;/app/flask_session
 51 | Website session data files are stored here at runtime.
 52 | 
 53 | ### <a name="dir_parsnip"></a>&lt;root&gt;/app/parsnip
 54 | * config.py
 55 |     - Class that contains configuration values
 56 | * \_\_init\_\_.py
 57 |     - Module initiation file
 58 |     - Contains function to create Flask App
 59 | 
 60 | ### <a name="dir_errors"></a>&lt;root&gt;/app/parsnip/errors
 61 | * handlers.py
 62 |     - Initializes HTTP Error (e.g., 403, 404, 500) handlers for the server
 63 | * \_\_init\_\_.py
 64 |     - Empty module initiation file
 65 | 
 66 | 
 67 | ### <a name="dir_main"></a>&lt;root&gt;/app/parsnip/main
 68 | * checkForMissingDependencies.py
 69 |     - Functions to help check for missing dependencies in the snapshot
 70 | * convert.py
 71 |     - Functions to help convert from snapshot to the Parsnip Intermediate Langugage Files
 72 | * forms.py
 73 |     - Form and validation classes used for website forms
 74 | * \_\_init\_\_.py
 75 |     - Empty module initiation file
 76 | * routes.py
 77 |     - Website request processing and routing rules
 78 |     - Utility functions to use within jinja2 web templates
 79 | * utils.py
 80 |     - Utility functions
 81 | 
 82 | ### <a name="dir_web"></a>&lt;root&gt;/app/parsnip/web
 83 | Other website resouces (i.e., static and page templates).
 84 | 
 85 | ### <a name="dir_static"></a>&lt;root&gt;/app/parsnip/web/static
 86 | Static websites resources.
 87 | 
 88 | ### <a name="dir_css"></a>&lt;root&gt;/app/parsnip/web/static/css
 89 | Static CSS files.
 90 | 
 91 | ### <a name="dir_images"></a>&lt;root&gt;/app/parsnip/web/static/css/images
 92 | Static image files for CSS resources.
 93 | 
 94 | ### <a name="dir_js"></a>&lt;root&gt;/app/parsnip/web/static/js
 95 | Static Javascript files.
 96 | 
 97 | ### <a name="dir_templates"></a>&lt;root&gt;/app/parsnip/web/templates
 98 | * bitfields.html
 99 |     - Page template to view and edit bitfields.
100 | * config.html
101 |     - Page template to view and edit overall parser configuration.
102 | * enums.html
103 |     - Page template to view and edit enums.
104 | * error.html
105 |     - Server HTTP Error page.
106 | * fields.html
107 |     - Page template to view and edit object fields.
108 | * index.html
109 |     - Home page.
110 |     - Displays basic instructions.
111 | * layout.base
112 |     - Base template that is used by other templates (provides overall page structure)
113 | * macros.j2
114 |     - jinja2 macros that can be used by multiple pages
115 | * objects.html
116 |     - Page template to view and edit objects.
117 | * review.html
118 |     - Page template to view errors encountered while reviewing snapshots for issues.
119 | * switches.html
120 |     - Page template to view and edit switches (i.e., choices).


--------------------------------------------------------------------------------
/frontend/app/app.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | from parsnip import create_app
 4 | from parsnip.config import Config
 5 | 
 6 | from flask_session import Session
 7 | 
 8 | app = create_app(Config)
 9 | Session(app)
10 | 
11 | if '__main__' == __name__:
12 |     app.run(debug=True, host='0.0.0.0')
13 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/__init__.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | from flask import Flask
 4 | 
 5 | def create_app(config_class):
 6 |     app = Flask(__name__,
 7 |                 static_url_path=config_class.STATIC_URL_PATH,
 8 |                 static_folder=config_class.STATIC_FOLDER,
 9 |                 template_folder=config_class.TEMPLATE_FOLDER)
10 |     # Set the rest of the configuration information
11 |     app.config.from_object(config_class)
12 | 
13 |     from parsnip.main.routes import main
14 |     from parsnip.errors.handlers import errors
15 | 
16 |     app.register_blueprint(main)
17 |     app.register_blueprint(errors)
18 | 
19 |     return app
20 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/config.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 2 | 
 3 | import os
 4 | import secrets
 5 | 
 6 | class Config:
 7 |     SECRET_KEY = os.environ.get("SECRET_KEY", secrets.token_hex(16))
 8 |     STATIC_FOLDER = 'web/static'
 9 |     STATIC_URL_PATH = ''
10 |     TEMPLATE_FOLDER = 'web/templates'
11 |     FLASK_DEBUG = True
12 |     SESSION_PERMANENT = False
13 |     SESSION_TYPE = "filesystem"
14 |     SESSION_COOKIE_SAMESITE = "None"
15 |     SESSION_COOKIE_SECURE = True
16 |     SESSION_COOKIE_HTTPONLY = False
17 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/errors/__init__.py:
--------------------------------------------------------------------------------
1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
2 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/errors/handlers.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2024, Battelle Energy Alliance, LLC All Rights Reserved
 2 | 
 3 | from flask import Blueprint, render_template
 4 | 
 5 | from parsnip.main.forms import UploadSnapshotForm
 6 | 
 7 | errors = Blueprint('errors', __name__)
 8 | 
 9 | @errors.app_errorhandler(403)
10 | @errors.app_errorhandler(404)
11 | @errors.app_errorhandler(500)
12 | def errorHandler(error):
13 |     uploadSnapshotForm = UploadSnapshotForm()
14 |     # error.get_response provides header information
15 |     # error.code is the error code (e.g., 404)
16 |     # error.name is the error name (e.g., "Not Found")
17 |     # error.description is the error description
18 |     return render_template('error.html', error=error, uploadSnapshotForm=uploadSnapshotForm), error.code
19 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/main/__init__.py:
--------------------------------------------------------------------------------
1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
2 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/main/checkForDuplicates.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python3
  2 | 
  3 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  4 | 
  5 | import argparse
  6 | import os
  7 | import sys
  8 | import json
  9 | 
 10 | 
 11 | #Todo - make sure bits aren't being used twice in same bitfield.
 12 | def _processBitfields(snapshot, returnList):
 13 |     bitfields = snapshot.get("Structures").get("Bitfields")
 14 |     itemNames = set()
 15 |     if bitfields:
 16 |         for bitfield in bitfields:
 17 |             itemName = bitfield.get("name")
 18 |             if itemName in itemNames:
 19 |                 returnList.append({"type": "Error",
 20 |                     "title": "Duplicate Bitfield",
 21 |                     "content": "Duplicate Bitfield with name {0}".format(itemName)})
 22 |             else:
 23 |                 fieldNames = set()
 24 |                 itemNames.add(itemName)
 25 |                 fields = bitfield.get("fields")
 26 |                 if fields:
 27 |                     for field in fields:
 28 |                         fieldName = field.get("name")
 29 |                         if fieldName in fieldNames:
 30 |                             returnList.append({"type": "Error",
 31 |                                 "title": "Duplicate Field",
 32 |                                 "content": "Duplicate field \"{0}\" in Bitfields.{1}".format(fieldName, itemName)})
 33 |                         else:
 34 |                             fieldNames.add(fieldName)
 35 |                 else:
 36 |                     returnList.append({"type": "Warning",
 37 |                         "title": "Empty Bitfield",
 38 |                         "content": "No fields in Bitfield.{0}".format(itemName)})
 39 |     else:
 40 |         returnList.append({"type": "Warning",
 41 |             "title": "Empty Structure",
 42 |             "content": "No Items of Type: Bitfield"})
 43 | 
 44 | def _processEnums(snapshot, returnList):
 45 |     enums = snapshot.get("Structures").get("Enums")
 46 |     itemNames = set()
 47 |     if enums:
 48 |         for enum in enums:
 49 |             itemName = enum.get("name")
 50 |             if itemName in itemNames:
 51 |                 returnList.append({"type": "Error",
 52 |                     "title": "Duplicate Enum",
 53 |                     "content": "Duplicate Enum with name {0}".format(itemName)})
 54 |             else:
 55 |                 fieldNames = set()
 56 |                 fieldValues = set()
 57 |                 itemNames.add(itemName)
 58 |                 fields = enum.get("fields")
 59 |                 if fields:
 60 |                     for field in fields:
 61 |                         fieldName = field.get("name")
 62 |                         fieldValue = field.get("value")
 63 |                         if fieldName in fieldNames:
 64 |                             returnList.append({"type": "Warning",
 65 |                                 "title": "Duplicate Field",
 66 |                                 "content": "Duplicate field \"{0}\" in Enums.{1}".format(fieldName, itemName)})
 67 |                         else:
 68 |                             fieldNames.add(fieldName)
 69 |                         if fieldValue in fieldValues:
 70 |                             returnList.append({"type": "Error",
 71 |                                 "title": "Duplicate Value",
 72 |                                 "content": "Duplicate Value \"{0}\" in Enums.{1}".format(fieldValue, itemName)})
 73 |                         else:
 74 |                             fieldValues.add(fieldValue)
 75 |                 else:
 76 |                     returnList.append({"type": "Warning",
 77 |                         "title": "Empty Enum",
 78 |                         "content": "No fields in Enums.{0}".format(itemName)})
 79 |     else:
 80 |         returnList.append({"type": "Warning",
 81 |             "title": "Empty Structure",
 82 |             "content": "No Items of Type: Enum"})
 83 | 
 84 | def _processSwitches(snapshot, returnList):
 85 |     switches = snapshot.get("Structures").get("Switches")
 86 |     itemNames = set()
 87 |     if switches:
 88 |         for switch in switches:
 89 |             itemName = switch.get("name")
 90 |             if itemName in itemNames:
 91 |                 returnList.append({"type": "Error",
 92 |                     "title": "Duplicate Switch",
 93 |                     "content": "Duplicate Switch with name {0}".format(itemName)})
 94 |             else:
 95 |                 fieldValues = set()
 96 |                 itemNames.add(itemName)
 97 |                 fields = switch.get("options")
 98 |                 if fields:
 99 |                     for field in fields:
100 |                         fieldValue = field.get("value")
101 |                         if fieldValue in fieldValues:
102 |                             returnList.append({"type": "Error",
103 |                                 "title": "Duplicate Value",
104 |                                 "content": "Duplicate Value \"{0}\" in Switches.{1}".format(fieldValue, itemName)})
105 |                         else:
106 |                             fieldValues.add(fieldValue)
107 |                 else:
108 |                     returnList.append({"type": "Warning",
109 |                         "title": "Empty Switch",
110 |                         "content": "No options in Switches.{0}".format(itemName)})
111 |     else:
112 |         returnList.append({"type": "Warning",
113 |             "title": "Empty Structure",
114 |             "content": "No Items of Type: Switch"})
115 | 
116 | def _processObjects(snapshot, returnList):
117 |     objects = snapshot.get("Structures").get("Objects")
118 |     itemNames = set()
119 |     if objects:
120 |         for obj in objects:
121 |             itemName = obj.get("name")
122 |             if itemName in itemNames:
123 |                 returnList.append({"type": "Error",
124 |                     "title": "Duplicate Object",
125 |                     "content": "Duplicate Object with name {0}".format(itemName)})
126 |             else:
127 |                 fieldNames = set()
128 |                 itemNames.add(itemName)
129 |                 fields = obj.get("fields")
130 |                 if fields:
131 |                     for field in fields:
132 |                         fieldName = field.get("name")
133 |                         if fieldName in fieldNames:
134 |                             returnList.append({"type": "Error",
135 |                                 "title": "Duplicate Field",
136 |                                 "content": "Duplicate field \"{0}\" in Objects.{1}".format(fieldName, itemName)})
137 |                         else:
138 |                             fieldNames.add(fieldName)
139 |                 else:
140 |                     returnList.append({"type": "Warning",
141 |                         "title": "Empty Object",
142 |                         "content": "No fields in Objects.{0}".format(itemName)})
143 |     else:
144 |         returnList.append({"type": "Warning",
145 |             "title": "Empty Structure",
146 |             "content": "No Items of Type: Objects"})
147 | 
148 | 
149 | def checkForDuplicates(snapshot, returnList):
150 |     snapshot = json.loads(snapshot)
151 |     _processBitfields(snapshot,returnList)
152 |     _processEnums(snapshot, returnList)
153 |     _processSwitches(snapshot, returnList)
154 |     _processObjects(snapshot, returnList)
155 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/main/checkForMissingDependencies.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python3
  2 | 
  3 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  4 | 
  5 | import os
  6 | import sys
  7 | import json
  8 | 
  9 | #spicyTypes = ["addr", "bitfield", "uint8", "uint16", "uint32", "uint64", "int8",
 10 | #              "int16", "int32", "int64", "bool", "bytes", "real"]
 11 | 
 12 | languageTypes = [
 13 |     ("addr", [32, 128]), # Passthrough Spicy Type
 14 |     ("uint", [8, 16, 24, 32, 64]), # Spicy built in for sizes 8, 16, 32, and 64; 24 we added
 15 |     ("int", [8, 16, 24, 32, 64]), # Spicy built in for sizes 8, 16, 32, and 64; 24 we added
 16 |     ("void", None), # Spicy type used to denote no fields
 17 |     ("bytes", None), # Passthrough Spicy Type, size will be converted to bytes from bits
 18 |     ("float", [32, 64]) # Maps to spicy "real" type with either float or double flag
 19 | ]
 20 | 
 21 | bitfieldSpecificTypes = ["bool", "uint", "enum"]
 22 | 
 23 | structureTypes = {
 24 |     "bits": "Bitfields", # Maps to bitfield structures
 25 |     "enum": "Enums", # Maps to enum structures
 26 |     "object": "Objects", # Maps to object structures
 27 |     "switch": "Switches" # Maps to switches structures
 28 | }
 29 | 
 30 | otherReferenceTypes = {
 31 |     "list" # A list of other types
 32 | }
 33 | 
 34 | DEFAULT_SCOPE = "general"
 35 | 
 36 | userDefinedTypes = []
 37 | 
 38 | ################################################################################
 39 | # Function Declarations
 40 | ################################################################################
 41 | def determineScope(item):
 42 |     if "scope" in item:
 43 |         return item.get("scope")
 44 |     else:
 45 |         return DEFAULT_SCOPE
 46 | 
 47 | def addObjectToScope(item, objectType, structuresToScope):
 48 |     name = item.get("name")
 49 |     scope = determineScope(item)
 50 | 
 51 |     if objectType not in structuresToScope:
 52 |         structuresToScope[objectType] = {}
 53 |     if name not in structuresToScope[objectType]:
 54 |         structuresToScope[objectType][name] = []
 55 |     structuresToScope[objectType][name].append(scope)
 56 |         
 57 |     return (scope, name)
 58 |     
 59 | def _addVerifiedDependency(parentInfo, itemInfo, dependencyInfo):
 60 |     if parentInfo[0] not in dependencyInfo:
 61 |         dependencyInfo[parentInfo[0]] = {}
 62 |     if parentInfo[1] not in dependencyInfo[parentInfo[0]]:
 63 |         dependencyInfo[parentInfo[0]][parentInfo[1]] = {}
 64 |     if parentInfo[2] not in dependencyInfo[parentInfo[0]][parentInfo[1]]:
 65 |         dependencyInfo[parentInfo[0]][parentInfo[1]][parentInfo[2]] = []
 66 |     dependencyInfo[parentInfo[0]][parentInfo[1]][parentInfo[2]].append(itemInfo)
 67 |     
 68 | def addDependencyToStructure(parentType, parentScope, parentName, dependentItem, dependencyInfo, returnValue):
 69 |     name = dependentItem.get("referenceType")
 70 |     itemName = dependentItem.get("name")
 71 |     itemType = dependentItem.get("type")
 72 |     size = dependentItem.get("size")
 73 |     
 74 |     typeIndex = next((index for index, value in enumerate(languageTypes) if value[0] == itemType), -1)
 75 |     
 76 |     if "bits" == parentType:
 77 |         if itemType not in bitfieldSpecificTypes:
 78 |             returnValue.append({"type": "Error",
 79 |                 "title": "Unknown Bitfield Item Type",
 80 |                 "content": "Unknown bitfield item type '{0}' in item '{1}.{2}.{3}'".format(itemType, parentType, parentScope, parentName)})
 81 |         elif "enum" == itemType:
 82 |             # Add the dependency
 83 |             _addVerifiedDependency((parentType, parentScope, parentName), (itemType, name), dependencyInfo)
 84 |     elif typeIndex != -1:
 85 |         # This is a known type
 86 |         if languageTypes[typeIndex][1] is None or \
 87 |            size in languageTypes[typeIndex][1]:
 88 |             # No size is expected or the size matches an expected size
 89 |             # Good to go
 90 |             return
 91 |         else:
 92 |             # Size is expected, but the one provided doesn't match
 93 |             returnValue.append({"type": "Error",
 94 |                 "title": "Unknown Size for Language Type",
 95 |                 "content": "Unknown Size '{0}' for language type '{1}' in item '{2}.{3}.{4}'".format(size, itemType, parentType, parentScope, parentName)})
 96 |     elif itemType in userDefinedTypes:
 97 |         # User defined type, good to go
 98 |         return
 99 |     elif itemType in structureTypes:
100 |         # Add the dependency
101 |         _addVerifiedDependency((parentType, parentScope, parentName), (itemType, name), dependencyInfo)
102 |     elif itemType in otherReferenceTypes:
103 |         itemType = dependentItem.get("elementType")
104 |         _addVerifiedDependency((parentType, parentScope, parentName), (itemType, name), dependencyInfo)
105 |     else:
106 |         # Unknown type
107 |         returnValue.append({"type": "Error",
108 |             "title": "Unknown Object Type",
109 |             "content": "Unknown object type '{0}' in '{1}' part of item '{2}.{3}.{4}'".format(itemType, itemName, parentType, parentScope, parentName)})
110 | 
111 | 
112 | def checkForMissingDependencies(snapshot, returnValue):
113 | 
114 |     ################################################################################
115 |     # Load the content
116 |     ################################################################################
117 |     contents = json.loads(snapshot)
118 |         
119 |     ################################################################################
120 |     # Load information about the custom types the user has defined
121 |     ################################################################################    
122 |     userTypes = contents.get("CustomFieldTypes")
123 | 
124 |     if userTypes is not None:
125 |         for userType in userTypes:
126 |             userDefinedTypes.append(userType.get("name"))
127 | 
128 |     ################################################################################
129 |     # Tracking Structures
130 |     ################################################################################
131 |     # Assumption, no duplicates
132 |     structuresToScopes = {} # Type -> ObjectName -> Scopes[]
133 |     structureDependencies = {} # Type -> Scope -> ObjectName -> Dependencies[]
134 | 
135 |     ################################################################################
136 |     # Load information about the structures present
137 |     ################################################################################
138 |     structures = contents.get("Structures")
139 | 
140 |     #############################################
141 |     # Process the Objects
142 |     #############################################
143 |     objects = structures.get("Objects")
144 |     if objects:
145 |         for currentObject in objects:
146 |             # Add item to scope and add the scope to the set of scopes
147 |             itemScope, itemName = addObjectToScope(currentObject, "object", structuresToScopes)
148 |             # Look for references in the dependsOn section
149 |             if "dependsOn" in currentObject:
150 |                 for dependency in currentObject.get("dependsOn"):
151 |                     addDependencyToStructure("object", itemScope, itemName, dependency, structureDependencies, returnValue)
152 |             # Look for references in the fields
153 |             for field in currentObject.get("fields"):
154 |                 addDependencyToStructure("object", itemScope, itemName, field, structureDependencies, returnValue)
155 | 
156 |     #############################################
157 |     # Process the Bitfields
158 |     #############################################
159 |     bitfields = structures.get("Bitfields")
160 | 
161 |     if bitfields:
162 |         for bitfield in bitfields:
163 |             itemScope, itemName = addObjectToScope(bitfield, "bits", structuresToScopes)
164 |             # Look for references in the fields
165 |             for field in bitfield.get("fields"):
166 |                 addDependencyToStructure("bits", itemScope, itemName, field, structureDependencies, returnValue)
167 | 
168 |     #############################################
169 |     # Process the Enums
170 |     #############################################
171 |     enums = structures.get("Enums")
172 | 
173 |     if enums:
174 |         for enum in enums:
175 |             itemScope, itemName = addObjectToScope(enum, "enum", structuresToScopes)
176 |             # Enum fields don't reference any types
177 | 
178 |     #############################################
179 |     # Process the Switches
180 |     #############################################
181 |     switches = structures.get("Switches")
182 | 
183 |     if switches:
184 |         for currentSwitch in switches:
185 |             itemScope, itemName = addObjectToScope(currentSwitch, "switch", structuresToScopes)
186 |             # Look for references in the dependsOn section
187 |             dependsOnSection = currentSwitch.get("dependsOn")
188 |             addDependencyToStructure("switch", itemScope, itemName, dependsOnSection, structureDependencies, returnValue)
189 |             # Look for references in the additionalDependsOn section
190 |             if "additionalDependsOn" in currentSwitch:
191 |                 for dependency in currentSwitch.get("additionalDependsOn"):
192 |                     addDependencyToStructure("switch", itemScope, itemName, dependency, structureDependencies, returnValue)
193 |             # Look for references in the options section
194 |             for option in currentSwitch.get("options"):
195 |                 actionSection = option.get("action")
196 |                 addDependencyToStructure("switch", itemScope, itemName, actionSection, structureDependencies, returnValue)
197 |             
198 |     ################################################################################
199 |     # Check the dependencies
200 |     ################################################################################
201 |     for structure in structureDependencies:
202 |         for scope in structureDependencies[structure]:
203 |             for objectName in structureDependencies[structure][scope]:
204 |                 for dependency in structureDependencies[structure][scope][objectName]:
205 |                     dependencyType = dependency[0]
206 |                     dependencyName = dependency[1]
207 |                     
208 |                     # See if we know about the dependency
209 |                     # structuresToScopes: Type -> ObjectName -> Scopes[]
210 |                     if dependencyType in structuresToScopes and \
211 |                     dependencyName in structuresToScopes[dependencyType]:
212 |                         # We know about it
213 |                         # See if there is any confusion about it
214 |                         scopes = structuresToScopes[dependencyType][dependencyName]
215 |                         if 1 != len(scopes):
216 |                             # Confusion about scope
217 |                             returnValue.append({"type": "Error",
218 |                                 "title": "Scope Confusion",
219 |                                 "content": "Dependency {0}.{1} for Item {2}.{3}.{4} exists in multiple scopes: {5}".format(dependencyType, dependencyName, structure, scope, objectName, "'" + ("', ".join(scopes)) + "'")})
220 |                     else:
221 |                         # No idea...
222 |                         returnValue.append({"type": "Error",
223 |                             "title": "No Dependency",
224 |                             "content": "Dependency {0}.{1} does not exist for Item {2}.{3}.{4}".format(dependencyType, dependencyName, structure, scope, objectName)})
225 | 
226 |     #print(languageTypes)
227 |     #print(bitfieldSpecificTypes)
228 |     #print(structureTypes)
229 |     #print(userDefinedTypes)
230 |     #print()
231 |     #print(structuresToScopes)
232 |     #print()
233 |     #print(structureDependencies)
234 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/main/forms.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  2 | 
  3 | from flask_wtf import FlaskForm
  4 | from wtforms import (Form, FormField, StringField, IntegerField, BooleanField,
  5 |                      FieldList, HiddenField, SelectField)
  6 | from flask_wtf.file import FileField, FileAllowed, FileRequired
  7 | from wtforms.validators import InputRequired, Regexp, NumberRange, Optional
  8 | 
  9 | ################################################################################
 10 | # Conditional Test Classes
 11 | ################################################################################
 12 | class RequiredIfReferenceType(InputRequired):
 13 |     field_flags = {'requiredif': True}
 14 |     
 15 |     def __init__(self, conditionalFieldName, message=None, *args, **kwargs):
 16 |         self.conditionalFieldName = conditionalFieldName
 17 |         self.message = message
 18 | 
 19 |     def __call__(self, form, field):
 20 |         checkField = form[self.conditionalFieldName]
 21 |         if checkField is None:
 22 |             raise Exception('no field named "%s" in form' % self.conditionalFieldName)
 23 |         if checkField.data in ["object", "enum", "bits", "switch"]:
 24 |             super(RequiredIfReferenceType, self).__call__(form, field)
 25 | 
 26 | class RequiredIfSizedElement(InputRequired):
 27 |     field_flags = {'requiredif': True}
 28 |     
 29 |     def __init__(self, conditionalFieldName, message=None, *args, **kwargs):
 30 |         self.conditionalFieldName = conditionalFieldName
 31 |         self.message = message
 32 | 
 33 |     def __call__(self, form, field):
 34 |         checkField = form[self.conditionalFieldName]
 35 |         if checkField is None:
 36 |             raise Exception('no field named "%s" in form' % self.conditionalFieldName)
 37 |         if checkField.data in ["uint", "int", "real"]:
 38 |             super(RequiredIfSizedElement, self).__call__(form, field)
 39 |             
 40 | class RequiredIfSizedElement2(InputRequired):
 41 |     field_flags = {'requiredif': True}
 42 |     
 43 |     def __init__(self, conditionalFieldName1, conditionalFieldName2, message=None, *args, **kwargs):
 44 |         self.conditionalFieldName1 = conditionalFieldName1
 45 |         self.conditionalFieldName2 = conditionalFieldName2
 46 |         self.message = message
 47 | 
 48 |     def __call__(self, form, field):
 49 |         checkField1 = form[self.conditionalFieldName1]
 50 |         checkField2 = form[self.conditionalFieldName2]
 51 |         if checkField1 is None:
 52 |             raise Exception('no field named "%s" in form' % self.conditionalFieldName1)
 53 |         if checkField2 is None:
 54 |             raise Exception('no field named "%s" in form' % self.conditionalFieldName2)
 55 |         if checkField1.data in ["uint", "int", "real"] or checkField2.data in ["uint", "int", "real"]:
 56 |             super(RequiredIfSizedElement2, self).__call__(form, field)
 57 |             
 58 | class RequiredIfBitfieldFieldTypeForBit(InputRequired):
 59 |     field_flags = {'requiredif': True}
 60 | 
 61 |     def __init__(self, conditionalFieldName, message=None, *args, **kwargs):
 62 |         self.conditionalFieldName = conditionalFieldName
 63 |         self.message = message
 64 | 
 65 |     def __call__(self, form, field):
 66 |         checkField = form[self.conditionalFieldName]
 67 |         if checkField is None:
 68 |             raise Exception('no field named "%s" in form' % self.conditionalFieldName)
 69 |         if "bool" == checkField.data:
 70 |             super(RequiredIfBitfieldFieldTypeForBit, self).__call__(form, field)
 71 |             
 72 | class RequiredIfBitfieldFieldTypeForBits(InputRequired):
 73 |     field_flags = {'requiredif': True}
 74 | 
 75 |     def __init__(self, conditionalFieldName, message=None, *args, **kwargs):
 76 |         self.conditionalFieldName = conditionalFieldName
 77 |         self.message = message
 78 | 
 79 |     def __call__(self, form, field):
 80 |         checkField = form[self.conditionalFieldName]
 81 |         if checkField is None:
 82 |             raise Exception('no field named "%s" in form' % self.conditionalFieldName)
 83 |         if checkField.data in ["enum", "uint"]:
 84 |             super(RequiredIfBitfieldFieldTypeForBits, self).__call__(form, field)
 85 |             
 86 | class RequiredIfBitfieldFieldTypeForReference(InputRequired):
 87 |     field_flags = {'requiredif': True}
 88 | 
 89 |     def __init__(self, conditionalFieldName, message=None, *args, **kwargs):
 90 |         self.conditionalFieldName = conditionalFieldName
 91 |         self.message = message
 92 | 
 93 |     def __call__(self, form, field):
 94 |         checkField = form[self.conditionalFieldName]
 95 |         if checkField is None:
 96 |             raise Exception('no field named "%s" in form' % self.conditionalFieldName)
 97 |         if "enum" == checkField.data:
 98 |             super(RequiredIfBitfieldFieldTypeForReference, self).__call__(form, field)
 99 |             
100 | ################################################################################
101 | # Sub-forms
102 | ################################################################################
103 | class AddEnumFieldForm(Form):
104 |     fieldName = StringField('Field Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
105 |     loggingValue = StringField('Value to Appear in the Log: ', validators=[InputRequired()])
106 |     fieldValue = IntegerField('Field Value: ', validators=[InputRequired()])
107 |     fieldNote = StringField('Field Note: ')
108 |     
109 | class AddBitfieldFieldForm(Form):
110 |     fieldName = StringField('Field Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
111 |     fieldDescription = StringField('Field Description: ', validators=[InputRequired()])
112 |     fieldNote = StringField('Field Note: ')
113 |     fieldType = SelectField('Field Type: ', choices=[('', '---')], validate_choice=False)
114 |     bit = IntegerField('Bit: ', validators=[RequiredIfBitfieldFieldTypeForBit("fieldType")])
115 |     startingBit = IntegerField('Starting Bit: ', validators=[RequiredIfBitfieldFieldTypeForBits("fieldType")])
116 |     endingBit = IntegerField('Ending Bit: ', validators=[RequiredIfBitfieldFieldTypeForBits("fieldType")])
117 |     referenceType = SelectField("Reference Type: ", validators=[RequiredIfBitfieldFieldTypeForReference("fieldType")], choices=[('', '---')], validate_choice=False)
118 |     
119 | class DependencyForm(Form):
120 |     dependencyName = StringField('Dependency Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
121 |     dependencyType = SelectField('Dependency Type: ', choices=[('', '---')], validate_choice=False)
122 |     fieldSize = IntegerField('Field Size (Bits): ', validators=[RequiredIfSizedElement("dependencyType"), NumberRange(0)], default=8);
123 |     referenceType = SelectField('Reference Type: ', choices=[('', '---')], validate_choice=False)
124 |     
125 | class OptionForm(Form):
126 |     optionValueSelection = StringField('Value: ', validators=[InputRequired()], render_kw={'readonly': True})
127 |     optionActionName = StringField('Action Name: ', validators=[InputRequired()])
128 |     optionActionType = SelectField('Action Type: ', choices=[('', '---')], validate_choice=False)
129 |     optionActionSize = IntegerField('Field Size (Bits): ', validators=[RequiredIfSizedElement("optionActionType"), NumberRange(0)], default=8);
130 |     referenceType = SelectField('Reference Type: ', choices=[('', '---')], validate_choice=False)
131 |     inputs = FieldList(SelectField('Input Value: ', choices=[('', '---')], validate_choice=False), min_entries=0, max_entries=65535)
132 | 
133 | ################################################################################
134 | # Forms
135 | ################################################################################
136 | class EditConfigForm(FlaskForm):
137 |     parserName = StringField('Parser Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
138 |     entryPoint = SelectField('Parser Entry Point Structure: ', choices=[("", "---")], validate_choice=False)
139 |     usesTCP = BooleanField('Uses TCP Protocol? ')
140 |     usesUDP = BooleanField('Uses UDP Protocol? ')
141 |     
142 | class AddPortForm(FlaskForm):
143 |     protocolName = SelectField('Parent Protocol Name: ', choices=[('tcp', 'TCP'), ('udp', 'UDP')])
144 |     portNumber = IntegerField('Port Number: ', validators=[InputRequired(), NumberRange(1)])
145 |     
146 | class AddUserTypeForm(FlaskForm):
147 |     typeName = StringField('Type Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9\-]*$')])
148 |     interpretingFunction = StringField('Interpreting Function: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
149 |     returnType = SelectField('Function Return Type: ', choices=[('string', 'string')])
150 |     
151 | class UploadSnapshotForm(FlaskForm):
152 |     snapshot = FileField('Upload Snapshot', validators=[FileRequired(), FileAllowed(['json'])])
153 |     
154 | class AddEnumForm(FlaskForm):
155 |     enumName = StringField('Enum Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
156 |     enumReference = StringField('Enum Reference: ')
157 |     enumNote = StringField('Enum Note: ')
158 |     enumScope = StringField('Enum Scope: ')
159 |     enumSize = IntegerField('Field Size (Bits): ', validators=[InputRequired(), NumberRange(0)], default=8);
160 |     fields = FieldList(FormField(AddEnumFieldForm), min_entries=1, max_entries=65535)
161 |     
162 | class AddBitfieldForm(FlaskForm):
163 |     bitfieldName = StringField('Bitfield Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
164 |     bitfieldReference = StringField('Bitfield Reference: ')
165 |     bitfieldNote = StringField('Bitfield Note: ')
166 |     bitfieldSize = IntegerField('Bitfield Read Size (Bits): ', validators=[InputRequired(), NumberRange(0)], default=8);
167 |     fields = FieldList(FormField(AddBitfieldFieldForm), min_entries=1, max_entries=65535)
168 |     
169 | class AddSwitchForm(FlaskForm):
170 |     switchName = StringField('Switch Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
171 |     switchMainDependency = FormField(DependencyForm)
172 |     switchAdditionalDependencies = FieldList(FormField(DependencyForm), min_entries=0, max_entries=65535)
173 |     switchOptions = FieldList(FormField(OptionForm), min_entries=0, max_entries=65535)
174 |     
175 | class AddObjectForm(FlaskForm):
176 |     objectName = StringField('Object Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
177 |     objectReference = StringField('Object Reference: ')
178 |     objectNote = StringField('Object Note: ')
179 |     objectScope = StringField('Object Scope: ', validators=[Regexp(r'^$|[a-zA-Z_][a-zA-Z_0-9]*$')])
180 |     logIndependently = BooleanField('Should Log Independently? ')
181 |     objectDependencies = FieldList(FormField(DependencyForm), min_entries=0, max_entries=65535)
182 |     
183 | class AddFieldForm(FlaskForm):
184 |     ###################################################
185 |     # General Fields
186 |     ###################################################
187 |     fieldName = StringField('Field Name: ', validators=[InputRequired(), Regexp(r'^[a-zA-Z_][a-zA-Z_0-9]*$')])
188 |     fieldDescription = StringField('Field Reference: ')
189 |     fieldNote = StringField('Field Note: ')
190 |     isConditional = BooleanField('Is Field Conditional? ', default=False)
191 |     conditionalIndicator = SelectField('Indicator: ', choices=[('', '---')], validate_choice=False)
192 |     conditionalOperator = SelectField('Operator: ', choices=[('=', '='), ('!=', '!='), ('>=', '>='), ('<=', '<='), ('<', '<'), ('>', '>')])
193 |     useConditionalTextValue = HiddenField('Use Conditional Text Value', default=False)
194 |     useConditionalNumberValue = HiddenField('Use Conditional Number Value', default=False)
195 |     conditionalValue = SelectField('Comparison Value: ', choices=[('', '---')], validate_choice=False)
196 |     conditionalTextValue = StringField('Comparison Value: ')
197 |     conditionalNumberValue = IntegerField('Comparison Value: ', default=0)
198 |     fieldType = SelectField('Field Type: ', choices=[('', '---')], validate_choice=False)
199 |     ###################################################
200 |     # Non-reference-type-specific fields
201 |     ###################################################
202 |     fieldSize = IntegerField('Field Size (Bits): ', validators=[RequiredIfSizedElement2("fieldType", "elementType"), NumberRange(0)], default=8);
203 |     ###################################################
204 |     # List-specific fields
205 |     ###################################################
206 |     elementType = SelectField('List Element Type: ', choices=[('', '---')], validate_choice=False)
207 |     untilConditionType = SelectField('List Condition Type: ', choices=[('COUNT', 'Count Field'), ('ENDOFDATA', 'Remaining Data')], validators=[Optional()])
208 |     untilConditionIndicator = SelectField('Indicator Field: ', choices=[('', '---')], validate_choice=False)
209 |     ###################################################
210 |     # List- and reference-type-specific fields
211 |     ###################################################
212 |     referenceType = SelectField('Reference Type: ', choices=[('', '---')], validate_choice=False)
213 |     # Can be used for "input", "additionalInputs", and "inputs" IL types
214 |     inputs = FieldList(SelectField('Input Value: ', choices=[('', '---')], validate_choice=False), min_entries=0, max_entries=65535)
215 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/main/routes.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
  2 | 
  3 | from parsnip.main.forms import (AddEnumForm, AddBitfieldForm, AddSwitchForm,
  4 |                                 AddObjectForm, AddFieldForm,
  5 |                                 UploadSnapshotForm,
  6 |                                 EditConfigForm, AddUserTypeForm, AddPortForm)
  7 | from parsnip.main.utils import (addEnumToStructure, removeEnumFromStructure,
  8 |                                 addBitfieldToStructure,
  9 |                                 removeBitfieldFromStructure,
 10 |                                 getSnapshot, setSnapshot,
 11 |                                 reviewStructure,
 12 |                                 updateConfig,
 13 |                                 addUserTypeToSession, removeUserTypeFromSession,
 14 |                                 addObjectToStructure, removeObjectFromStructure,
 15 |                                 addFieldToObject, removeFieldFromObject,
 16 |                                 addPortToSession, removePortFromSession,
 17 |                                 addSwitchToStructure, removeSwitchFromStructure,
 18 |                                 getReferenceSelectorTypes,
 19 |                                 getAllReferenceSelectorTypes,
 20 |                                 getBitfieldTypeSelectorTypes,
 21 |                                 getAllDependencySelectorTypes,
 22 |                                 getDependencyStructureTypes,
 23 |                                 getActionTypeSelectorTypes,
 24 |                                 getAllFieldTypeSelectorTypes,
 25 |                                 getObjectInputs,
 26 |                                 getStructuresOfAType,
 27 |                                 getStructuresOfATypeAsDictionary,
 28 |                                 getStructureNamesOfAType)
 29 | 
 30 | from parsnip.main.convert import (getParsnipFile)
 31 | 
 32 | 
 33 | from flask import render_template
 34 | from flask import url_for # Used in the render_template function
 35 | #from flask import flash
 36 | #from flask import request # Used for "get args"
 37 | from flask import redirect
 38 | from flask import Blueprint
 39 | from flask import session
 40 | from flask import abort
 41 | from flask import Response
 42 | 
 43 | main = Blueprint('main', __name__)
 44 | 
 45 | @main.add_app_template_global
 46 | def getTypeStructuresDictionary(structureTypeName):
 47 |     return getStructuresOfATypeAsDictionary(structureTypeName)
 48 | 
 49 | @main.add_app_template_global
 50 | def getTypeStructures(structureTypeName):
 51 |     return getStructuresOfAType(structureTypeName)
 52 |     
 53 | @main.add_app_template_global
 54 | def getNames(structureTypeName):
 55 |     return getStructureNamesOfAType(structureTypeName)
 56 | 
 57 | @main.add_app_template_global
 58 | def findStructureItemIndex(structureTypeName, itemName):
 59 |     tempStructures = getStructuresOfAType(structureTypeName)
 60 |     if len(tempStructures) > 0:
 61 |         return next((index for index, value in enumerate(tempStructures) if value.get("name") == itemName), -1)
 62 |     else:
 63 |         return -1
 64 | 
 65 | @main.route("/", methods=['GET'])
 66 | def index(title=""):
 67 |     uploadSnapshotForm = UploadSnapshotForm()
 68 |     return render_template('index.html', title=title, \
 69 |                            uploadSnapshotForm=uploadSnapshotForm)
 70 |                            
 71 | @main.route("/import/<string:importType>", methods=['POST'])
 72 | def importData(importType):
 73 |     if "snapshot" == importType:
 74 |         uploadSnapshotForm = UploadSnapshotForm()
 75 |         if uploadSnapshotForm.validate_on_submit():
 76 |             setSnapshot(uploadSnapshotForm.snapshot.data)
 77 |         else:
 78 |             print(uploadSnapshotForm.snapshot.errors)
 79 |         return redirect(url_for('main.index'))
 80 |     else:
 81 |         abort(404)
 82 |                            
 83 | @main.route("/config", methods=['GET'])
 84 | def config(title="Parser Configuration"):
 85 |     uploadSnapshotForm = UploadSnapshotForm()
 86 |     editConfigForm = EditConfigForm()
 87 |     if "Protocol" in session and "" != session["Protocol"]:
 88 |         editConfigForm.parserName.data = session["Protocol"]
 89 |     editConfigForm.entryPoint.choices = getReferenceSelectorTypes("Objects")
 90 |     if "EntryPoint" in session and "" != session["EntryPoint"]:
 91 |         editConfigForm.entryPoint.data = session["EntryPoint"]
 92 |     if "usesTCP" in session:
 93 |         editConfigForm.usesTCP.data = session["usesTCP"]
 94 |     if "usesUDP" in session:
 95 |         editConfigForm.usesUDP.data = session["usesUDP"]
 96 |     addPortForm = AddPortForm()
 97 |     addUserTypeForm = AddUserTypeForm()
 98 |     return render_template('config.html', title=title, \
 99 |                            uploadSnapshotForm=uploadSnapshotForm, editConfigForm=editConfigForm, addPortForm=addPortForm, \
100 |                            addUserTypeForm=addUserTypeForm)
101 |     
102 | @main.route("/editConfig", methods=['POST'])
103 | def editConfig():
104 |     editConfigForm = EditConfigForm()
105 |     
106 |     if editConfigForm.validate_on_submit():
107 |         updateConfig(editConfigForm)
108 |     else:
109 |         print(editConfigForm.errors)
110 |     return redirect(url_for('main.config'))
111 |     
112 | @main.route("/addUserType", methods=['POST'])
113 | def addUserType():
114 |     addUserTypeForm = AddUserTypeForm()
115 |     
116 |     if addUserTypeForm.validate_on_submit():
117 |         addUserTypeToSession(addUserTypeForm)
118 |     else:
119 |         print(addUserTypeForm.errors)
120 |     return redirect(url_for('main.config'))
121 |     
122 | @main.route("/removeUserType/<int:index>", methods=['GET'])
123 | def removeUserType(index):
124 |     removeUserTypeFromSession(index)
125 |     return redirect(url_for('main.config'))
126 |     
127 | @main.route("/addPort", methods=['POST'])
128 | def addPort():
129 |     addPortForm = AddPortForm()
130 |     
131 |     if addPortForm.validate_on_submit():
132 |         addPortToSession(addPortForm)
133 |     else:
134 |         print(addPortForm.errors)
135 |     return redirect(url_for('main.config'))
136 |     
137 | @main.route("/removePort/<int:index>", methods=['GET'])
138 | def removePort(index):
139 |     removePortFromSession(index)
140 |     return redirect(url_for('main.config'))
141 |                            
142 | @main.route("/enums", methods=['GET'])
143 | def enums(title="Enums"):
144 |     uploadSnapshotForm = UploadSnapshotForm()
145 |     addEnumForm = AddEnumForm()
146 |     
147 |     return render_template('enums.html', title=title, \
148 |                            uploadSnapshotForm=uploadSnapshotForm, \
149 |                            addEnumForm=addEnumForm)
150 |                            
151 | @main.route("/objects", methods=['GET', 'POST'])
152 | def objects(title="Objects"):
153 |     uploadSnapshotForm = UploadSnapshotForm()
154 |     addObjectForm = AddObjectForm()
155 |     
156 |     enumReferences = getReferenceSelectorTypes("Enums")
157 |     
158 |     dependencyTypes = getAllDependencySelectorTypes()
159 |     
160 |     for dependency in addObjectForm.objectDependencies:
161 |         dependency.dependencyType.choices = dependencyTypes
162 |         dependency.referenceType.choices = enumReferences
163 |     
164 |     return render_template('objects.html', title=title, \
165 |                            uploadSnapshotForm=uploadSnapshotForm, \
166 |                            addObjectForm=addObjectForm, \
167 |                            dependencyTypes=dependencyTypes, \
168 |                            enumReferences=enumReferences)
169 |                            
170 | @main.route("/addObject", methods=['POST'])
171 | def addObject():
172 |     addObjectForm = AddObjectForm()
173 |     
174 |     if addObjectForm.validate_on_submit():
175 |         addObjectToStructure(addObjectForm)
176 |     else:
177 |         print(addObjectForm.errors)
178 |     
179 |     return redirect(url_for('main.objects'))
180 | 
181 | @main.route("/removeObject/<int:index>", methods=['GET'])
182 | def removeObject(index):
183 |     removeObjectFromStructure(index)
184 |     return redirect(url_for('main.objects'))
185 |                            
186 | @main.route("/bitfields", methods=['GET'])
187 | def bitfields(title="Bitfields"):
188 |     uploadSnapshotForm = UploadSnapshotForm()
189 |     addBitfieldForm = AddBitfieldForm()
190 |     typeChoices = getBitfieldTypeSelectorTypes()
191 |     referenceChoices = getReferenceSelectorTypes("Enums")
192 |     for field in addBitfieldForm.fields:
193 |         field.referenceType.choices = referenceChoices
194 |         field.fieldType.choices = typeChoices
195 |     
196 |     return render_template('bitfields.html', title=title, \
197 |                            uploadSnapshotForm=uploadSnapshotForm, \
198 |                            addBitfieldForm=addBitfieldForm, referenceChoices=referenceChoices, typeChoices=typeChoices)
199 |                            
200 | @main.route("/viewFields/<int:index>", methods=['Get'])
201 | def viewFields(index, title="Fields"):
202 |     uploadSnapshotForm = UploadSnapshotForm()
203 |     addFieldForm = AddFieldForm()
204 |     addFieldForm.fieldType.choices = getAllFieldTypeSelectorTypes()
205 |     addFieldForm.elementType.choices = getAllFieldTypeSelectorTypes(includeListType=False, includeChoiceType=False)
206 |     
207 |     return render_template('fields.html', title=title, \
208 |                            uploadSnapshotForm=uploadSnapshotForm, \
209 |                            objectIndex=index, addFieldForm=addFieldForm)
210 | 
211 | @main.route("/addField/<int:objectIndex>/<int:displayIndex>", methods=['POST'])
212 | def addField(objectIndex, displayIndex):
213 |     addFieldForm = AddFieldForm()
214 |     
215 |     if addFieldForm.validate_on_submit():
216 |         addFieldToObject(objectIndex, addFieldForm)
217 |     else:
218 |         for field in addFieldForm:
219 |             print("field {0}: {1}".format(field.id, field.data))
220 |         print(addFieldForm.errors)
221 |     
222 |     return redirect(url_for('main.viewFields', index=displayIndex))
223 |                            
224 | @main.route("/removeField/<int:objectIndex>/<int:index>/<int:displayIndex>", methods=['GET'])
225 | def removeField(objectIndex, index, displayIndex):
226 |     removeFieldFromObject(objectIndex, index)
227 |     return redirect(url_for('main.viewFields', index=displayIndex))
228 |                            
229 | @main.route("/switches", methods=['GET'])
230 | def switches(title="Switches"):
231 |     uploadSnapshotForm = UploadSnapshotForm()
232 |     addSwitchForm = AddSwitchForm()
233 |     
234 |     addSwitchForm.switchMainDependency.dependencyType.choices = getDependencyStructureTypes()
235 |     
236 |     enumReferences = getReferenceSelectorTypes("Enums")
237 |     
238 |     addSwitchForm.switchMainDependency.referenceType.choices = enumReferences
239 |     
240 |     dependencyTypes = getAllDependencySelectorTypes()
241 |     
242 |     for dependency in addSwitchForm.switchAdditionalDependencies:
243 |         dependency.dependencyType.choices = dependencyTypes
244 |         dependency.referenceType.choices = enumReferences
245 |     
246 |     return render_template('switches.html', title=title, \
247 |                            uploadSnapshotForm=uploadSnapshotForm, \
248 |                            addSwitchForm=addSwitchForm, \
249 |                            dependencyTypes=dependencyTypes, \
250 |                            enumReferences=enumReferences, \
251 |                            enumValues=getStructuresOfATypeAsDictionary("enum"), \
252 |                            actionTypes=getActionTypeSelectorTypes(), \
253 |                            objectReferences=getReferenceSelectorTypes("Objects"),
254 |                            objectInputs=getObjectInputs())
255 |                            
256 | @main.route("/addEnum", methods=['POST'])
257 | def addEnum():
258 |     addEnumForm = AddEnumForm()
259 |     
260 |     if addEnumForm.validate_on_submit():
261 |         addEnumToStructure(addEnumForm)
262 |     return redirect(url_for('main.enums'))
263 |     
264 | @main.route("/removeEnum/<int:index>", methods=['GET'])
265 | def removeEnum(index):
266 |     removeEnumFromStructure(index)
267 |     return redirect(url_for('main.enums'))
268 |     
269 | @main.route("/addBitfield", methods=['POST'])
270 | def addBitfield():
271 |     addBitfieldForm = AddBitfieldForm()
272 |     
273 |     if addBitfieldForm.validate_on_submit():
274 |         addBitfieldToStructure(addBitfieldForm)
275 |     else:
276 |         print(addBitfieldForm.errors)
277 |     return redirect(url_for('main.bitfields'))
278 |     
279 | @main.route("/removeBitfield/<int:index>", methods=['GET'])
280 | def removeBitfield(index):
281 |     removeBitfieldFromStructure(index)
282 |     return redirect(url_for('main.bitfields'))
283 |     
284 | @main.route("/addSwitch", methods=['POST'])
285 | def addSwitch():
286 |     addSwitchForm = AddSwitchForm()
287 |     
288 |     if addSwitchForm.validate_on_submit():
289 |         addSwitchToStructure(addSwitchForm)
290 |     else:
291 |         print(addSwitchForm.errors)
292 |     return redirect(url_for('main.switches'))
293 |     
294 | @main.route("/removeSwitch/<int:index>", methods=['GET'])
295 | def removeSwitch(index):
296 |     removeSwitchFromStructure(index)
297 |     return redirect(url_for('main.switches'))
298 |                            
299 | ################################################################################
300 | # WIP
301 | ################################################################################
302 |                            
303 | @main.route("/export/<string:exportType>", methods=['GET'])
304 | def exportData(exportType):
305 |     if "snapshot" == exportType:
306 |         return Response(getSnapshot(),
307 |                        mimetype="application/json",
308 |                        headers={"Content-Disposition":
309 |                                     "attachment;filename=snapshot.json"})
310 |     elif "parsnip" == exportType:
311 |         parsnip = getParsnipFile(getSnapshot())
312 |         return Response(parsnip,
313 |                         mimetype='application/zip', 
314 |                         headers={'Content-Disposition': 'attachment;filename=parsnip.zip'})
315 |     else:
316 |         abort(404)
317 |     
318 | @main.route("/review", methods=['GET'])
319 | def review(title="Review"):
320 |     issues = reviewStructure()
321 |     uploadSnapshotForm = UploadSnapshotForm()
322 |     return render_template('review.html', title=title, issues=issues, uploadSnapshotForm=uploadSnapshotForm)
323 |     
324 | @main.route("/notice", methods=['GET'])
325 | def notice(title="Notice"):
326 |     uploadSnapshotForm = UploadSnapshotForm()
327 |     return render_template('notice.html', title=title, uploadSnapshotForm=uploadSnapshotForm)
328 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-bg_glass_100_f5f0e5_1x400.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-bg_glass_100_f5f0e5_1x400.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-bg_glass_25_cb842e_1x400.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-bg_glass_25_cb842e_1x400.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-bg_glass_70_ede4d4_1x400.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-bg_glass_70_ede4d4_1x400.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-bg_highlight-hard_100_f4f0ec_1x100.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-bg_highlight-hard_100_f4f0ec_1x100.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-bg_highlight-hard_65_fee4bd_1x100.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-bg_highlight-hard_65_fee4bd_1x100.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-bg_highlight-hard_75_f5f5b5_1x100.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-bg_highlight-hard_75_f5f5b5_1x100.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-bg_inset-soft_100_f4f0ec_1x100.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-bg_inset-soft_100_f4f0ec_1x100.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-icons_c47a23_256x240.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-icons_c47a23_256x240.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-icons_cb672b_256x240.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-icons_cb672b_256x240.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-icons_f08000_256x240.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-icons_f08000_256x240.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-icons_f35f07_256x240.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-icons_f35f07_256x240.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-icons_ff7519_256x240.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-icons_ff7519_256x240.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/images/ui-icons_ffffff_256x240.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cisagov/parsnip/dceeb9fefeee8fbedaacbcee53a170f569bb2f96/frontend/app/parsnip/web/static/css/images/ui-icons_ffffff_256x240.png


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/sm-core-css.css:
--------------------------------------------------------------------------------
 1 | /* Mobile first layout SmartMenus Core CSS (it's not recommended editing these rules)
 2 |    You need this once per page no matter how many menu trees or different themes you use.
 3 | -------------------------------------------------------------------------------------------*/
 4 | 
 5 | .sm{box-sizing:border-box;position:relative;z-index:9999;-webkit-tap-highlight-color:rgba(0,0,0,0);}
 6 | .sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;}
 7 | .sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right;}
 8 | .sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0;}
 9 | .sm ul{display:none;}
10 | .sm li,.sm a{position:relative;}
11 | .sm a{display:block;}
12 | .sm a.disabled{cursor:default;}
13 | .sm::after{content:"";display:block;height:0;font:0px/0 serif;clear:both;overflow:hidden;}
14 | .sm *,.sm *::before,.sm *::after{box-sizing:inherit;}


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/sm-custom.css:
--------------------------------------------------------------------------------
  1 | /* Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED */
  2 | @import "theme.css";
  3 | 
  4 | .sm {
  5 |     z-index: 99 !important;
  6 | }
  7 | 
  8 | .sm-custom {
  9 |   background: var(--color1a);
 10 |   border-radius: 5px;
 11 | }
 12 | .sm-custom a, .sm-custom a:hover, .sm-custom a:focus, .sm-custom a:active {
 13 |   padding: 13px 20px;
 14 |   /* make room for the toggle button (sub indicator) */
 15 |   padding-right: 58px;
 16 |   color: var(--color1b);
 17 |   font-family: "Lucida Sans Unicode", "Lucida Sans", "Lucida Grande", Arial, sans-serif;
 18 |   font-size: 18px;
 19 |   font-weight: normal;
 20 |   line-height: 17px;
 21 |   text-decoration: none;
 22 | }
 23 | .sm-custom a.current {
 24 |   color: var(--color2);
 25 | }
 26 | .sm-custom a.disabled {
 27 |   color: var(--color1c);
 28 | }
 29 | .sm-custom a .sub-arrow {
 30 |   position: absolute;
 31 |   top: 50%;
 32 |   margin-top: -17px;
 33 |   left: auto;
 34 |   right: 4px;
 35 |   width: 34px;
 36 |   height: 34px;
 37 |   overflow: hidden;
 38 |   font: bold 16px/34px monospace !important;
 39 |   text-align: center;
 40 |   text-shadow: none;
 41 |   background: rgba(255, 255, 255, 0.5);
 42 |   border-radius: 5px;
 43 | }
 44 | .sm-custom a .sub-arrow::before {
 45 |   content: '+';
 46 | }
 47 | .sm-custom a.highlighted .sub-arrow::before {
 48 |   content: '-';
 49 | }
 50 | .sm-custom > li:first-child > a, .sm-custom > li:first-child > :not(ul) a {
 51 |   border-radius: 5px 5px 0 0;
 52 | }
 53 | .sm-custom > li:last-child > a, .sm-custom > li:last-child > *:not(ul) a, .sm-custom > li:last-child > ul, .sm-custom > li:last-child > ul > li:last-child > a, .sm-custom > li:last-child > ul > li:last-child > *:not(ul) a, .sm-custom > li:last-child > ul > li:last-child > ul, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > a, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > *:not(ul) a, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > a, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > *:not(ul) a, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > ul, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > a, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > *:not(ul) a, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > ul {
 54 |   border-radius: 0 0 5px 5px;
 55 | }
 56 | .sm-custom > li:last-child > a.highlighted, .sm-custom > li:last-child > *:not(ul) a.highlighted, .sm-custom > li:last-child > ul > li:last-child > a.highlighted, .sm-custom > li:last-child > ul > li:last-child > *:not(ul) a.highlighted, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > a.highlighted, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > *:not(ul) a.highlighted, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > a.highlighted, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > *:not(ul) a.highlighted, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > a.highlighted, .sm-custom > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > ul > li:last-child > *:not(ul) a.highlighted {
 57 |   border-radius: 0;
 58 | }
 59 | .sm-custom li {
 60 |   border-top: 1px solid rgba(0, 0, 0, 0.05);
 61 | }
 62 | .sm-custom > li:first-child {
 63 |   border-top: 0;
 64 | }
 65 | .sm-custom ul {
 66 |   background: rgba(162, 162, 162, 0.1);
 67 | }
 68 | .sm-custom ul a, .sm-custom ul a:hover, .sm-custom ul a:focus, .sm-custom ul a:active {
 69 |   font-size: 16px;
 70 |   border-left: 8px solid transparent;
 71 | }
 72 | .sm-custom ul ul a,
 73 | .sm-custom ul ul a:hover,
 74 | .sm-custom ul ul a:focus,
 75 | .sm-custom ul ul a:active {
 76 |   border-left: 16px solid transparent;
 77 | }
 78 | .sm-custom ul ul ul a,
 79 | .sm-custom ul ul ul a:hover,
 80 | .sm-custom ul ul ul a:focus,
 81 | .sm-custom ul ul ul a:active {
 82 |   border-left: 24px solid transparent;
 83 | }
 84 | .sm-custom ul ul ul ul a,
 85 | .sm-custom ul ul ul ul a:hover,
 86 | .sm-custom ul ul ul ul a:focus,
 87 | .sm-custom ul ul ul ul a:active {
 88 |   border-left: 32px solid transparent;
 89 | }
 90 | .sm-custom ul ul ul ul ul a,
 91 | .sm-custom ul ul ul ul ul a:hover,
 92 | .sm-custom ul ul ul ul ul a:focus,
 93 | .sm-custom ul ul ul ul ul a:active {
 94 |   border-left: 40px solid transparent;
 95 | }
 96 | 
 97 | @media (min-width: 768px) {
 98 |   /* Switch to desktop layout
 99 |   -----------------------------------------------
100 |      These transform the menu tree from
101 |      collapsible to desktop (navbar + dropdowns)
102 |   -----------------------------------------------*/
103 |   /* start... (it's not recommended editing these rules) */
104 |   .sm-custom ul {
105 |     position: absolute;
106 |     width: 12em;
107 |   }
108 | 
109 |   .sm-custom li {
110 |     float: left;
111 |   }
112 | 
113 |   .sm-custom.sm-rtl li {
114 |     float: right;
115 |   }
116 | 
117 |   .sm-custom ul li, .sm-custom.sm-rtl ul li, .sm-custom.sm-vertical li {
118 |     float: none;
119 |   }
120 | 
121 |   .sm-custom a {
122 |     white-space: nowrap;
123 |   }
124 | 
125 |   .sm-custom ul a, .sm-custom.sm-vertical a {
126 |     white-space: normal;
127 |   }
128 | 
129 |   .sm-custom .sm-nowrap > li > a, .sm-custom .sm-nowrap > li > :not(ul) a {
130 |     white-space: nowrap;
131 |   }
132 | 
133 |   /* ...end */
134 |   .sm-custom {
135 |     padding: 0 10px;
136 |     background: var(--color1a);
137 |     border-radius: 100px;
138 |   }
139 |   .sm-custom a, .sm-custom a:hover, .sm-custom a:focus, .sm-custom a:active, .sm-custom a.highlighted {
140 |     padding: 12px 12px;
141 |     color: var(--color1b);
142 |     border-radius: 0 !important;
143 |   }
144 |   .sm-custom a:hover, .sm-custom a:focus, .sm-custom a:active, .sm-custom a.highlighted {
145 |     color: var(--color2);
146 |   }
147 |   .sm-custom a.current {
148 |     color: var(--color2);
149 |   }
150 |   .sm-custom a.disabled {
151 |     color: var(--color1c);
152 |   }
153 |   .sm-custom a.has-submenu {
154 |     padding-right: 24px;
155 |   }
156 |   .sm-custom a .sub-arrow {
157 |     top: 50%;
158 |     margin-top: -2px;
159 |     right: 12px;
160 |     width: 0;
161 |     height: 0;
162 |     border-width: 4px;
163 |     border-style: solid dashed dashed dashed;
164 |     border-color: var(--color1b) transparent transparent transparent;
165 |     background: transparent;
166 |     border-radius: 0;
167 |   }
168 |   .sm-custom a .sub-arrow::before {
169 |     display: none;
170 |   }
171 |   .sm-custom li {
172 |     border-top: 0;
173 |   }
174 |   .sm-custom > li > ul::before,
175 |   .sm-custom > li > ul::after {
176 |     content: '';
177 |     position: absolute;
178 |     top: -18px;
179 |     left: 30px;
180 |     width: 0;
181 |     height: 0;
182 |     overflow: hidden;
183 |     border-width: 9px;
184 |     border-style: dashed dashed solid dashed;
185 |     border-color: transparent transparent var(--color1c) transparent;
186 |   }
187 |   .sm-custom > li > ul::after {
188 |     top: -16px;
189 |     left: 31px;
190 |     border-width: 8px;
191 |     border-color: transparent transparent var(--color1) transparent;
192 |   }
193 |   .sm-custom ul {
194 |     border: 1px solid var(--color1c);
195 |     padding: 5px 0;
196 |     background: var(--color1);
197 |     border-radius: 5px !important;
198 |     box-shadow: 0 5px 9px rgba(0, 0, 0, 0.2);
199 |   }
200 |   .sm-custom ul a, .sm-custom ul a:hover, .sm-custom ul a:focus, .sm-custom ul a:active, .sm-custom ul a.highlighted {
201 |     border: 0 !important;
202 |     padding: 10px 20px;
203 |     color: var(--color1b);
204 |   }
205 |   .sm-custom ul a:hover, .sm-custom ul a:focus, .sm-custom ul a:active, .sm-custom ul a.highlighted {
206 |     background: var(--color1a);
207 |     color: var(--color2);
208 |   }
209 |   .sm-custom ul a.current {
210 |     color: var(--color2);
211 |   }
212 |   .sm-custom ul a.disabled {
213 |     background: var(--color1);
214 |     color: var(--color3);
215 |   }
216 |   .sm-custom ul a.has-submenu {
217 |     padding-right: 20px;
218 |   }
219 |   .sm-custom ul a .sub-arrow {
220 |     right: 8px;
221 |     top: 50%;
222 |     margin-top: -5px;
223 |     border-width: 5px;
224 |     border-style: dashed dashed dashed solid;
225 |     border-color: transparent transparent transparent var(--color1b);
226 |   }
227 |   .sm-custom .scroll-up,
228 |   .sm-custom .scroll-down {
229 |     position: absolute;
230 |     display: none;
231 |     visibility: hidden;
232 |     overflow: hidden;
233 |     background: var(--color1);
234 |     height: 20px;
235 |   }
236 |   .sm-custom .scroll-up:hover,
237 |   .sm-custom .scroll-down:hover {
238 |     background: var(--color1a);
239 |   }
240 |   .sm-custom .scroll-up:hover .scroll-up-arrow {
241 |     border-color: transparent transparent var(--color2) transparent;
242 |   }
243 |   .sm-custom .scroll-down:hover .scroll-down-arrow {
244 |     border-color: var(--color2) transparent transparent transparent;
245 |   }
246 |   .sm-custom .scroll-up-arrow,
247 |   .sm-custom .scroll-down-arrow {
248 |     position: absolute;
249 |     top: 0;
250 |     left: 50%;
251 |     margin-left: -6px;
252 |     width: 0;
253 |     height: 0;
254 |     overflow: hidden;
255 |     border-width: 6px;
256 |     border-style: dashed dashed solid dashed;
257 |     border-color: transparent transparent var(--color1b) transparent;
258 |   }
259 |   .sm-custom .scroll-down-arrow {
260 |     top: 8px;
261 |     border-style: solid dashed dashed dashed;
262 |     border-color: var(--color1b) transparent transparent transparent;
263 |   }
264 |   .sm-custom.sm-rtl a.has-submenu {
265 |     padding-right: 12px;
266 |     padding-left: 24px;
267 |   }
268 |   .sm-custom.sm-rtl a .sub-arrow {
269 |     right: auto;
270 |     left: 12px;
271 |   }
272 |   .sm-custom.sm-rtl.sm-vertical a.has-submenu {
273 |     padding: 10px 20px;
274 |   }
275 |   .sm-custom.sm-rtl.sm-vertical a .sub-arrow {
276 |     right: auto;
277 |     left: 8px;
278 |     border-style: dashed solid dashed dashed;
279 |     border-color: transparent var(--color1b) transparent transparent;
280 |   }
281 |   .sm-custom.sm-rtl > li > ul::before {
282 |     left: auto;
283 |     right: 30px;
284 |   }
285 |   .sm-custom.sm-rtl > li > ul::after {
286 |     left: auto;
287 |     right: 31px;
288 |   }
289 |   .sm-custom.sm-rtl ul a.has-submenu {
290 |     padding: 10px 20px !important;
291 |   }
292 |   .sm-custom.sm-rtl ul a .sub-arrow {
293 |     right: auto;
294 |     left: 8px;
295 |     border-style: dashed solid dashed dashed;
296 |     border-color: transparent var(--color1b) transparent transparent;
297 |   }
298 |   .sm-custom.sm-vertical {
299 |     padding: 10px 0;
300 |     border-radius: 5px;
301 |   }
302 |   .sm-custom.sm-vertical a {
303 |     padding: 10px 20px;
304 |   }
305 |   .sm-custom.sm-vertical a:hover, .sm-custom.sm-vertical a:focus, .sm-custom.sm-vertical a:active, .sm-custom.sm-vertical a.highlighted {
306 |     background: var(--color1);
307 |   }
308 |   .sm-custom.sm-vertical a.disabled {
309 |     background: var(--color1a);
310 |   }
311 |   .sm-custom.sm-vertical a .sub-arrow {
312 |     right: 8px;
313 |     top: 50%;
314 |     margin-top: -5px;
315 |     border-width: 5px;
316 |     border-style: dashed dashed dashed solid;
317 |     border-color: transparent transparent transparent var(--color1b);
318 |   }
319 |   .sm-custom.sm-vertical > li > ul::before,
320 |   .sm-custom.sm-vertical > li > ul::after {
321 |     display: none;
322 |   }
323 |   .sm-custom.sm-vertical ul a {
324 |     padding: 10px 20px;
325 |   }
326 |   .sm-custom.sm-vertical ul a:hover, .sm-custom.sm-vertical ul a:focus, .sm-custom.sm-vertical ul a:active, .sm-custom.sm-vertical ul a.highlighted {
327 |     background: var(--color1a);
328 |   }
329 |   .sm-custom.sm-vertical ul a.disabled {
330 |     background: var(--color1);
331 |   }
332 | }
333 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/styles.css:
--------------------------------------------------------------------------------
 1 | /* Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED */
 2 | 
 3 | @import "theme.css";
 4 | 
 5 | body
 6 | {
 7 |     background-color: var(--color1);
 8 |     color: var(--text1);
 9 |     margin: 0px;
10 |     font-family: Arial, sans-serif;
11 | }
12 | 
13 | footer
14 | {
15 |     text-align: center;
16 | }
17 | 
18 | h1, h2, h3, h4, h5, h6
19 | {
20 |     text-align: center;
21 | }
22 | 
23 | .leftText
24 | {
25 |     text-align: left;
26 | }
27 | 
28 | .hidden
29 | {
30 |     display: none;
31 | }
32 | 
33 | .buttonColumn a, .buttonColumn button, .buttonColumn input
34 | {
35 |     display: block;
36 | }
37 | 
38 | .centeredText
39 | {
40 |     text-align: center;
41 | }
42 | 
43 | .buttonRow
44 | {
45 |     display: flex;
46 |     width: 100%;
47 | }
48 | 
49 | div.ui-state-error
50 | {
51 |     padding: 0 .7em;
52 | }
53 | 
54 | span.ui-icon-alert
55 | {
56 |     float: left;
57 |     margin-right: .3em;
58 | }
59 | 
60 | p.errorLabel
61 | {
62 |     font-weight: bold;
63 | }
64 | 
65 | .ui-widget input
66 | {
67 |     padding: 0px 5px;
68 | }
69 | 
70 | table.infoTable
71 | {
72 |     border-collapse: collapse;
73 | }
74 | 
75 | table.infoTable tr
76 | {
77 |     border-width: 1px;
78 |     border-style: solid;
79 | }
80 | 
81 | table.infoTable td, table.infoTable th
82 | {
83 |     border-width: 1px;
84 |     border-style: dashed;
85 |     padding: 5px;
86 | }
87 | 
88 | /* Alternate Row Shading */
89 | table.infoTable tr:nth-child(even)
90 | {
91 |     background-color: var(--tableColor2);
92 |     color: var(--text2);
93 | }
94 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/theme.css:
--------------------------------------------------------------------------------
 1 | /* Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED */
 2 | 
 3 | :root
 4 | {
 5 |     --color1: #fff5d7; /* Border and Disabled Background Color */
 6 |     --color1a: #ceb568; /* Background Color */
 7 |     --color1b: #555555; /* Inactive Text Color */
 8 |     --color1c: #bbbbbb; /* Border and Disabled Text Color */
 9 |     --color2: #000000; /* Active Text Color */
10 |     --color3: #cccccc; /* 2nd Disabled Text Color? */
11 |     --tableColor1: #fff5d7;
12 |     --text1: #000000;
13 |     --tableColor2: #ceb568;
14 |     --text2: #000000;
15 | }
16 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/static/css/view.css:
--------------------------------------------------------------------------------
 1 | /* Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED */
 2 | 
 3 | @import "theme.css";
 4 | 
 5 | div.flexArea
 6 | {
 7 |     display: flex;
 8 |     height: max-content;
 9 | }
10 | 
11 | div#addStructure
12 | {
13 |     width: 20%;
14 |     min-width: 10%;
15 | }
16 | 
17 | div#viewStructure
18 | {
19 |     width: 80%;
20 |     min-width: 40%;
21 | }
22 | 
23 | div#addFields
24 | {
25 |     width: 100%;
26 |     min-width: 40%;
27 | }
28 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/config.html:
--------------------------------------------------------------------------------
  1 | {# Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED #}
  2 | 
  3 | {% set years = "2024" %}
  4 | 
  5 | {% import 'macros.j2' as macros -%}
  6 | 
  7 | {% extends "layout.base" %}
  8 | 
  9 | {% block additionalHeader %}
 10 | {% endblock additionalHeader %}
 11 | 
 12 | {% block content %}
 13 | <h2>Parser Configuration</h2>
 14 | <div id="viewConfigTabs">
 15 |   <ul>
 16 |     <li><a href="#parserConfigTab">General Parser Configuration</a></li>
 17 |     <li><a href="#portsTab">Protocol Ports</a></li>
 18 |     <li><a href="#userTypesTab">User Types</a></li>
 19 |   </ul>
 20 |   <div id="parserConfigTab">
 21 |     <h3>General Parser Configuration</h3>
 22 |     <table id="parserConfigTable" class="infoTable">
 23 |         <thead>
 24 |             <tr>
 25 |                 <th scope="col">Option Name</th>
 26 |                 <th scope="col">Option Value</th>
 27 |             </tr>
 28 |         </thead>
 29 |         <tbody>
 30 |             <tr>
 31 |                 <td>Protocol Name</td>
 32 |                 <td>{{ session["Protocol"] }}</td>
 33 |             </tr>
 34 |             <tr>
 35 |                 <td>Parser Entry Point</td>
 36 |                 <td>{{ session["EntryPoint"] }}</td>
 37 |             </tr>
 38 |             <tr>
 39 |                 <td>Uses TCP? </td>
 40 | {%- set usesTCP = False -%}
 41 | {%- if session["usesTCP"] -%}
 42 |     {%- set usesTCP = session["usesTCP"] -%}
 43 | {%- endif -%}
 44 |                 <td>{{ usesTCP }}</td>
 45 |             </tr>
 46 |             <tr>
 47 |                 <td>Uses UDP? </td>
 48 | {%- set usesUDP = False -%}
 49 | {%- if session["usesUDP"] -%}
 50 |     {%- set usesUDP = session["usesUDP"] -%}
 51 | {%- endif -%}
 52 |                 <td>{{ usesUDP }}</td>
 53 |             </tr>
 54 |         </tbody>
 55 |     </table>
 56 |     <div class="buttonRow">
 57 |         <a href="#" class="ui-button ui-widget ui-corner-all editParserConfigButton">Edit Parser Configuration</a>
 58 |     </div>
 59 |   </div>
 60 |   <div id="portsTab">
 61 |     <h3>Protocol Ports</h3>
 62 |     <table id="userTypesTable" class="infoTable">
 63 |         <thead>
 64 |             <tr>
 65 |                 <th scope="col">Parent Network Protocol</th>
 66 |                 <th scope="col">Port</th>
 67 |                 <th scope="col">Delete?</th>
 68 |             </tr>
 69 |         </thead>
 70 |         <tbody>
 71 |         {% if "Ports" in session %}
 72 |             {% for entry in session["Ports"] %}
 73 |             <tr>
 74 |                 <td>{{ entry["protocol"] }}</td>
 75 |                 <td>{{ entry["port"] }}</td>
 76 |                 <td class="centeredText confirmDelete"><a href="{{ url_for('main.removePort', index=loop.index0) }}">X</a></td>
 77 |             </tr>
 78 |             {% endfor %}
 79 |         {% endif %}
 80 |         </tbody>
 81 |     </table>
 82 |     <div class="buttonRow">
 83 |         <a href="#" class="ui-button ui-widget ui-corner-all addPortButton">Add Port</a>
 84 |     </div>
 85 |   </div>
 86 |   <div id="userTypesTab">
 87 |     <h3>User Types</h3>
 88 |     <div class="buttonRow">
 89 |         <a href="#" class="ui-button ui-widget ui-corner-all addUserTypeButton">Add User Type</a>
 90 |     </div>
 91 |     <table id="userTypesTable" class="infoTable">
 92 |         <thead>
 93 |             <tr>
 94 |                 <th scope="col">Type Name</th>
 95 |                 <th scope="col">Type Interpretation Function Name</th>
 96 |                 <th scope="col">Function Return Type</th>
 97 |                 <th scope="col">Delete?</th>
 98 |             </tr>
 99 |         </thead>
100 |         <tbody>
101 |         {% if "CustomFieldTypes" in session %}
102 |             {% for entry in session["CustomFieldTypes"] %}
103 |             <tr>
104 |                 <td>{{ entry["name"] }}</td>
105 |                 <td>{{ entry["interpretingFunction"] }}</td>
106 |                 <td>{{ entry["returnType"] }}</td>
107 |                 <td class="centeredText confirmDelete"><a href="{{ url_for('main.removeUserType', index=loop.index0) }}">X</a></td>
108 |             </tr>
109 |             {% endfor %}
110 |         {% endif %}
111 |         </tbody>
112 |     </table>
113 |     <div class="buttonRow">
114 |         <a href="#" class="ui-button ui-widget ui-corner-all addUserTypeButton">Add User Type</a>
115 |     </div>
116 |   </div>
117 | </div>
118 | 
119 | <!-- Dialogs -->
120 | <div id="editParserConfigDialog" class="dialog" title="Edit Parser Configuration">
121 |     <form method="POST" action="{{ url_for('main.editConfig') }}">
122 |         {{ editConfigForm.csrf_token }}
123 |         
124 |         <!-- Parser Name -->
125 |         <p>Notes:</p>
126 |         <ul>
127 |             <li>The first character must be a letter or an underscore</li>
128 |             <li>Additional characters may be a letter, number, or underscore</li>
129 |         </ul>
130 |         <p class="fieldSet">
131 |             {{ editConfigForm.parserName.label }}
132 |             {{ editConfigForm.parserName }}
133 |         </p>
134 |         {% if editConfigForm.parserName.error %}
135 |         <div class="ui-widget">
136 | 	        <div class="ui-state-error ui-corner-all">
137 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
138 | 		        <ul class="errors">
139 |                 {% for error in editConfigForm.parserName.error %}
140 |                     <li>{{ error }}</li>
141 |                 {% endfor %}
142 |                 </ul>
143 | 	        </div>
144 |         </div>
145 |         {% endif %}
146 |         <!-- End Parser Name -->
147 |         
148 |         <!-- Entry Point -->
149 |         <p class="fieldSet">
150 |             {{ editConfigForm.entryPoint.label }}
151 |             {{ editConfigForm.entryPoint }}
152 |         </p>
153 |         <!-- End Entry Point -->
154 |         
155 |         <!-- Uses TCP -->
156 |         <p class="fieldSet">
157 |             {{ editConfigForm.usesTCP.label }}
158 |             {{ editConfigForm.usesTCP }}
159 |         </p>
160 |         <!-- End Uses TCP -->
161 |         
162 |         <!-- Uses UDP -->
163 |         <p class="fieldSet">
164 |             {{ editConfigForm.usesUDP.label }}
165 |             {{ editConfigForm.usesUDP }}
166 |         </p>
167 |         <!-- End Uses UDP -->
168 |         
169 |         <input type="submit" value="Save Configuration" class="ui-button ui-widget ui-corner-all" />
170 |     </form>
171 | </div>
172 | 
173 | <div id="addPortDialog" class="dialog" title="Add Protocol Port">
174 |     <form method="POST" action="{{ url_for('main.addPort') }}">
175 |         {{ addPortForm.csrf_token }}
176 |         
177 |         <!-- Parent Protocol -->
178 |         <p class="fieldSet">
179 |             {{ addPortForm.protocolName.label }}
180 |             {{ addPortForm.protocolName }}
181 |         </p>
182 |         <!-- End Parent Protocol -->
183 |         
184 |         <!-- Port Number -->
185 |         <p class="fieldSet">
186 |             {{ addPortForm.portNumber.label }}
187 |             {{ addPortForm.portNumber }}
188 |         </p>
189 |         {% if addPortForm.portNumber.error %}
190 |         <div class="ui-widget">
191 | 	        <div class="ui-state-error ui-corner-all">
192 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
193 | 		        <ul class="errors">
194 |                 {% for error in addPortForm.portNumber.error %}
195 |                     <li>{{ error }}</li>
196 |                 {% endfor %}
197 |                 </ul>
198 | 	        </div>
199 |         </div>
200 |         {% endif %}
201 |         <!-- End Port Number -->
202 |         
203 |         <input type="submit" value="Add Port" class="ui-button ui-widget ui-corner-all" />
204 |     </form>
205 | </div>
206 | 
207 | <div id="addUserTypeDialog" class="dialog" title="Add User Type">
208 |     <form method="POST" action="{{ url_for('main.addUserType') }}">
209 |         {{ addUserTypeForm.csrf_token }}
210 |         
211 |         <!-- Type Name -->
212 |         <p>Notes:</p>
213 |         <ul>
214 |             <li>The first character must be a letter or an underscore</li>
215 |             <li>Additional characters may be a letter, number, underscore, or hyphen</li>
216 |         </ul>
217 |         <p class="fieldSet">
218 |             {{ addUserTypeForm.typeName.label }}
219 |             {{ addUserTypeForm.typeName }}
220 |         </p>
221 |         {% if addUserTypeForm.typeName.error %}
222 |         <div class="ui-widget">
223 | 	        <div class="ui-state-error ui-corner-all">
224 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
225 | 		        <ul class="errors">
226 |                 {% for error in addUserTypeForm.typeName.error %}
227 |                     <li>{{ error }}</li>
228 |                 {% endfor %}
229 |                 </ul>
230 | 	        </div>
231 |         </div>
232 |         {% endif %}
233 |         <!-- End Type Name -->
234 |         
235 |         <!-- Interpreting Function -->
236 |         <p>Notes:</p>
237 |         <ul>
238 |             <li>The first character must be a letter or an underscore</li>
239 |             <li>Additional characters may be a letter, number, or underscore</li>
240 |         </ul>
241 |         <p class="fieldSet">
242 |             {{ addUserTypeForm.interpretingFunction.label }}
243 |             {{ addUserTypeForm.interpretingFunction }}
244 |         </p>
245 |         {% if addUserTypeForm.interpretingFunction.error %}
246 |         <div class="ui-widget">
247 | 	        <div class="ui-state-error ui-corner-all">
248 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
249 | 		        <ul class="errors">
250 |                 {% for error in addUserTypeForm.interpretingFunction.error %}
251 |                     <li>{{ error }}</li>
252 |                 {% endfor %}
253 |                 </ul>
254 | 	        </div>
255 |         </div>
256 |         {% endif %}
257 |         <!-- End Interpreting Function -->
258 |         
259 |         <!-- Return Type -->
260 |         <p class="fieldSet">
261 |             {{ addUserTypeForm.returnType.label }}
262 |             {{ addUserTypeForm.returnType }}
263 |         </p>
264 |         <!-- End Return Type -->
265 |         
266 |         <input type="submit" value="Add User Type" class="ui-button ui-widget ui-corner-all" />
267 |     </form>
268 | </div>
269 | {% endblock content %}
270 | 
271 | {% block additionalJavascript %}
272 | <script>
273 | $(function() {
274 | 	$('#viewConfigTabs').tabs();
275 | 	
276 | 	const buttonsAndDialogs = ["editParserConfig", "addPort", "addUserType"];
277 | 
278 | 	for(let i = 0; i < buttonsAndDialogs.length; ++i)
279 | 	{
280 | 	    let value = buttonsAndDialogs[i];
281 |         $('#' + value + 'Dialog').dialog(dialogInitializationValue);
282 |         $('.' + value + 'Button').click(function(event) {
283 |             loadForm(event, value + 'Dialog');
284 |         });
285 | 	}
286 | 	
287 | 	$(".confirmDelete").click(function(){
288 |         return confirm("Are you sure you want to delete?");
289 |     })
290 | });
291 | </script>
292 | {% endblock additionalJavascript %}
293 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/enums.html:
--------------------------------------------------------------------------------
  1 | {# Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED #}
  2 | 
  3 | {% set years = "2024" %}
  4 | 
  5 | {% import 'macros.j2' as macros -%}
  6 | 
  7 | {% extends "layout.base" %}
  8 | 
  9 | {% block additionalHeader %}
 10 | {% endblock additionalHeader %}
 11 | 
 12 | {% block content %}
 13 | <h2>Parser Enums</h2>
 14 | <div class="ui-widget-content">
 15 |     <div class="buttonRow">
 16 |         <a href="#" class="ui-button ui-widget ui-corner-all addEnumButton">Add Enum</a>
 17 |     </div>
 18 |     <table id="objecsTable" class="infoTable">
 19 |         <thead>
 20 |             <tr>
 21 |                 <th scope="col">Name</th>
 22 |                 <th scope="col">Reference</th>
 23 |                 <th scope="col">Notes</th>
 24 |                 <th scope="col">Size in Bits</th>
 25 |                 <th scope="col">Scope</th>
 26 |                 <th scope="col">Values</th>
 27 |                 <th scope="col">Delete?</th>
 28 |             </tr>
 29 |         </thead>
 30 |         <tbody>
 31 |         {% if "Structures" in session and "Enums" in session["Structures"]%}
 32 |             {% for entry in session["Structures"]["Enums"] %}
 33 |             <tr>
 34 |                 <td id="enum{{ loop.index0 }}">{{ entry["name"] }}</td>
 35 |                 <td>{{ entry["reference"] }}</td>
 36 |                 <td>{{ entry["notes"] }}</td>
 37 |                 <td>{{ entry["size"] }}</td>
 38 |                 <td>{{ entry["scope"] }}</td>
 39 |                 <td>
 40 |                     <ol>
 41 |                         {% for field in entry["fields"] %}
 42 |                         <li value='{{ field["value"] }}'>
 43 |                             <dl>
 44 |                                 <dt>{{ field["name"] }}<br />(Logged as "{{ field["loggingValue"] }}")</dt>
 45 |                                 <dd>{{ field["notes"] }}</dd>
 46 |                             </dl>
 47 |                         </li>
 48 |                         {% endfor %}
 49 |                     </ol>
 50 |                 </td>
 51 |                 <td class="centeredText confirmDelete"><a href="{{ url_for('main.removeEnum', index=loop.index0) }}">X</a></td>
 52 |             </tr>
 53 |             {% endfor %}
 54 |         {% endif %}
 55 |         </tbody>
 56 |     </table>
 57 |     <div class="buttonRow">
 58 |         <a href="#" class="ui-button ui-widget ui-corner-all addEnumButton">Add Enum</a>
 59 |     </div>
 60 |   </div>
 61 | </div>
 62 | 
 63 | <!-- Dialogs -->
 64 | <div id="addEnumDialog" class="dialog" title="Add Enum">
 65 |     <form method="POST" action="{{ url_for('main.addEnum') }}">
 66 |         {{ addEnumForm.csrf_token }}
 67 |         
 68 |         <!-- Name -->
 69 |         <p class="fieldSet">
 70 |             {{ addEnumForm.enumName.label }}
 71 |             {{ addEnumForm.enumName }}
 72 |         </p>
 73 |         {% if addEnumForm.enumName.error %}
 74 |         <div class="ui-widget">
 75 | 	        <div class="ui-state-error ui-corner-all">
 76 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
 77 | 		        <ul class="errors">
 78 |                 {% for error in addEnumForm.enumName.error %}
 79 |                     <li>{{ error }}</li>
 80 |                 {% endfor %}
 81 |                 </ul>
 82 | 	        </div>
 83 |         </div>
 84 |         {% endif %}
 85 |         <!-- End Name -->
 86 |         
 87 |         <!-- Reference -->
 88 |         <p class="fieldSet">
 89 |             {{ addEnumForm.enumReference.label }}
 90 |             {{ addEnumForm.enumReference }}
 91 |         </p>
 92 |         {% if addEnumForm.enumReference.error %}
 93 |         <div class="ui-widget">
 94 | 	        <div class="ui-state-error ui-corner-all">
 95 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
 96 | 		        <ul class="errors">
 97 |                 {% for error in addEnumForm.enumReference.error %}
 98 |                     <li>{{ error }}</li>
 99 |                 {% endfor %}
100 |                 </ul>
101 | 	        </div>
102 |         </div>
103 |         {% endif %}
104 |         <!-- End Reference -->
105 |         
106 |         <!-- Note -->
107 |         <p class="fieldSet">
108 |             {{ addEnumForm.enumNote.label }}
109 |             {{ addEnumForm.enumNote }}
110 |         </p>
111 |         {% if addEnumForm.enumNote.error %}
112 |         <div class="ui-widget">
113 | 	        <div class="ui-state-error ui-corner-all">
114 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
115 | 		        <ul class="errors">
116 |                 {% for error in addEnumForm.enumNote.error %}
117 |                     <li>{{ error }}</li>
118 |                 {% endfor %}
119 |                 </ul>
120 | 	        </div>
121 |         </div>
122 |         {% endif %}
123 |         <!-- End Note -->
124 |         
125 |         <!-- Scope -->
126 |         <p class="fieldSet">
127 |             {{ addEnumForm.enumScope.label }}
128 |             {{ addEnumForm.enumScope }}
129 |         </p>
130 |         {% if addEnumForm.enumScope.error %}
131 |         <div class="ui-widget">
132 | 	        <div class="ui-state-error ui-corner-all">
133 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
134 | 		        <ul class="errors">
135 |                 {% for error in addEnumForm.enumScope.error %}
136 |                     <li>{{ error }}</li>
137 |                 {% endfor %}
138 |                 </ul>
139 | 	        </div>
140 |         </div>
141 |         {% endif %}
142 |         <!-- End Scope -->
143 |         
144 |         <p>Field Size must be a multiple of 8 bits</p>
145 |         
146 |         <!-- Size -->
147 |         <p class="fieldSet">
148 |             {{ addEnumForm.enumSize.label }}
149 |             {{ addEnumForm.enumSize }}
150 |         </p>
151 |         {% if addEnumForm.enumSize.error %}
152 |         <div class="ui-widget">
153 | 	        <div class="ui-state-error ui-corner-all">
154 | 		        <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
155 | 		        <ul class="errors">
156 |                 {% for error in addEnumForm.enumSize.error %}
157 |                     <li>{{ error }}</li>
158 |                 {% endfor %}
159 |                 </ul>
160 | 	        </div>
161 |         </div>
162 |         {% endif %}
163 |         <!-- End Size -->
164 |         
165 |         <hr />
166 |         <p id="fieldLimits">Between {{ addEnumForm.fields.min_entries }} and {{ addEnumForm.fields.max_entries }} fields must be provided.</p>
167 |         {% set fieldsText = addEnumForm.fields|length %}
168 |         {% if fieldsText != 1 %}
169 |             {% set fieldsText = fieldsText|string + " fields are" %}
170 |         {% else %}
171 |             {% set fieldsText = fieldsText|string + " field is" %}
172 |         {% endif %}
173 |         <p id="currentFieldCount"><span id="fieldCounterSpace">{{fieldsText}}</span> currently defined.</p>
174 |         <!-- Start Field List -->
175 |         <div id="enumFields">
176 |             {% for field in addEnumForm.fields %}
177 |                 <p class="fieldSet" id="fieldSet-{{loop.index0}}">
178 |                     <a href="#" id="removeFieldSet-{{loop.index0}}" onclick="removeEnumField({{ loop.index0 }});">X</a>
179 |                     {{ field.fieldName.label }}
180 |                     {{ field.fieldName(size=15) }}<br />
181 |                     {{ field.loggingValue.label }}
182 |                     {{ field.loggingValue(size=15) }}<br />
183 |                     {{ field.fieldValue.label }}
184 |                     {{ field.fieldValue(size=2) }}<br />
185 |                     {{ field.fieldNote.label }}
186 |                     {{ field.fieldNote }}
187 |                 </p>
188 |                 {% if field.fieldName.error %}
189 |                 <div class="ui-widget">
190 | 	                <div class="ui-state-error ui-corner-all">
191 | 		                <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
192 | 		                <ul class="errors">
193 |                         {% for error in field.fieldName.error %}
194 |                             <li>{{ error }}</li>
195 |                         {% endfor %}
196 |                         </ul>
197 | 	                </div>
198 |                 </div>
199 |                 {% endif %}
200 |                 {% if field.fieldValue.error %}
201 |                 <div class="ui-widget">
202 | 	                <div class="ui-state-error ui-corner-all">
203 | 		                <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
204 | 		                <ul class="errors">
205 |                         {% for error in field.fieldValue.error %}
206 |                             <li>{{ error }}</li>
207 |                         {% endfor %}
208 |                         </ul>
209 | 	                </div>
210 |                 </div>
211 |                 {% endif %}
212 |             {% endfor %}
213 |         </div>
214 |         <!-- End Field List -->
215 |         <a href="#" class="ui-button ui-widget ui-corner-all" onclick="addEnumField();">Add Enum Field</a>
216 |         <hr />
217 |         <input type="submit" value="Add Enum" class="ui-button ui-widget ui-corner-all" />
218 |     </form>
219 | </div>
220 | {% endblock content %}
221 | 
222 | {% block additionalJavascript %}
223 | <script>
224 | const maxEnumFields = {{ addEnumForm.fields.max_entries }};
225 | var currentEnumFields = {{ addEnumForm.fields|length }};
226 | var nextEnumFieldIndex = {{ addEnumForm.fields|length }};
227 | 
228 | function updateEnumFieldCount() {
229 |     text = currentEnumFields;
230 |     if(1 == text)
231 |     {
232 |         text = text + " field is";
233 |     }
234 |     else
235 |     {
236 |         text = text + " fields are";
237 |     }
238 |     $("#fieldCounterSpace").html(text);
239 | }
240 | 
241 | function addEnumField() {
242 |     currentHTML = $("#enumFields").html();
243 |     currentNameValues = $("#enumFields [id$='fieldName']")
244 |     currentLoggingValueValues = $("#enumFields [id$='loggingValue']")
245 |     currentValueValues = $("#enumFields [id$='fieldValue']")
246 |     currentNoteValues = $("#enumFields [id$='fieldNote']")
247 |     
248 |     fieldNameID = "fields-" + nextEnumFieldIndex + "-fieldName";
249 |     loggingValueID = "fields-" + nextEnumFieldIndex + "-loggingValue";
250 |     fieldValueID = "fields-" + nextEnumFieldIndex + "-fieldValue";
251 |     fieldNoteID = "fields-" + nextEnumFieldIndex + "-fieldNote";
252 |     
253 |     currentHTML += "\n<p class=\"fieldSet\" id=\"fieldSet-" + nextEnumFieldIndex + "\">";
254 |     currentHTML += "<a href=\"#\" id=\"removeFieldSet-" + nextEnumFieldIndex + "\" onclick=\"removeEnumField(" + nextEnumFieldIndex + ");\">X</a>\n";
255 |     currentHTML += "<label for=\"" + fieldNameID + "\">Field Name: </label>";
256 |     currentHTML += "<input id=\"" + fieldNameID + "\" name=\"" + fieldNameID + "\" required size=\"15\" type=\"text\"><br />";
257 |     currentHTML += "<label for=\"" + loggingValueID + "\">Value to Appear in the Log: </label>";
258 |     currentHTML += "<input id=\"" + loggingValueID + "\" name=\"" + loggingValueID + "\" required size=\"15\" type=\"text\"><br />";
259 |     currentHTML += "<label for=\"" + fieldValueID + "\">Field Value: </label>";
260 |     currentHTML += "<input id=\"" + fieldValueID + "\" name=\"" + fieldValueID + "\" required size=\"2\" type=\"number\" value=\"\"><br />";
261 |     currentHTML += "<label for=\"" + fieldNoteID + "\">Field Note: </label>";
262 |     currentHTML += "<input id=\"" + fieldNoteID + "\" name=\"" + fieldNoteID + "\" type=\"text\">";
263 |     currentHTML += "</p>\n"
264 |     currentHTML = $("#enumFields").html(currentHTML);
265 |     ++currentEnumFields;
266 |     ++nextEnumFieldIndex;
267 |     updateEnumFieldCount();
268 |     
269 |     currentNameValues.each(function(){
270 |         currentID = $(this).attr("id");
271 |         currentValue = $(this).val();
272 |         $("#" + currentID).val(currentValue);
273 |     });
274 |     
275 |     currentLoggingValueValues.each(function(){
276 |         currentID = $(this).attr("id");
277 |         currentValue = $(this).val();
278 |         $("#" + currentID).val(currentValue);
279 |     });
280 |     
281 |     currentValueValues.each(function(){
282 |         currentID = $(this).attr("id");
283 |         currentValue = $(this).val();
284 |         $("#" + currentID).val(currentValue);
285 |     });
286 |     
287 |     currentNoteValues.each(function(){
288 |         currentID = $(this).attr("id");
289 |         currentValue = $(this).val();
290 |         $("#" + currentID).val(currentValue);
291 |     });
292 | }
293 | 
294 | function removeEnumField(fieldNumber) {
295 |     $("#fieldSet-" + fieldNumber).remove();
296 |     --currentEnumFields;
297 |     updateEnumFieldCount();
298 | }
299 | 
300 | $(function() {
301 | 	
302 | 	const buttonsAndDialogs = ["addEnum"];
303 | 
304 | 	for(let i = 0; i < buttonsAndDialogs.length; ++i)
305 | 	{
306 | 	    let value = buttonsAndDialogs[i];
307 |         $('#' + value + 'Dialog').dialog(dialogInitializationValue);
308 |         $('.' + value + 'Button').click(function(event) {
309 |             loadForm(event, value + 'Dialog');
310 |         });
311 | 	}
312 | 	
313 | 	$(".confirmDelete").click(function(){
314 |         return confirm("Are you sure you want to delete?");
315 |     })
316 | });
317 | </script>
318 | {% endblock additionalJavascript %}
319 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/error.html:
--------------------------------------------------------------------------------
 1 | {# Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED #}
 2 | 
 3 | {% extends "layout.base" %}
 4 | {% block content %}
 5 | <div>
 6 |     <p>Error {{ error.code }}</p>
 7 |     <p>({{ error.name }})</p>
 8 | </div>
 9 | {% endblock content %}
10 | {% set years = "2024" %}
11 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/index.html:
--------------------------------------------------------------------------------
 1 | {# Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED #}
 2 | 
 3 | {% set years = "2024" %}
 4 | 
 5 | {% extends "layout.base" %}
 6 | 
 7 | {% block additionalHeader %}
 8 | {% endblock additionalHeader %}
 9 | 
10 | {% block content %}
11 | <div class="ui-widget-content">
12 |     <h1>Welcome to PARSNIP!</h1>
13 |     <div id="content">
14 |         <h2 class="leftText">Overview</h2>
15 |         <div id="navigationOverview">
16 |             <p>General Overview Information</p>
17 |         </div>
18 |         <h2 class="leftText">Navigation</h2>
19 |         <div id="navigationContent">
20 |             <dl>
21 |                 <dt>File</dt>
22 |                 <dd>Allows import and export of save files (snapshots)</dd>
23 |                 
24 |                 <dt>Instructions</dt>
25 |                 <dd>This page</dd>
26 |                 
27 |                 <dt>Parser Configuration</dt>
28 |                 <dd>General Parser information: Name, TCP/UDP, ports, etc.</dd>
29 |                 
30 |                 <dt>View/Edit Components</dt>
31 |                 <dd>Direct access to top level components: Enums, Bitfields, Objects, and Choices</dd>
32 |                 
33 |                 <dt>Review</dt>
34 |                 <dd>Runs a series of checks related to the parser and provides feedback to the user</dd>
35 |                 
36 |                 <dt>Export Parsnip Files</dt>
37 |                 <dd>Exports a zip file of files to use with the Parsnip Backend to generate a parser.</dd>
38 |             </dl>
39 |         </div>
40 |         <h2 class="leftText">Review Limitations</h2>
41 |         <div id="reviewContent">
42 |             <p>Currently, the review checks for duplicate structures of the same type, duplicate fields/values within a specific structure, structures defined in multiple scopes, and checks for missing dependencies.</p>
43 |         </div>
44 |         <h2 class="leftText">Frontend Limitations</h2>
45 |         <div id="frontendLimitations">
46 |             <p>Currently, there are several concepts that are supported by the Parsnip language, but are not currently implemented in the frontend. Look at the syntax.md file in the docs folder of this repository for more information.</p>
47 |         </div>
48 |     </div>
49 | </div>
50 | {% endblock content %}
51 | 
52 | {% block additionalJavascript %}
53 | <script>
54 |   $(function() {
55 |     $( "#content" ).accordion({
56 |         active: false,
57 |         collapsible: true
58 |     });
59 |   });
60 | </script>
61 | {% endblock additionalJavascript %}
62 | 
63 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/layout.base:
--------------------------------------------------------------------------------
  1 | <!-- Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED -->
  2 | 
  3 | <!DOCTYPE html>
  4 | <html lang="en">
  5 |     <head>
  6 |         <!-- Required Meta Tags -->
  7 |         <meta charset="utf-8" />
  8 |         <meta name="viewport"
  9 |               content="width=device-width, initial-scale=1, shrink-to-fit=no" />
 10 | 
 11 |         <!-- Page Title -->
 12 |         {%- set actualTitle = "PARSNIP" -%}
 13 |         {%- if title -%}
 14 |             {%- set actualTitle = actualTitle + " - " + title -%}
 15 |         {%- endif -%}
 16 |         <title>{{actualTitle}}</title>
 17 | 
 18 |         <!-- Page Resources -->
 19 |         <!--<link rel="icon" href="{{ url_for('static', filename='favicon.png') }}" />-->
 20 |         <link rel="stylesheet" type="text/css" href="//code.jquery.com/ui/1.13.2/themes/humanity/jquery-ui.css" />
 21 |         <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='css/styles.css') }}" />
 22 |         <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='css/sm-core-css.css') }}" />
 23 |         <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='css/sm-custom.css') }}" />
 24 |         <!--<link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='css/jquery-confirm.min.css') }}" />-->
 25 |         
 26 |         {% block additionalHeader %}{% endblock additionalHeader %}
 27 |     </head>
 28 |     <body>
 29 |         <header role="banner" class="">
 30 |             <h1>PARSNIP</h1>
 31 |         </header>
 32 |         <nav role="navigation" class="">
 33 |             <ul id="mainMenu" class="sm sm-custom">
 34 |                 <li><a href="#">File</a>
 35 |                     <ul>
 36 |                         <li><a href="#" class="uploadSnapshotButton">Import Snapshot</a></li>
 37 |                         <li><a href="{{ url_for('main.exportData', exportType='snapshot') }}">Export Snapshot</a></li>
 38 |                     </ul>
 39 |                 </li>
 40 |                 <li><a href="{{ url_for('main.index') }}">Instructions</a></li>
 41 |                 <li><a href="{{ url_for('main.config') }}">Parser Configuration</a></li>
 42 |                 <li><a href="#">View/Edit Components</a>
 43 |                     <ul>
 44 |                         <li><a href="{{ url_for('main.enums') }}">Enums</a></li>
 45 |                         <li><a href="{{ url_for('main.bitfields') }}">Bitfields</a></li>
 46 |                         <li><a href="{{ url_for('main.objects') }}">Objects</a></li>
 47 |                         <li><a href="{{ url_for('main.switches') }}">Choices</a></li>
 48 |                     </ul>
 49 |                 </li>
 50 |                 <li><a href="{{ url_for('main.review') }}">Review</a></li>
 51 |                 <li><a href="{{ url_for('main.exportData',exportType='parsnip')}}">Export Parsnip Files</a></li>
 52 |                 <li><a href="{{ url_for('main.notice') }}">Notice</a></li>
 53 |             </ul>
 54 |         </nav>
 55 |         <hr />
 56 |         <main role="main" class="">
 57 |             {% block content %}{% endblock content %}
 58 |         </main>
 59 |         <footer role="contentinfo" class="">
 60 |             &copy; {{years}}, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED
 61 |         </footer>
 62 | 
 63 |         <!-- Dialogs -->
 64 | 
 65 |         <div id="uploadSnapshotDialog" class="dialog" title="Upload Snapshot">
 66 |             <form method="POST" action="{{ url_for('main.importData', importType='snapshot') }}" enctype="multipart/form-data">
 67 |                 {{ uploadSnapshotForm.csrf_token }}
 68 |                 
 69 |                 <!-- Snapshot File -->
 70 |                 <p class="fieldSet">
 71 |                     {{ uploadSnapshotForm.snapshot.label }}
 72 |                     {{ uploadSnapshotForm.snapshot }}
 73 |                 </p>
 74 |                 {% if uploadSnapshotForm.snapshot.error %}
 75 |                 <div class="ui-widget">
 76 | 	                <div class="ui-state-error ui-corner-all">
 77 | 		                <p class="errorLabel"><span class="ui-icon ui-icon-alert"></span>Error:</p>
 78 | 		                <ul class="errors">
 79 |                         {% for error in uploadSnapshotForm.snapshot.error %}
 80 |                             <li>{{ error }}</li>
 81 |                         {% endfor %}
 82 |                         </ul>
 83 | 	                </div>
 84 |                 </div>
 85 |                 {% endif %}
 86 |                 <!-- End Snapshot File -->
 87 |                 <input type="submit" value="Upload Snapshot" class="ui-button ui-widget ui-corner-all" />
 88 |             </form>
 89 |         </div>
 90 |         <!-- Javascript Includes -->
 91 |         <script src="//code.jquery.com/jquery-3.7.0.min.js" crossorigin="anonymous"></script>
 92 |         <script src="//code.jquery.com/ui/1.13.2/jquery-ui.min.js" crossorigin="anonymous"></script>
 93 |         <script src="{{ url_for('static', filename='js/jquery.smartmenus.js') }}"></script>
 94 |         <!--<script src="{{ url_for('static', filename='js/jquery-confirm.min.js') }}"></script> -->
 95 |         <script>
 96 |             const dialogInitializationValue =
 97 |             {
 98 |                 autoOpen: false,
 99 |                 width: 600
100 |             }
101 |             function loadForm(event, dialogID) {
102 |                 $("#" + dialogID).dialog( "open" );
103 |                 event.preventDefault();
104 |             }
105 |             $(function() {
106 |                 $('#mainMenu').smartmenus();
107 |                 
108 |                 const buttonsAndDialogs = ["uploadSnapshot"];
109 | 
110 | 	            for(let i = 0; i < buttonsAndDialogs.length; ++i)
111 | 	            {
112 | 	                let value = buttonsAndDialogs[i];
113 |                     $('#' + value + 'Dialog').dialog(dialogInitializationValue);
114 |                     $('.' + value + 'Button').click(function(event) {
115 |                         loadForm(event, value + 'Dialog');
116 |                     });
117 | 	            }
118 |             });
119 |         </script>
120 |         {% block additionalJavascript %}{% endblock additionalJavascript %}
121 |     </body>
122 | </html>
123 | 
124 | <!--
125 | vim: ai si syntax=html tabstop=4 shiftwidth=4 expandtab colorcolumn=81:
126 | -->
127 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/macros.j2:
--------------------------------------------------------------------------------
1 | {# Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED #}
2 | 
3 | {% macro removeLastURLPart(url) -%}
4 | {{ "/".join(url.split("/")[:-1]) }}
5 | {%- endmacro %}
6 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/notice.html:
--------------------------------------------------------------------------------
 1 | {# Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED #}
 2 | 
 3 | {% set years = "2024" %}
 4 | 
 5 | {% extends "layout.base" %}
 6 | 
 7 | {% block additionalHeader %}
 8 | {% endblock additionalHeader %}
 9 | 
10 | {% block content %}
11 | <div class="ui-widget-content">
12 |     <h1>Notice</h1>
13 |     <div id="content">
14 |         <p>This project contains code from Idaho National Laboratory's Industrial Control System Tradecraft &amp; Capabilities.</p>
15 |         <p>Licensed under BSD-3</p>
16 |         <p>&copy; 2024 Battelle Energy Alliance, LLC<br />ALL RIGHTS RESERVED</p>
17 |         <p>Prepared by Battelle Energy Alliance, LLC<br />Under Contract No. DE-AC07-05ID14517<br />With the U. S. Department of Energy</p>
18 |         <p>NOTICE:  This computer software was prepared by Battelle Energy Alliance, LLC, hereinafter the Contractor, under Contract No. AC07-05ID14517 with the United States (U. S.) Department of Energy (DOE).  This software was developed with funding from the Cybersecurity and Infrastructure Security Agency of the U.S. Department of Homeland Security. The Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. There is provision for the possible extension of the term of this license.  Subsequent to that period or any extension granted, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so.  The specific term of the license can be identified by inquiry made to Contractor or DOE.  NEITHER THE UNITED STATES NOR THE UNITED STATES DEPARTMENT OF ENERGY, NOR CONTRACTOR MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY OR RESPONSIBILITY FOR THE USE, ACCURACY, COMPLETENESS, OR USEFULNESS OR ANY INFORMATION, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS.</p>
19 |     </div>
20 | </div>
21 | {% endblock content %}
22 | 
23 | {% block additionalJavascript %}
24 | <script>
25 | </script>
26 | {% endblock additionalJavascript %}
27 | 
28 | 


--------------------------------------------------------------------------------
/frontend/app/parsnip/web/templates/review.html:
--------------------------------------------------------------------------------
 1 | {# Copyright 2024, Battelle Energy Alliance, LLC, ALL RIGHTS RESERVED #}
 2 | 
 3 | {% set years = "2024" %}
 4 | 
 5 | {% import 'macros.j2' as macros -%}
 6 | 
 7 | {% extends "layout.base" %}
 8 | 
 9 | {% block additionalHeader %}
10 | {% endblock additionalHeader %}
11 | 
12 | {% block content %}
13 | <div id="issues">
14 | {% for issue in issues %}
15 |     <div class='issueSection'>
16 |         <h3>Issue: {{ issue["title"] }}</h3>
17 |         <p>Type: {{ issue["type"] }}</p>
18 |         <p>Content: {{ issue["content"] }}</p>
19 |     </div>
20 | {% endfor %}
21 | </div>
22 | {% endblock content %}
23 | 
24 | {% block additionalJavascript %}
25 | {% endblock additionalJavascript %}
26 | 


--------------------------------------------------------------------------------
/frontend/removeSessions.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | 
3 | sudo rm -rf app/flask_session/*
4 | 


--------------------------------------------------------------------------------
/frontend/requirements.txt:
--------------------------------------------------------------------------------
 1 | # This file is used by pip to install required python packages
 2 | # Usage: pip install -r requirements.txt
 3 | 
 4 | # Explicit cachelib install to fix an issue with newer docker images
 5 | cachelib
 6 | 
 7 | # Flask Framework
 8 | flask
 9 | flask-wtf
10 | Flask-Session
11 | 


--------------------------------------------------------------------------------
/frontend/start_webServer.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # Copyright 2024, Battelle Energy Alliance, LLC All Rights Reserved
 4 | 
 5 | hostPort=5000
 6 | dockerPort=5000
 7 | # Routine Build
 8 | docker build -t flask-app .
 9 | # Build that forces everything to be new
10 | #docker build --force-rm --rm --no-cache -t flask-app .
11 | docker run -t -i -P --rm --entrypoint=/bin/bash -p $hostPort:$dockerPort -v $(pwd)/app:/opt/app:rw flask-app
12 | 


--------------------------------------------------------------------------------