You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2012/09/13 17:01:08 UTC

[jira] [Created] (DERBY-5928) Add more task focus to Derby security documentation

Kim Haase created DERBY-5928:
--------------------------------

             Summary: Add more task focus to Derby security documentation
                 Key: DERBY-5928
                 URL: https://issues.apache.org/jira/browse/DERBY-5928
             Project: Derby
          Issue Type: Task
          Components: Documentation
    Affects Versions: 10.9.1.0
            Reporter: Kim Haase
            Assignee: Kim Haase


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.


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Resolved] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase resolved DERBY-5928.
------------------------------

          Resolution: Fixed
       Fix Version/s: 10.10.0.0
    Issue & fix info:   (was: Patch Available)

Resolving, since some time has passed with no suggestions for additional work. 
                
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>             Fix For: 10.10.0.0
>
>         Attachments: cdevcsecureidentity.html, DERBY-5928-2.diff, DERBY-5928.diff, DERBY-5928.stat, DERBY-5928.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13483329#comment-13483329 ] 

Kim Haase commented on DERBY-5928:
----------------------------------

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. 
                
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5928.diff, DERBY-5928.stat, DERBY-5928.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13484942#comment-13484942 ] 

Kim Haase commented on DERBY-5928:
----------------------------------

Committed patch DERBY-5928-2.diff to documentation trunk at revision 1402517. 
                
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: cdevcsecureidentity.html, DERBY-5928-2.diff, DERBY-5928.diff, DERBY-5928.stat, DERBY-5928.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13454938#comment-13454938 ] 

Kim Haase commented on DERBY-5928:
----------------------------------

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
                
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-5928:
-----------------------------

    Attachment: cdevcsecureidentity.html
                DERBY-5928-2.diff

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.
                
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: cdevcsecureidentity.html, DERBY-5928-2.diff, DERBY-5928.diff, DERBY-5928.stat, DERBY-5928.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-5928:
-----------------------------

    Issue & fix info: Patch Available
    
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5928.diff, DERBY-5928.stat, DERBY-5928.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-5928:
-----------------------------

    Attachment: DERBY-5928.zip
                DERBY-5928.stat
                DERBY-5928.diff

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.
                
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5928.diff, DERBY-5928.stat, DERBY-5928.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (DERBY-5928) Add more task focus to Derby security documentation

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5928?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13484434#comment-13484434 ] 

Rick Hillegas commented on DERBY-5928:
--------------------------------------

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

                
> Add more task focus to Derby security documentation
> ---------------------------------------------------
>
>                 Key: DERBY-5928
>                 URL: https://issues.apache.org/jira/browse/DERBY-5928
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5928.diff, DERBY-5928.stat, DERBY-5928.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira