/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-18 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
11
*** EXAMPLES
14
12
    Examples of normal usage, debug usage, debugging single or all
15
13
    plugins, etc.
16
14
*** FILES
17
15
*** 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).
22
16
*** BUGS
23
17
*** SEE ALSO
24
18
    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
25
21
 
26
22
* password-request
27
23
** [#A] Man page: man8/password-request.8mandos
55
51
** Do not depend on GnuPG key rings on disk
56
52
   This would mean creating new GnuPG key rings with GPGME by
57
53
   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
60
54
 
61
55
* password-prompt
62
 
** [#C] Use getpass(3)?
 
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)?
63
76
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
77
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
78
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
79
   [[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?]]
67
80
 
68
81
* 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)
69
84
** [#A] /etc/init.d/mandos-server               :teddy:
70
85
** [#B] Log level                               :bugs:
71
86
** /etc/mandos/clients.d/*.conf
87
102
** Disable client
88
103
** Enable client
89
104
 
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
 
**** DONE mandos.xml
110
 
**** DONE plugin-runner.xml
111
 
**** DONE plugins.d/password-prompt.xml
112
 
**** DONE plugins.d/password-request.xml
113
 
** Use xinclude for common sections
114
 
   Like copyright, authors, etc.
115
 
 
116
 
 
117
105
* Installer
118
 
** Client-side
 
106
** Client
119
107
*** Update initrd.img after installation
120
108
    This seems to use some kind of "trigger" system
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
 
109
** Server
131
110
*** [#A] Create mandos user and group for server
132
111
*** [#A] Create /var/run/mandos directory with perm and ownership
133
112
 
 
113
** mandos-keygen
 
114
*** [#A] Output cut-and-paste ready snippet for clients.conf.
 
115
 
134
116
* [#A] Package
135
117
** /usr/share/initramfs-tools/hooks/mandos
136
118
*** Do not install in initrd.img if configured not to.
137
119
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
138
120
    question.
139
121
** /etc/bash_completion.d/mandos
140
 
   From XML sources directly?
 
122
*** From XML sources directly?
141
123
** unperish
142
124
** bzr-builddeb
143
125