Add Minimum Permissions Map

* detect commonly used GitHub owned actions use a map to suggest the
  minimum permissions needed for the GITHUB_TOKEN

Author: KyFaSt

actions/ql/lib/codeql/actions/config/Config.qll

@@ -126,6 +126,18 @@ predicate vulnerableActionsDataModel(
  */
 predicate immutableActionsDataModel(string action) { Extensions::immutableActionsDataModel(action) }
 
+/**
+ * MaD models for minimum permissions for actions
+ * Fields:
+ *    - action: action name
+ *    - minimum_permissions: list of minimum permissions
+ */
+predicate minimumPermissionsDataModel(
+  string action, string minimum_permissions
+) {
+  Extensions::minimumPermissionsDataModel(action, minimum_permissions)
+}
+
 /**
  * MaD models for untrusted git commands
  * Fields:

actions/ql/lib/codeql/actions/config/ConfigExtensions.qll

@@ -63,6 +63,11 @@ extensible predicate vulnerableActionsDataModel(
  */
 extensible predicate immutableActionsDataModel(string action);
 
+/**
+ * Holds for actions that have a minimum permissions definition.
+ */
+extensible predicate minimumPermissionsDataModel(string action, string minimum_permissions);
+
 /**
  * Holds for git commands that may introduce untrusted data when called on an attacker controlled branch.
  */

actions/ql/lib/codeql/actions/security/MinimumActionsPermissions.qll

@@ -0,0 +1,14 @@
+import actions
+class MinimumActionsPermissions extends UsesStep {
+  string action;
+  string minimum_permissions;
+
+  MinimumActionsPermissions() {
+    minimumPermissionsDataModel(action, minimum_permissions) and
+    this.getCallee() = action
+  }
+
+  string getMinimumPermissions() { result = minimum_permissions }
+
+  string getAction() { result = action }
+}

actions/ql/lib/ext/config/minimum_permissions_map.yml

@@ -0,0 +1,25 @@
+:
+  - addsTo:
+    pack: github/actions-all
+    extensible: minimumPermissionsDataModel
+    data:
+    - ["actions/cache", "{}"]
+    - ["actions/setup-node", "contents:read"]
+    - ["actions/upload-artifact", "{}"]
+    - ["actions/setup-python", "contents:read"]
+    - ["actions/download-artifact", "{}"]
+    - ["actions/github-script", "It depends on what the script does"]
+    - ["actions/setup-java", "contents:read"]
+    - ["actions/setup-go", "contents:read"]
+    - ["actions/setup-dotnet", "contents:read"]
+    - ["actions/labeler", "contents:read, pull-requests:write"]
+    - ["actions/attest", "id-token:write, attestations:write"]
+    - ["actions/add-to-project", "repository-projects:read, repository-projects:write, issues:read, pull-requests:read"]
+    - ["actions/dependency-review-action", "contents:read"]
+    - ["actions/attest-sbom", "id-token:write, attestations:write"]
+    - ["actions/stale", "contents:write, issues:write, pull-requests:write"]
+    - ["actions/attest-build-provenance", "id-token:write, attestations:write"]
+    - ["actions/jekyll-build-pages", "contents:read, pages:write, id-token:write"]
+    - ["actions/publish-action", "contents:write"]
+    - ["actions/version-package-tools", "contents:read, actions:read"]
+    - ["actions/reusable-workflows", "contents:read, actions:read"]

actions/ql/src/Security/CWE-275/MissingActionsPermissions.ql

@@ -11,15 +11,38 @@
  *       external/cwe/cwe-275
  */
 
-import actions
+ import actions
+ import codeql.actions.security.MinimumActionsPermissions
 
-from Job job
-where
-  not exists(job.getPermissions()) and
-  not exists(job.getEnclosingWorkflow().getPermissions()) and
-  // exists a trigger event that is not a workflow_call
-  exists(Event e |
-    e = job.getATriggerEvent() and
-    not e.getName() = "workflow_call"
-  )
-select job, "Actions Job or Workflow does not set permissions"
+ // Returns the minimum permissions for all of the uses steps
+ // that are children of the job separated by a comma
+ // e.g. "contents: read, packages: write".  If we cannot determine
+ // the permission we fallback to "unknown"
+ string getMinPermissions(Job job) {
+   if unknownPermissions(job) = true then result = "unknown" else
+   result = minPermissions(job)
+ }
+
+ string minPermissions(Job job) {
+   result = concat(job.getAChildNode*().(MinimumActionsPermissions).getMinimumPermissions(), ", ")
+ }
+
+ // Holds if we cannot determine the permissions for the uses step
+ // using the data extension or there are no uses steps
+ // that are children of the job
+ boolean unknownPermissions(Job job) {
+    minPermissions(job) = "" and result = true or count(job.getAChildNode*().(MinimumActionsPermissions)) = 0 and result = true
+ }
+
+ from Job job
+ where
+   not exists(job.getPermissions()) and
+   not exists(job.getEnclosingWorkflow().getPermissions()) and
+   // exists a trigger event that is not a workflow_call
+   exists(Event e |
+     e = job.getATriggerEvent() and
+     not e.getName() = "workflow_call"
+   )
+ select job,
+ "Actions Job or Workflow does not set permissions. Recommended minimum permissions are ($@)",
+ job, getMinPermissions(job)