# NIOSslSocket.java

    /*
    ** Module   : NIOSslSocket.java
    ** Abstract : Implements NetSocket operations which are specific for SSL channels.
    **
    ** Copyright (c) 2016-2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date--  ---------------------------------------Description---------------------------------------
    ** 001 IAS 20160805  Initial version
    ** 002 IAS 20200805  Improve logging and fixed handshake
    ** 003 IAS 20210608  Log SSL session details
    ** 004 GBB 20230512  Logging methods replaced by CentralLogger/ConversionStatus.
    ** 005 EVL 20231124  Decreased poll time to 100 milliseconds to improve responce time.
    */
    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.net;

    import java.io.*;
    import java.nio.*;
    import java.nio.channels.*;
    import java.util.concurrent.*;
    import java.util.concurrent.atomic.*;
    import java.util.logging.*;

    import javax.net.ssl.*;
    import javax.net.ssl.SSLEngineResult.*;

    import com.goldencode.p2j.util.logging.*;

    /**
     * Implements NetSocket operations which are specific for SSL channels
     */
    class NIOSslSocket
    extends NIONetSocketBase
    {
       /** Logger */
       protected static final CentralLogger LOG = CentralLogger.get(NIOSslSocket.class.getName(), true, true);

       protected static final AtomicInteger THREAD_COUNT = new AtomicInteger(0);
       /** SSLEngine */
       protected final SSLEngine engine;

       /** SSL Provider */
       protected final SSL ssl;

       /** Input chunks' queue */
       protected final BlockingQueue<byte[]> queue = new LinkedBlockingQueue<>();

       /** Auxiliary executor service */
       protected final ExecutorService sslFsmWorkers;

       /** Input byte stream splitter */
       protected final ByteArrayHandler byteArrayHandler;

       /**
        * Constructor
        *
        * @param engine
        *        SSL Engine
        * @param channel
        *        underlying SocketChannel
        * @throws   IOException
        *           on error
        */
       public NIOSslSocket(SSLEngine engine, SocketChannel channel)
       throws IOException
       {
          super(channel);
          channel.configureBlocking(engine.getUseClientMode());
          String parent = Thread.currentThread().getName();
          this.engine = engine;
          this.sslFsmWorkers = Executors.newFixedThreadPool(2,
                   new ThreadFactory()
                   {
                      @Override
                      public Thread newThread(Runnable r)
                      {
                         Thread t = new Thread(r, parent + ":nioSslTaskWorker#" + THREAD_COUNT.getAndIncrement());
                         t.setDaemon(true);
                         return t;
                      }
                   }
          );
          this.byteArrayHandler = new ByteArrayHandler(BUF_SIZE, TRACE_LM)
          {
             @Override
             protected void ready(byte[] data)
             {
                queue.offer(data);
             }
          };

          engine.beginHandshake();
          this.ssl = new BlockingSSL(channel, engine, sslFsmWorkers)
          {
             /**
              * Accept the next decrypted portion of the input
              *
              * @param decrypted
              *        the next decrypted portion of the input
              */
             @Override
             public void nextChunk(ByteBuffer decrypted)
             {
                byteArrayHandler.nextChunk(decrypted);
             }
          };
          CountDownLatch hs = new CountDownLatch(1);
          this.sslFsmWorkers.execute(() ->
          {
             ssl.run();
          });

          this.sslFsmWorkers.execute(() ->
          {
             while(channel.isOpen())
             {
                if (ssl.handshakeDone())
                {
                   hs.countDown();
                }
                try
                {
                   ssl.checkInput();
                }
                catch (EOFException e)
                {
                   break;
                }
                catch (Exception e)
                {
                   LOG.log(Level.WARNING, "Exception on SSL handshake ", e);
                }
                HandshakeStatus handshakeStatus = engine.getHandshakeStatus();
                if(SSL.AFTER_HANDSHAKE.contains(handshakeStatus))
                {
                   hs.countDown();
                }
             }
             queue.offer(new byte[0]);
          });

          try
          {
             boolean isFineLoggable = LOG.isLoggable(Level.FINE);
             hs.await(handshakeTimeout, TimeUnit.MILLISECONDS);
             if (hs.getCount() != 0)
             {
                if (isFineLoggable)
                {
                   LOG.log(Level.FINE, parent + ":Handshake timed out.");
                }
                close();
                throw new SSLHandshakeException(parent + ":Handshake timed out.");
             }
             if (isFineLoggable)
             {
                SSLSession session = engine.getSession();
                LOG.log(Level.FINE,
                         String.format("%s:Handshake done; %s; %s",
                                  parent, session.getProtocol(), session.toString()));
             }
             channel.configureBlocking(true);
          }
          catch (InterruptedException e)
          {
             LOG.log(Level.WARNING, "Waiting for SSL handshake interruptred", e);
          }
      }

       /**
        * Closes the socket.
        */
       public void close()
       {
          super.close();
          sslFsmWorkers.shutdownNow();
          traceln("NIOSsslSocket closed");
       }

       /**
        * Gets the SSL session.
        *
        * @return   The SSL session or <code>null</code> if the socket is not
        *           secure.
        */
       @Override
       public SSLSession getSession()
       {
          return engine.getSession();
       }

       /**
        * Send the data to the channel
        *
        * @param bb
        *        data to be sent
        */
       protected void write(ByteBuffer bb) throws IOException
       {
          ssl.send(bb);
       }

       /**
        * Read next data chunk from the channel
        *
        * @return next data chunk
        */
       @Override
       protected byte[] readFully() throws IOException, EOFException
       {
          byte[] b = null;
          while(b == null)
          {
             if (!channel.isOpen())
             {
                throw new EOFException();
             }
             try
             {
                b = queue.poll(100, TimeUnit.MILLISECONDS);
             }
             catch (InterruptedException ignore)
             {
             }
          }
          if (b.length == 0)
          {
             throw new EOFException();
          }
          return b;
       }

       /**
        * Get maximal message size
        *
        * @return maximal message size;
        */
       @Override
       protected int getMaxMessageSize()
       {
          return ssl.getMaxMessageSize();
       }
    }