Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.26 KB

MAPL_ENGINE.md

File metadata and controls

52 lines (39 loc) · 2.26 KB
Raw

MAPL Engine

Overview

The MAPL Engine is a go library that provides functionality to parse and verify rules written in MAPL as described in the MAPL Specification.

Installation

go get -u -v github.com/octarinesec/MAPL

Use of the Engine

  • The main functionality of the Engine is the check function:
result, msg, _, _, _, _, _ := MAPL_engine.Check(&message, &rules)
  • The Engine provides ability to read MAPL rules from yaml files:
rules, err := MAPL_engine.YamlReadRulesFromFile(rulesFilename)

  • The Check function uses regular expressions in order to support wildcards and lists as described in the MAPL Specification. Therefore, after reading the rules from the input file, the relevant fields are converted to regular expressions using convertStringToRegex and convertOperationStringToRegex functions.

  • The Engine provides ability to read message attributes from yaml files (for testing purposes):

messages, err := MAPL_engine.YamlReadMessagesFromFile(messagesFilename)

  • After reading the messages from the input file, some fields are parsed and added as message attributes (for example, requestTimeHoursFromMidnightUTC is extracted from message.RequestTime). When message attributes are created by a different method (for example, getting the attributes from a seperate process as in the [Istio mixer adapter](insert link here)) attention is needed to parse and add them in that process.

  • one-attribute-conditions are tested in testOneCondition function. The value to compare is extracted there from the message attributes. For example in the case of "payloadSize"

valueToCompareInt = message.RequestSize

The list of supported message attributes to be used in the conditions is given in Supported Attributes document.

Data Structures

The rules and message attributes data structures are defined in definitions.go

Examples