Add Suricata

[satta]

This project lints correctly:

$ npx awesome-lint
✔ Linting
$

and has been out there for 30 days. Let's get it into the list! :)

https://github.com/satta/awesome-suricata#readme

This list contains resources in support of Suricata, a Free intrusion detection/prevention system and Network Security Monitoring engine. Suricata is a state of the art software tool that is used by many organizations, and that has spawned an active community of users and developers providing software, information and rulesets to support Suricata's mission.

As a member of that community, I compiled this list to gather these resources and create some visibility for the awesome projects out there!

My 2 reviews:

• Add Slack apps for developers #2391 (comment)
• Add Nim #2442 (comment)

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

• Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
• You have to review at least 2 other open pull requests.
  Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
• You have read and understood the instructions for creating a list.
• This pull request has a title in the format Add Name of List.
  • ✅ Add Swift
  • ✅ Add Software Architecture
  • ❌ Update readme.md
  • ❌ Add Awesome Swift
  • ❌ Add swift
  • ❌ add Swift
  • ❌ Adding Swift
  • ❌ Added Swift
• Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
  • ✅ - [iOS](…) - Mobile operating system for Apple phones and tablets.
  • ✅ - [Framer](…) - Prototyping interactive UI designs.
  • ❌ - [iOS](…) - Resources and tools for iOS development.
  • ❌ - [Framer](…)
  • ❌ - [Framer](…) - prototyping interactive UI designs
• Your entry should be added at the bottom of the appropriate category.
• The title of your entry should be title-cased and the URL to your list should end in #readme.
  • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
• The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

• Has been around for at least 30 days.
  That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
• Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
• Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
• The default branch should be named main, not master.
• Includes a succinct description of the project/theme at the top of the readme. (Example)
  • ✅ Mobile operating system for Apple phones and tablets.
  • ✅ Prototyping interactive UI designs.
  • ❌ Resources and tools for iOS development.
  • ❌ Awesome Framer packages and tools.
• It's the result of hard work and the best I could possibly produce.
  If you have not put in considerable effort into your list, your pull request will be immediately closed.
• The repo name of your list should be in lowercase slug format: awesome-name-of-list.
  • ✅ awesome-swift
  • ✅ awesome-web-typography
  • ❌ awesome-Swift
  • ❌ AwesomeWebTypography
• The heading title of your list should be in title case format: # Awesome Name of List.
  • ✅ # Awesome Swift
  • ✅ # Awesome Web Typography
  • ❌ # awesome-swift
  • ❌ # AwesomeSwift
• Non-generated Markdown file in a GitHub repo.
• The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
• Not a duplicate. Please search for existing submissions.
• Only has awesome items. Awesome lists are curations of the best, not everything.
• Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
• Includes a project logo/illustration whenever possible.
  • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
  • The image should link to the project website or any relevant website.
  • The image should be high-DPI. Set it to maximum half the width of the original image.
• Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
• Includes the Awesome badge.
  • Should be placed on the right side of the readme heading.
    • Can be placed centered if the list has a centered graphics header.
  • Should link back to this list.
• Has a Table of Contents section.
  • Should be named Contents, not Table of Contents.
  • Should be the first section in the list.
  • Should only have one level of nested lists, preferably none.
  • Must not feature Contributing or Footnotes sections.
• Has an appropriate license.
  • We strongly recommend the CC0 license, but any Creative Commons license will work.
    • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
  • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
  • Place a file named license or LICENSE in the repo root with the license text.
  • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
  • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
• Has contribution guidelines.
  • The file should be named contributing.md. Casing is up to you.
  • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
  • The section should not appear in the Table of Contents.
• All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
• Has consistent formatting and proper spelling/grammar.
  • The link and description are separated by a dash.
    Example: - [AVA](…) - JavaScript test runner.
  • The description starts with an uppercase character and ends with a period.
  • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
• Doesn't use hard-wrapping.
• Doesn't include a Travis badge.
  You can still use Travis for list linting, but the badge has no value in the readme.
• Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

[satta]

unicorn

[sindresorhus]

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

[satta]

Thanks! Awaiting reviews. 👍🏻

I noticed multiple things that are not followed

Huh. I can't find anything obvious, even after going through the list multiple times. Just to be safe, I did the following changes:

• Renamed LICENSE.md to LICENSE and changed to plain text. I wouldn't think that would change anything about the readability and information content, but if it's that important...
• Changed the wording in the description, by moving the text describing Suricata into the non-quoted text and using the quoted text to describe the list, as the other lists do.
• Removed the line mentioning that contributions are welcome.
• Removed the license badge. Badges are not mentioned in the requirements, but might be understood as "adding the license name".
• Used title casing for all headings, not just the list title.
• Change wording of the added line in this PR to only describe what Suricata is, not the list itself (i.e. remove the Anything... in front).

Note that there is no logo because I don't want to use possibly copyrighted project logos (that would potentially make the list look like it's officially created or endorsed by the project team) and the requirements just say "have a logo wherever possible" which does not sound like a hard requirement. If it is, please mention it explicitly.

If there's anything else, just let me know.

[satta]

After reaching out to the OISF/Suricata team and confirming that I am permitted to use it, provided I do not alter the logo in any way, I now also added a logo including a link back to the Suricata home page https://suricata.io.

[satta]

Just resolved the merge conflict that came up in the meantime.

I am curious: Any other feedback so far? Is there anything else I can do to move this forward?

[satta]

Hello? Does anyone actually check any updates here?

From what I can see, I have addressed all points in the requirements that might be debatable even in the slightest sense. If there is anything left for me to do, please let me know. A one-word pointer would do, no need for any detailed explanation.

[claire-lex]

The list seems to follow the requirements.
It would be good to explicitly state the words IDS and IPS, as acronyms can be confusing.

[satta]

The list seems to follow the requirements. It would be good to explicitly state the words IDS and IPS, as acronyms can be confusing.

Thanks a lot for the review, I was already thinking this was stalled :)
Sure, I will make sure to explain these acronyms -> Done in the list!

If you're happy with the list now, could you also please approve this PR to have it count against some minimum approval requirements to be considered to merge?

[sindresorhus]

Linkify Suricata in Suricata is a free intrusion detection/prevention system (IDS/IPS) and network security monitoring engine. to its website.

[satta]

Linkify Suricata in Suricata is a free intrusion detection/prevention system (IDS/IPS) and network security monitoring engine. to its website.

Done.

[sindresorhus]

Tweet: https://twitter.com/awesome__re/status/1671458477661736960

[satta]

Thanks a lot for making this happen!