mtien-apache commented on a change in pull request #4593: URL: https://github.com/apache/nifi/pull/4593#discussion_r511161695
########## File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-security/src/test/groovy/org/apache/nifi/web/security/oidc/OidcServiceGroovyTest.groovy ########## @@ -0,0 +1,212 @@ +/* + * 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.nifi.web.security.oidc + + +import com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod +import com.nimbusds.oauth2.sdk.id.Issuer +import com.nimbusds.openid.connect.sdk.SubjectType +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata +import io.jsonwebtoken.Jwts +import io.jsonwebtoken.SignatureAlgorithm +import org.apache.nifi.admin.service.KeyService +import org.apache.nifi.key.Key +import org.apache.nifi.util.NiFiProperties +import org.apache.nifi.web.security.jwt.JwtService +import org.apache.nifi.web.security.token.LoginAuthenticationToken +import org.junit.After +import org.junit.Before +import org.junit.BeforeClass +import org.junit.Test +import org.junit.runner.RunWith +import org.junit.runners.JUnit4 +import org.slf4j.Logger +import org.slf4j.LoggerFactory + +import java.util.concurrent.TimeUnit + +@RunWith(JUnit4.class) +class OidcServiceGroovyTest extends GroovyTestCase { + private static final Logger logger = LoggerFactory.getLogger(OidcServiceGroovyTest.class) + + private static final Key SIGNING_KEY = new Key(id: 1, identity: "signingKey", key: "mock-signing-key-value") + private static final Map<String, Object> DEFAULT_NIFI_PROPERTIES = [ + isOidcEnabled : true, + getOidcDiscoveryUrl : "https://localhost/oidc";, + isLoginIdentityProviderEnabled: false, + isKnoxSsoEnabled : false, + getOidcConnectTimeout : "1000", + getOidcReadTimeout : "1000", + getOidcClientId : "expected_client_id", + getOidcClientSecret : "expected_client_secret", + getOidcClaimIdentifyingUser : "username", + getOidcPreferredJwsAlgorithm : "" + ] + + // Mock collaborators + private static NiFiProperties mockNiFiProperties + private static JwtService mockJwtService = [:] as JwtService + private static StandardOidcIdentityProvider soip + + private static final String MOCK_REQUEST_IDENTIFIER = "mock-request-identifier" + private static final String MOCK_JWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZS" + + "I6Ik5pRmkgT0lEQyBVbml0IFRlc3RlciIsImlhdCI6MTUxNjIzOTAyMiwiZXhwIjoxNTE2MzM5MDIyLCJpc3MiOiJuaWZpX3VuaXRf" + + "dGVzdF9hdXRob3JpdHkiLCJhdWQiOiJhbGwiLCJ1c2VybmFtZSI6Im9pZGNfdGVzdCIsImVtYWlsIjoib2lkY190ZXN0QG5pZmkuYX" + + "BhY2hlLm9yZyJ9.b4NIl0RONKdVLOH0D1eObdwAEX8qX-ExqB8KuKSZFLw" + + @BeforeClass + static void setUpOnce() throws Exception { + logger.metaClass.methodMissing = { String name, args -> + logger.info("[${name?.toUpperCase()}] ${(args as List).join(" ")}") + } + } + + @Before + void setUp() throws Exception { + mockNiFiProperties = buildNiFiProperties() + soip = new StandardOidcIdentityProvider(mockJwtService, mockNiFiProperties) + } + + @After + void teardown() throws Exception { + } + + private static NiFiProperties buildNiFiProperties(Map<String, Object> props = [:]) { + def combinedProps = DEFAULT_NIFI_PROPERTIES + props + def mockNFP = combinedProps.collectEntries { String k, def v -> + [k, { -> return v }] + } + mockNFP as NiFiProperties + } + + private static JwtService buildJwtService() { + def mockJS = new JwtService([:] as KeyService) { + @Override + String generateSignedToken(LoginAuthenticationToken lat) { + signNiFiToken(lat) + } + } + mockJS + } + + private static String signNiFiToken(LoginAuthenticationToken lat) { + String identity = "mockUser" + String USERNAME_CLAIM = "username" + String KEY_ID_CLAIM = "keyId" + Calendar expiration = Calendar.getInstance() + expiration.setTimeInMillis(System.currentTimeMillis() + 10_000) + String username = lat.getName() + + return Jwts.builder().setSubject(identity) + .setIssuer(lat.getIssuer()) + .setAudience(lat.getIssuer()) + .claim(USERNAME_CLAIM, username) + .claim(KEY_ID_CLAIM, SIGNING_KEY.getId()) + .setExpiration(expiration.getTime()) + .setIssuedAt(Calendar.getInstance().getTime()) + .signWith(SignatureAlgorithm.HS256, SIGNING_KEY.key.getBytes("UTF-8")).compact() + } + + @Test + void testShouldStoreJwt() { + // Arrange + StandardOidcIdentityProvider soip = buildIdentityProviderWithMockInitializedProvider([:]) + + OidcService service = new OidcService(soip) + + // Expected JWT + logger.info("EXPECTED_JWT: ${MOCK_JWT}") + + // Act + service.storeJwt(MOCK_REQUEST_IDENTIFIER, MOCK_JWT) + + // Assert + final String cachedJwt = service.getJwt(MOCK_REQUEST_IDENTIFIER) + logger.info("Cached JWT: ${cachedJwt}") + + assert cachedJwt == MOCK_JWT + } + + @Test + void testShouldGetJwt() { + // Arrange + StandardOidcIdentityProvider soip = buildIdentityProviderWithMockInitializedProvider([:]) + + OidcService service = new OidcService(soip) + + // Expected JWT + logger.info("EXPECTED_JWT: ${MOCK_JWT}") + + // store the jwt + service.storeJwt(MOCK_REQUEST_IDENTIFIER, MOCK_JWT) + + // Act + final String retrievedJwt = service.getJwt(MOCK_REQUEST_IDENTIFIER) + logger.info("Retrieved JWT: ${retrievedJwt}") + + // Assert + assert retrievedJwt == MOCK_JWT + } + + @Test + void testGetJwtShouldReturnNullWithExpiredDuration() { + // Arrange + StandardOidcIdentityProvider soip = buildIdentityProviderWithMockInitializedProvider([:]) + + final int DURATION = 1 + final TimeUnit EXPIRATION_UNITS = TimeUnit.SECONDS + OidcService service = new OidcService(soip, DURATION, EXPIRATION_UNITS) + + // Expected JWT + logger.info("EXPECTED_JWT: ${MOCK_JWT}") + + // Store the jwt + service.storeJwt(MOCK_REQUEST_IDENTIFIER, MOCK_JWT) + + // Put thread to sleep + long millis = 3 * 1000 + Thread.sleep(millis) Review comment: Thanks for the suggestion, @exceptionfactory . Fixed. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
