CT-V Package Details
Extracting the CT-V zip file creates the directory structure as shown below:
The below section lists the content of the CT-V directory. Followed by the content are the two notes, one for the CADP JCE directory, and one for the Tokenization directory:
Note
Be sure to explore the samples directory! Thales includes many items in the SafeNetTokenization/Tokenization/Samples directory to simplify the installation, build, and preparation of the samples. For details, see the notes at the end of this listing of the directory contents.
├───IngrianJCE
│ ├───documentation
│ │ └───javadoc
│ │ │ allclasses-frame.html
│ │ │ allclasses-noframe.html
│ │ │ constant-values.html
│ │ │ deprecated-list.html
│ │ │ help-doc.html
│ │ │ index-all.html
│ │ │ index.html
│ │ │ overview-frame.html
│ │ │ overview-summary.html
│ │ │ overview-tree.html
│ │ │ package-list
│ │ │ serialized-form.html
│ │ │ stylesheet.css
│ │ │
│ │ ├───com
│ │ │ └───ingrian
│ │ │ ├──────internal
│ │ │ │ └──────kmip
│ │ │ │ └───────api
│ │ │ │ └────────crypto
│ │ │ │ KMIPCipher.html
│ │ │ │ KMIPCryptoResult.html
│ │ │ │ KMIPGCMSpec.html
│ │ │ │ KMIPIvSpec.html
│ │ │ │ package-frame.html
│ │ │ │ package-summary.html
│ │ │ │ package-tree.html
│ │ │ │
│ │ │ └───security
│ │ │ └─────nae
│ │ │ BulkOperation.html
│ │ │ CSRInformation.html
│ │ │ CSRSigningInfo.html
│ │ │ FPEFormat.html
│ │ │ FPEParameterAndFormatSpec.html
│ │ │ GCMParameterSpec.html
│ │ │ IngrianProvider.html
│ │ │ KeyExportData.html
│ │ │ KMIPAttributeNames.html
│ │ │ KMIPAttributeNames.KMIPAttribute.html
│ │ │ KMIPAttributes.html
│ │ │ KMIPBatch.html
│ │ │ KMIPBatchItemResult.html
│ │ │ KMIPBatchResults.html
│ │ │ KMIPCertificateIdentifier.html
│ │ │ KMIPCertificateIssuer.html
│ │ │ KMIPCertificateSubject.html
│ │ │ KMIPCertificateType.html
│ │ │ KMIPCertificateTypes.html
│ │ │ KMIPDigestAttribute.HashingAlgorithms.html
│ │ │ KMIPDigestAttribute.html
│ │ │ KMIPLinkAttribute.html
│ │ │ KMIPLinkAttribute.LinkTypes.html
│ │ │ KMIPNameAttribute.html
│ │ │ KMIPNameAttribute.NameTypes.html
│ │ │ KMIPQueryFunction.html
│ │ │ KMIPQueryFunction.Query.html
│ │ │ KMIPSecretData.html
│ │ │ KMIPSecretData.SecretDataType.html
│ │ │ KMIPSession.html
│ │ │ KMIPStates.html
│ │ │ LoadKeystore.html
│ │ │ MACValue.html
│ │ │ NAEAdminRequestProcessor.html
│ │ │ NAECertificate.html
│ │ │ NAEClientCertificate.html
│ │ │ NAEException.html
│ │ │ NAEFPECipher.AESCard10.html
│ │ │ NAEFPECipher.AESCard26.html
│ │ │ NAEFPECipher.AESCard62.html
│ │ │ NAEFPECipher.AESUnicode.html
│ │ │ NAEFPECipher.html
│ │ │ NAEIvAndDbColumnIdParameterSpec.html
│ │ │ NAEIvAndTweakDataParameter.html
│ │ │ NAEKey.html
│ │ │ NAEParameterSpec.html
│ │ │ NAEPermission.html
│ │ │ NAEPrivateKey.html
│ │ │ NAEPublicKey.html
│ │ │ NAESecretKey.html
│ │ │ NAESecureRandom.html
│ │ │ NAESecureRandom.SHA1PRNG.html
│ │ │ NAESEEDCipher.CBCNoPadding.html
│ │ │ NAESEEDCipher.CBCPKCS5Padding.html
│ │ │ NAESEEDCipher.ECBNoPadding.html
│ │ │ NAESEEDCipher.ECBPKCS5Padding.html
│ │ │ NAESEEDCipher.html
│ │ │ NAESession.html
│ │ │ package-frame.html
│ │ │ package-summary.html
│ │ │ package-tree.html
│ │ │ SessionLevelConfig.html
│ │ │ UserKeysDetail.html
│ │ │
│ │ └───resources
│ │ background.gif
│ │ tab.gif
│ │ titlebar.gif
│ │ titlebar_end.gif
│ │
│ └───lib
│ └────ext
│ commons-collections4-4.1.jar
│ commons-lang3-3.1.jar
│ gson-2.1.jar
│ guava-20.0.jar
│ Ingrianlog4j-api-2.10.0.jar
│ Ingrianlog4j-core-2.10.0.jar
│ IngrianNAE-8.12.2.000.jar
│ IngrianNAE.properties
│
└───Tokenization
├────── doc
│ └────javadoc
│ │ allclasses-frame.html
│ │ allclasses-frame.html.bak
│ │ allclasses-noframe.html
│ │ allclasses-noframe.html.bak
│ │ constant-values.html
│ │ constant-values.html.bak
│ │ deprecated-list.html
│ │ deprecated-list.html.bak
│ │ help-doc.html
│ │ help-doc.html.bak
│ │ index-all.html
│ │ index-all.html.bak
│ │ index.html
│ │ index.html.bak
│ │ overview-frame.html
│ │ overview-frame.html.bak
│ │ overview-summary.html
│ │ overview-summary.html.bak
│ │ overview-tree.html
│ │ overview-tree.html.bak
│ │ package-frame.html
│ │ package-frame.html.bak
│ │ package-list
│ │ package-summary.html
│ │ package-summary.html.bak
│ │ package-tree.html
│ │ package-tree.html.bak
│ │ SafeNetTokenizer.html
│ │ SafeNetTokenizer.html.bak
│ │ serialized-form.html
│ │ serialized-form.html.bak
│ │ stylesheet.css
│ │
│ ├───com
│ │ └───safenet
│ │ └───token
│ │ CustomSiteIDGenerator.html
│ │ DeleteTable.html
│ │ IHashSiteIdGenerator.html
│ │ IStrategyDeleteToken.html
│ │ IStrategySearch.html
│ │ IStrategyUpdateTokenProperty.html
│ │ ITokenGenerator.html
│ │ ITokenService.html
│ │ ITokenValidator.html
│ │ package-frame.html
│ │ package-summary.html
│ │ package-tree.html
│ │ ReKey.html
│ │ RotateKey.html
│ │ RtConfig.html
│ │ SearchCriteria.html
│ │ SearchPurgeUtility.html
│ │ SetKey.html
│ │ SetupDB.html
│ │ SiteBean.html
│ │ StrategyDeleteTokenSink.html
│ │ StrategyMultiSiteDelete.html
│ │ StrategyMultiSiteGetToken.html
│ │ StrategyMultisiteSearch.html
│ │ StrategyMultiSiteUpdateTokenProperty.html
│ │ StrategySearchSink.html
│ │ StrategyUpdateTokenPropertySink.html
│ │ TmResult.html
│ │ TokenException.html
│ │ TokenProperty.html
│ │ TokenService.html
│ │ TokenServiceDob.html
│ │ TokenServiceImpl.html
│ │ TokenServiceUpgrader.html
│ │ TokenVaultManager.html
│ │ TsList.html
│ │ Utils.html
│ │ Utils.PrompterTool.html
│ │
│ └───resources
│ inherit.gif
│
├───dotNet
│ ├───x64
│ │ SafeNetTokenization.exe
│ │
│ └───x86
│ SafeNetTokenization.exe
│
├───lib
│ └───ext
│ bson-2.5.1.jar
│ c3p0-0.9.5.4.jar
│ detokenization.properties
│ install_sap_tm.bat
│ jaxb-api-2.2.3.jar
│ jdbc-4.10.6.20151104.jar
│ jtds-1.2.8.jar
│ Databases.json
│ masking.properties
│ mchange-commons-java-0.2.11.jar
│ migration.properties
│ MultiSite.properties
│ mysql-connector-java-5.1.42-bin.jar
│ mysql-connector-java-5.1.48.jar
│ ojdbc7.jar
│ oraclepki.jar
│ osdt_cert.jar
│ osdt_core.jar
│ SafeNetToken.properties
│ Utility.properties
│ json-simple-1.1.jar
│
├───restfulService
│ │ tmrest.war
│ │
│ └───tmRestDockerization
│ build.sh
│ config.properties
│ Dockerfile
│
└───samples
│ AdvancedMultiThreadSample.class
│ AdvancedMultiThreadSample.java
│ CustomSiteIdGeneratorSample.class
│ CustomSiteIdGeneratorSample.java
│ DeleteTokenExSample.class
│ DeleteTokenExSample.java
│ MultiThreadSample.class
│ MultiThreadSample.java
│ PerfUtil.java
│ RandomLengthCustomFormatSample.class
│ RandomLengthCustomFormatSample.java
│ SafeNetTokenStub-8.12.3.000.jar
│ TokenPropertySample.class
│ TokenPropertySample.java
│ MultipleDBSample.java
│ MultipleDBSample.class
│ TokenServiceSample$1.class
│ TokenServiceSample$2.class
│ TokenServiceSample$3.class
│ TokenServiceSample$MyTokenGenerator.class
│ TokenServiceSample$MyTokenValidator.class
│ TokenServiceSample.class
│ TokenServiceSample.java
│ TokenServiceUnicodeSample.class
│ TokenServiceUnicodeSample.java
│ wsbuild.bat
│ wsbuild.sh
│ wscheckenv.bat
│ wscheckenv.sh
│ WSDeleteTokenExBatchSample.class
│ WSDeleteTokenExBatchSample.java
│ WSDeleteTokenExSample.class
│ WSDeleteTokenExSample.java
│ WSRandomLengthCustomFormatSample.class
│ WSRandomLengthCustomFormatSample.java
│ wsrun.bat
│ wsrun.sh
│ WSTokenSample.class
│ WSTokenSample.java
│ WSTokenSampleOneOperation.class
│ WSTokenSampleOneOperation.java
│ WSTokenServiceUnicodeSample.class
│ WSTokenServiceUnicodeSample.java
│
├───bulkutility
│ ├───detokenization
│ │ ├───delimited
│ │ │ detokenization.properties
│ │ │ tokenized.csv
│ │ │
│ │ ├───positional
│ │ │ detokenization.properties
│ │ │ tokenized.csv
│ │ │
│ │ └───streamInput_Positional
│ │ detokenization.properties
│ │ EOutput.txt
│ │
│ └───tokenization
│ ├───--delimited
│ │ customerTable.csv
│ │ migration.properties
│ │
│ ├───positional
│ │ customerTable_Positional.csv
│ │ migration.properties
│ │
│ └───streamInput_Positional
│ customerTable.csv
│ migration.properties
│
├───cctest
│ cctest.war
│ INSTALL.TXT
│
├───epcc_jsp_sample
│ epcc-sample-payment-processor.war
│ epcc-sample-token-manager.war
│ epcc-sample-vendor.war
│ INSTALL.TXT
│
├───log_samples
│ CustomLoggingServiceSample.java
│ JavaUtilLogger.java
│ log.properties
│
├───rest
│ GsonMessageBodyHandler.java
│ TMRestCXFClient.java
│
└───SAPTM
Z_CREATEGENVALTOKENFORMAT.txt
Z_CREATENEWTOKENFORMAT.txt
Z_CREATEREGEXTOKENFORMAT.txt
Z_CREATETOKENFORMATRANGELENGTH.txt
Z_CREATETOKENFORMATTOKENLENGTH.txt
Z_DELETETOKEN.txt
Z_DELETETOKENBATCH.txt
Z_DELETEVALUE.txt
Z_DELETEVALUEBATCH.txt
Z_GETTOKEN.txt
Z_GETTOKENBATCH.txt
Z_GETTOKENSBYDATE.txt
Z_GETTOKENSBYRANGEDATE.txt
Z_GETVALUE.txt
Z_GETVALUEBATCH.txt
Z_INSERTBATCH.txt
Z_INSERTBATCHSMARTCHECK.txt
Z_INSERTBATCHWITHCUSTOMDATA.txt
Z_INSERTTOKEN.txt
Z_INSERT_CUSTDATA_GEN_VAL.txt
Z_MASK.txt
Z_MASKWITHFORMAT.txt
Notes on CADP JCE (JCE Provider) subdirectories and files
The IngrianJCE/documentation directory contains the javadoc for our JCE Provider, which gives a complete description of all of its public classes and methods.
The IngrianJCE/lib/ext directory contains the following files:
| Filename | Description |
|---|---|
| commonscollections4- 4.1.jar | Apache Commons reusable Java components. Extends or augments the Java Collections Framework. |
| Ingrianlog4j-api- 2.10.0.jar | Thales log4j logging application. Required for all installations. |
| Ingrianlog4j-core- 2.10.0.jar | Thales' log4j logging application. Required for all installations. |
| commons-lang3- 3.1.jar | Apache 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 to String and equals. |
| gson-2.1.jar | A java library to convert JSON to Java objects and vice versa. |
| guava-20.0.jar | Library used for key caching. |
| IngrianNAE- 8.12.2.000.jar | The Java components of the CADP JCE Provider. Required for all installations. |
| IngrianNAE.properties | Contains the parameters used by the CADP JCE Provider. Controls logging level, log file location, communication with the Key Manager, among other features. |
Notes on Tokenization Subdirectories and Files
The Tokenization/doc directory contains the javadoc for our CT-V, which gives a complete description of all of its public classes and methods.
The Tokenization/lib/ext directory contains the following files:
| Filename | Description |
|---|---|
| c3p0-0.9.5.4.jar | Library used to augment jdbc drivers with JNDI-bindable DataSources, including DataSources that implement connection and statement pooling. Required for all installations. |
| detokenization.proper ties | Contains the parameters used to set up the bulk detokenization feature without using the token vault. |
| migration.properties | Contains the parameters used to set up the bulk migration feature using the token vault. |
| masking.properties | Contains the parameters used to set up the bulk migration feature without using the token vault |
| MultiSite.properties | Contains the parameters used to configure the multi-site feature. |
| mysql-connector- java-5.1.42-bin.jar | The MySQL JDBC driver. Required when the token vault resides on a MySQL database and CT-V Java runtime environment version is 7. |
| mysql-connector- java-5.1.48.jar | The MySQL JDBC driver. Required when a token vault resides on MySQL database and CT-V Java runtime environment version is 8 or above. |
| ojdbc7.jar | The Oracle JDBC driver. Required when the token vault resides on an Oracle database. |
| SafeNetToken.properties | Contains the parameters used by the CT-V. Required for all installations. |
| SafeNetTokenService-8.12.3.000.jar | The Java components of the CT-V. Required for all installations. |
| services.xml | The services.xml file for Axis2. |
| SfntDbp.properties | Contains the following database connection pooling parameters used by c3p0 for local database settings. Required for all installations. • com.mchange.v2.log.MLog. • com.mchange.v2.log.FallbackMLog.DEFAULT_CUTOFF_LEVEL. • c3p0.initialPoolSize • c3p0.maxStatementsPerConnection • c3p0.acquireRetryAttempts. • c3p0.checkoutTimeout • ^breakAfterAcquireFailure • ^testConnectionOnCheckin • *c3p0.minPoolSize • *c3p0.maxPoolSize • *c3p0.maxIdleTime Please find details of the C3p0 settings available at the following link: http://www.mchange.com/projects/c3p0/#configuration_properties Notes: • ^When these parameters are enabled the DatabaseRetryTime parameter of SafeNetToken.properties file gets enabled, which allows the CT-V to retry the connection to a database server only after 120seconds of first failure. • *These properties have been moved from the SafeNetToken.properties file. • Applying any property, other than the ones mentioned above, are ignored. • c3p0 logging related property (com.mchange.v2.log) can be set only once. |
| SilentInstallation.prop erties | Contains the parameters used to configure the silent installation of CT-V for Java API and Web Services. |
| sqljdbc41.jar | The SQL Server JDBC driver. Requires when the token vault resides on an MS SQL Server database. |
| TokenizationInstaller- 8.12.3.000.jar | The installation program for the CT-V. Required for all installations. (But not required after installation.) |
| TVMMySQL.jar | Contains classes needed to communicate with MySQL database. |
| TVMOracle.jar | Contains the classes needed to communicate with Oracle database. |
| TVMSQLServer.jar | Contains the classes needed to communicate with SQL Server database. |
| TVMInformix.jar | Contains the classes needed to communicate with Informix database. |
| unicode.properties | Contains the parameters used by CT-V to recognize and apply Unicode characters. |
| TMService.zip | Contains SAP related binaries. |
| install_sap_tm.bat | Script to install SAPTM. |
| Utility.properties | Contains the properties to run the SearchPurgeUtility. |
The Tokenization/samples directory contains the class and java files for multiple sample applications, including:
An example of single-threaded API usage, and two examples of multi-threaded API usage.
SafeNetTokenStub-8.12.3.000.jar simplifies the sample installation process.
Unicode samples for both Java and .Net developers. These show how to use a Unicode Customization File to define custom character sets to be used in tokenization. Specified sets of Unicode input characters can be recognized and converted during tokenization processing into other specified sets of Unicode characters.
Three Web Service samples now come pre-compiled. A batch file (wsbuild.bat for Windows, wsbuild.sh for Unix-like) assists in building them.
wsrun.bat prompts for parameters.
wsrun.sh prompts for parameters.
Java files for two web service examples (WSTokenSample and WSTokenSampleOneOperation), both of which are now compiled as part of the build process.
Note
For more information on the Web service samples, refer to [Web Service Examples for Java Developers].
Class and java files for a .jsp sample utility (epcc_jsp_sample). This enables an administrator to set up a vendor to tokenize credit card numbers at the end point (e.g., at a customer website). To use this sample utility, you must run the TokenServiceAuth utility to create a token service user.
SAPTM contains Advanced Business Application Programming (ABAP) samples to invoke CT-V related operations on SAP. Refer to CT-V SAP Integration User Guide for integration task.
You must compile some samples yourself. Instructions are included in this document.
