{"id":26654142,"url":"https://github.com/malice-plugins/nsrl","last_synced_at":"2025-04-11T07:18:45.221Z","repository":{"id":57572586,"uuid":"48824573","full_name":"malice-plugins/nsrl","owner":"malice-plugins","description":"Malice NSRL Plugin","archived":false,"fork":false,"pushed_at":"2023-04-03T22:45:09.000Z","size":3383,"stargazers_count":7,"open_issues_count":1,"forks_count":7,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-29T22:11:10.844Z","etag":null,"topics":["binary","docker","malice","md5","nsrl","sha1","whitelist"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/malice-plugins.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-31T00:03:23.000Z","updated_at":"2024-07-01T07:38:52.000Z","dependencies_parsed_at":"2024-06-20T04:19:58.191Z","dependency_job_id":"17e374c1-41f9-46f9-970b-b7acc879781e","html_url":"https://github.com/malice-plugins/nsrl","commit_stats":null,"previous_names":["maliceio/malice-nsrl"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fnsrl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fnsrl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fnsrl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fnsrl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/malice-plugins","download_url":"https://codeload.github.com/malice-plugins/nsrl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248358603,"owners_count":21090405,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["binary","docker","malice","md5","nsrl","sha1","whitelist"],"created_at":"2025-03-25T04:57:27.935Z","updated_at":"2025-04-11T07:18:45.199Z","avatar_url":"https://github.com/malice-plugins.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![NSRL logo](https://raw.githubusercontent.com/malice-plugins/nsrl/master/docs/logo.png)\n\n# malice-nsrl\n\n[![Circle CI](https://circleci.com/gh/malice-plugins/nsrl.png?style=shield)](https://circleci.com/gh/malice-plugins/nsrl) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org) [![Docker Stars](https://img.shields.io/docker/stars/malice/nsrl.svg)](https://hub.docker.com/r/malice/nsrl/) [![Docker Pulls](https://img.shields.io/docker/pulls/malice/nsrl.svg)](https://hub.docker.com/r/malice/nsrl/) [![Docker Image](https://img.shields.io/badge/docker%20image-117MB-blue.svg)](https://hub.docker.com/r/malice/nsrl/)\n\nMalice NSRL Plugin - This takes the **5.5 GB** [NSRL](http://www.nsrl.nist.gov/Downloads.htm) minimal set and converts it into a **77.4 MB** [bloom filter](https://en.wikipedia.org/wiki/Bloom_filter) with an Estimate False Positive Rate of `0.001`\n\nThis repository contains a **Dockerfile** of the [NSRL](http://www.nsrl.nist.gov) lookup malice plugin **malice/nsrl**.\n\n### Dependencies\n\n- [malice/alpine](https://hub.docker.com/r/malice/alpine/)\n\n## Image Tags\n\n```\nREPOSITORY          TAG                 SIZE\nmalice/nsrl         latest              117MB\nmalice/nsrl         0.1.0               117MB\nmalice/nsrl         sha1                117MB\nmalice/nsrl         md5                 117MB\n```\n\n\u003e **NOTE:**\n\u003e\n\u003e - tags `latest` and `0.1.0` are the same as `sha1`\n\u003e - tag `sha1` can query by sha1 hash\n\u003e - tag `md5` can query by md5 hash\n\n## Installation\n\n1. Install [Docker](https://www.docker.io/).\n2. Download [trusted build](https://hub.docker.com/r/malice/nsrl/) from public [DockerHub](https://hub.docker.com): `docker pull malice/nsrl`\n\n## Usage\n\n```bash\ndocker run --rm malice/nsrl --help\n\nUsage: nsrl [OPTIONS] COMMAND [arg...]\n\nMalice nsrl Plugin\n\nVersion: v0.1.0, BuildTime: 20161119\n\nAuthor:\n  blacktop - \u003chttps://github.com/blacktop\u003e\n\nOptions:\n  --verbose, -V  verbose output\n  --help, -h     show help\n  --version, -v  print the version\n\nCommands:\n  web     Create a NSRL lookup web service\n  build   Build bloomfilter from NSRL database\n  lookup  Query NSRL for hash\n  help    Shows a list of commands or help for one command\n\nRun 'nsrl COMMAND --help' for more information on a command.\n```\n\n### Lookup By Hash `md5|sha1`\n\n```\ndocker run --rm malice/nsrl:md5 lookup 829e4805b0e12b383ee09abdc9e2dc3c\ndocker run --rm malice/nsrl:sha1 lookup 5a272b7441328e09704b6d7eabdbd51b8858fde4\n```\n\n```\nNAME:\n   nsrl lookup - Query NSRL for hash\n\nUSAGE:\n   nsrl lookup [command options] SHA1 to query NSRL with\n\nOPTIONS:\n   --elasticsearch value  elasticsearch url for Malice to store results [$MALICE_ELASTICSEARCH_URL]\n   --post, -p             POST results to Malice webhook [$MALICE_ENDPOINT]\n   --proxy, -x            proxy settings for Malice webhook endpoint [$MALICE_PROXY]\n   --timeout value        malice plugin timeout (in seconds) (default: 10) [$MALICE_TIMEOUT]\n   --table, -t            output as Markdown table\n```\n\n## Sample Output\n\n### [JSON](https://github.com/malice-plugins/nsrl/blob/master/docs/results.json)\n\n---\n\n```json\n{\n  \"nsrl\": {\n    \"found\": true,\n    \"hash\": \"5A272B7441328E09704B6D7EABDBD51B8858FDE4\"\n  }\n}\n```\n\n---\n\n### [Markdown](https://github.com/malice-plugins/nsrl/blob/master/docs/SAMPLE.md)\n\n---\n\n#### NSRL Database\n\n- Found :white_check_mark:\n\n---\n\n## Documentation\n\n- [To write results to ElasticSearch](https://github.com/malice-plugins/nsrl/blob/master/docs/elasticsearch.md)\n- [To create a nsrl lookup micro-service](https://github.com/malice-plugins/nsrl/blob/master/docs/web.md)\n- [To post results to a webhook](https://github.com/malice-plugins/nsrl/blob/master/docs/callback.md)\n- [To query NSRL for a filename](https://github.com/malice-plugins/nsrl/blob/master/docs/query_filename.md)\n\n## Issues\n\nFind a bug? Want more features? Find something missing in the documentation? Let me know! Please don't hesitate to [file an issue](https://github.com/malice-plugins/nsrl/issues/new)\n\n## CHANGELOG\n\nSee [`CHANGELOG.md`](https://github.com/malice-plugins/nsrl/blob/master/CHANGELOG.md)\n\n## Contributing\n\n[See all contributors on GitHub](https://github.com/malice-plugins/nsrl/graphs/contributors).\n\nPlease update the [CHANGELOG.md](https://github.com/malice-plugins/nsrl/blob/master/CHANGELOG.md) and submit a [Pull Request on GitHub](https://help.github.com/articles/using-pull-requests/).\n\n## License\n\nMIT Copyright (c) 2015 **blacktop**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalice-plugins%2Fnsrl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmalice-plugins%2Fnsrl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalice-plugins%2Fnsrl/lists"}