FossID Documentation

String matching

The FossID Workbench allows users to create text string matching rules to assist in finding interesting words or phrases in files under audit. The rules are created, administered and executed from the scan interface.

Access the rules administration interface from the Scan parameters dialog:

String matching edit rules String matching rules administration

Rules can be created either as plain text or as ERE/extended regular expressions (see online documentation for GNU Grep). There are four possible scopes for each rule:

  • Scan specific: Rules that will apply to this scan. Requires the “Scans - Add and remove String Match Rules” permission to modify.
  • Project specific: Rules that will apply to all scans within a specific project. Requires the “Projects - Add and remove String Match Rules” permission to modify.
  • Global: Rules that will apply to all scans. Requires the “Scans - Add and remove Global String Match Rules” permission to modify.
  • Personal: Rules that will apply to all scans performed by this user only. Always possible to modify.

Existing rules will be executed automatically as a step in the scan process. The string matching results can be accessed from the “String Matches” tab:

String matching results

Files with string matches will be included in the tree view and the matching lines can then be examined individually. Matching lines for the currently selected rule will be highlighted in the file contents display. Optionally, a comment explaining that a particular rule was matched in a file can be easily added by clicking on the add comment button. These comments can later be reviewed in, for example, a FossID HTML report.

String matching comments