Rule packages
Manage rule packages
Rule packages combine one or more rules into a file. There are four different types of rule packages in mosparo. Two of the types are automatically updated (load automatically from URL or file), while the other two are updated manually via CLI command or an API request.
To add a new rule package, you choose "Add rule package" in the rule package interface. After that, you have to select the type.
After choosing the type, you have to fill in all the information for the rule package. For the automatic rule packages, you have to set the path or URL. You can also specify a factor that can be used to strengthen or weaken the rule package.
After a rule package is added, you can view the rule package. If you choose a manual rule package type, you first need to import the rule package content depending on the selected type. To import the rule package via CLI, see CLI. To import the rule package via API, you find all the details in the API documentation.
Since the rule package is created in a different place and delivered to your mosparo installation, you cannot edit or delete the rules in the rules package.
Format of rule packages
Saving the rule package
A rule package is a JSON file. The JSON file must conform to the rule package and rules pattern. The schema for the rule package and the rules are available in the specifications repository.
In addition to the JSON file, you must store the checksum of the JSON file in the same location. The SHA256 hash of the file must be created and saved with the same file name but with the suffix ".sha256".
Address of the rule package (entered in mosparo)
https://example.com/rulepackage.json
/home/mosparo/my-rulepackage.json
Checksum address:
https://example.com/rulepackage.json.sha256
/home/mosparo/my-rulepackage.json.sha256
Structure of a rule package
The JSON structure of the rule package is built as a JSON object. The object has the following properties:
| Property | Type | Description |
|---|---|---|
| lastUpdatedAt | DateTime | Indicates when the rule package was last modified. This value is used to decide whether mosparo needs to update the rule package or if the latest version is already available. |
| refreshInterval | Integer | Defines the time in seconds when mosparo is allowed to retrieve the rule package again. mosparo stores the rule package in a cache and the rule package is downloaded again only after this time. |
| rules | Array | Is an array that contains all rules as a JSON object |
Building a rule
A rule's JSON object consists of the following properties:
| Property | Type | Description |
|---|---|---|
| uuid | UUID | A unique identification number of the rule |
| name | String | Name of the rule |
| description | String | Description of the rule |
| type | String | Type of rule (for example: word or user-agent) |
| items | Array | Array with all rule item |
| spamRatingFactor | Float | Rating factor of the rule to strengthen or weaken the rule items. A value greater than 1.0 strengthens the items, and a value less than 1.0 weakens the items. |
Structure of a rule item
The JSON object of a rule item consists of the following properties:
| Property | Type | Description |
|---|---|---|
| uuid | UUID | A unique identification number of the rule item |
| type | String | Defines the type of rule (for example: text or regex) |
| value | String | The actual value of the item |
| rating | Float | Defines the spam value of the item. This value is multiplied by the spam score to give the submission score. |