Skip to content

Add example policy solution to flawfinder sast encoding issue

Sam Morris requested to merge flawfinder-sast-policy-solution into master

What does this MR do?

This MR updates our troubleshooting docs for the common SAST flawfinder UTF-8 encoding issue. This solution unblocks customers with C and C++ codebases who want to leverage SAST at scale. The example provided uses a pipeline execution policy with a before_script to install the encoder library and convert the cpp files so they can be scanned in the flawfinder SAST job. This is a working solution I have validated to mitigate the SAST on C and C++ projects errors in the flawfinder job.

Related issues

#7020 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports