Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 71211 - Convert Gentoo Security Guide to Security Handbook
Summary: Convert Gentoo Security Guide to Security Handbook
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Gentoo Security Guide (show other bugs)
Hardware: All Linux
: High enhancement (vote)
Assignee: Xavier Neys (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-11-14 14:42 UTC by Eric Brown
Modified: 2005-06-02 01:47 UTC (History)
3 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Gentoo Linux Security Handbook (security.tar.gz,39.39 KB, application/x-gzip)
2005-05-31 02:06 UTC, Curtis Napier (RETIRED)
Details
update for metadoc.xml (metadoc.diff,4.48 KB, patch)
2005-05-31 02:07 UTC, Curtis Napier (RETIRED)
Details | Diff
update for gentoo-security guide (gentoo-security.diff,117.43 KB, patch)
2005-05-31 02:09 UTC, Curtis Napier (RETIRED)
Details | Diff
update uri in /security/en/index.xml (security-en-index.diff,711 bytes, patch)
2005-05-31 02:10 UTC, Curtis Napier (RETIRED)
Details | Diff
Security Handbook w/changes (security-handbookv2.tar.gz,39.16 KB, application/x-gzip)
2005-06-01 08:03 UTC, Curtis Napier (RETIRED)
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Eric Brown 2004-11-14 14:42:55 UTC
The guide is already rather long, and I was thinking that if we changed it into a handbook, we might be more inclined to add more stuff to it (like chapters on advanced topics, or breaking it down into specific practical areas)..

If I happened to come up with a few significant addidtions to the security guide, would anyone object to me also submitting a handbook style reorganization of it? These would be more like long, term goals.. but I think if we were conscious of it, we might be able to gather new docs and intentionally make them fit into chapters?

Reproducible: Always
Steps to Reproduce:
1.
2.
3.
Comment 1 Sven Vermeulen (RETIRED) gentoo-dev 2004-11-26 14:14:37 UTC
It's certainly worth converting into a handbook style. It's indeed getting tremendously long. This might scare away users while it's indeed a very powerful and interesting document.
Comment 2 Eric Brown 2005-01-22 12:50:44 UTC
I'm going to use this to track suggestions on the guide...

tseng reported that /lib/ld-linux.so.2 would run files on partitions marked as noexec..

we should also consider using files on other partitions to execute those restricted files, or the possibility of copying them to other places..
Comment 3 Sven Vermeulen (RETIRED) gentoo-dev 2005-02-05 10:37:22 UTC
Actually I rather not use a bug to track stuff unless it's non-disputable. Let this bug remain for it's original report: creating a handbook-format for it.
Comment 4 Curtis Napier (RETIRED) gentoo-dev 2005-05-31 02:06:19 UTC
Created attachment 60253 [details]
Gentoo Linux Security Handbook

I converted the /doc/en/gentoo-security.xml guide into a handbook. It should go
in /doc/en/security/

The files are attached as a tarball. Also attached are diffs for
/security/en/index.xml | /doc/en/gentoo-security.xml | /doc/en/metadoc.xml
Comment 5 Curtis Napier (RETIRED) gentoo-dev 2005-05-31 02:07:52 UTC
Created attachment 60254 [details, diff]
update for metadoc.xml

This updates the location of the security handbook in the <files> section of
/doc/en/metadoc.xml
Comment 6 Curtis Napier (RETIRED) gentoo-dev 2005-05-31 02:09:33 UTC
Created attachment 60255 [details, diff]
update for gentoo-security guide

This updates /doc/en/gentoo-security.xml

It is a simple message saying the guide has been deprecated in favor of the
Handbook and gives a link.
Comment 7 Curtis Napier (RETIRED) gentoo-dev 2005-05-31 02:10:56 UTC
Created attachment 60256 [details, diff]
update uri in /security/en/index.xml

This patch updates the <uri> and changes the reference to handbook from guide.
Comment 8 Alin Dobre (RETIRED) gentoo-dev 2005-05-31 02:26:32 UTC
Curtis, can you put it online on your site?
Comment 9 Xavier Neys (RETIRED) gentoo-dev 2005-05-31 08:52:03 UTC
Comment on attachment 60254 [details, diff]
update for metadoc.xml

Sorry, plenty of pointless changes but none of the required ones.
Comment 10 Xavier Neys (RETIRED) gentoo-dev 2005-05-31 08:52:29 UTC
Comment on attachment 60255 [details, diff]
update for gentoo-security guide

A patch that removes all lines is not very useful, is it?
Comment 11 Xavier Neys (RETIRED) gentoo-dev 2005-05-31 08:53:26 UTC
Comment on attachment 60256 [details, diff]
update uri in /security/en/index.xml

We can't change that one. Let's remember to ping its authors when we are ready.
Comment 12 Xavier Neys (RETIRED) gentoo-dev 2005-05-31 08:54:07 UTC
Having a look.
Did you change any content? In other words, are the sh-*xml files an exact break
up of gentoo-security.xml?
Comment 13 Xavier Neys (RETIRED) gentoo-dev 2005-05-31 10:00:15 UTC
Please use xmllint to validate your files (<sections> may not have a <title> child)
FYI, kernel-security had twice the same content.

Note to translators: no content change.
Comment 15 Sven Vermeulen (RETIRED) gentoo-dev 2005-06-01 04:05:16 UTC
Looks good, but perhaps don't call the first (only) part of the handbook "Contents".

Perhaps "System Security" with an abstract of "This part covers various system
security aspects allowing you to harden your system on a step-by-step basis" or
something similar?
Comment 16 Curtis Napier (RETIRED) gentoo-dev 2005-06-01 08:03:05 UTC
Created attachment 60364 [details]
Security Handbook w/changes

Sorry for not validating it first. It was on my list when I started. It was
late when I attached it and I must have forgotten (I was a little
overenthusiastic it seems). I did not change any content. I copied it directly
with no content left out.

I think I did a good job for my first Handbook :)
Next time I'll make sure to get it right the first time. 
___________

