/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
8
8
** [#B] Seperate more code to function for more readability
9
9
** [#A] Man page: man8/plugin-runner.8mandos
10
10
*** EXIT STATUS
11
 
*** EXAMPLES
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
12
14
    Examples of normal usage, debug usage, debugging single or all
13
15
    plugins, etc.
14
16
*** FILES
15
17
*** SECURITY
 
18
    Note the danger of using this program, since you might lock
 
19
    yourself out of your system without any means of entering the root
 
20
    file system password.  This is, however, very unlikely considering
 
21
    the fallback to getpass(3).
16
22
*** BUGS
17
23
*** SEE ALSO
18
24
    Explaining text on what you can read
19
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
20
 
   Must create in preinst if not pre-depending on cryptsetup
21
25
 
22
26
* password-request
23
27
** [#A] Man page: man8/password-request.8mandos
51
55
** Do not depend on GnuPG key rings on disk
52
56
   This would mean creating new GnuPG key rings with GPGME by
53
57
   importing the key files from scratch on every program start.
 
58
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
59
   Must create in preinst if not pre-depending on cryptsetup
54
60
 
55
61
* password-prompt
56
 
** [#A] Man page: man8/password-prompt.8mandos
57
 
*** SYNOPSIS
58
 
    Document short options
59
 
*** DESCRIPTION
60
 
    Note that this is more or less a simple getpass(3) wrapper, even
61
 
    though actual use of getpass(3) is not guaranteed.
62
 
*** EXIT STATUS
63
 
*** ENVIRONMENT
64
 
    Document use of "cryptsource" and "crypttarget".
65
 
*** FILES
66
 
*** BUGS
67
 
*** EXAMPLE
68
 
    Examples of normal usage, debug usage, with a prefix, etc.
69
 
*** SECURITY
70
 
    Not much to do here but it is noteworthy to state the danger of
71
 
    not having a fallback option.
72
 
*** SEE ALSO
73
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
74
 
    and also, perhaps, to cryptsetup(8)?
75
 
** Use getpass(3)?
 
62
** [#C] Use getpass(3)?
76
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
77
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
78
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
79
66
   [[http://www.steve.org.uk/Reference/Unix/faq_4.html#SEC48][Unix Programming FAQ 3.1 How can I make my program not echo input?]]
80
67
 
81
68
* mandos (server)
82
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
83
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
84
69
** [#A] /etc/init.d/mandos-server               :teddy:
85
70
** [#B] Log level                               :bugs:
86
71
** /etc/mandos/clients.d/*.conf
102
87
** Disable client
103
88
** Enable client
104
89
 
 
90
* Man pages
 
91
** Tags
 
92
   Go through all man pages to conform to the style of tags chosen in
 
93
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
 
94
*** SYNOPSIS
 
95
    <arg> with inner <option> and <replaceable> tags
 
96
    Unify long and short options.
 
97
**** DONE mandos-clients.conf.xml
 
98
**** DONE mandos-keygen.xml
 
99
**** DONE mandos.conf.xml
 
100
**** DONE mandos.xml
 
101
**** DONE plugin-runner.xml
 
102
**** DONE plugins.d/password-prompt.xml
 
103
**** DONE plugins.d/password-request.xml
 
104
*** OPTIONS
 
105
    Separate <term> tags with <option> and <replaceable> tags.
 
106
**** DONE mandos-clients.conf.xml
 
107
**** DONE mandos-keygen.xml
 
108
**** DONE mandos.conf.xml
 
109
**** TODO mandos.xml
 
110
**** TODO plugin-runner.xml
 
111
**** TODO plugins.d/password-prompt.xml
 
112
**** TODO plugins.d/password-request.xml
 
113
** Use xinclude for common sections
 
114
   Like copyright, authors, etc.
 
115
 
 
116
 
105
117
* Installer
106
 
** Client
 
118
** Client-side
107
119
*** Update initrd.img after installation
108
120
    This seems to use some kind of "trigger" system
109
 
** Server
 
121
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
122
    dpkg-trigger(1), deb-triggers(5)
 
123
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
124
    Must create in preinst if not pre-depending on cryptsetup
 
125
*** mandos-keygen
 
126
**** "--passfile" option
 
127
     Using the "secfile" option instead of "secret"
 
128
**** [#A] "--test" option
 
129
     For testing decryption before rebooting.
 
130
** Server-side
110
131
*** [#A] Create mandos user and group for server
111
132
*** [#A] Create /var/run/mandos directory with perm and ownership
112
133
 
113
 
** mandos-keygen
114
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
115
 
 
116
134
* [#A] Package
117
135
** /usr/share/initramfs-tools/hooks/mandos
118
136
*** Do not install in initrd.img if configured not to.
119
137
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
120
138
    question.
121
139
** /etc/bash_completion.d/mandos
122
 
*** From XML sources directly?
 
140
   From XML sources directly?
123
141
** unperish
124
142
** bzr-builddeb
125
143