com.mps.deepviolet.api.DVFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of DeepViolet Show documentation
TLS/SSL security introspection API
The newest version!
package com.mps.deepviolet.api;

import java.io.IOException;
import java.net.URL;
import java.net.InetAddress;
import java.util.ArrayList;

import javax.net.ssl.SSLSocket;
import javax.net.ssl.SSLSocketFactory;

import com.mps.deepviolet.api.IDVSession.CIPHER_NAME_CONVENTION;
import com.mps.deepviolet.util.FileUtils;

/**
 * Initial entry point for all DeepViolet API work.
 * 
 * The DeepViolet API is divided across two main functions, online and offline
 * reporting. Online reports like SSL/TLS DAST scans require an online host.
 * However, other features may be used offline like processing and printing PEM
 * encoded X.509 certificates. To get an idea for how to use DeepViolet API take
 * a look at the following examples.
 * 
 * 
 * {@code IDSession session = DVFactory.initializeSession(url);
 * IDVEng eng = DVFactory.getIDVEng(session);
 * IDVCipherSuite[] ciphers = eng.getHostCipherSuites();
 * ...iterate over the ciphers, do cool stuff, makes your own custom reports or UI...}
 * 
 * 
 *  * {@code com.mps.deepviolet.api.samples}
 * 
 * 
 * @author Milton Smith
 */
public class DVFactory {

	private DVFactory() {
	}

	/**
	 * Initialize a session. Required for obtaining an instance of IDVOnEng.
	 * 
	 * @param url
	 *            URL of the host to perform SSL/TLS scan
	 * @return Initialized session instance for this host.
	 * @throws DVException
	 *             Thrown on problems initializing host.
	 */
	public static final synchronized IDVSession initializeSession(URL url) throws DVException {
		ArrayList list = new ArrayList();
		MutableDVSession session = null;

		SSLSocketFactory factory = (SSLSocketFactory) SSLSocketFactory.getDefault();
		SSLSocket socket = null;

		try {
			
			// Creates default working dir if needed for log files.
			FileUtils.createWorkingDirectory();
			
			socket = (SSLSocket) factory.createSocket(url.getHost(), url.getDefaultPort());

			// Add interfaces
			InetAddress[] addresses = InetAddress.getAllByName(url.getHost());
			for (InetAddress address : addresses) {
				String host = address.getHostName();
				String ip = address.getHostAddress();
				String canonical = address.getCanonicalHostName();
				ImmutableDVHost dvhost = new ImmutableDVHost(host, ip, canonical, url);
				list.add(dvhost);
			}

			// TODO: Fix types, e.g. int for size of receive buffer
			String soKeepalive = Boolean.toString(socket.getKeepAlive());
			String soRcvbuf = Integer.toString(socket.getReceiveBufferSize());
			String soLinger = Integer.toString(socket.getSoLinger());
			String soTimeout = Integer.toString(socket.getSoTimeout());
			String trafficClass = Integer.toString(socket.getTrafficClass());
			String clientAuthReq = Boolean.toString(socket.getNeedClientAuth());
			String clientAuthWant = Boolean.toString(socket.getWantClientAuth());
			String tcpNodelay = Boolean.toString(socket.getTcpNoDelay());
			String soReuseaddr = Boolean.toString(socket.getReuseAddress());
			String soSendbuff = Integer.toString(socket.getSendBufferSize());
			// TODO OOBINLINE causes socket to error, leave for now
			// String oobinline = Boolean.toString(socket.getOOBInline());

			// Grab enabled protocols as reported by socket
			String enabledProtocols = String.join(",", socket.getEnabledProtocols());
			
			session = new MutableDVSession(url, (IDVHost[]) list.toArray(new ImmutableDVHost[0]));
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.SO_KEEPALIVE, soKeepalive);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.SO_RCVBUF, soRcvbuf);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.SO_LINGER, soLinger);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.SO_TIMEOUT, soTimeout);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.SO_REUSEADDR, soReuseaddr);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.SO_SENDBUFF, soSendbuff);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.CLIENT_AUTH_REQ, clientAuthReq);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.CLIENT_AUTH_WANT, clientAuthWant);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.TRAFFIC_CLASS, trafficClass);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.TCP_NODELAY, tcpNodelay);
			session.setSessionPropertyValue(IDVSession.SESSION_PROPERTIES.ENABLED_PROTOCOLS, enabledProtocols);
			
		} catch (Exception e) {
			throw new DVException(e);
		} finally {
			if (socket != null) {
				try {
					socket.close();
				} catch (IOException ignored) {
				}
			}
		}
		return session;
	}

	/**
	 * Retrieve an instance of IDVOnEng. Use this method for online functions
	 * against an initialize host.  Calls {@link #getDVEng(IDVSession, CIPHER_NAME_CONVENTION)} and
	 * passes CIPHER_NAME_CONVENTION.IANA.
	 *
	 * @param session
	 *            Initialized session from previous call to initializeSession(URL)
	 * @return Engine instance for offline functions
	 * @throws DVException
	 *           Thrown on problems initializing host.
	 * @see #initializeSession(URL)
	 */
	public static final synchronized IDVEng getDVEng(IDVSession session) throws DVException {
		return new DVEng(session, IDVSession.CIPHER_NAME_CONVENTION.IANA);
	}
	
	/**
	 * Retrieve an instance of IDVOnEng. Use this method for online functions
	 * against an initialize host.
	 * 
	 * @param session
	 *            Initialized session from previous call to initializeSession(URL)
	 *  @param cipher_name_convention Cipher suite name convention.
	 * @return Engine instance for offline functions
	 * @throws DVException
	 *           Thrown on problems initializing host.
	 * @see #initializeSession(URL)
	 */
	public static final synchronized IDVEng getDVEng(IDVSession session, IDVSession.CIPHER_NAME_CONVENTION cipher_name_convention ) throws DVException {
		return new DVEng(session, cipher_name_convention);
	}
	
	/**
	 * Retrieve an instance of IDVOnEng. Use this method to post regular status to your DVBackgroundTask.
	 * 
	 * @param session
	 *            Initialized session from previous call to initializeSession(URL)
	 * @param cipher_name_convention Cipher suite name convention.
	 * @param dvtask DVBackgroundTask to update with user displayable status information.
	 * @return Engine instance for offline functions
	 * @throws DVException
	 *           Thrown on problems initializing host.
	 * @see #initializeSession(URL)
	 */
	public static final synchronized IDVEng getDVEng(IDVSession session, IDVSession.CIPHER_NAME_CONVENTION cipher_name_convention, DVBackgroundTask dvtask ) throws DVException {
		return new DVEng(session, cipher_name_convention, dvtask);
	}
}