-
Notifications
You must be signed in to change notification settings - Fork 358
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for new property to ignore responses in exceptions thrown by …
…the Client API. If the property jersey.config.client.ignoreExceptionResponse is set to true, any response in an exception thrown by the Client API will be mapped to an empty response that only includes the status code of the original one. This is to prevent accidental leaks of confidential data. Signed-off-by: Santiago Pericasgeertsen <santiago.pericasgeertsen@oracle.com>
- Loading branch information
Showing
3 changed files
with
180 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
...ient/src/test/java/org/glassfish/jersey/tests/e2e/client/IgnoreExceptionResponseTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License v. 2.0, which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * This Source Code may also be made available under the following Secondary | ||
| * Licenses when the conditions for such availability set forth in the | ||
| * Eclipse Public License v. 2.0 are satisfied: GNU General Public License, | ||
| * version 2 with the GNU Classpath Exception, which is available at | ||
| * https://www.gnu.org/software/classpath/license.html. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| */ | ||
|
|
||
| package org.glassfish.jersey.tests.e2e.client; | ||
|
|
||
| import javax.ws.rs.GET; | ||
| import javax.ws.rs.Path; | ||
| import javax.ws.rs.WebApplicationException; | ||
| import javax.ws.rs.client.Client; | ||
| import javax.ws.rs.client.ClientBuilder; | ||
| import javax.ws.rs.core.Application; | ||
| import javax.ws.rs.core.NewCookie; | ||
| import javax.ws.rs.core.Response; | ||
| import java.net.URI; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
|
|
||
| import static junit.framework.TestCase.assertEquals; | ||
| import static junit.framework.TestCase.assertFalse; | ||
| import static junit.framework.TestCase.assertNull; | ||
| import org.glassfish.jersey.CommonProperties; | ||
| import org.glassfish.jersey.client.ClientProperties; | ||
| import org.glassfish.jersey.server.ResourceConfig; | ||
| import org.glassfish.jersey.test.JerseyTest; | ||
| import org.junit.AfterClass; | ||
| import org.junit.BeforeClass; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Tests ignoring of client responses in exceptions. | ||
| * | ||
| * @author Santiago Pericas-Geertsen | ||
| */ | ||
| public class IgnoreExceptionResponseTest extends JerseyTest { | ||
|
|
||
| static String lastAllowSystemProperties; | ||
| static String lastIgnoreExceptionResponse; | ||
| static AtomicReference<URI> baseUri = new AtomicReference<>(); | ||
|
|
||
| @Override | ||
| protected Application configure() { | ||
| return new ResourceConfig(TestResource.class); | ||
| } | ||
|
|
||
| public IgnoreExceptionResponseTest() { | ||
| baseUri.set(getBaseUri()); | ||
| } | ||
|
|
||
| /** | ||
| * Sets ignore exception response as system property after enabling the provider. | ||
| */ | ||
| @BeforeClass | ||
| public static void startUp() { | ||
| lastAllowSystemProperties = System.setProperty(CommonProperties.ALLOW_SYSTEM_PROPERTIES_PROVIDER, "true"); | ||
| lastIgnoreExceptionResponse = System.setProperty(ClientProperties.IGNORE_EXCEPTION_RESPONSE, "true"); | ||
| } | ||
|
|
||
| /** | ||
| * Restores state after completion. | ||
| */ | ||
| @AfterClass | ||
| public static void cleanUp() { | ||
| if (lastIgnoreExceptionResponse != null) { | ||
| System.setProperty(ClientProperties.IGNORE_EXCEPTION_RESPONSE, lastIgnoreExceptionResponse); | ||
| } | ||
| if (lastAllowSystemProperties != null) { | ||
| System.setProperty(CommonProperties.ALLOW_SYSTEM_PROPERTIES_PROVIDER, lastAllowSystemProperties); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void test() { | ||
| Client client = ClientBuilder.newClient(); | ||
| Response r = client.target(getBaseUri()) | ||
| .path("test") | ||
| .path("first") | ||
| .request() | ||
| .get(); | ||
| assertEquals(Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), r.getStatus()); | ||
| assertNull(r.getHeaderString("confidential")); | ||
| assertNull(r.getCookies().get("confidential")); | ||
| assertFalse(r.hasEntity()); | ||
| } | ||
|
|
||
| @Path("test") | ||
| public static class TestResource { | ||
|
|
||
| @Path("first") | ||
| @GET | ||
| public String first() { | ||
| Client client = ClientBuilder.newClient(); | ||
| String entity = client.target(baseUri.get()) | ||
| .path("test") | ||
| .path("second") | ||
| .request() | ||
| .get(String.class); // WebApplicationException may be thrown | ||
| return processEntity(entity); | ||
| } | ||
|
|
||
| @Path("second") | ||
| @GET | ||
| public String second() { | ||
| throw new WebApplicationException( | ||
| "Leaking confidential information", | ||
| Response.status(500) | ||
| .header("confidential", "nuke-codes") | ||
| .cookie(NewCookie.valueOf("confidential=more-nuke-codes")) | ||
| .entity("even-more-nuke-codes") | ||
| .build()); | ||
| } | ||
|
|
||
| private String processEntity(String entity) { | ||
| return entity; // filter confidential information | ||
| } | ||
| } | ||
| } |