Derby
  1. Derby
  2. DERBY-1721

DOCS - Remove duplicate information in Dev Guide re: Encryption

    Details

    • Urgency:
      Normal

      Description

      In the Developers Guide. there are 2 sections that contain information about encryption.
      In some cases there are topics with different content but with the same titles.
      There should not be duplicate titles in the Derby documentation.

      There is this section:
      JDBC applications and Derby basics -->Derby embedded basics -->Working with the database connection URL attributes
      that has these topic titles:
      --Using the databaseName attribute
      --Shutting down Derby or an individual database
      --Creating and accessing a database
      --Providing a user name and password
      --Encrypting a database when you create it
      --Booting an encrypted database
      --Specifying attributes in a properties object

      Then there is this section:
      Derby and Security -->Encrypting databases on disk -->Working with encryption
      that has these topic titles:
      --Encrypting databases on creation
      --Creating the boot password
      --Specifying an alternate encryption provider
      --Specifying an alternate encryption algorithm
      --Booting an encrypted database
      --Changing the boot password

      Someone needs to look at the content of these files, rework the information and necessary, create the related links, and then retitle the topics to avoid duplicate titles.

      1. DERBY-1721.diff
        35 kB
        Kim Haase
      2. DERBY-1721.stat
        0.7 kB
        Kim Haase
      3. DERBY-1721.zip
        29 kB
        Kim Haase
      4. DERBY-1721-2.diff
        35 kB
        Kim Haase
      5. DERBY-1721-2.zip
        29 kB
        Kim Haase

        Issue Links

          Activity

          Hide
          Kim Haase added a comment -

          The section "Working with the database connection URL attributes" should point to "Encrypting databases on disk" for information on database encryption, since the latter section is the one cited by the Reference Manual topics on encryption.

          The information in "Encrypting a database when you create it" and "Creating an encrypted database with an external key" should be added to "Encrypting databases on creation". (The term "external key" is not used in the Reference Manual. Is it meaningful?)

          Any duplicate information in the first "Booting an encrypted database" should be added to the second one.

          Show
          Kim Haase added a comment - The section "Working with the database connection URL attributes" should point to "Encrypting databases on disk" for information on database encryption, since the latter section is the one cited by the Reference Manual topics on encryption. The information in "Encrypting a database when you create it" and "Creating an encrypted database with an external key" should be added to "Encrypting databases on creation". (The term "external key" is not used in the Reference Manual. Is it meaningful?) Any duplicate information in the first "Booting an encrypted database" should be added to the second one.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-1721.diff, DERBY-1721.stat, and DERBY-1721.zip, with the following changes:

          D src/devguide/tdevdvlp14496.dita
          M src/devguide/derbydev.ditamap
          M src/devguide/tdevcsecurenewkeyoverview.dita
          M src/devguide/cdevcsecure60146.dita
          D src/devguide/tdevdvlp40140.dita
          M src/devguide/cdevcsecure67151.dita
          M src/devguide/cdevcsecure96815.dita
          D src/devguide/tdevdvlpcreateencryptdbextkey.dita
          M src/devguide/cdevcsecure866716.dita
          M src/devguide/tdevcsecureunencrypteddb.dita
          M src/devguide/cdevdvlp51654.dita
          M src/devguide/cdevcsecure31493.dita
          M src/devguide/cdevcsecure88690.dita
          M src/devguide/tdevcsecurenewextkey.dita
          M src/devguide/tdevcsecurenewbootpw.dita
          M src/devguide/cdevcsecure24366.dita

          Removed 3 encryption-related topics from under "Working with the database connection URL attributes" and added information to "Encrypting databases on disk" subtopics as needed, providing a cross-reference in the "Working with the database connection URL attributes" topic. Also corrected typos and formatting inconsistencies, updated provider versions, and removed an unneeded reference to JDK 1.4.

          Show
          Kim Haase added a comment - Attaching DERBY-1721 .diff, DERBY-1721 .stat, and DERBY-1721 .zip, with the following changes: D src/devguide/tdevdvlp14496.dita M src/devguide/derbydev.ditamap M src/devguide/tdevcsecurenewkeyoverview.dita M src/devguide/cdevcsecure60146.dita D src/devguide/tdevdvlp40140.dita M src/devguide/cdevcsecure67151.dita M src/devguide/cdevcsecure96815.dita D src/devguide/tdevdvlpcreateencryptdbextkey.dita M src/devguide/cdevcsecure866716.dita M src/devguide/tdevcsecureunencrypteddb.dita M src/devguide/cdevdvlp51654.dita M src/devguide/cdevcsecure31493.dita M src/devguide/cdevcsecure88690.dita M src/devguide/tdevcsecurenewextkey.dita M src/devguide/tdevcsecurenewbootpw.dita M src/devguide/cdevcsecure24366.dita Removed 3 encryption-related topics from under "Working with the database connection URL attributes" and added information to "Encrypting databases on disk" subtopics as needed, providing a cross-reference in the "Working with the database connection URL attributes" topic. Also corrected typos and formatting inconsistencies, updated provider versions, and removed an unneeded reference to JDK 1.4.
          Hide
          Kim Haase added a comment -

          I have learned of an error in src/devguide/cdevcsecure60146.dita, "Booting an encrypted database" – to access a database that was encrypted with a non-default algorithm, you do not need to specify the algorithm again, since the algorithm is stored in service.properties. You need only specify the boot password or encryption key.

          I plan to commit the existing patch on October 8 and then file a revised patch with this change. If anyone notices other changes that need to be made, please let me know. I also plan to backport the changes, but no further back than 10.5.

          Show
          Kim Haase added a comment - I have learned of an error in src/devguide/cdevcsecure60146.dita, "Booting an encrypted database" – to access a database that was encrypted with a non-default algorithm, you do not need to specify the algorithm again, since the algorithm is stored in service.properties. You need only specify the boot password or encryption key. I plan to commit the existing patch on October 8 and then file a revised patch with this change. If anyone notices other changes that need to be made, please let me know. I also plan to backport the changes, but no further back than 10.5.
          Hide
          Kim Haase added a comment -

          Decided it would be simpler to file a second patch than to have to backport two patches. Attaching DERBY-1721-2.diff and DERBY-1721-2.zip, with a change to "Booting an encrypted database" (cdevcsecure60146.dita). I will commit this patch and backport it.

          Show
          Kim Haase added a comment - Decided it would be simpler to file a second patch than to have to backport two patches. Attaching DERBY-1721 -2.diff and DERBY-1721 -2.zip, with a change to "Booting an encrypted database" (cdevcsecure60146.dita). I will commit this patch and backport it.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-1721-2.diff to documentation trunk at revision 1395617.
          Merged to 10.9 doc branch at revision 1395632.
          Merged to 10.8 doc branch at revision 1395633.
          Merged to 10.7 doc branch at revision 1395647.
          Merged to 10.6 doc branch at revision 1395663.
          Merged to 10.5 doc branch at revision 1395678.

          Show
          Kim Haase added a comment - Committed patch DERBY-1721 -2.diff to documentation trunk at revision 1395617. Merged to 10.9 doc branch at revision 1395632. Merged to 10.8 doc branch at revision 1395633. Merged to 10.7 doc branch at revision 1395647. Merged to 10.6 doc branch at revision 1395663. Merged to 10.5 doc branch at revision 1395678.
          Hide
          Kim Haase added a comment -

          Closing, since trunk changes have appeared in Latest Alpha Manuals.

          Show
          Kim Haase added a comment - Closing, since trunk changes have appeared in Latest Alpha Manuals.

            People

            • Assignee:
              Kim Haase
              Reporter:
              Laura Stewart
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development