diff --git a/docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst b/docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst index 5676a77cf866..2bf452b5a90b 100644 --- a/docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst +++ b/docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst @@ -43,4 +43,43 @@ Customizing Actions-specific analysis: - **untrustedGhCommandDataModel**\(cmd_regex, flag) - **untrustedGitCommandDataModel**\(cmd_regex, flag) - **vulnerableActionsDataModel**\(action, vulnerable_version, vulnerable_sha, fixed_version) -- **workflowDataModel**\(path, trigger, job, secrets_source, permissions, runner) \ No newline at end of file +- **workflowDataModel**\(path, trigger, job, secrets_source, permissions, runner) + +Examples of custom model definitions +------------------------------------ + +The examples in this section are taken from the standard CodeQL Actions query pack published by GitHub. They demonstrate how to add tuples to extend extensible predicates that are used by the standard queries. + +Example: Extend the trusted Actions publishers for the ``actions/unpinned-tag`` query +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If there is an Action publisher that you trust, you can include the owner name/organization in a data extension model pack to add it to the allow list for this query. Adding owners to this list will prevent security alerts when using unpinned tags for Actions published by that owner. + +To allow any Action from the publisher ``octodemo``, such as ``octodemo/3rd-party-action``, follow these steps: + +1. Create a data extension file ``/models/trusted-owner.model.yml`` with the following content: + + .. code-block:: yaml + + extensions: + - addsTo: + pack: codeql/actions-all + extensible: trustedActionsOwnerDataModel + data: + - ["octodemo"] + +2. Create a model pack file ``/codeql-pack.yml`` with the following content: + + .. code-block:: yaml + + name: my-org/actions-extensions-model-pack + version: 0.0.0 + library: true + extensionTargets: + codeql/actions-all: '*' + dataExtensions: + - models/**/*.yml + +3. Ensure that the model pack is included in your CodeQL analysis. + +By following these steps, you will add ``octodemo`` to the list of trusted Action publishers, and the query will no longer generate security alerts for unpinned tags from this publisher. For more information, see `Extending CodeQL coverage with CodeQL model packs in default setup `_ and `Creating and working with CodeQL packs `_.