/*
    * MIT License
    *
    * Copyright (c) 2010-2024 The Waffle Project Contributors: https://github.com/Waffle/waffle/graphs/contributors
    *
    * Permission is hereby granted, free of charge, to any person obtaining a copy
    * of this software and associated documentation files (the "Software"), to deal
    * in the Software without restriction, including without limitation the rights
    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   * copies of the Software, and to permit persons to whom the Software is
   * furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in all
   * copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   * SOFTWARE.
   */
  package waffle.apache;
  
  import static org.assertj.core.api.Assertions.assertThat;
  
  import com.sun.jna.platform.win32.Sspi;
  import com.sun.jna.platform.win32.SspiUtil.ManagedSecBufferDesc;
  
  import java.util.Base64;
  import java.util.Collections;
  
  import javax.servlet.ServletException;
  
  import mockit.Expectations;
  import mockit.Mocked;
  
  import org.apache.catalina.Context;
  import org.apache.catalina.Engine;
  import org.apache.catalina.LifecycleException;
  import org.apache.catalina.realm.GenericPrincipal;
  import org.junit.jupiter.api.AfterEach;
  import org.junit.jupiter.api.Assertions;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  
  import waffle.apache.catalina.SimpleHttpRequest;
  import waffle.apache.catalina.SimpleHttpResponse;
  import waffle.mock.MockWindowsAuthProvider;
  import waffle.windows.auth.IWindowsCredentialsHandle;
  import waffle.windows.auth.IWindowsIdentity;
  import waffle.windows.auth.PrincipalFormat;
  import waffle.windows.auth.impl.WindowsAccountImpl;
  import waffle.windows.auth.impl.WindowsCredentialsHandleImpl;
  import waffle.windows.auth.impl.WindowsSecurityContextImpl;
  
  /**
   * Waffle Tomcat Mixed Authenticator Test.
   */
  class MixedAuthenticatorTest {
  
      /** The authenticator. */
      MixedAuthenticator authenticator;
  
      /** The context. */
      @Mocked
      Context context;
  
      /** The engine. */
      @Mocked
      Engine engine;
  
      /**
       * Sets the up.
       *
       * @throws LifecycleException
       *             the lifecycle exception
       */
      @BeforeEach
      void setUp() throws LifecycleException {
          this.authenticator = new MixedAuthenticator();
          this.authenticator.setContainer(this.context);
          Assertions.assertNotNull(new Expectations() {
              {
                  MixedAuthenticatorTest.this.context.getParent();
                  this.result = MixedAuthenticatorTest.this.engine;
                  MixedAuthenticatorTest.this.context.getParent();
                  this.result = null;
              }
          });
          this.authenticator.start();
      }
  
      /**
       * Tear down.
       *
       * @throws LifecycleException
       *             the lifecycle exception
      */
     @AfterEach
     void tearDown() throws LifecycleException {
         this.authenticator.stop();
     }
 
     /**
      * Test challenge get.
      */
     @Test
     void testChallengeGET() {
         final SimpleHttpRequest request = new SimpleHttpRequest();
         request.setMethod("GET");
         request.setQueryString("j_negotiate_check");
         final SimpleHttpResponse response = new SimpleHttpResponse();
         this.authenticator.authenticate(request, response);
         final String[] wwwAuthenticates = response.getHeaderValues("WWW-Authenticate");
         Assertions.assertNotNull(wwwAuthenticates);
         Assertions.assertEquals(2, wwwAuthenticates.length);
         Assertions.assertEquals("Negotiate", wwwAuthenticates[0]);
         Assertions.assertEquals("NTLM", wwwAuthenticates[1]);
         Assertions.assertEquals("close", response.getHeader("Connection"));
         Assertions.assertEquals(2, response.getHeaderNames().size());
         Assertions.assertEquals(401, response.getStatus());
     }
 
     /**
      * Test challenge post.
      */
     @Test
     void testChallengePOST() {
         final String securityPackage = "Negotiate";
         IWindowsCredentialsHandle clientCredentials = null;
         WindowsSecurityContextImpl clientContext = null;
         try {
             // client credentials handle
             clientCredentials = WindowsCredentialsHandleImpl.getCurrent(securityPackage);
             clientCredentials.initialize();
             // initial client security context
             clientContext = new WindowsSecurityContextImpl();
             clientContext.setPrincipalName(WindowsAccountImpl.getCurrentUsername());
             clientContext.setCredentialsHandle(clientCredentials);
             clientContext.setSecurityPackage(securityPackage);
             clientContext.initialize(null, null, WindowsAccountImpl.getCurrentUsername());
             final SimpleHttpRequest request = new SimpleHttpRequest();
             request.setQueryString("j_negotiate_check");
             request.setMethod("POST");
             request.setContentLength(0);
             final String clientToken = Base64.getEncoder().encodeToString(clientContext.getToken());
             request.addHeader("Authorization", securityPackage + " " + clientToken);
             final SimpleHttpResponse response = new SimpleHttpResponse();
             this.authenticator.authenticate(request, response);
             Assertions.assertTrue(response.getHeader("WWW-Authenticate").startsWith(securityPackage + " "));
             Assertions.assertEquals("keep-alive", response.getHeader("Connection"));
             Assertions.assertEquals(2, response.getHeaderNames().size());
             Assertions.assertEquals(401, response.getStatus());
         } finally {
             if (clientContext != null) {
                 clientContext.dispose();
             }
             if (clientCredentials != null) {
                 clientCredentials.dispose();
             }
         }
     }
 
     /**
      * Test get.
      */
     @Test
     void testGet() {
         final SimpleHttpRequest request = new SimpleHttpRequest();
         final SimpleHttpResponse response = new SimpleHttpResponse();
         Assertions.assertFalse(this.authenticator.authenticate(request, response));
     }
 
     /**
      * Test get info.
      */
     @Test
     void testGetInfo() {
         assertThat(this.authenticator.getInfo()).isNotEmpty();
     }
 
     /**
      * Test negotiate.
      */
     @Test
     void testNegotiate() {
         final String securityPackage = "Negotiate";
         IWindowsCredentialsHandle clientCredentials = null;
         WindowsSecurityContextImpl clientContext = null;
         try {
             // client credentials handle
             clientCredentials = WindowsCredentialsHandleImpl.getCurrent(securityPackage);
             clientCredentials.initialize();
             // initial client security context
             clientContext = new WindowsSecurityContextImpl();
             clientContext.setPrincipalName(WindowsAccountImpl.getCurrentUsername());
             clientContext.setCredentialsHandle(clientCredentials);
             clientContext.setSecurityPackage(securityPackage);
             clientContext.initialize(null, null, WindowsAccountImpl.getCurrentUsername());
             // negotiate
             boolean authenticated = false;
             final SimpleHttpRequest request = new SimpleHttpRequest();
             request.setQueryString("j_negotiate_check");
             String clientToken;
             while (true) {
                 clientToken = Base64.getEncoder().encodeToString(clientContext.getToken());
                 request.addHeader("Authorization", securityPackage + " " + clientToken);
 
                 final SimpleHttpResponse response = new SimpleHttpResponse();
                 authenticated = this.authenticator.authenticate(request, response);
 
                 if (authenticated) {
                     assertThat(response.getHeaderNames().size()).isNotNegative();
                     break;
                 }
 
                 Assertions.assertTrue(response.getHeader("WWW-Authenticate").startsWith(securityPackage + " "));
                 Assertions.assertEquals("keep-alive", response.getHeader("Connection"));
                 Assertions.assertEquals(2, response.getHeaderNames().size());
                 Assertions.assertEquals(401, response.getStatus());
                 final String continueToken = response.getHeader("WWW-Authenticate")
                         .substring(securityPackage.length() + 1);
                 final byte[] continueTokenBytes = Base64.getDecoder().decode(continueToken);
                 assertThat(continueTokenBytes).isNotEmpty();
                 final ManagedSecBufferDesc continueTokenBuffer = new ManagedSecBufferDesc(Sspi.SECBUFFER_TOKEN,
                         continueTokenBytes);
                 clientContext.initialize(clientContext.getHandle(), continueTokenBuffer,
                         WindowsAccountImpl.getCurrentUsername());
             }
             Assertions.assertTrue(authenticated);
         } finally {
             if (clientContext != null) {
                 clientContext.dispose();
             }
             if (clientCredentials != null) {
                 clientCredentials.dispose();
             }
         }
     }
 
     /**
      * Test post security check.
      */
     @Test
     void testPostSecurityCheck() {
         final SimpleHttpRequest request = new SimpleHttpRequest();
         request.setQueryString("j_security_check");
         request.addParameter("j_username", "username");
         request.addParameter("j_password", "password");
         final SimpleHttpResponse response = new SimpleHttpResponse();
         Assertions.assertFalse(this.authenticator.authenticate(request, response));
     }
 
     /**
      * Test programmatic security BOTH.
      *
      * @param identity
      *            the identity
      *
      * @throws ServletException
      *             the servlet exception
      */
     @Test
     void testProgrammaticSecurityBoth(@Mocked final IWindowsIdentity identity) throws ServletException {
         this.authenticator.setAuth(new MockWindowsAuthProvider());
         final SimpleHttpRequest request = new SimpleHttpRequest();
         request.getMappingData().context = (Context) this.authenticator.getContainer();
 
         request.login(WindowsAccountImpl.getCurrentUsername(), "");
 
         Assertions.assertNotNull(new Expectations() {
             {
                 identity.getFqn();
                 this.result = "fqn";
                 identity.getSidString();
                 this.result = "S-1234";
             }
         });
         request.setUserPrincipal(new GenericWindowsPrincipal(identity, PrincipalFormat.BOTH, PrincipalFormat.BOTH));
 
         Assertions.assertTrue(request.getUserPrincipal() instanceof GenericWindowsPrincipal);
         final GenericWindowsPrincipal windowsPrincipal = (GenericWindowsPrincipal) request.getUserPrincipal();
         Assertions.assertTrue(windowsPrincipal.getSidString().startsWith("S-"));
     }
 
     /**
      * Test programmatic security SID.
      *
      * @param identity
      *            the identity
      *
      * @throws ServletException
      *             the servlet exception
      */
     @Test
     void testProgrammaticSecuritySID(@Mocked final IWindowsIdentity identity) throws ServletException {
         this.authenticator.setAuth(new MockWindowsAuthProvider());
         final SimpleHttpRequest request = new SimpleHttpRequest();
         request.getMappingData().context = (Context) this.authenticator.getContainer();
 
         request.login(WindowsAccountImpl.getCurrentUsername(), "");
 
         Assertions.assertNotNull(new Expectations() {
             {
                 identity.getSidString();
                 this.result = "S-1234";
             }
         });
         request.setUserPrincipal(new GenericWindowsPrincipal(identity, PrincipalFormat.SID, PrincipalFormat.SID));
 
         Assertions.assertTrue(request.getUserPrincipal() instanceof GenericWindowsPrincipal);
         final GenericWindowsPrincipal windowsPrincipal = (GenericWindowsPrincipal) request.getUserPrincipal();
         Assertions.assertTrue(windowsPrincipal.getSidString().startsWith("S-"));
     }
 
     /**
      * Test programmatic security NONE.
      *
      * @param identity
      *            the identity
      *
      * @throws ServletException
      *             the servlet exception
      */
     @Test
     void testProgrammaticSecurityNone(@Mocked final IWindowsIdentity identity) throws ServletException {
         this.authenticator.setAuth(new MockWindowsAuthProvider());
         final SimpleHttpRequest request = new SimpleHttpRequest();
         request.getMappingData().context = (Context) this.authenticator.getContainer();
 
         request.login(WindowsAccountImpl.getCurrentUsername(), "");
 
         request.setUserPrincipal(new GenericWindowsPrincipal(identity, PrincipalFormat.NONE, PrincipalFormat.NONE));
 
         Assertions.assertTrue(request.getUserPrincipal() instanceof GenericWindowsPrincipal);
         final GenericWindowsPrincipal windowsPrincipal = (GenericWindowsPrincipal) request.getUserPrincipal();
         Assertions.assertNull(windowsPrincipal.getSidString());
     }
 
     /**
      * Test security check parameters.
      */
     @Test
     void testSecurityCheckParameters() {
         this.authenticator.setAuth(new MockWindowsAuthProvider());
         final SimpleHttpRequest request = new SimpleHttpRequest();
         request.addParameter("j_security_check", "");
         request.addParameter("j_username", WindowsAccountImpl.getCurrentUsername());
         request.addParameter("j_password", "");
         final SimpleHttpResponse response = new SimpleHttpResponse();
         Assertions.assertTrue(this.authenticator.authenticate(request, response));
     }
 
     /**
      * Test security check query string.
      */
     @Test
     void testSecurityCheckQueryString() {
         this.authenticator.setAuth(new MockWindowsAuthProvider());
         final SimpleHttpRequest request = new SimpleHttpRequest();
         request.setQueryString("j_security_check");
         request.addParameter("j_username", WindowsAccountImpl.getCurrentUsername());
         request.addParameter("j_password", "");
         final SimpleHttpResponse response = new SimpleHttpResponse();
         Assertions.assertTrue(this.authenticator.authenticate(request, response));
     }
 
     @Test
     void testCustomPrincipal() throws LifecycleException {
         final GenericPrincipal genericPrincipal = new GenericPrincipal("my-principal", "my-password",
                 Collections.emptyList());
         final MixedAuthenticator customAuthenticator = new MixedAuthenticator() {
             @Override
             protected GenericPrincipal createPrincipal(final IWindowsIdentity windowsIdentity) {
                 return genericPrincipal;
             }
         };
         try {
             customAuthenticator.setContainer(this.context);
             customAuthenticator.setAlwaysUseSession(true);
             customAuthenticator.start();
 
             customAuthenticator.setAuth(new MockWindowsAuthProvider());
             final SimpleHttpRequest request = new SimpleHttpRequest();
             request.addParameter("j_security_check", "");
             request.addParameter("j_username", WindowsAccountImpl.getCurrentUsername());
             request.addParameter("j_password", "");
             final SimpleHttpResponse response = new SimpleHttpResponse();
             Assertions.assertTrue(customAuthenticator.authenticate(request, response));
 
             Assertions.assertEquals(genericPrincipal, request.getUserPrincipal());
         } finally {
             customAuthenticator.stop();
         }
 
     }
 
 }