Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 2.15 KB

README.md

File metadata and controls

88 lines (59 loc) · 2.15 KB

wasmshield CLI

wasmshield is a command-line tool designed for verifying and auditing WebAssembly (WASM) components. With its focus on security and integrity, wasmshield helps developers ensure their WASM components are robust and trustworthy.

Features

  • SBOM Audit: Analyze auditable data baked into components using cargo auditable.
  • Signature Verification: Verify the digital signatures of WASM components for integrity checks.

Installation

TBD

Usage

To view the full list of commands and options:

wasmshield --help

Commands

sbom

Audits a specified WASM component using its Software Bill of Materials (SBOM). This requires cargo auditable data baked into the component.

Syntax:

wasmshield sbom <COMPONENT>

Arguments:

  • <COMPONENT>: Path to the WASM component to analyze.

Example:

wasmshield sbom my_component.wasm

signature

Verifies the signature of a specified WASM component to ensure it has not been tampered with.

Syntax:

wasmshield signature <COMPONENT> --public-key <PUBLIC-KEY>

Arguments:

  • <COMPONENT>: Path to the WASM component to verify.
  • --public-key, -K: Path to the public key file associated with the signature.

Example:

wasmshield signature my_component.wasm --public-key public_key.pem

Error Handling

  • File not found: If a specified file (e.g., WASM component or public key) does not exist, an appropriate error will be displayed.
  • Audit failures: The sbom command will report vulnerabilities and warnings found during the audit.
  • Signature verification failures: The signature command will notify if any signatures fail the verification process.

Author

Developed by Titus Abele
📧 [email protected]

Contributing

Contributions are welcome! Please fork the repository, and submit a pull request with your changes.

License

wasmshield is licensed under