Documentation

Strata.Util.Sarif

SARIF Output #

This module provides support for outputting results in SARIF (Static Analysis Results Interchange Format) version 2.1.0.

SARIF specification: https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html

SARIF Data Structures #

SARIF location representing a position in source code

Instances For
    Equations
    • One or more equations did not get rendered due to their size.
    Instances For
      Equations
      • One or more equations did not get rendered due to their size.
      Instances For
        Equations
        • One or more equations did not get rendered due to their size.
        Instances For
          Equations
          Instances For

            SARIF artifact location representing a file URI

            Instances For
              Equations
              • One or more equations did not get rendered due to their size.
              Instances For
                Equations
                Instances For

                  SARIF region representing a source code region with line and column information

                  • startLine : Nat
                  • startColumn : Nat
                  Instances For
                    Equations
                    • One or more equations did not get rendered due to their size.
                    Instances For
                      Equations
                      • One or more equations did not get rendered due to their size.
                      Instances For
                        def Strata.Sarif.instDecidableEqRegion.decEq (x✝ x✝¹ : Region) :
                        Decidable (x✝ = x✝¹)
                        Equations
                        • One or more equations did not get rendered due to their size.
                        Instances For

                          SARIF physical location with region information

                          Instances For
                            Equations
                            • One or more equations did not get rendered due to their size.
                            Instances For
                              Equations
                              • One or more equations did not get rendered due to their size.
                              Instances For
                                Equations
                                • One or more equations did not get rendered due to their size.
                                Instances For

                                  SARIF location wrapper

                                  Instances For
                                    Equations
                                    • One or more equations did not get rendered due to their size.
                                    Instances For
                                      Equations
                                      • One or more equations did not get rendered due to their size.
                                      Instances For
                                        Equations
                                        Instances For

                                          SARIF message

                                          Instances For
                                            Equations
                                            • One or more equations did not get rendered due to their size.
                                            Instances For
                                              Equations
                                              Instances For

                                                SARIF result level

                                                Instances For
                                                  Equations
                                                  • One or more equations did not get rendered due to their size.
                                                  Equations
                                                  • One or more equations did not get rendered due to their size.

                                                  SARIF property bag for tool-specific properties

                                                  • propertyType : String

                                                    Strata-specific classification of the property being checked

                                                  Instances For
                                                    Equations
                                                    • One or more equations did not get rendered due to their size.
                                                    Instances For
                                                      Equations
                                                      • One or more equations did not get rendered due to their size.
                                                      Instances For
                                                        Equations
                                                        Instances For

                                                          SARIF related location with message

                                                          Instances For
                                                            Equations
                                                            • One or more equations did not get rendered due to their size.
                                                            Instances For
                                                              Equations
                                                              • One or more equations did not get rendered due to their size.
                                                              Instances For
                                                                Equations
                                                                • One or more equations did not get rendered due to their size.
                                                                Instances For
                                                                  Equations
                                                                  • One or more equations did not get rendered due to their size.
                                                                  Instances For

                                                                    SARIF result representing a single verification result

                                                                    • ruleId : String

                                                                      Stable identifier of the rule that was evaluated to produce the result -

                                                                    • level : Level
                                                                    • message : Message
                                                                    • locations : Array SarifLocation
                                                                    • relatedLocations : Array RelatedLocation

                                                                      Related locations (e.g., original assertion location when inlined). Order follows the call stack: the innermost (most deeply inlined) location comes first. Each element's id field is 1-indexed and matches its position.

                                                                    • properties : PropertyBag

                                                                      Tool-specific properties (SARIF property bag)

                                                                    Instances For
                                                                      Equations
                                                                      • One or more equations did not get rendered due to their size.
                                                                      Instances For
                                                                        Equations
                                                                        • One or more equations did not get rendered due to their size.
                                                                        Instances For
                                                                          Equations
                                                                          • One or more equations did not get rendered due to their size.
                                                                          Instances For
                                                                            def Strata.Sarif.instDecidableEqResult.decEq (x✝ x✝¹ : Result) :
                                                                            Decidable (x✝ = x✝¹)
                                                                            Equations
                                                                            • One or more equations did not get rendered due to their size.
                                                                            Instances For
                                                                              Equations

                                                                              SARIF tool driver information

                                                                              • name : String

                                                                                The exact command-line tool in Strata -

                                                                              • version : String
                                                                              • informationUri : String
                                                                              Instances For
                                                                                Equations
                                                                                • One or more equations did not get rendered due to their size.
                                                                                Instances For
                                                                                  Equations
                                                                                  • One or more equations did not get rendered due to their size.
                                                                                  Instances For
                                                                                    Equations
                                                                                    • One or more equations did not get rendered due to their size.
                                                                                    Instances For

                                                                                      SARIF tool information

                                                                                      Instances For
                                                                                        Equations
                                                                                        • One or more equations did not get rendered due to their size.
                                                                                        Instances For
                                                                                          Equations
                                                                                          • One or more equations did not get rendered due to their size.
                                                                                          Instances For

                                                                                            SARIF run representing a single analysis run

                                                                                            Instances For
                                                                                              Equations
                                                                                              • One or more equations did not get rendered due to their size.
                                                                                              Instances For
                                                                                                Equations
                                                                                                • One or more equations did not get rendered due to their size.
                                                                                                Instances For

                                                                                                  Top-level SARIF document

                                                                                                  Instances For
                                                                                                    Equations
                                                                                                    • One or more equations did not get rendered due to their size.
                                                                                                    Instances For
                                                                                                      Equations
                                                                                                      • One or more equations did not get rendered due to their size.
                                                                                                      Instances For

                                                                                                        Utility Functions #

                                                                                                        Convert a location to SARIF format

                                                                                                        Equations
                                                                                                        Instances For

                                                                                                          Convert SARIF document to JSON string

                                                                                                          Equations
                                                                                                          Instances For

                                                                                                            Convert SARIF document to pretty-printed JSON string

                                                                                                            Equations
                                                                                                            Instances For