Issue Details (XML | Word | Printable)

Key: DERBY-2372
Type: Improvement Improvement
Status: Closed Closed
Resolution: Fixed
Priority: Major Major
Assignee: Rick Hillegas
Reporter: Rick Hillegas
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Derby

Document the secure-by-default network server

Created: 23/Feb/07 04:57 PM   Updated: 01/Jul/09 12:34 AM
Return to search
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 10.3.1.4

Time Tracking:
Not Specified

File Attachments:
  Size
File Licensed for inclusion in ASF works derby-2372-02.diff 2007-03-06 09:40 PM Rick Hillegas 1 kB
File Licensed for inclusion in ASF works derby-2372-hostparametername-01.diff 2007-06-15 01:52 PM Rick Hillegas 2 kB
File Licensed for inclusion in ASF works derby-2372-hostparameterspec-01.diff 2007-07-05 04:43 PM Rick Hillegas 1 kB
File Licensed for inclusion in ASF works derby-2372-no-auth-01.diff 2007-06-06 06:13 PM Rick Hillegas 3 kB
File derby-2372-secure-server-01.diff 2007-03-02 03:59 PM Rick Hillegas 18 kB
File Licensed for inclusion in ASF works derby-2372-userdir-01.diff 2007-07-06 05:05 PM Rick Hillegas 2 kB
HTML File Licensed for inclusion in ASF works tadmincbdjhhfd.html 2007-06-06 06:13 PM Rick Hillegas 13 kB
HTML File Licensed for inclusion in ASF works tadmincbdjhhfd.html 2007-03-02 04:01 PM Rick Hillegas 13 kB
HTML File Licensed for inclusion in ASF works tadminnetservbasic.html 2007-07-06 05:05 PM Rick Hillegas 6 kB
HTML File Licensed for inclusion in ASF works tadminnetservbasic.html 2007-07-05 04:43 PM Rick Hillegas 6 kB
HTML File Licensed for inclusion in ASF works tadminnetservbasic.html 2007-06-15 01:52 PM Rick Hillegas 6 kB
HTML File Licensed for inclusion in ASF works tadminnetservbasic.html 2007-06-06 06:13 PM Rick Hillegas 6 kB
HTML File tadminnetservbasic.html 2007-03-02 03:59 PM Rick Hillegas 6 kB
HTML File Licensed for inclusion in ASF works tadminnetservcustom.html 2007-07-06 05:05 PM Rick Hillegas 7 kB
HTML File Licensed for inclusion in ASF works tadminnetservcustom.html 2007-07-05 04:43 PM Rick Hillegas 7 kB
HTML File Licensed for inclusion in ASF works tadminnetservcustom.html 2007-06-15 01:52 PM Rick Hillegas 7 kB
HTML File tadminnetservcustom.html 2007-03-02 04:02 PM Rick Hillegas 6 kB
HTML File Licensed for inclusion in ASF works tadminnetservopen.html 2007-03-02 04:01 PM Rick Hillegas 4 kB
HTML File Licensed for inclusion in ASF works tadminnetservrun.html 2007-03-02 04:01 PM Rick Hillegas 4 kB
HTML File toc.html 2007-03-02 03:59 PM Rick Hillegas 11 kB
Issue Links:
Incorporates
 

Resolution Date: 06/Jul/07 10:04 PM


 Description  « Hide
Add documentation to the user guides as described in the functional spec for DERBY-2196.

 All   Comments   Work Log   Change History   Subversion Commits      Sort Order: Ascending order - Click to sort in descending order
Rick Hillegas added a comment - 02/Mar/07 03:59 PM
Attaching first rev of user documentation for the secure-server feature: derby-2372-secure-server-01.diff. Also attaching the html output for these changes.

This patch does the following:

1) Adds a page describing the Basic security policy.

2) Adds a page describing how to customize this policy.

3) Adds a page describing how to override the server's impulse to install a security manager.

4) Removes the previous, confusing example policy for network security.

