| /* |
| * 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 |
| * <p> |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * <p> |
| * 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.hadoop.ozone.om.request.security; |
| |
| import java.io.IOException; |
| import java.nio.charset.StandardCharsets; |
| import com.google.common.base.Optional; |
| import java.util.UUID; |
| import org.apache.hadoop.ozone.om.response.OMClientResponse; |
| import org.apache.hadoop.ozone.security.OzoneDelegationTokenSecretManager; |
| import org.apache.hadoop.ozone.security.OzoneTokenIdentifier; |
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type; |
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Status; |
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos |
| .OMRequest; |
| import static org.apache.hadoop.ozone.security.OzoneTokenIdentifier.KIND_NAME; |
| import org.apache.hadoop.security.token.Token; |
| import org.apache.hadoop.security.proto.SecurityProtos.GetDelegationTokenRequestProto; |
| import org.apache.commons.lang3.RandomStringUtils; |
| import org.apache.hadoop.io.Text; |
| import org.mockito.Mockito; |
| import static org.mockito.ArgumentMatchers.any; |
| import static org.mockito.ArgumentMatchers.anyLong; |
| import static org.mockito.Mockito.when; |
| import org.junit.Assert; |
| import org.junit.Before; |
| import org.junit.Test; |
| |
| /** |
| * The class tests OMGetDelegationTokenRequest. |
| */ |
| public class TestOMGetDelegationTokenRequest extends |
| TestOMDelegationTokenRequest { |
| |
| private OzoneDelegationTokenSecretManager secretManager; |
| private OzoneTokenIdentifier identifier; |
| private Token<OzoneTokenIdentifier> token; |
| private Text tester; |
| private OMRequest originalRequest; |
| private OMRequest modifiedRequest; |
| private OMGetDelegationTokenRequest omGetDelegationTokenRequest; |
| final private String checkResponse = ""; |
| |
| @Before |
| public void setupGetDelegationToken() { |
| secretManager = Mockito.mock(OzoneDelegationTokenSecretManager.class); |
| when(ozoneManager.getDelegationTokenMgr()).thenReturn(secretManager); |
| |
| setupToken(); |
| setupRequest(); |
| } |
| |
| private void setupRequest() { |
| GetDelegationTokenRequestProto getDelegationTokenRequestProto = |
| GetDelegationTokenRequestProto.newBuilder() |
| .setRenewer(identifier.getRenewer().toString()) |
| .build(); |
| |
| originalRequest = OMRequest.newBuilder() |
| .setClientId(UUID.randomUUID().toString()) |
| .setCmdType(Type.GetDelegationToken) |
| .setGetDelegationTokenRequest(getDelegationTokenRequestProto) |
| .build(); |
| |
| omGetDelegationTokenRequest = |
| new OMGetDelegationTokenRequest(originalRequest); |
| |
| modifiedRequest = null; |
| } |
| |
| private void verifyUnchangedRequest() { |
| Assert.assertEquals( |
| originalRequest.getCmdType(), |
| modifiedRequest.getCmdType()); |
| Assert.assertEquals( |
| originalRequest.getClientId(), |
| modifiedRequest.getClientId()); |
| } |
| |
| private void setupToken() { |
| tester = new Text("tester"); |
| identifier = new OzoneTokenIdentifier(tester, tester, tester); |
| identifier.setOmCertSerialId("certID"); |
| identifier.setOmServiceId(""); |
| |
| byte[] password = RandomStringUtils |
| .randomAlphabetic(10) |
| .getBytes(StandardCharsets.UTF_8); |
| Text service = new Text("OMTest:9862"); |
| token = new Token<>(identifier.getBytes(), password, KIND_NAME, service); |
| } |
| |
| private OMClientResponse setValidateAndUpdateCache() throws IOException { |
| modifiedRequest = omGetDelegationTokenRequest.preExecute(ozoneManager); |
| OMGetDelegationTokenRequest reqPreExecuted = |
| new OMGetDelegationTokenRequest(modifiedRequest); |
| |
| long txLogIndex = 1L; |
| return reqPreExecuted.validateAndUpdateCache( |
| ozoneManager, txLogIndex, ozoneManagerDoubleBufferHelper); |
| } |
| |
| @Test |
| public void testPreExecuteWithNonNullToken() throws Exception { |
| /* Let token of ozoneManager.getDelegationToken() is nonNull. */ |
| when(ozoneManager.getDelegationToken(tester)).thenReturn(token); |
| |
| long tokenRenewInterval = 1000L; |
| when(ozoneManager.getDelegationTokenMgr().getTokenRenewInterval()) |
| .thenReturn(tokenRenewInterval); |
| |
| modifiedRequest = omGetDelegationTokenRequest.preExecute(ozoneManager); |
| verifyUnchangedRequest(); |
| |
| long originalInterval = originalRequest.getUpdateGetDelegationTokenRequest() |
| .getTokenRenewInterval(); |
| long renewInterval = modifiedRequest.getUpdateGetDelegationTokenRequest() |
| .getTokenRenewInterval(); |
| Assert.assertNotEquals(originalInterval, renewInterval); |
| Assert.assertEquals(tokenRenewInterval, renewInterval); |
| |
| /* In preExecute(), if the token is nonNull |
| we set GetDelegationTokenResponse with response. */ |
| Assert.assertNotEquals(checkResponse, |
| modifiedRequest.getUpdateGetDelegationTokenRequest() |
| .getGetDelegationTokenResponse() |
| .toString()); |
| Assert.assertNotNull(modifiedRequest |
| .getUpdateGetDelegationTokenRequest() |
| .getGetDelegationTokenResponse()); |
| } |
| |
| @Test |
| public void testPreExecuteWithNullToken() throws Exception { |
| /* Let token of ozoneManager.getDelegationToken() is Null. */ |
| when(ozoneManager.getDelegationToken(tester)).thenReturn(null); |
| |
| modifiedRequest = omGetDelegationTokenRequest.preExecute(ozoneManager); |
| verifyUnchangedRequest(); |
| |
| /* In preExecute(), if the token is null |
| we do not set GetDelegationTokenResponse with response. */ |
| Assert.assertEquals(checkResponse, |
| modifiedRequest.getUpdateGetDelegationTokenRequest() |
| .getGetDelegationTokenResponse() |
| .toString()); |
| } |
| |
| @Test |
| public void testValidateAndUpdateCacheWithNonNullToken() throws Exception { |
| /* Let token of ozoneManager.getDelegationToken() is nonNull. */ |
| when(ozoneManager.getDelegationToken(tester)).thenReturn(token); |
| |
| /* Mock OzoneDelegationTokenSecretManager#updateToken() to |
| * get specific renewTime for verifying OMClientResponse returned by |
| * validateAndUpdateCache(). */ |
| long renewTime = 1000L; |
| when(secretManager.updateToken( |
| any(Token.class), any(OzoneTokenIdentifier.class), anyLong())) |
| .thenReturn(renewTime); |
| |
| OMClientResponse clientResponse = setValidateAndUpdateCache(); |
| |
| Optional<Long> responseRenewTime = Optional.fromNullable( |
| omMetadataManager.getDelegationTokenTable().get(identifier)); |
| Assert.assertEquals(Optional.of(renewTime), responseRenewTime); |
| |
| Assert.assertEquals(Status.OK, clientResponse.getOMResponse().getStatus()); |
| } |
| |
| @Test |
| public void testValidateAndUpdateCacheWithNullToken() throws Exception { |
| /* Let token of ozoneManager.getDelegationToken() is Null. */ |
| when(ozoneManager.getDelegationToken(tester)).thenReturn(null); |
| |
| OMClientResponse clientResponse = setValidateAndUpdateCache(); |
| |
| boolean hasResponse = modifiedRequest.getUpdateGetDelegationTokenRequest() |
| .getGetDelegationTokenResponse().hasResponse(); |
| Assert.assertFalse(hasResponse); |
| |
| Optional<Long> responseRenewTime = Optional.fromNullable( |
| omMetadataManager.getDelegationTokenTable().get(identifier)); |
| Assert.assertEquals(Optional.absent(), responseRenewTime); |
| |
| Assert.assertEquals(Status.OK, clientResponse.getOMResponse().getStatus()); |
| } |
| |
| @Test |
| public void testValidateAndUpdateCacheWithException() throws Exception { |
| /* Create a token that causes InvalidProtocolBufferException by |
| * OzoneTokenIdentifier#readProtoBuf(). */ |
| Token<OzoneTokenIdentifier> exceptToken = new Token<>(); |
| when(ozoneManager.getDelegationToken(tester)).thenReturn(exceptToken); |
| |
| OMClientResponse clientResponse = setValidateAndUpdateCache(); |
| |
| boolean hasResponse = modifiedRequest.getUpdateGetDelegationTokenRequest() |
| .getGetDelegationTokenResponse().hasResponse(); |
| Assert.assertTrue(hasResponse); |
| |
| Assert.assertNotEquals(Status.OK, |
| clientResponse.getOMResponse().getStatus()); |
| } |
| } |