ids-rule-converter 4.0.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ids_rule_converter-4.0.2/LICENSE +201 -0
- ids_rule_converter-4.0.2/PKG-INFO +240 -0
- ids_rule_converter-4.0.2/README.md +216 -0
- ids_rule_converter-4.0.2/ids_rule_converter.egg-info/PKG-INFO +240 -0
- ids_rule_converter-4.0.2/ids_rule_converter.egg-info/SOURCES.txt +12 -0
- ids_rule_converter-4.0.2/ids_rule_converter.egg-info/dependency_links.txt +1 -0
- ids_rule_converter-4.0.2/ids_rule_converter.egg-info/entry_points.txt +2 -0
- ids_rule_converter-4.0.2/ids_rule_converter.egg-info/top_level.txt +1 -0
- ids_rule_converter-4.0.2/pyproject.toml +51 -0
- ids_rule_converter-4.0.2/setup.cfg +4 -0
- ids_rule_converter-4.0.2/snort_suricata_rule_converter.py +3177 -0
- ids_rule_converter-4.0.2/tests/test_readme_visual.py +44 -0
- ids_rule_converter-4.0.2/tests/test_release.py +143 -0
- ids_rule_converter-4.0.2/tests/test_snort_suricata_rule_converter.py +621 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Fusion Technology Strategies
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ids-rule-converter
|
|
3
|
+
Version: 4.0.2
|
|
4
|
+
Summary: Loss-aware Snort and Suricata rule conversion toolkit
|
|
5
|
+
Author: Fusion Technology Strategies
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/fusiontechstrategies/IDS-Rule-Converter
|
|
8
|
+
Project-URL: Issues, https://github.com/fusiontechstrategies/IDS-Rule-Converter/issues
|
|
9
|
+
Classifier: Environment :: Console
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Intended Audience :: Information Technology
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
19
|
+
Classifier: Topic :: Security
|
|
20
|
+
Requires-Python: <3.15,>=3.10
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Dynamic: license-file
|
|
24
|
+
|
|
25
|
+
# IDS Rule Converter
|
|
26
|
+
|
|
27
|
+
[](https://github.com/fusiontechstrategies/IDS-Rule-Converter/actions/workflows/ci.yml)
|
|
28
|
+
[](https://github.com/fusiontechstrategies/IDS-Rule-Converter/actions/workflows/engine-validation.yml)
|
|
29
|
+
[](https://github.com/fusiontechstrategies/IDS-Rule-Converter/actions/workflows/security.yml)
|
|
30
|
+
[](LICENSE)
|
|
31
|
+
|
|
32
|
+
Stop guessing whether a converted IDS rule still means the same thing.
|
|
33
|
+
|
|
34
|
+
IDS Rule Converter is a secure, loss-aware, one-file Python toolkit for parsing,
|
|
35
|
+
validating, analyzing, comparing, and converting Snort and Suricata rules. It
|
|
36
|
+
defaults to refusing uncertain translations instead of silently dropping or
|
|
37
|
+
weakening detection logic.
|
|
38
|
+
|
|
39
|
+
The runtime has no third-party Python dependencies. Copy
|
|
40
|
+
`snort_suricata_rule_converter.py` to a system with Python 3.10 or newer and run
|
|
41
|
+
it directly.
|
|
42
|
+
|
|
43
|
+
Version 4.0.1 is the current release. Download the verified
|
|
44
|
+
[standalone Python runtime](https://github.com/fusiontechstrategies/IDS-Rule-Converter/releases/download/v4.0.1/IDS-Rule-Converter-v4.0.1.py)
|
|
45
|
+
or the deterministic
|
|
46
|
+
[documentation ZIP](https://github.com/fusiontechstrategies/IDS-Rule-Converter/releases/download/v4.0.1/IDS-Rule-Converter-v4.0.1.zip).
|
|
47
|
+
The [release page](https://github.com/fusiontechstrategies/IDS-Rule-Converter/releases/tag/v4.0.1)
|
|
48
|
+
also provides the SPDX SBOM, SHA-256 checksums, release evidence, and GitHub
|
|
49
|
+
provenance. See [RELEASING.md](RELEASING.md) for the exact artifact and
|
|
50
|
+
publication gates.
|
|
51
|
+
|
|
52
|
+
## Why this tool is different
|
|
53
|
+
|
|
54
|
+
Rule conversion is not a keyword replacement problem. Sticky buffers, content
|
|
55
|
+
modifier placement, service declarations, application protocols, regular
|
|
56
|
+
expressions, and engine-specific actions all affect detection behavior.
|
|
57
|
+
|
|
58
|
+
IDS Rule Converter provides:
|
|
59
|
+
|
|
60
|
+
- Ordered parsing that preserves repeated options and content modifier context
|
|
61
|
+
- Strict, fail-safe conversion between Snort 2, Snort 3, and Suricata 8
|
|
62
|
+
- Explicit rejection files and machine-readable reports for unsafe rules
|
|
63
|
+
- Native JSON and SARIF output for automation and code scanning systems
|
|
64
|
+
- Duplicate SID, conflicting SID, keyword, protocol, and action analysis
|
|
65
|
+
- Semantic ruleset comparison by GID, SID, revision, and fingerprint
|
|
66
|
+
- Offline Panorama IPS Signature Converter 2.0.4 compatibility preflight
|
|
67
|
+
- Safe download support for allowlisted Cisco Talos community feeds
|
|
68
|
+
- Archive defenses against traversal, links, special files, duplicate paths,
|
|
69
|
+
encrypted ZIP entries, Windows device names, and decompression abuse
|
|
70
|
+
- Atomic output writes, overwrite refusal, and input replacement protection
|
|
71
|
+
- No telemetry and no implicit network access
|
|
72
|
+
|
|
73
|
+
## Quick start
|
|
74
|
+
|
|
75
|
+
```text
|
|
76
|
+
python snort_suricata_rule_converter.py --help
|
|
77
|
+
python snort_suricata_rule_converter.py validate input.rules
|
|
78
|
+
python snort_suricata_rule_converter.py analyze input.rules --output analysis.json
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Convert a Snort 3 ruleset to Suricata. Strict mode is the default, so no ruleset
|
|
82
|
+
is written if any rule has an unsafe or unverified mapping.
|
|
83
|
+
|
|
84
|
+
```text
|
|
85
|
+
python snort_suricata_rule_converter.py convert input.rules --source-dialect snort3 --target suricata --output converted.rules --report conversion.json
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
To export only the verified subset, preserve every rejected source rule, and
|
|
89
|
+
receive a detailed report:
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
python snort_suricata_rule_converter.py convert input.rules --source-dialect snort3 --target suricata --output accepted.rules --allow-partial --rejected-output rejected.rules --report conversion.json
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
An intentional partial result exits with code 2 so automation cannot mistake it
|
|
96
|
+
for a complete conversion.
|
|
97
|
+
|
|
98
|
+
### Strict and reviewed partial results
|
|
99
|
+
|
|
100
|
+

|
|
101
|
+
|
|
102
|
+
Constructed test data. Strict mode writes no converted ruleset when one mapping
|
|
103
|
+
is unsafe. An explicit partial export preserves accepted rules, rejected source
|
|
104
|
+
rules, and the report as one review set. Native target validation is still
|
|
105
|
+
required.
|
|
106
|
+
|
|
107
|
+
## Commands
|
|
108
|
+
|
|
109
|
+
| Command | Purpose |
|
|
110
|
+
| --- | --- |
|
|
111
|
+
| `validate` | Parse rules and report structural or identifier problems |
|
|
112
|
+
| `analyze` | Inventory rules, keywords, actions, protocols, duplicates, and conflicts |
|
|
113
|
+
| `convert` | Convert to Snort 2, Snort 3, Suricata, or structured JSON |
|
|
114
|
+
| `panorama-preflight` | Check and batch rules for Panorama plugin 2.0.4 |
|
|
115
|
+
| `diff` | Compare two rulesets by GID and SID |
|
|
116
|
+
| `list-sources` | Show built-in HTTPS feed definitions |
|
|
117
|
+
| `fetch` | Download and optionally extract an allowlisted rule feed safely |
|
|
118
|
+
|
|
119
|
+
See [QUICK_REFERENCE.md](QUICK_REFERENCE.md) for copy-ready examples.
|
|
120
|
+
|
|
121
|
+
## Conversion safety model
|
|
122
|
+
|
|
123
|
+
The default behavior is intentionally conservative:
|
|
124
|
+
|
|
125
|
+
1. The complete input must parse successfully.
|
|
126
|
+
2. Each rule is checked against the declared target dialect.
|
|
127
|
+
3. Verified transformations preserve option order and buffer context.
|
|
128
|
+
4. A rule with an unsafe mapping is rejected, not approximated.
|
|
129
|
+
5. Strict conversion writes nothing when any rule is rejected.
|
|
130
|
+
6. Partial conversion requires both a rejection file and a JSON report.
|
|
131
|
+
7. Unknown target keywords require the explicit `--allow-unverified` opt-out.
|
|
132
|
+
|
|
133
|
+
Important verified transformations include Snort 3 and Suricata HTTP sticky
|
|
134
|
+
buffers, Snort 2 HTTP content modifiers, safe service mappings, TLS protocol
|
|
135
|
+
naming, selected SIP options, `bufferlen` to `bsize`, `stream_size` syntax,
|
|
136
|
+
fast-pattern offsets, and compatible tag syntax.
|
|
137
|
+
|
|
138
|
+
The converter rejects ambiguous multi-service rules, unsupported target actions,
|
|
139
|
+
conflicting application protocols, unsafe buffer arguments, packet and
|
|
140
|
+
application-layer conflicts, unsupported BER and DCE options, and other cases
|
|
141
|
+
where equivalence has not been established.
|
|
142
|
+
|
|
143
|
+
Always run the target engine's native configuration test before deployment.
|
|
144
|
+
Successful parsing proves that an engine accepts a rule. It does not prove that
|
|
145
|
+
every rule will detect identical traffic under every engine configuration.
|
|
146
|
+
|
|
147
|
+
## Panorama preflight
|
|
148
|
+
|
|
149
|
+
The Panorama command performs an offline compatibility review for IPS Signature
|
|
150
|
+
Converter plugin 2.0.4. It checks documented action, protocol, condition, PCRE,
|
|
151
|
+
threshold, reference, case-sensitivity, negation, and positional limits. Accepted
|
|
152
|
+
source rules are divided into batches of no more than 100 rules and 8 MB.
|
|
153
|
+
|
|
154
|
+
```text
|
|
155
|
+
python snort_suricata_rule_converter.py panorama-preflight input.rules --output-dir panorama-review
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
The tool never connects to Panorama and never uploads a rule.
|
|
159
|
+
|
|
160
|
+
## Safe feed retrieval
|
|
161
|
+
|
|
162
|
+
Network access occurs only when `fetch` is explicitly invoked. Built-in sources
|
|
163
|
+
use HTTPS and an exact hostname allowlist. Redirects outside that allowlist are
|
|
164
|
+
refused.
|
|
165
|
+
|
|
166
|
+
```text
|
|
167
|
+
python snort_suricata_rule_converter.py list-sources
|
|
168
|
+
python snort_suricata_rule_converter.py fetch --source snort3-community --output-dir downloads --extract
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
The downloaded archive, SHA-256 metadata, and extracted files are local outputs.
|
|
172
|
+
Rules remain subject to their provider's terms and are not part of this project's
|
|
173
|
+
Apache 2.0 license.
|
|
174
|
+
|
|
175
|
+
## Test evidence
|
|
176
|
+
|
|
177
|
+
The 4.0.1 release-readiness tree contains 64 automated tests covering parsing,
|
|
178
|
+
conversion, reports, Panorama checks, overwrite controls, URL and redirect
|
|
179
|
+
policy, malicious archives, repository text policy, and deterministic release
|
|
180
|
+
construction. CI exercises Python 3.10 through 3.14 on Linux, Python 3.12 on
|
|
181
|
+
Windows and macOS, and both conversion directions against pinned Snort 3.10.0.0
|
|
182
|
+
and Suricata 8.0.6 containers.
|
|
183
|
+
|
|
184
|
+
The larger 4,017-rule Cisco Talos community corpus was validated for version
|
|
185
|
+
4.0.0. Snort accepted the full same-dialect round trip with zero warnings. The
|
|
186
|
+
fail-safe Suricata conversion accepted 3,762 rules, rejected 255 with recorded
|
|
187
|
+
reasons, and passed native validation with zero errors. Suricata emitted 71
|
|
188
|
+
nonfatal duplicate-buffer warnings for source patterns that intentionally revisit
|
|
189
|
+
an earlier sticky buffer.
|
|
190
|
+
|
|
191
|
+
Version 4.0.1 changes output-file race handling, feed URL validation, repository
|
|
192
|
+
controls, and release construction. It does not change conversion semantics. The
|
|
193
|
+
large third-party corpus has not been rerun for the candidate, so its result is
|
|
194
|
+
kept explicitly separate from the current hosted native-fixture checks. Full
|
|
195
|
+
commands, container digests, and scope are recorded in
|
|
196
|
+
[docs/TESTING.md](docs/TESTING.md).
|
|
197
|
+
|
|
198
|
+
## Exit codes
|
|
199
|
+
|
|
200
|
+
| Code | Meaning |
|
|
201
|
+
| --- | --- |
|
|
202
|
+
| `0` | Operation completed without blocking findings |
|
|
203
|
+
| `1` | Operational failure, unsafe path, network failure, or invalid invocation |
|
|
204
|
+
| `2` | Validation findings, conflicts, rejected rules, or an intentional partial result |
|
|
205
|
+
| `130` | Interrupted by the operator |
|
|
206
|
+
|
|
207
|
+
## Development
|
|
208
|
+
|
|
209
|
+
```text
|
|
210
|
+
python -m pip install -r requirements-dev.txt
|
|
211
|
+
python -m ruff format --check .
|
|
212
|
+
python -m ruff check .
|
|
213
|
+
python -m bandit -q -r snort_suricata_rule_converter.py scripts
|
|
214
|
+
python -m pip_audit -r requirements-dev.txt
|
|
215
|
+
python -m unittest discover -s tests -v
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
The production runtime remains one file. Tests, documentation, and repository
|
|
219
|
+
automation are separate so the executable itself stays portable.
|
|
220
|
+
|
|
221
|
+
## Security and privacy
|
|
222
|
+
|
|
223
|
+
- Rule files are processed locally.
|
|
224
|
+
- The tool contains no credentials, tokens, account IDs, or environment-specific
|
|
225
|
+
resource names.
|
|
226
|
+
- Output files are UTF-8 and written atomically.
|
|
227
|
+
- Existing outputs are refused unless `--force` is supplied.
|
|
228
|
+
- `--force` cannot replace an input file.
|
|
229
|
+
- Report suspected vulnerabilities through the private process in
|
|
230
|
+
[SECURITY.md](SECURITY.md).
|
|
231
|
+
|
|
232
|
+
## License
|
|
233
|
+
|
|
234
|
+
The converter, tests, and project documentation are licensed under the Apache
|
|
235
|
+
License 2.0. Third-party rules, vendor documents, and downloaded feeds are not
|
|
236
|
+
redistributed by this repository and retain their original terms.
|
|
237
|
+
|
|
238
|
+
Snort is a registered trademark of Cisco. Suricata is a registered trademark of
|
|
239
|
+
the Open Information Security Foundation. This project is independent and is not
|
|
240
|
+
endorsed by either organization.
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
# IDS Rule Converter
|
|
2
|
+
|
|
3
|
+
[](https://github.com/fusiontechstrategies/IDS-Rule-Converter/actions/workflows/ci.yml)
|
|
4
|
+
[](https://github.com/fusiontechstrategies/IDS-Rule-Converter/actions/workflows/engine-validation.yml)
|
|
5
|
+
[](https://github.com/fusiontechstrategies/IDS-Rule-Converter/actions/workflows/security.yml)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
|
|
8
|
+
Stop guessing whether a converted IDS rule still means the same thing.
|
|
9
|
+
|
|
10
|
+
IDS Rule Converter is a secure, loss-aware, one-file Python toolkit for parsing,
|
|
11
|
+
validating, analyzing, comparing, and converting Snort and Suricata rules. It
|
|
12
|
+
defaults to refusing uncertain translations instead of silently dropping or
|
|
13
|
+
weakening detection logic.
|
|
14
|
+
|
|
15
|
+
The runtime has no third-party Python dependencies. Copy
|
|
16
|
+
`snort_suricata_rule_converter.py` to a system with Python 3.10 or newer and run
|
|
17
|
+
it directly.
|
|
18
|
+
|
|
19
|
+
Version 4.0.1 is the current release. Download the verified
|
|
20
|
+
[standalone Python runtime](https://github.com/fusiontechstrategies/IDS-Rule-Converter/releases/download/v4.0.1/IDS-Rule-Converter-v4.0.1.py)
|
|
21
|
+
or the deterministic
|
|
22
|
+
[documentation ZIP](https://github.com/fusiontechstrategies/IDS-Rule-Converter/releases/download/v4.0.1/IDS-Rule-Converter-v4.0.1.zip).
|
|
23
|
+
The [release page](https://github.com/fusiontechstrategies/IDS-Rule-Converter/releases/tag/v4.0.1)
|
|
24
|
+
also provides the SPDX SBOM, SHA-256 checksums, release evidence, and GitHub
|
|
25
|
+
provenance. See [RELEASING.md](RELEASING.md) for the exact artifact and
|
|
26
|
+
publication gates.
|
|
27
|
+
|
|
28
|
+
## Why this tool is different
|
|
29
|
+
|
|
30
|
+
Rule conversion is not a keyword replacement problem. Sticky buffers, content
|
|
31
|
+
modifier placement, service declarations, application protocols, regular
|
|
32
|
+
expressions, and engine-specific actions all affect detection behavior.
|
|
33
|
+
|
|
34
|
+
IDS Rule Converter provides:
|
|
35
|
+
|
|
36
|
+
- Ordered parsing that preserves repeated options and content modifier context
|
|
37
|
+
- Strict, fail-safe conversion between Snort 2, Snort 3, and Suricata 8
|
|
38
|
+
- Explicit rejection files and machine-readable reports for unsafe rules
|
|
39
|
+
- Native JSON and SARIF output for automation and code scanning systems
|
|
40
|
+
- Duplicate SID, conflicting SID, keyword, protocol, and action analysis
|
|
41
|
+
- Semantic ruleset comparison by GID, SID, revision, and fingerprint
|
|
42
|
+
- Offline Panorama IPS Signature Converter 2.0.4 compatibility preflight
|
|
43
|
+
- Safe download support for allowlisted Cisco Talos community feeds
|
|
44
|
+
- Archive defenses against traversal, links, special files, duplicate paths,
|
|
45
|
+
encrypted ZIP entries, Windows device names, and decompression abuse
|
|
46
|
+
- Atomic output writes, overwrite refusal, and input replacement protection
|
|
47
|
+
- No telemetry and no implicit network access
|
|
48
|
+
|
|
49
|
+
## Quick start
|
|
50
|
+
|
|
51
|
+
```text
|
|
52
|
+
python snort_suricata_rule_converter.py --help
|
|
53
|
+
python snort_suricata_rule_converter.py validate input.rules
|
|
54
|
+
python snort_suricata_rule_converter.py analyze input.rules --output analysis.json
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Convert a Snort 3 ruleset to Suricata. Strict mode is the default, so no ruleset
|
|
58
|
+
is written if any rule has an unsafe or unverified mapping.
|
|
59
|
+
|
|
60
|
+
```text
|
|
61
|
+
python snort_suricata_rule_converter.py convert input.rules --source-dialect snort3 --target suricata --output converted.rules --report conversion.json
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
To export only the verified subset, preserve every rejected source rule, and
|
|
65
|
+
receive a detailed report:
|
|
66
|
+
|
|
67
|
+
```text
|
|
68
|
+
python snort_suricata_rule_converter.py convert input.rules --source-dialect snort3 --target suricata --output accepted.rules --allow-partial --rejected-output rejected.rules --report conversion.json
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
An intentional partial result exits with code 2 so automation cannot mistake it
|
|
72
|
+
for a complete conversion.
|
|
73
|
+
|
|
74
|
+
### Strict and reviewed partial results
|
|
75
|
+
|
|
76
|
+

|
|
77
|
+
|
|
78
|
+
Constructed test data. Strict mode writes no converted ruleset when one mapping
|
|
79
|
+
is unsafe. An explicit partial export preserves accepted rules, rejected source
|
|
80
|
+
rules, and the report as one review set. Native target validation is still
|
|
81
|
+
required.
|
|
82
|
+
|
|
83
|
+
## Commands
|
|
84
|
+
|
|
85
|
+
| Command | Purpose |
|
|
86
|
+
| --- | --- |
|
|
87
|
+
| `validate` | Parse rules and report structural or identifier problems |
|
|
88
|
+
| `analyze` | Inventory rules, keywords, actions, protocols, duplicates, and conflicts |
|
|
89
|
+
| `convert` | Convert to Snort 2, Snort 3, Suricata, or structured JSON |
|
|
90
|
+
| `panorama-preflight` | Check and batch rules for Panorama plugin 2.0.4 |
|
|
91
|
+
| `diff` | Compare two rulesets by GID and SID |
|
|
92
|
+
| `list-sources` | Show built-in HTTPS feed definitions |
|
|
93
|
+
| `fetch` | Download and optionally extract an allowlisted rule feed safely |
|
|
94
|
+
|
|
95
|
+
See [QUICK_REFERENCE.md](QUICK_REFERENCE.md) for copy-ready examples.
|
|
96
|
+
|
|
97
|
+
## Conversion safety model
|
|
98
|
+
|
|
99
|
+
The default behavior is intentionally conservative:
|
|
100
|
+
|
|
101
|
+
1. The complete input must parse successfully.
|
|
102
|
+
2. Each rule is checked against the declared target dialect.
|
|
103
|
+
3. Verified transformations preserve option order and buffer context.
|
|
104
|
+
4. A rule with an unsafe mapping is rejected, not approximated.
|
|
105
|
+
5. Strict conversion writes nothing when any rule is rejected.
|
|
106
|
+
6. Partial conversion requires both a rejection file and a JSON report.
|
|
107
|
+
7. Unknown target keywords require the explicit `--allow-unverified` opt-out.
|
|
108
|
+
|
|
109
|
+
Important verified transformations include Snort 3 and Suricata HTTP sticky
|
|
110
|
+
buffers, Snort 2 HTTP content modifiers, safe service mappings, TLS protocol
|
|
111
|
+
naming, selected SIP options, `bufferlen` to `bsize`, `stream_size` syntax,
|
|
112
|
+
fast-pattern offsets, and compatible tag syntax.
|
|
113
|
+
|
|
114
|
+
The converter rejects ambiguous multi-service rules, unsupported target actions,
|
|
115
|
+
conflicting application protocols, unsafe buffer arguments, packet and
|
|
116
|
+
application-layer conflicts, unsupported BER and DCE options, and other cases
|
|
117
|
+
where equivalence has not been established.
|
|
118
|
+
|
|
119
|
+
Always run the target engine's native configuration test before deployment.
|
|
120
|
+
Successful parsing proves that an engine accepts a rule. It does not prove that
|
|
121
|
+
every rule will detect identical traffic under every engine configuration.
|
|
122
|
+
|
|
123
|
+
## Panorama preflight
|
|
124
|
+
|
|
125
|
+
The Panorama command performs an offline compatibility review for IPS Signature
|
|
126
|
+
Converter plugin 2.0.4. It checks documented action, protocol, condition, PCRE,
|
|
127
|
+
threshold, reference, case-sensitivity, negation, and positional limits. Accepted
|
|
128
|
+
source rules are divided into batches of no more than 100 rules and 8 MB.
|
|
129
|
+
|
|
130
|
+
```text
|
|
131
|
+
python snort_suricata_rule_converter.py panorama-preflight input.rules --output-dir panorama-review
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
The tool never connects to Panorama and never uploads a rule.
|
|
135
|
+
|
|
136
|
+
## Safe feed retrieval
|
|
137
|
+
|
|
138
|
+
Network access occurs only when `fetch` is explicitly invoked. Built-in sources
|
|
139
|
+
use HTTPS and an exact hostname allowlist. Redirects outside that allowlist are
|
|
140
|
+
refused.
|
|
141
|
+
|
|
142
|
+
```text
|
|
143
|
+
python snort_suricata_rule_converter.py list-sources
|
|
144
|
+
python snort_suricata_rule_converter.py fetch --source snort3-community --output-dir downloads --extract
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
The downloaded archive, SHA-256 metadata, and extracted files are local outputs.
|
|
148
|
+
Rules remain subject to their provider's terms and are not part of this project's
|
|
149
|
+
Apache 2.0 license.
|
|
150
|
+
|
|
151
|
+
## Test evidence
|
|
152
|
+
|
|
153
|
+
The 4.0.1 release-readiness tree contains 64 automated tests covering parsing,
|
|
154
|
+
conversion, reports, Panorama checks, overwrite controls, URL and redirect
|
|
155
|
+
policy, malicious archives, repository text policy, and deterministic release
|
|
156
|
+
construction. CI exercises Python 3.10 through 3.14 on Linux, Python 3.12 on
|
|
157
|
+
Windows and macOS, and both conversion directions against pinned Snort 3.10.0.0
|
|
158
|
+
and Suricata 8.0.6 containers.
|
|
159
|
+
|
|
160
|
+
The larger 4,017-rule Cisco Talos community corpus was validated for version
|
|
161
|
+
4.0.0. Snort accepted the full same-dialect round trip with zero warnings. The
|
|
162
|
+
fail-safe Suricata conversion accepted 3,762 rules, rejected 255 with recorded
|
|
163
|
+
reasons, and passed native validation with zero errors. Suricata emitted 71
|
|
164
|
+
nonfatal duplicate-buffer warnings for source patterns that intentionally revisit
|
|
165
|
+
an earlier sticky buffer.
|
|
166
|
+
|
|
167
|
+
Version 4.0.1 changes output-file race handling, feed URL validation, repository
|
|
168
|
+
controls, and release construction. It does not change conversion semantics. The
|
|
169
|
+
large third-party corpus has not been rerun for the candidate, so its result is
|
|
170
|
+
kept explicitly separate from the current hosted native-fixture checks. Full
|
|
171
|
+
commands, container digests, and scope are recorded in
|
|
172
|
+
[docs/TESTING.md](docs/TESTING.md).
|
|
173
|
+
|
|
174
|
+
## Exit codes
|
|
175
|
+
|
|
176
|
+
| Code | Meaning |
|
|
177
|
+
| --- | --- |
|
|
178
|
+
| `0` | Operation completed without blocking findings |
|
|
179
|
+
| `1` | Operational failure, unsafe path, network failure, or invalid invocation |
|
|
180
|
+
| `2` | Validation findings, conflicts, rejected rules, or an intentional partial result |
|
|
181
|
+
| `130` | Interrupted by the operator |
|
|
182
|
+
|
|
183
|
+
## Development
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
python -m pip install -r requirements-dev.txt
|
|
187
|
+
python -m ruff format --check .
|
|
188
|
+
python -m ruff check .
|
|
189
|
+
python -m bandit -q -r snort_suricata_rule_converter.py scripts
|
|
190
|
+
python -m pip_audit -r requirements-dev.txt
|
|
191
|
+
python -m unittest discover -s tests -v
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
The production runtime remains one file. Tests, documentation, and repository
|
|
195
|
+
automation are separate so the executable itself stays portable.
|
|
196
|
+
|
|
197
|
+
## Security and privacy
|
|
198
|
+
|
|
199
|
+
- Rule files are processed locally.
|
|
200
|
+
- The tool contains no credentials, tokens, account IDs, or environment-specific
|
|
201
|
+
resource names.
|
|
202
|
+
- Output files are UTF-8 and written atomically.
|
|
203
|
+
- Existing outputs are refused unless `--force` is supplied.
|
|
204
|
+
- `--force` cannot replace an input file.
|
|
205
|
+
- Report suspected vulnerabilities through the private process in
|
|
206
|
+
[SECURITY.md](SECURITY.md).
|
|
207
|
+
|
|
208
|
+
## License
|
|
209
|
+
|
|
210
|
+
The converter, tests, and project documentation are licensed under the Apache
|
|
211
|
+
License 2.0. Third-party rules, vendor documents, and downloaded feeds are not
|
|
212
|
+
redistributed by this repository and retain their original terms.
|
|
213
|
+
|
|
214
|
+
Snort is a registered trademark of Cisco. Suricata is a registered trademark of
|
|
215
|
+
the Open Information Security Foundation. This project is independent and is not
|
|
216
|
+
endorsed by either organization.
|