Skip to content

Commit

Permalink
TOMEE-2247 - Fixed remaining tests that load key from an URL. TCK exp…
Browse files Browse the repository at this point in the history
…ects application to be deployed to load the key, but key load is part of the deployment, so the key endpoint cannot be part of the app being tested.
  • Loading branch information
radcortez committed Dec 4, 2018
1 parent 214a12b commit 4dee78b
Show file tree
Hide file tree
Showing 6 changed files with 249 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ public void process(final Archive<?> applicationArchive, final TestClass testCla
PublicKeyAsJWKSTest.class,
PublicKeyAsJWKSLocationTest.class,
IssValidationTest.class,
org.apache.tomee.microprofile.tck.jwt.config.PublicKeyAsPEMLocationTest.class)
org.apache.tomee.microprofile.tck.jwt.config.PublicKeyAsPEMLocationTest.class,
org.apache.tomee.microprofile.tck.jwt.config.PublicKeyAsJWKLocationURLTest.class)
.filter(c -> c.equals(testClass.getJavaClass()))
.findAny()
.ifPresent(c -> war.deleteClass(JWTAuthContextInfoProvider.class));
Expand All @@ -106,7 +107,7 @@ public void process(final Archive<?> applicationArchive, final TestClass testCla
try {
final Properties properties = new Properties();
properties.load(node.getAsset().openStream());
properties.replaceAll((key, value) -> ((String) value).replaceAll("8080", httpPort + "/" + war.getName().replaceAll("\\.war", "")));
properties.replaceAll((key, value) -> ((String) value).replaceAll("8080", httpPort + "/" + "KeyEndpoint.war".replaceAll("\\.war", "")));
final StringWriter stringWriter = new StringWriter();
properties.store(stringWriter, null);
war.delete(archivePath);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomee.microprofile.tck.jwt.config;

import org.eclipse.microprofile.auth.LoginConfig;

import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

@LoginConfig(authMethod = "MP-JWT", realmName = "TCK-MP-JWT")
@ApplicationPath("/key")
public class KeyApplication extends Application {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomee.microprofile.tck.jwt.config;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.StringReader;
import java.io.StringWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.security.PrivateKey;
import java.util.HashMap;
import java.util.Properties;

import javax.json.Json;
import javax.json.JsonArray;
import javax.json.JsonObject;
import javax.json.JsonReader;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Response;

import org.eclipse.microprofile.jwt.config.Names;
import org.eclipse.microprofile.jwt.tck.TCKConstants;
import org.eclipse.microprofile.jwt.tck.config.JwksApplication;
import org.eclipse.microprofile.jwt.tck.config.PublicKeyAsPEMLocationURLTest;
import org.eclipse.microprofile.jwt.tck.config.PublicKeyEndpoint;
import org.eclipse.microprofile.jwt.tck.config.SimpleTokenUtils;
import org.eclipse.microprofile.jwt.tck.util.MpJwtTestVersion;
import org.eclipse.microprofile.jwt.tck.util.TokenUtils;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.container.test.api.OperateOnDeployment;
import org.jboss.arquillian.container.test.api.RunAsClient;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.arquillian.testng.Arquillian;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.StringAsset;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.testng.Assert;
import org.testng.Reporter;
import org.testng.annotations.Test;

import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
import static org.eclipse.microprofile.jwt.tck.TCKConstants.TEST_GROUP_CONFIG;

public class PublicKeyAsJWKLocationURLTest extends Arquillian {

/**
* The base URL for the container under test
*/
@ArquillianResource
private URL baseURL;

@Deployment(name = "keyEndpoint", order = 1)
public static WebArchive createKeyEndpoint() throws Exception {
URL publicKey = PublicKeyAsPEMLocationURLTest.class.getResource("/publicKey4k.pem");

final WebArchive webArchive = ShrinkWrap
.create(WebArchive.class, "KeyEndpoint.war")
.addAsResource(publicKey, "/publicKey4k.pem")
.addAsResource(publicKey, "/publicKey.pem")
.addClass(PublicKeyEndpoint.class)
.addClass(KeyApplication.class)
.addClass(SimpleTokenUtils.class)
.addAsWebInfResource("beans.xml", "beans.xml");
return webArchive;
}

/**
* Create a CDI aware base web application archive that includes a JWKS endpoint that
* is referenced via the mp.jwt.verify.publickey.location as a URL resource property.
* The root url is /jwks
* @return the base base web application archive
* @throws IOException - on resource failure
*/
@Deployment(name = "testApp", order = 2)
public static WebArchive createLocationURLDeployment() throws IOException {
URL publicKey = PublicKeyAsJWKLocationURLTest.class.getResource("/publicKey4k.pem");
// Setup the microprofile-config.properties content
Properties configProps = new Properties();
// Read in the base URL of deployment since it cannot be injected for use by this method
String jwksBaseURL = System.getProperty("mp.jwt.tck.jwks.baseURL", "http://localhost:8080/");
// Location points to the JWKS endpoint of the deployment
System.out.printf("baseURL=%s\n", jwksBaseURL);
URL jwksURL = new URL(new URL(jwksBaseURL), "key/endp/publicKey4kAsJWKS?kid=publicKey4k");
System.out.printf("jwksURL=%s\n", jwksURL);
configProps.setProperty(Names.VERIFIER_PUBLIC_KEY_LOCATION, jwksURL.toExternalForm());
configProps.setProperty(Names.ISSUER, TCKConstants.TEST_ISSUER);
StringWriter configSW = new StringWriter();
configProps.store(configSW, "PublicKeyAsJWKLocationURLTest microprofile-config.properties");
StringAsset configAsset = new StringAsset(configSW.toString());
WebArchive webArchive = ShrinkWrap
.create(WebArchive.class, "PublicKeyAsJWKLocationURLTest.war")
.addAsManifestResource(new StringAsset(MpJwtTestVersion.MPJWT_V_1_1.name()), MpJwtTestVersion.MANIFEST_NAME)
.addAsResource(publicKey, "/publicKey4k.pem")
.addAsResource(publicKey, "/publicKey.pem")
.addClass(PublicKeyEndpoint.class)
.addClass(JwksApplication.class)
.addClass(SimpleTokenUtils.class)
.addAsWebInfResource("beans.xml", "beans.xml")
.addAsManifestResource(configAsset, "microprofile-config.properties")
;
System.out.printf("WebArchive: %s\n", webArchive.toString(true));
return webArchive;
}

@RunAsClient()
@OperateOnDeployment("testApp")
@Test(groups = TEST_GROUP_CONFIG,
description = "Validate the http://localhost:8080/jwks/endp/publicKey4kAsJWKS JWKS endpoint")
public void validateLocationUrlContents() throws Exception {
URL locationURL = new URL(baseURL, "jwks/endp/publicKey4kAsJWKS?kid=publicKey4k");
Reporter.log("Begin validateLocationUrlContents");

StringWriter content = new StringWriter();
try(BufferedReader reader = new BufferedReader(new InputStreamReader(locationURL.openStream()))) {
String line = reader.readLine();
while(line != null) {
content.write(line);
content.write('\n');
line = reader.readLine();
}
}
Reporter.log("Received: "+content);
JsonReader jsonReader = Json.createReader(new StringReader(content.toString()));
JsonObject jwks = jsonReader.readObject();
JsonArray keys = jwks.getJsonArray("keys");
JsonObject key = keys.getJsonObject(0);
Assert.assertEquals(key.getJsonString("kty").getString(), "RSA");
Assert.assertEquals(key.getJsonString("use").getString(), "sig");
Assert.assertEquals(key.getJsonString("kid").getString(), "publicKey4k");
Assert.assertEquals(key.getJsonString("alg").getString(), "RS256");
Assert.assertEquals(key.getJsonString("e").getString(), "AQAB");
Assert.assertTrue(key.getJsonString("n").getString().startsWith("tL6HShqY5H4y56rsCo7VdhT9"));
}

@RunAsClient
@OperateOnDeployment("testApp")
@Test(groups = TEST_GROUP_CONFIG, dependsOnMethods = { "validateLocationUrlContents" },
description = "Validate specifying the mp.jwt.verify.publickey.location as remote URL to a JWKS key")
public void testKeyAsLocationUrl() throws Exception {
Reporter.log("testKeyAsLocationUrl, expect HTTP_OK");

PrivateKey privateKey = TokenUtils.readPrivateKey("/privateKey4k.pem");
String kid = "publicKey4k";
HashMap<String, Long> timeClaims = new HashMap<>();
String token = TokenUtils.generateTokenString(privateKey, kid, "/Token1.json", null, timeClaims);

String uri = baseURL.toExternalForm() + "jwks/endp/verifyKeyLocationAsJWKSUrl";
WebTarget echoEndpointTarget = ClientBuilder.newClient()
.target(uri)
.queryParam("kid", kid)
;
Response response = echoEndpointTarget.request(APPLICATION_JSON).header(HttpHeaders.AUTHORIZATION, "Bearer "+token).get();
Assert.assertEquals(response.getStatus(), HttpURLConnection.HTTP_OK);
String replyString = response.readEntity(String.class);
JsonReader jsonReader = Json.createReader(new StringReader(replyString));
JsonObject reply = jsonReader.readObject();
Reporter.log(reply.toString());
Assert.assertTrue(reply.getBoolean("pass"), reply.getString("msg"));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.eclipse.microprofile.jwt.tck.config.SimpleTokenUtils;
import org.eclipse.microprofile.jwt.tck.util.TokenUtils;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.container.test.api.OperateOnDeployment;
import org.jboss.arquillian.container.test.api.RunAsClient;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.arquillian.testng.Arquillian;
Expand Down Expand Up @@ -63,20 +64,36 @@ public class PublicKeyAsPEMLocationTest extends Arquillian {
@ArquillianResource
private URL baseURL;

@Deployment(name = "keyEndpoint", order = 1)
public static WebArchive createKeyEndpoint() throws Exception {
URL publicKey = PublicKeyAsPEMLocationURLTest.class.getResource("/publicKey4k.pem");

final WebArchive webArchive = ShrinkWrap
.create(WebArchive.class, "KeyEndpoint.war")
.addAsResource(publicKey, "/publicKey4k.pem")
.addAsResource(publicKey, "/publicKey.pem")
.addClass(PublicKeyEndpoint.class)
.addClass(KeyApplication.class)
.addClass(SimpleTokenUtils.class)
.addAsWebInfResource("beans.xml", "beans.xml");
return webArchive;
}

/**
* Create a CDI aware base web application archive that includes an embedded JWK public key that
* is referenced via the mp.jwt.verify.publickey.location as a URL resource property.
* The root url is /pem
*
* @return the base base web application archive
* @throws IOException - on resource failure
*/
@Deployment()
@Deployment(name = "testApp", order = 2)
public static WebArchive createLocationURLDeployment() throws IOException {
URL publicKey = PublicKeyAsPEMLocationURLTest.class.getResource("/publicKey4k.pem");
// Setup the microprofile-config.properties content
Properties configProps = new Properties();
// Location points to an endpoint that returns a PEM key
configProps.setProperty(Names.VERIFIER_PUBLIC_KEY_LOCATION, "http://localhost:8080/pem/endp/publicKey4k");
configProps.setProperty(Names.VERIFIER_PUBLIC_KEY_LOCATION, "http://localhost:8080/key/endp/publicKey4k");
configProps.setProperty(Names.ISSUER, TCKConstants.TEST_ISSUER);
StringWriter configSW = new StringWriter();
configProps.store(configSW, "PublicKeyAsPEMLocationURLTest microprofile-config.properties");
Expand All @@ -92,11 +109,11 @@ public static WebArchive createLocationURLDeployment() throws IOException {
.addAsWebInfResource("beans.xml", "beans.xml")
.addAsManifestResource(configAsset, "microprofile-config.properties")
;
System.out.printf("WebArchive: %s\n", webArchive.toString(true));
return webArchive;
}

@RunAsClient()
@OperateOnDeployment("testApp")
@Test(groups = TEST_GROUP_CONFIG,
description = "Validate the http://localhost:8080/pem/endp/publicKey4k PEM endpoint")
public void validateLocationUrlContents() throws Exception {
Expand All @@ -118,6 +135,7 @@ public void validateLocationUrlContents() throws Exception {
}

@RunAsClient
@OperateOnDeployment("testApp")
@Test(groups = TEST_GROUP_CONFIG, dependsOnMethods = { "validateLocationUrlContents" },
description = "Validate specifying the mp.jwt.verify.publickey.location as remote URL to a PEM key")
public void testKeyAsLocationUrl() throws Exception {
Expand Down
8 changes: 6 additions & 2 deletions tck/microprofile-tck/jwt/src/test/resources/dev.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,14 @@
<class name="org.eclipse.microprofile.jwt.tck.container.jaxrs.PrincipalInjectionTest" />
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsPEMTest" />
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsPEMLocationTest" />
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsPEMLocationURLTest" />
<!-- TODO - Replaced with internal test. TCK needs fixing since expects the app to be deployed before loading the key. Key load should be part of the deployment -->
<!-- <class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsPEMLocationURLTest" /> -->
<class name="org.apache.tomee.microprofile.tck.jwt.config.PublicKeyAsPEMLocationTest"/>
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsJWKTest" />
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsJWKLocationTest" />
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsJWKLocationURLTest" />
<!-- TODO - Replaced with internal test. TCK needs fixing since expects the app to be deployed before loading the key. Key load should be part of the deployment -->
<!-- <class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsJWKLocationURLTest" /> -->
<class name="org.apache.tomee.microprofile.tck.jwt.config.PublicKeyAsJWKLocationURLTest"/>
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsJWKSTest" />
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsJWKSLocationTest" />
<class name="org.eclipse.microprofile.jwt.tck.config.PublicKeyAsBase64JWKTest" />
Expand Down
14 changes: 14 additions & 0 deletions tck/microprofile-tck/jwt/src/test/resources/publicKey4k.pem
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtL6HShqY5H4y56rsCo7V
dhT9/eLQwsJpKWg66j98XsB/qc5ZxkJ25GXCzpjR0ZvzAxMNlj1hrMORaKVzz2/5
axZgF1eZfzgrNyQ9rtGaBtMNAB20jLsoYp5psRTaYxKeOiLHPr3956ukSRUF9YfJ
GSamrvGOwC8h6zbq6uaydv+FVJXijlMD/iCggUfoirtVOWK/X1IzV7covxcGzT0X
019/4RbtjLdnvqZnGqmpHQpBEItI+4gNvaKR8NDWUxAjO/v+oOKR5nEUnDWcQSCx
KmyQrVJtHr9PBwWrHzTSx4k1L1hLf+AWXAdy/r6c0Lzgt5knmZTyWDG2+n8SlrXx
HHxFO1Wz8H/OKBzTAf8zIuj2lkXYo+M6aoJM7qQmTys80dtYvnaHGSl+jpe2plMb
S9RS4XcHH7vCqJc9acBnp9CvLgjOmA0b5Rc0WyN4sn1SDFYe6HZcVo4YGTbtTTlw
gu/ozQ1x+xpTAaU0mWkHMwT0CO79rPORjhDXokEuduvtp6VUiAaoFF6Y3QQLf6O3
P9p8yghpBBLb460lEQqOHQQGP0EK46cU81dlcD5lYE0TayDzb9pZZWUyjIE4Elzy
W7wgI4xw7czdBalN+IhXKfGUCqIDVh7X7JpmskZMaRixf424yBcZLntEejZy59yL
DSssHMc/bqnBraXuo8JBEPkCAwEAAQ==
-----END PUBLIC KEY-----

0 comments on commit 4dee78b

Please sign in to comment.