Derby
  1. Derby
  2. DERBY-5928

Add more task focus to Derby security documentation

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.9.1.0
    • Fix Version/s: 10.10.1.1
    • Component/s: Documentation
    • Labels:
      None

      Description

      It has been recommended that the Derby security documentation in the Developer's Guide should have more of a task-based focus: instead of beginning with an outline of security concepts and then describing the tasks a user or administrator should perform to secure Derby, we should begin with a list of the steps required for security, with links to details on how to perform them, and cover the concepts after that. Users should have a single location where they can verify that they have done everything they can to ensure database security.

      1. cdevcsecureidentity.html
        7 kB
        Kim Haase
      2. DERBY-5928-2.diff
        0.5 kB
        Kim Haase
      3. DERBY-5928.zip
        13 kB
        Kim Haase
      4. DERBY-5928.stat
        0.2 kB
        Kim Haase
      5. DERBY-5928.diff
        21 kB
        Kim Haase

        Activity

        Kim Haase created issue -
        Hide
        Kim Haase added a comment -

        The section "Configuring security for your environment" has lists of tasks that are somewhat different depending whether you are in embedded or client-server mode. I assume these differences are current and valid and that the list of tasks should be different for the two modes. Please let me know if any changes are needed here.

        The major work involved in this documentation, I believe, is to flip the contents of the "Derby and security" and "Configuring security for your environment" sections of http://db.apache.org/derby/docs/dev/devguide/, rework them slightly, and add links to further information to the "Configuring security for your environment" sections. The remaining sections can probably remain as is.

        Further information is to be found in both the Reference Manual and the Admin Guide.

        The first topic, "Derby and security", should be titled "Configuring security for Derby" and should rework the contents of "Configuring security for your environment" and its two subsections.

        The next topic should be "Derby security concepts" and should use the material from the original "Derby and security" topic.

        The other topics should probably remain the same, although additional tweaks are possible.
        Working with user authentication
        Users and authorization identifiers
        User authorizations
        Encrypting databases on disk
        Signed jar files
        User authentication and authorization examples
        Running Derby under a security manager

        Show
        Kim Haase added a comment - The section "Configuring security for your environment" has lists of tasks that are somewhat different depending whether you are in embedded or client-server mode. I assume these differences are current and valid and that the list of tasks should be different for the two modes. Please let me know if any changes are needed here. The major work involved in this documentation, I believe, is to flip the contents of the "Derby and security" and "Configuring security for your environment" sections of http://db.apache.org/derby/docs/dev/devguide/ , rework them slightly, and add links to further information to the "Configuring security for your environment" sections. The remaining sections can probably remain as is. Further information is to be found in both the Reference Manual and the Admin Guide. The first topic, "Derby and security", should be titled "Configuring security for Derby" and should rework the contents of "Configuring security for your environment" and its two subsections. The next topic should be "Derby security concepts" and should use the material from the original "Derby and security" topic. The other topics should probably remain the same, although additional tweaks are possible. Working with user authentication Users and authorization identifiers User authorizations Encrypting databases on disk Signed jar files User authentication and authorization examples Running Derby under a security manager
        Hide
        Kim Haase added a comment -

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

        M src/devguide/cdevcsecure12392.dita
        M src/devguide/derbydev.ditamap
        M src/devguide/tdevcsecure81850.dita
        A src/devguide/cdevcsecureidentity.dita
        M src/devguide/tdevcsecure82556.dita
        M src/devguide/cdevcsecuree.dita

        Instead of putting all the conceptual material into a catchall topic, I created a new topic for the "Identity in Derby" material and moved the figures to the "Configuring security in a client/server environment" and "Configuring security in an embedded environment" topics, respectively.

        I hope I covered all the needed tasks. Please let me know if more work is needed.

        Show
        Kim Haase added a comment - Attaching DERBY-5928 .diff, DERBY-5928 .stat, and DERBY-5928 .zip, with the following changes: M src/devguide/cdevcsecure12392.dita M src/devguide/derbydev.ditamap M src/devguide/tdevcsecure81850.dita A src/devguide/cdevcsecureidentity.dita M src/devguide/tdevcsecure82556.dita M src/devguide/cdevcsecuree.dita Instead of putting all the conceptual material into a catchall topic, I created a new topic for the "Identity in Derby" material and moved the figures to the "Configuring security in a client/server environment" and "Configuring security in an embedded environment" topics, respectively. I hope I covered all the needed tasks. Please let me know if more work is needed.
        Kim Haase made changes -
        Field Original Value New Value
        Attachment DERBY-5928.diff [ 12550295 ]
        Attachment DERBY-5928.stat [ 12550296 ]
        Attachment DERBY-5928.zip [ 12550297 ]
        Kim Haase made changes -
        Issue & fix info Patch Available [ 10102 ]
        Hide
        Kim Haase added a comment -

        As a preliminary step, committed patch DERBY-5928.diff to documentation trunk at revision 1401740.

        I believe there may be more work to do here, so I'm not closing the issue yet.

        Show
        Kim Haase added a comment - As a preliminary step, committed patch DERBY-5928 .diff to documentation trunk at revision 1401740. I believe there may be more work to do here, so I'm not closing the issue yet.
        Hide
        Rick Hillegas added a comment -

        Thanks for these changes, Kim. They look sensible to me. One comment:

        cdevcsecureidentity

        o Last paragraph: "coarse-grained connection organization" -> "coarse-grained connection authorization"

        Thanks,
        -Rick

        Show
        Rick Hillegas added a comment - Thanks for these changes, Kim. They look sensible to me. One comment: cdevcsecureidentity o Last paragraph: "coarse-grained connection organization" -> "coarse-grained connection authorization" Thanks, -Rick
        Hide
        Kim Haase added a comment -

        Whoops, that typo's been around for a while. Thanks for catching that. I'm attaching a second patch, DERBY-5928-2.diff, and updated cdevcsecureidentity.html. I'll commit this patch but still leave the issue open for a bit to give others time to review the changes.

        Show
        Kim Haase added a comment - Whoops, that typo's been around for a while. Thanks for catching that. I'm attaching a second patch, DERBY-5928 -2.diff, and updated cdevcsecureidentity.html. I'll commit this patch but still leave the issue open for a bit to give others time to review the changes.
        Kim Haase made changes -
        Attachment DERBY-5928-2.diff [ 12550965 ]
        Attachment cdevcsecureidentity.html [ 12550966 ]
        Hide
        Kim Haase added a comment -

        Committed patch DERBY-5928-2.diff to documentation trunk at revision 1402517.

        Show
        Kim Haase added a comment - Committed patch DERBY-5928 -2.diff to documentation trunk at revision 1402517.
        Hide
        Kim Haase added a comment -

        Resolving, since some time has passed with no suggestions for additional work.

        Show
        Kim Haase added a comment - Resolving, since some time has passed with no suggestions for additional work.
        Kim Haase made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Issue & fix info Patch Available [ 10102 ]
        Fix Version/s 10.10.0.0 [ 12321550 ]
        Resolution Fixed [ 1 ]
        Hide
        Kim Haase added a comment -

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

        Show
        Kim Haase added a comment - Closing, since the changes have appeared in the Latest Alpha Manuals.
        Kim Haase made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Gavin made changes -
        Workflow jira [ 12725289 ] Default workflow, editable Closed status [ 12801932 ]

          People

          • Assignee:
            Kim Haase
            Reporter:
            Kim Haase
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development