Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

Quick Start

Deploy CADP for Java using installer

search

Please Note:

Deploy CADP for Java using installer

  1. Download the provider from our customer support site. The software adheres to the following naming convention:

    Product Name - Product Version - File Format

    CADP_for_JAVA_v8.17.1.000.zip

  2. Extract the file using any standard archive utility.

    Extracting the archive creates the following directory structure:

    For information on directory structure and its content, refer to Directory Structure

  3. Navigate to the directory where the CADP for Java is extracted.

  4. Navigate to the CADP_for_JAVA/lib/ext directory and run the following command to install CADP for Java.

    java -jar CADP_for_JAVA_Installer-8.17.1.000.jar

    The license agreement is displayed on the console.

  5. Press return/enter to continue or s to skip to the end.

  6. Enter Yes, If you agree to the license terms.

    The installer verifies the Java version.

  7. Specify the installation location for CADP for Java.

    • For Java 8, enter Yes to install CADP for Java in the default directory that is <JAVA_HOME>\lib\ext. Enter No to select a different location.

    • For Java 10 and higher versions, the installer will prompt for the installation directory.

    The installer displays the following properties that are required to connect to the Key Manager.

    • NAE_IP.1

    • NAE_Port

    • Log_File

  8. Enter Yes to update these properties. Enter No to continue with the existing values.

    The installation setup is complete; now, you need to perform Post Installation Steps.

    CADP for Java is also available as a Maven distribution. To learn more, refer to Deploy CADP for Java using Maven Distribution.

Directory Structure

Here are the files that you need to be aware of.

FilenameDescription
commons-codec-1.15.jarApache Commons reusable Java components. Apache Commons Codec (TM) software provides implementations of common encoders and decoders such as Base64, Hex, and others.
commons-lang3-3.12.0.jarApache Commons reusable Java components. Lang provides methods for manipulation of core classes in the standard Java library, utilities for the java.lang API, and helps with building methods, such as hashCode, toString and equals.
commons-collections4-4.4.jarApache Commons reusable Java components. Extends or augments the Java Collections Framework.
gson-2.10.1.jarA Java library to convert JSON to Java objects and vice versa.
guava-31.1-jre.jarGuava is a suite of core and expanded libraries that include utility classes, Google's collections, I/O classes, and much more. This library is used for key caching.
failureaccess-1.0.1.jarContains com.google.common.
util.concurrent.internal.InternalFutureFailureAccess
and InternalFutures classes.
CADP_for_JAVA.propertiesCADP for Java’s configuration file.
CADP_for_JAVA-8.17.1.000.jarThe Java components of the CADP for Java (Ingrian) Provider. Required for all installations.
CADP_for_JAVA_Installer-8.17.1.000.jarAutomates the CADP for Java installation by placing the CADP for Java jar files at default Java path or user provided path and setting basic Key Manager configuration parameters such as IP, Port, and Log path.
cryptodatautility.jarCADP for Java utility used to decrypt a string without specifying the keyName and algorithm.
license.rtfCADP for Java license file.
NOTICE.txtCADP for Java’s open source notice.
log4j-core-2.19.0.jarThe Apache Log4j ImplementationLogging application.
log4j-api-2.19.0.jarProvides the interface that applications should code to and provides the adapter components required for implementers to create a logging implementation.
bcprov-jdk15to18-1.71.jarRequired for AES/GCM and SEED algorithms when symmetric cache is enabled.
bcpkix-jdk15on-1.70.jarBouncy castle jar required for format conversion of EC keys.
bcutil-jdk15on-1.70.jarBouncy Castle Java APIs required for ASN.1 extension and utility APIs to support bcpkix and bctls.
SafeNetVaultlessTokenization.propertiesContains the parameters used for tokenization. Required for all installations.
SafeNetVaultlessTokenization-8.10.0.000.jarContains the Java components required for tokenization. Required for all installations.
unicode.propertiesContains the parameters required to tokenize Unicode characters.
migration.propertiesContains the parameters used to set up the bulk migration feature.
detokenization.propertiesContains the parameters used to set up the bulk detokenization feature.

Important Notes

Note

We are migrating CSEG and BYOK REST API support to open-source as integration. To handle these migrations, 8.15.0 release onward, the safenetcloud.war and sfbyok.war files are not bundled with the CADP for Java package. Soon, CSEG and BYOK REST API support will be available as open-source.

  1. In case of Java 10, the java.se.ee module needs to be added as a JVM argument.

  2. For Java 11 and higher versions, download the following JAR files from a trusted source and add their paths in Tomcat's CLASSPATH:

    • jaxb-api-2.3.1.jar

    • jaxb-impl-2.3.1.jar

    • jaxb-core-2.3.0.1.jar

    • javax.activation-1.2.0.jar

  3. For Java 8, the following jar files are OSGI compliant:

    • cryptodatautility.jar

    • CADP_for_JAVA-8.17.1.000.jar

    These jar files access some non-public APIs, user needs to enable the org.osgi.framework.bootdelegation=sun.,com.sun. property in the OSGI framework to provide access to these APIs.

  4. User can configure an external logger to capture logs instead of the default logging jar files log4j-core-2.19.0.jar and log4j-api-2.19.0.jar.

  5. To run multiple web applications using CADP for Java, place the CADP_for_JAVA jar file and dependent jar files in a desired directory and specify it as CLASSPATH for each web application.
    For example, when deploying multiple web applications using CADP for Java in Tomcat, place the jar files in Tomcat's lib directory.

On this page