Skip to main content

Precaution security static analysis command line

Project description

Precaution CLI Build and Test

Precli is the core of the Precaution GitHub App and Action. It also serves as a command line interface to demonstate its functionality. It is designed to do static code analysis of source code with a number of rules covering the standard library for the corresponding programming language.

If your needs go beyond the analysis of just the standard library, consider upgrading to Precaution Professional to get access to finding and fixing security vulnerabilities in third-party libraries. See https://www.securesauce.dev/ for more details.

Quick Start

To install precli (requires Python 3.12):

pip install precli

Run precli on a single test example:

precli tests/unit/rules/python/stdlib/hmac/examples/hmac_timing_attack.py

Example code:

# level: ERROR
# start_line: 18
# end_line: 18
# start_column: 13
# end_column: 15
import hmac


received_digest = (
    b"\xe2\x93\x08\x19T8\xdc\x80\xef\x87\x90m\x1f\x9d\xf7\xf2"
    b"\xf5\x10>\xdbf\xa2\xaf\xf7x\xcdX\xdf"
)

key = b"my-super-duper-secret-key-string"
password = b"pass"
digest = hmac.digest(key, password, digest="sha224")

print(digest == received_digest)

Example result:

Example output

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

precli-0.7.0.tar.gz (376.8 kB view details)

Uploaded Source

Built Distribution

precli-0.7.0-py3-none-any.whl (157.4 kB view details)

Uploaded Python 3

File details

Details for the file precli-0.7.0.tar.gz.

File metadata

  • Download URL: precli-0.7.0.tar.gz
  • Upload date:
  • Size: 376.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for precli-0.7.0.tar.gz
Algorithm Hash digest
SHA256 14d4c74d91eb1add9ade80568419ad24546fd8b991fb5b8e81822718796eb99f
MD5 2ba573fa26bdd11ec77fad20de1bb118
BLAKE2b-256 cc2213560758b8a03c34253609e880923db05cb59d90591478e735edf6df3693

See more details on using hashes here.

File details

Details for the file precli-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: precli-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 157.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for precli-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62cbbd9db1b673b4ef8d23c3b747ca8f3659d07781cd7ec985515dceaf8b227f
MD5 73865ff9c1dae10332a22b6fe3916136
BLAKE2b-256 0409574bcdde2441474bce279b0ad58427cf16204bf0d1808c17cd270038c67a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page