Package com.unboundid.util.ssl

Class TrustStoreTrustManager

java.lang.Object
com.unboundid.util.ssl.TrustStoreTrustManager
All Implemented Interfaces:
Serializable, TrustManager, X509TrustManager
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TrustStoreTrustManager extends Object implements X509TrustManager, Serializable
This class provides an SSL trust manager that will consult a specified trust store file to determine whether to trust a certificate that is presented to it. By default, it will use the default trust store format for the JVM (e.g., "JKS" for Sun-provided Java implementations), but alternate formats like PKCS12 may be used.
See Also:

  • Constructor Details

    • TrustStoreTrustManager

      public TrustStoreTrustManager(@NotNull File trustStoreFile)
      Creates a new instance of this trust store trust manager that will trust all certificates in the specified file within the validity window. It will use the default trust store format and will not provide a PIN when attempting to read the trust store.
      Parameters:
      trustStoreFile - The path to the trust store file to use. It must not be null.

    • TrustStoreTrustManager

      public TrustStoreTrustManager(@NotNull String trustStoreFile)
      Creates a new instance of this trust store trust manager that will trust all certificates in the specified file within the validity window. It will use the default trust store format and will not provide a PIN when attempting to read the trust store.
      Parameters:
      trustStoreFile - The path to the trust store file to use. It must not be null.

    • TrustStoreTrustManager

      public TrustStoreTrustManager(@NotNull File trustStoreFile, @Nullable char[] trustStorePIN, @Nullable String trustStoreFormat, boolean examineValidityDates)
      Creates a new instance of this trust store trust manager that will trust all certificates in the specified file with the specified constraints.
      Parameters:
      trustStoreFile - The path to the trust store file to use. It must not be null.
      trustStorePIN - The PIN to use to access the contents of the trust store. It may be null if no PIN is required.
      trustStoreFormat - The format to use for the trust store. It may be null if the default format should be used.
      examineValidityDates - Indicates whether to reject certificates if the current time is outside the validity window for the certificate.

    • TrustStoreTrustManager

      public TrustStoreTrustManager(@NotNull String trustStoreFile, @Nullable char[] trustStorePIN, @Nullable String trustStoreFormat, boolean examineValidityDates)
      Creates a new instance of this trust store trust manager that will trust all certificates in the specified file with the specified constraints.
      Parameters:
      trustStoreFile - The path to the trust store file to use. It must not be null.
      trustStorePIN - The PIN to use to access the contents of the trust store. It may be null if no PIN is required.
      trustStoreFormat - The format to use for the trust store. It may be null if the default format should be used.
      examineValidityDates - Indicates whether to reject certificates if the current time is outside the validity window for the certificate.

    • TrustStoreTrustManager

      public TrustStoreTrustManager(@NotNull TrustStoreTrustManagerProperties properties)
      Creates a new instance of this trust store trust manager that will trust all certificates in the specified file with the specified constraints.
      Parameters:
      properties - The properties to use for this trust manager. It must not be null.

  • Method Details

    • getTrustStoreFile

      @NotNull public String getTrustStoreFile()
      Retrieves the path to the trust store file to use.
      Returns:
      The path to the trust store file to use.

    • getTrustStoreFormat

      @NotNull public String getTrustStoreFormat()
      Retrieves the name of the trust store file format.
      Returns:
      The name of the trust store file format.

    • examineValidityDates

      public boolean examineValidityDates()
      Indicate whether to reject certificates if the current time is outside the validity window for the certificate.
      Returns:
      true if the certificate validity time should be examined and certificates should be rejected if they are expired or not yet valid, or false if certificates should be accepted even outside of the validity window.

    • checkClientTrusted

      public void checkClientTrusted(@NotNull X509Certificate[] chain, @NotNull String authType) throws CertificateException
      Checks to determine whether the provided client certificate chain should be trusted.
      Specified by:
      checkClientTrusted in interface X509TrustManager
      Parameters:
      chain - The client certificate chain for which to make the determination.
      authType - The authentication type based on the client certificate.
      Throws:
      CertificateException - If the provided client certificate chain should not be trusted.

    • checkServerTrusted

      public void checkServerTrusted(@NotNull X509Certificate[] chain, @NotNull String authType) throws CertificateException
      Checks to determine whether the provided server certificate chain should be trusted.
      Specified by:
      checkServerTrusted in interface X509TrustManager
      Parameters:
      chain - The server certificate chain for which to make the determination.
      authType - The key exchange algorithm used.
      Throws:
      CertificateException - If the provided server certificate chain should not be trusted.

    • getAcceptedIssuers

      @NotNull public X509Certificate[] getAcceptedIssuers()
      Retrieves the accepted issuer certificates for this trust manager. This will always return an empty array.
      Specified by:
      getAcceptedIssuers in interface X509TrustManager
      Returns:
      The accepted issuer certificates for this trust manager.