Easily scan files for threats to security and privacy. A Rust library and command line tool.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
rfc
src
.gitignore
.travis.yml
CNAME
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Cargo.toml
ISSUE_TEMPLATE.md
LICENSE
README.md
_config.yml

README.md

🔒 ArmorLib 🔒

Easily scan files for threats to security and privacy. A Rust library and command line tool.
Explore ArmorLib »

DocumentationCLI Quick StartContributing

Status

Crates.io Build status GitHub issues GitHub forks GitHub stars GitHub license Twitter

Installation

ArmorLib is available on Cargo, and can be installed with cargo install armorlib.

Getting Started

Want to jump right in? Check out our getting started guides to get you up to speed on how to use ArmorLib either on the command line or in your own Rust library:

  • Command line guide available here.
  • Library guide available here.

Looking to contribute a preprocessor or a scan module? There are separate guides for that—see CONTRIBUTING.md.

Documentation

ArmorLib has near 100% documentation coverage, and offers both a comprehensive rustdoc and several other guides. Explore the ArmorLib documentation here.

Looking for a more high-level description of ArmorLib? Be sure to take a look at docs/STRUCTURE.md.

Contributing

ArmorLib welcomes contributions! Several resources are available to help you in this process.

  • Contributing guidelines available here.
  • Preprocessor contribution guide available here.
  • Scan module contribution guide available here.

Be sure to always follow the code of conduct! ArmorLib is a constructive community, and certain behaviors aren't tolerated.

Quick Demos

Using ArmorLib in your own program

Using ArmorLib on the command line


ArmorLib was created by Miles McCain as a part of CSC630: The Open Source Movement at Phillips Academy Andover. Logo: secure by Gregor Cresnar from the Noun Project.