Python

This article shows you how to analyze your applications that are written in Python using NG SAST.

Prerequisites

You must have:

  • Set up and authenticated with ShiftLeft
  • Set up Python 3.8 (regardless of which version of Python your app uses) and make sure python3.8 is available in your PATH.
  • Set up the python3.8-venv package (Linux only)

Because you must have Python 3.8 installed on the machine where NG SAST runs, we recommend using a Python virtual environment tool (such as pyenv or virtualenv) to manage multiple versions of Python.

NG SAST only supports applications written using Python 3.8 or earlier.

CI/CD-Based Scans

The build agent should have Python 3.8 set up and support the creation of Python virtual environments.

Considerations

ShiftLeft's Python analyzer attempts to gather as much information about your project as possible to achieve a high level of accuracy. As such, it expects an environment set up close to the one you have for running your project. This means that the Python interpreter must find all of the project's dependencies set up in one of the directories of its module search path. The most straightforward way to do this is to create a virtual environment and install the project's dependencies in it.

ShiftLeft supports setups that do not use virtual environments as long as the Python interpreter can find the dependencies in its search path. You can specify additional directories to look for dependencies using the --extra-sys-paths flag.

Additionally, the Python analyzer goes through your project's files and modules in a way that's similar to the Python interpreter. This process is crucial for gathering important information and can be fragile for certain setups. If the analyzer cannot follow one of the imports in your project, the analysis will proceed, but the files related to the import may not be included in the resulting analysis. As such, NG SAST may not detect security vulnerabilities related to these files. To receive a complete analysis possible, include the --strict-deps flag.

Analyzing Your Python Application

note

ShiftLeft offers a sample application that you can use to run and test NG SAST. It also includes a functioning configuration file to demonstrate how you can leverage GitHub Actions to automate code analysis whenever you open a new Pull Request (PR).

We also offer samples for GitLab integration, as well as configurations for Docker, Linux, macOS, and Windows.

Before running code analysis, please run pip install and make sure this is successful.

pip install -r requirements.txt

On macOS and in some Linux environments, pip and python may be using version 2 instead of version 3. If so, use pip3 and python3 instead.

To analyze your Python application:

sl analyze --app <name> --python [<path>]
ParameterDescription
--app <name>The name of the application to be analyzed
--pythonThe flag identifying the application as written in Python
<path>The path to the Python app to be analyzed

The analysis accepts additional parameters after a double hyphen --.

For example, the following CLI invocation ignores the dev-folder directory and all directories named experiments and adds a new entry to Python's module search path:

sl analyze --app <name> --python [<path>] -- --ignore-paths /path/to/dev-folder --ignore-dir-names experiments --extra-sys-paths /path/to/lib/python3.8/site-packages
Additional parameterDescription
--extra-sys-paths [<path>]Include additional module search paths in the analysis
--strict-depsRequires that all of the project's module paths can be followed for analysis to proceed
--ignore-pathsIgnores the specified paths from the analysis
--ignore-dir-namesExcludes all matching directories from the analysis. You must provide the exact directory name

Such parameters, if valid, are passed directly to the Python plugin.

To provide an additional module search path for the analysis:

sl analyze --app <name> --python [<path>] -- --extra-sys-paths [<path>]

To specify that the analysis should only continue if all the project's modules can be followed:

sl analyze --app <name> --python [<path>] -- --strict-deps

To ignore specific paths from the analysis:

sl analyze --app <name> --python [<path>] -- --ignore-paths [<ignore_path_1>] [<ignore_path_2>]

To ignore specific directory names from the analysis:

sl analyze --app <name> --python [<path>] -- --ignore-dir-names [<ignore_dir_name_1>] [<ignore_dir_name_2>]

To enable detailed logging of the analysis in case of troubleshooting:

sl analyze --app <name> --python [<path>] -- -l debug

See the CLI reference for additional sl analyze options.

Python Vulnerabilities