Add documentation for encrypted database using encryptionKey
------------------------------------------------------------
Key: DERBY-1622
URL: http://issues.apache.org/jira/browse/DERBY-1622
Project: Derby
Issue Type: Task
Components: Documentation
Affects Versions: 10.2.0.0
Reporter: Sunitha Kambhampati
Priority: Minor
Fix For: 10.2.0.0
1)
In Reference Manual:Section: Setting attributes for the database connection url
Add the following attribute:
encryptionKey=key
Function
Specifies the key to use for encrypting a new database or booting an existing
encrypted database. The application
provides the encryption key.
Combining with other attributes
When creating a new database, must be combined with create=true and
dataEncryption=true. When booting an existing
encrypted database, the encryptionAlgorithm is also required to be specified if
the algorithm used when creating the
database was not the default algorithm. The default encryption algorithm used
by Derby is DES/CBC/NoPadding.
-- create a new, encrypted database
jdbc:derby:newDB;create=true;dataEncryption=true;encryptionAlgorithm=DES/CBC/NoPadding;encryptionKey=6162636465666768
-- boot an encrypted database
jdbc:derby:encryptedDB;encryptionKey=6162636465666768
2)
Developers Guide:
http://db.apache.org/derby/docs/dev/devguide/tdevdvlp40140.html
This should say , Booting an encrypted database.
This section should also mention the encryptionKey attribute.
http://db.apache.org/derby/docs/dev/devguide/cdevcsecure60146.html
This section should also mention the encryptionKey attribute.
Something like change this line from
"Once you have created an encrypted database, you must supply the boot password
to reboot it."
to
"If you have created an encrypted database using the bootPassword, then you
must supply the boot password to reboot it. If you have created an encrypted
database using the encryptionKey, then you must supply the encryptionKey to
reboot it"
The example should also include the example to boot using the encryptionKey.
For example, to access an encrypted database called encryptedDB, created with
the encryptionKey c566bab9ee8b62a5ddb4d9229224c678 and with
encryptionAlgorithm=AES/CBC/NoPadding, you would use the following connection
URL:
jdbc:derby:encryptedDB;encryptionAlgorithm=AES/CBC/NoPadding;encryptionKey=c566bab9ee8b62a5ddb4d9229224c678
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
