Package org.apache.tomcat.util.net.openssl.ciphers

Class OpenSSLCipherConfigurationParser

  • public class OpenSSLCipherConfigurationParser
extends java.lang.Object
    Class in charge with parsing openSSL expressions to define a list of ciphers.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.List<java.lang.String> convertForJSSE​(java.util.Collection<Cipher> ciphers)
      Converts a collection of OpenSSL ciphers to their JSSE names.
      static boolean isTls13Cipher​(java.lang.String cipherSuiteName)
      Determines if the provided name is the name of a TLS 1.3 cipher suite.
      static java.lang.String jsseToOpenSSL​(java.lang.String jsseCipherName)
      Converts a JSSE cipher name to an OpenSSL cipher name.
      static void main​(java.lang.String[] args)
      Main entry point for the cipher configuration parser tool.
      static java.lang.String openSSLToJsse​(java.lang.String opensslCipherName)
      Converts an OpenSSL cipher name to a JSSE cipher name.
      static java.util.LinkedHashSet<Cipher> parse​(java.lang.String expression)
      Parses an OpenSSL cipher expression into a set of ciphers.
      static java.util.List<java.lang.String> parseExpression​(java.lang.String expression)
      Parse the specified expression according to the OpenSSL syntax and returns a list of standard JSSE cipher names.
      static void usage()
      Prints usage information for the command-line tool.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • OpenSSLCipherConfigurationParser

        public OpenSSLCipherConfigurationParser()
        Constructs an OpenSSLCipherConfigurationParser.

    • Method Detail

      • parse

        public static java.util.LinkedHashSet<Cipher> parse​(java.lang.String expression)
        Parses an OpenSSL cipher expression into a set of ciphers.
        Parameters:
        expression - The cipher expression to parse
        Returns:
        The set of matching ciphers

      • convertForJSSE

        public static java.util.List<java.lang.String> convertForJSSE​(java.util.Collection<Cipher> ciphers)
        Converts a collection of OpenSSL ciphers to their JSSE names.
        Parameters:
        ciphers - The OpenSSL ciphers to convert
        Returns:
        The list of JSSE cipher names

      • isTls13Cipher

        public static boolean isTls13Cipher​(java.lang.String cipherSuiteName)
        Determines if the provided name is the name of a TLS 1.3 cipher suite.
        Parameters:
        cipherSuiteName - The name to test
        Returns:
        true if the provided String is recognised as the name of a TLS 1.3 cipherSuite.

      • parseExpression

        public static java.util.List<java.lang.String> parseExpression​(java.lang.String expression)
        Parse the specified expression according to the OpenSSL syntax and returns a list of standard JSSE cipher names.
        Parameters:
        expression - the openssl expression to define a list of cipher.
        Returns:
        the corresponding list of ciphers.

      • jsseToOpenSSL

        public static java.lang.String jsseToOpenSSL​(java.lang.String jsseCipherName)
        Converts a JSSE cipher name to an OpenSSL cipher name.
        Parameters:
        jsseCipherName - The JSSE name for a cipher
        Returns:
        The OpenSSL name for the specified JSSE cipher

      • openSSLToJsse

        public static java.lang.String openSSLToJsse​(java.lang.String opensslCipherName)
        Converts an OpenSSL cipher name to a JSSE cipher name.
        Parameters:
        opensslCipherName - The OpenSSL name for a cipher
        Returns:
        The JSSE name for the specified OpenSSL cipher. If none is known, the IANA standard name will be returned instead

      • usage

        public static void usage()
        Prints usage information for the command-line tool.

      • main

        public static void main​(java.lang.String[] args)
                 throws java.lang.Exception
        Main entry point for the cipher configuration parser tool.
        Parameters:
        args - Command line arguments
        Throws:
        java.lang.Exception - if an error occurs