rdm-crypt

Database Encryption Utility

Synopsis

rdm-crypt [OPTION]… db-uri

Description

rdm-crypt is a command-line utility for adding encryption to or removing it from an existing RaimaDB database.

Options

Short options can be combined into one string starting with a single '-'. Mandatory arguments to long options are mandatory for short options too. Long option arguments can also be specified in a separate argument.

-h, --help Display this usage information
--version Display the version information
-q, --quiet Quiet mode. No information will be displayed
--key=key Specify the encryption key for the database ([algorithm:]passcode). The valid algorithms are xor, aes128, aes192 and aes256. The AES algorithms are only available for packages that have strong encryption support. If an algorithm is not specified, the default is aes128 for strong encryption packages and xor otherwise.
--docroot=path Document root to use instead of the current working directory. The environment variable RDM_DOCROOT can also be used. (See Document Root (docroot))
-key-new=key Specify the new encryption key for the database
--full If re-encrypting do a full re-encryption (change the internal key)
--tables=tablelist Comma separated list of the tables to encrypt, decrypt or re-encrypt
--log-level=level Set the log level ('--log-level=all', '--log-level=error', '--log-level=warning', '--log-level=info', '--log-level=mesg', or a number (5-99)) - the default is '99')
--err-level=level Set the error level (all, error, warning, info, mesg,or a number (5-99)) - the default is info)
--use-ssl Use SSL for remote connections
db-uri An RDM database name or URI. See Database Identifier (db-uri) for more information.

Comments

Specifying a database name will by default open the database in the current working directory. However, specifying a database URI will open the database on a remote TFServer. Examples of database name or URIs:

'MY_DB', 'tfs-tcp://localhost:21553/MY_DB', 'tfs-shm://MY_TFS/MY_DB'.

This utility is uses the rdm_dbEncrypt() function to encrypt, decrypt or re-encrypt the database.