Skip to content
This repository was archived by the owner on Jun 4, 2025. It is now read-only.

penguinite/nim-fp-suite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Antivirus False Positive Reduction Suite. (nim-fp-suite)

Migration notice: The git repository for this project has been moved to https://codeberg.org/penguinite/nim-fp-suite, this link will still work but any new updates or data won't make it here. Consider migrating to the link above.


A set of programs and files to generate emails which will be sent to antivirus companies to (hopefully) reduce false positives in the long run.

2025 Update

This code has been updated, and it should be way cleaner now. Although there are still a couple of pain spots.

How to use

This single repository includes a suite of programs each designed for a specific task. Each one can be ran with nimble run PROGRAM where PROGRAM is one of the following:

  • rescan: This issues "re-analyze" requests to VirusTotal
  • fetch: This fetches the VirusTotal data for nim binaries
  • generate: This uses the previously fetched data to generate a bunch of emails/messages to be sent to antivirus companies.
  • all: This program just runs all the above three in a sensible order.

So in order to use this suite of tools, you should do the following:

  1. Get a VirusTotal API key and create a file named .vt_key containing it.
  2. (Optional) Execute nimble run rescan to re-scan every nim binary. (The command finishes immediately but waiting for the rescans to finish takes a while about an hour or two.)
  3. Execute nimble run fetch to fetch VirusTotal data
  4. Adjust the start and end templates to your hearts content. (Maybe add your own contact info instead of mine lol)
  5. And then run nimble run generate to generate the emails!
  6. Voila! You should be able to find the emails in the emails/ folder. Good luck!

You now have to manually find each antivirus company's email and forward the results to them. nim-fp-suite might in the future make this process easier, but I have decided not to implement it for now.

Here is a github repo that should help

Note: The reason why issuing rescans is optional is because with GitHub Actions, I've setup a workflow to automatically do this with my own API key every day, so you should be able to just skip the second step. :-)

Archived VirusTotal data

In the past, this repo used to only store the tools needed for email generation but i'd honestly like to merge this repo with the nim-fp-data repo which archives historical VirusTotal data for Nim versions.

I wanna do this mostly to lessen the burden of maintenance, but also I understand that most people cloning this repo are here for the tools and not the archived data and so it will be a waste of bandwidth to store that here.

Maybe I could split the actual logic into a separate repo, but that means maintaining three repos. Or I could run the workflows on my personal server, and keep the data there, which is not that bad.

About

A suite of tools for dealing with reporting nim false positives to Antivirus Companies.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages