[JENKINS-46795] TrustworthyBuild extension point

src/main/java/jenkins/scm/api/SCMSource.java

@@ -77,6 +77,8 @@
 public abstract class SCMSource extends AbstractDescribableImpl<SCMSource>
         implements ExtensionPoint {
 
+    private static final Logger LOGGER = Logger.getLogger(SCMSource.class.getName());
+
     /**
      * Replaceable pronoun of that points to a {@link SCMSource}. Defaults to {@code null} depending on the context.
      * @since 2.0
@@ -956,13 +958,37 @@ public final SCM build(@NonNull SCMHead head) {
      * @throws IOException in case the implementation must call {@link #fetch(SCMHead, TaskListener)} or similar
      * @throws InterruptedException in case the implementation must call {@link #fetch(SCMHead, TaskListener)} or similar
      * @since 1.1
+     * @see #getTrustedRevisionForBuild
      */
     @NonNull
     public SCMRevision getTrustedRevision(@NonNull SCMRevision revision, @NonNull TaskListener listener)
             throws IOException, InterruptedException {
         return revision;
     }
 
+    /**
+     * Refined version of {@link #getTrustedRevision(SCMRevision, TaskListener)} that takes into account the build context.
+     * @param build a running build
+     * @return {@link #getTrustedRevision} if the build itself does not indicate trust;
+     *         simply {@code revision} if any {@link TrustworthyBuild} says that it does
+     */
+    @NonNull
+    public final SCMRevision getTrustedRevisionForBuild(@NonNull SCMRevision revision, @NonNull TaskListener listener, @NonNull Run<?, ?> build)
+            throws IOException, InterruptedException {
+        if (ExtensionList.lookup(TrustworthyBuild.class).stream().anyMatch(tb -> tb.shouldBeTrusted(build))) {
+            LOGGER.fine(() -> build + " with " + build.getCauses() + " was considered trustworthy, so using " + revision + " as is");
+            return revision;
+        } else {
+            SCMRevision trustedRevision = getTrustedRevision(revision, listener);
+            if (trustedRevision.equals(revision)) {
+                LOGGER.fine(() -> build + " was not considered trustworthy, but " + revision + " was trusted anyway");
+            } else {
+                LOGGER.fine(() -> build + " was not considered trustworthy, so replacing " + revision + " with " + trustedRevision);
+            }
+            return trustedRevision;
+        }
+    }
+
     /**
      * Turns a possibly {@code null} {@link TaskListener} reference into a guaranteed non-null reference.
      *

src/main/java/jenkins/scm/api/TrustworthyBuild.java

@@ -0,0 +1,68 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2022 CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package jenkins.scm.api;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.ExtensionPoint;
+import hudson.model.Cause;
+import hudson.model.Run;
+import hudson.triggers.SCMTrigger;
+import hudson.triggers.TimerTrigger;
+
+/**
+ * Allows plugins to declare that builds were triggered deliberately.
+ * This allows an authorized user to run CI on (say) a pull request filed by an outsider,
+ * having confirmed that there is nothing malicious about the contents.
+ * @see SCMSource#getTrustedRevisionForBuild
+ */
+public interface TrustworthyBuild extends ExtensionPoint {
+
+    /**
+     * Should this build be trusted to load sensitive source files?
+     * If any implementation returns true then it is trusted.
+     */
+    boolean shouldBeTrusted(@NonNull Run<?, ?> build);
+
+    /**
+     * Convenience for the common case that a particular trigger cause indicates trust.
+     * Examples of causes which could be trusted include:
+     * <ul>
+     * <li>{@link Cause.UserIdCause}
+     * <li>{@code ReplayCause}
+     * <li>{@code CheckRunGHEventSubscriber.GitHubChecksRerunActionCause}
+     * </ul>
+     * Examples of causes which should <em>not</em> be registered include:
+     * <ul>
+     * <li>{@link TimerTrigger.TimerTriggerCause}
+     * <li>{@link SCMTrigger.SCMTriggerCause}
+     * <li>{@code BranchIndexingCause}
+     * <li>{@code BranchEventCause}
+     * </ul>
+     */
+    static TrustworthyBuild byCause(Class<? extends Cause> causeType) {
+        return build -> build.getCause(causeType) != null;
+    }
+
+}

src/main/java/jenkins/scm/impl/TrustworthyBuilds.java

@@ -0,0 +1,47 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2022 CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package jenkins.scm.impl;
+
+import hudson.Extension;
+import hudson.model.Cause;
+import jenkins.scm.api.TrustworthyBuild;
+
+public class TrustworthyBuilds {
+
+    // Also effectively handles ReplayCause since that is only ever added in conjunction with UserIdCause. (see ReplayAction.run2)
+    @Extension
+    public static TrustworthyBuild byUserId() {
+        return TrustworthyBuild.byCause(Cause.UserIdCause.class);
+    }
+
+    // TODO until github-checks can declare a dep on a sufficiently new scm-api
+    @Extension
+    public static TrustworthyBuild byGitHubChecks() {
+        return build -> build.getCauses().stream().anyMatch(cause -> cause.getClass().getName().equals("io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber$GitHubChecksRerunActionCause"));
+    }
+
+    private TrustworthyBuilds() {}
+
+}