pysast
1.1

Getting Started

  • Writing SAST Rules
    • Benefits of Writing SAST Rules
    • Rule Format
      • Rule Properties
    • Usage
    • Example
  • Performing a SAST Scan
    • Command syntax
      • Positional Arguments
      • Options
    • Usage Examples
    • Program Optimization with Threading
      • How It Works
      • Usage

SAST API

  • API Reference
    • Interface
      • is_rule_file()
      • get_mime_type()
      • extract_filter_keys()
      • load_sast_rules()
      • run()
    • Classes
      • FileFilter
        • FileFilter.apply()
        • FileFilter.reset()
        • FileFilter.with_re()
      • SupportsFilter
        • SupportsFilter.apply_filters()
      • SastPattern
        • SastPattern.compile()
        • SastPattern.engine
        • SastPattern.modes
        • SastPattern.text
      • SastRule
        • SastRule.add_pattern()
        • SastRule.meta
        • SastRule.must_not_patterns
        • SastRule.required_patterns
      • SastContext
        • SastContext.match()
      • SastScanner
        • SastScanner.filter_scan_results()
        • SastScanner.get_context()
        • SastScanner.has_matches
        • SastScanner.json
        • SastScanner.load_rule_directory()
        • SastScanner.load_rule_file()
        • SastScanner.rules
        • SastScanner.scan()
        • SastScanner.scan_results
pysast
  • Index

Index

A | C | E | F | G | H | I | J | L | M | R | S | T | W

A

  • add_pattern() (pysast.SastRule method)
  • apply() (pysast.FileFilter method)
  • apply_filters() (pysast.SupportsFilter method)

C

  • compile() (pysast.SastPattern method)

E

  • engine (pysast.SastPattern attribute)
  • extract_filter_keys() (in module pysast)

F

  • FileFilter (class in pysast)
  • filter_scan_results() (pysast.SastScanner method)

G

  • get_context() (pysast.SastScanner method)
  • get_mime_type() (in module pysast)

H

  • has_matches (pysast.SastScanner property)

I

  • is_rule_file() (in module pysast)

J

  • json (pysast.SastScanner property)

L

  • load_rule_directory() (pysast.SastScanner method)
  • load_rule_file() (pysast.SastScanner method)
  • load_sast_rules() (in module pysast)

M

  • match() (pysast.SastContext method)
  • meta (pysast.SastRule property)
  • modes (pysast.SastPattern attribute)
  • must_not_patterns (pysast.SastRule property)

R

  • required_patterns (pysast.SastRule property)
  • reset() (pysast.FileFilter method)
  • rules (pysast.SastScanner property)
  • run() (in module pysast)

S

  • SastContext (class in pysast)
  • SastPattern (class in pysast)
  • SastRule (class in pysast)
  • SastScanner (class in pysast)
  • scan() (pysast.SastScanner method)
  • scan_results (pysast.SastScanner property)
  • SupportsFilter (class in pysast)

T

  • text (pysast.SastPattern attribute)

W

  • with_re() (pysast.FileFilter method)

© Copyright 2023, MatrixEditor.

Built with Sphinx using a theme provided by Read the Docs.