Running the JADE Database Encryption Utility

The JADE Database Encryption utility (jdbcrypt.exe), installed with your JADE software, is a batch utility in which all input values except passphrases are specified on the command line.

As the JADE Database Encryption utility can be run only in single user mode, you must first shut down the database server.

The JADE Database Encryption utility must be run under the same account as the database server.

The jdbcrypt command line format is as follows.

jdbcrypt path=database-path
         ini=initialization-file
         action=ListStatus|EnableDatabaseEncryption|
                DisableDatabaseEncryption|EncryptFile|EncryptFiles|
                DecryptFile|DecryptFiles|ApplyPendingChanges|
                ClearPendingChanges|ExportMasterKey|ImportMasterKey|
                ListStoredKeys|DeleteStoredKey|help
         [optional-arguments]

Command actions have the following syntax.

ListStatus                ListStatus [ListPartitions=true]
EnableDatabaseEncryption  EnableDatabaseEncryption ExportPath=file-path
                          [AccessCheck=Default|Strong|None]
                          [MultipleExport=true]
                          [MandatoryFullEncryption=true]
DisableDatabaseEncryption DisableDatabaseEncryption [RetainMasterKey=true]
EncryptFile|EncryptFiles  File=file-name|File1=file-name File2=file-name …|
                          Files=file-name;file-name;…
                          [NoPassPhrase=true]
EncryptFile               MandatoryFullEncryption=true|false
                          [NoPassPhrase=true]
DecryptFile|DecryptFiles  File=file-name|File1=file-name File2=file-name …|
                          Files=file-name;file-name;…
                          [NoPassPhrase=true]
ApplyPendingChanges       ApplyPendingChanges
ClearPendingChanges       ClearPendingChanges
ExportMasterKey           ExportMasterKey ExportPath=file-path
ImportMasterKey           ImportMasterKey ImportPath=file-path
                          [SuppressDatabaseAccess=true
                          KeyFileName=file-name]
ListStoredKeys            ListStoredKeys [ListKeyDetails=true]
DeleteStoredKey           DeleteStoredKey StoredKeyName=key-name
help                      help

The following is an example of the command for marking files for encryption. The targeted files are _userscm, _userxrf, _usergui, _userint, _userdev, mydata, and shrdemo.

jdbcrypt path=d:\jade\system ini=d:\salesdb\jade.ini action=EncryptFiles Files=_user*;mydata;shrdemo

Detailed results of the action are written to the appropriate log file in your specified database directory.

If the jdbcrypt executable program fails, a non-zero exit code is returned and an error message is displayed; for example, if the database directory was invalid.