5) Prominently notes that booting the Network Server will, by default, install a security manager and will fail if you have not enabled user authentication.

Touches the following files:

M src/adminguide/derbyadmin.ditamap
A src/adminguide/tadminnetservbasic.dita
M src/adminguide/tadminnetservrun.dita
M src/adminguide/tadmincbdjhhfd.dita
A src/adminguide/tadminnetservopen.dita
A src/adminguide/tadminnetservcustom.dita

Rick Hillegas added a comment - 02/Mar/07 04:01 PM
Attaching more of the html output for derby-2372-secure-server-01.

Rick Hillegas added a comment - 02/Mar/07 04:02 PM
Attaching more html output for patch derby-2372-secure-server-01.

Rick Hillegas added a comment - 06/Mar/07 07:41 PM
Committed derby-2372-01.diff at subversion revision 515270.

Andrew McIntyre added a comment - 06/Mar/07 08:05 PM
Sorry for the late comments, meant to review this before you got around to committing it, two minor comments:

tadminnetservopen.html:

Maybe for the warning here:

"You incur a severe security risk by opening up the server to all clients without limiting access via ^user authentication^ and a security policy." ?

Since the new requirement is actually that user authentication be configured and enabled, it would be good to mention it here.

tadminnetservbasic and tadmincbdjhhfd:

For instructions on setting up user authentication, this page points the user to "Derby Security" in the devguide, but tadmincbdjhhfd points the user to "Working with user authentication" in the devguide. Probably would be good to point the users to the same place for consistency.

Rick Hillegas added a comment - 06/Mar/07 09:40 PM
Thanks for the feedback, Andrew. I have addressed your comments in derby-2372-02.diff, which I'm attaching and which I committed at subversion revision 515313..

Rick Hillegas added a comment - 06/Jun/07 06:09 PM
Re-opening in order to adjust the documentation to reflect the fact that server boot will not fail if authentication is not turned on.

Rick Hillegas added a comment - 06/Jun/07 06:13 PM
Attaching changes to the Admin Guide which reflect the work of DERBY-2757: the server will still come up even if authentication is not enabled. Also attaching html output for these changes. These changes should not commit until DERBY-2757 commits. Patch is called derby-2372-no-auth-01.diff. Touches the following files:

M src/adminguide/tadmincbdjhhfd.dita
M src/adminguide/tadminnetservbasic.dita

Rick Hillegas added a comment - 07/Jun/07 03:13 PM
Committed derby-2372-no-auth-01.diff at subversion revision 545211.

Rick Hillegas added a comment - 15/Jun/07 01:52 PM
Attaching derby-2372-hostparametername-01.diff and the corresponding html output: tadminnetservbasic.html and tadminnetservcustom.html. This changes the name of the host parameter in the default server policy file, per DERBY-2811. Committed at subversion revision 547683.

Rick Hillegas added a comment - 05/Jul/07 04:43 PM
Attaching derby-2372-hostparameterspec-01.diff. This adjusts the Admin Guide to reflect the changes introduced by DERBY-2874 at revision 552977. Also attaching the corresponding html output:

adminguide/tadminnetservcustom.html
adminguide/tadminnetservbasic.html

Committed to trunk docs at subversion 553555. Ported to 10.3 docs at subversion revision 553556.

Rick Hillegas added a comment - 06/Jul/07 05:05 PM
Attaching derby-2372-userdir-01.diff. This reflects the permission to read the user.dir property which was added as part of DERBY-2908 at revision 553949. Also attaching the corresponding html output:

adminguide/tadminnetservcustom.html
adminguide/tadminnetservbasic.html


Rick Hillegas added a comment - 06/Jul/07 05:11 PM
Committed derby-2372-userdir-01.diff to trunk docs at subversion revision 553956. Ported to 10.3 docs at revision 553959.

Myrna van Lunteren added a comment - 06/Jul/07 10:04 PM
I assume this can be closed again.