Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(webhook): add new webhook.followRedirects property #4838

Merged
merged 2 commits into from
Feb 16, 2025
Merged

feat(webhook): add new webhook.followRedirects property #4838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4b7b3f
refactor(webhook): small tweak to redirect handling
dbyron-sf Oct 22, 2024
5ac5beb
feat(webhook): add new webhook.followRedirects property
dbyron-sf Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions ...webhook/src/main/java/com/netflix/spinnaker/orca/webhook/config/WebhookConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,18 @@ public ClientHttpRequestFactory webhookRequestFactory(

validateResponseSize(response, webhookProperties.getMaxResponseBytes());

if (webhookProperties.isVerifyRedirects() && response.isRedirect()) {
// verify that we are not redirecting to a restricted url
if (response.isRedirect()) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I see we have this validateRequestSize and validateResponseSize, would it make sense to move this to a method called validateAnyRedirects?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We didn't decide the isRedirect method name here. It's a method on the okhttp3.Response class.

We do get to decide property names though, and I figured followRedirects was consistent with the existing verifyRedirects.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aaah, I see...We could move all this logic to a separate method for handling redirect validation...yes, that makes sense.

String redirectLocation = response.header("Location");
if (redirectLocation != null && !redirectLocation.trim().startsWith("/")) {
userConfiguredUrlRestrictions.validateURI(redirectLocation);
if (!webhookProperties.isFollowRedirects()) {
throw new IllegalStateException(
"redirects disabled, not visiting " + redirectLocation);
}

if (webhookProperties.isVerifyRedirects()) {
// verify that we are not redirecting to a restricted url
if (redirectLocation != null && !redirectLocation.trim().startsWith("/")) {
userConfiguredUrlRestrictions.validateURI(redirectLocation);
}
}
}

Expand Down
3 changes: 3 additions & 0 deletions orca-webhook/src/main/java/com/netflix/spinnaker/orca/webhook/config/WebhookProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ public class WebhookProperties {

private boolean verifyRedirects = true;

/** If true, follow redirects. If false, don't follow redirects. */
private boolean followRedirects = true;

private List<Integer> defaultRetryStatusCodes = List.of(429);

// For testing *only*
Expand Down
26 changes: 26 additions & 0 deletions ...-webhook/src/test/java/com/netflix/spinnaker/orca/webhook/service/WebhookServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor;
import static com.github.tomakehurst.wiremock.client.WireMock.post;
import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor;
import static com.github.tomakehurst.wiremock.client.WireMock.temporaryRedirect;
import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching;
import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
Expand Down Expand Up @@ -370,4 +371,29 @@ void testResponseHeadersAndBodySmallEnough() throws Exception {

apiProvider.verify(getRequestedFor(urlPathEqualTo(path)));
}

@Test
void testDontFollowRedirects() throws Exception {
webhookProperties.setFollowRedirects(false);

String path = "/some/path";
String url = apiProvider.baseUrl() + path;

String redirectUrl = "https://anywhere";
apiProvider.stubFor(get(urlMatching(path)).willReturn(temporaryRedirect(redirectUrl)));

// The StageExecutionImpl constructor mutates the map, so use a mutable map.
Map<String, Object> webhookStageData =
new HashMap<>(Map.of("url", url, "method", HttpMethod.GET));
StageExecution stage =
new StageExecutionImpl(null, "webhook", "test-webhook-stage", webhookStageData);

Throwable thrown = catchThrowable(() -> webhookService.callWebhook(stage));

assertThat(thrown)
.isInstanceOf(IllegalStateException.class)
.hasMessageContaining("redirects disabled, not visiting " + redirectUrl);

apiProvider.verify(getRequestedFor(urlPathEqualTo(path)));
}
}