Validation complete. All pages now validate.

Removed duplicate content from Kernel Security (not sure how I missed that).

Changed the "Contents" to "System Security" as swift suggested.

Added my name as an editor. Is this ok? 

attached new tarball with changes.

--------------

View online:
http://curtis119.no-ip.org/doc/en/security/
Comment 17 Xavier Neys (RETIRED) gentoo-dev 2005-06-01 08:06:31 UTC
Don't bother. I've got all files ready and all needed some changes anyway (still
no content changes).
Comment 18 Curtis Napier (RETIRED) gentoo-dev 2005-06-01 08:16:59 UTC
(In reply to comment #17)
> Don't bother. I've got all files ready and all needed some changes anyway (still
> no content changes).

Great, thanks neysx!

Were there any other mistakes besides the ones you already listed? I need as
much feedback as possible so I don't make those same mistakes in the future.
Comment 19 Xavier Neys (RETIRED) gentoo-dev 2005-06-01 09:41:02 UTC
Thierry, CC'ed to you because you committed /security/en/index.xml recently.
Can you update the link when you have a moment? Tx.

"/doc/en/gentoo-security.xml" should become "/doc/en/security/"
Comment 20 Xavier Neys (RETIRED) gentoo-dev 2005-06-01 10:45:27 UTC
Note to translators: 

Please mind the cross-chapter links when splitting up gentoo-security.xml (see
revisions 1.2 in http://www.gentoo.org/cgi-bin/viewcvs.cgi/en/security/?root=doc)
Comment 21 Thierry Carrez (RETIRED) gentoo-dev 2005-06-02 01:21:04 UTC
(In reply to comment #19)

> Can you update the link when you have a moment? Tx.
> "/doc/en/gentoo-security.xml" should become "/doc/en/security/"

Done.
Comment 22 Xavier Neys (RETIRED) gentoo-dev 2005-06-02 01:47:04 UTC
All done. Thanks a lot.