/mandos/trunk

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

« 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
2
2
 
3
3
* [#A] README file
4
4
 
5
 
* [#A] COPYING file
6
 
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
 
 
8
 
* Mandos-client
9
 
** [#A] Man page: man8/mandos-client.8mandos
10
 
*** DESCRIPTION
11
 
    Describe the plus sign syntax for passing options from crypttab
 
5
* plugin-runner
 
6
** [#B] Add more comments to code
 
7
** [#B] Add more if(debug) calls
 
8
** [#B] Seperate more code to function for more readability
 
9
** [#A] Man page: man8/plugin-runner.8mandos
12
10
*** EXIT STATUS
13
 
    Text needed
14
 
*** EXAMPLES
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
15
14
    Examples of normal usage, debug usage, debugging single or all
16
 
    plugins, examples of crypttab lines with plus syntax, etc.
 
15
    plugins, etc.
17
16
*** FILES
18
 
    Text needed
19
17
*** SECURITY
20
 
    Text needed
21
 
*** NOTES
22
 
    Text needed
 
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).
23
22
*** BUGS
24
 
    Text needed
25
23
*** SEE ALSO
26
 
    Explaining test on what you can read
27
 
** Use asprintf instead of malloc and strcat?
28
 
** use strsep instead of strtok?
29
 
** use config file in addition to arguments
30
 
** pass things in environment, like device name, etc
 
24
    Explaining text on what you can read
31
25
 
32
 
* Password-request
 
26
* password-request
33
27
** [#A] Man page: man8/password-request.8mandos
 
28
*** SYNOPSIS
 
29
    Document short options
34
30
*** DESCRIPTION
35
 
    Move options to new OPTIONS section.
36
31
    State that this command is not meant to be invoked directly, but
37
32
    is run as a plugin from mandos-client(8) and only run in the
38
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
39
38
*** EXIT STATUS
40
 
    Create this section
41
 
*** EXAMPLES
 
39
*** ENVIRONMENT
 
40
    Note that it does *not* currently use cryptsource or crypttarget.
 
41
*** FILES
 
42
    Describe the key files and the key ring files.  Also note that
 
43
    they should normally have been automatically created.
 
44
*** BUGS
 
45
*** EXAMPLE
42
46
    Examples of normal usage, debug usage, debugging by connecting
43
47
    directly, etc.
44
 
*** FILES
45
 
    Describe the key files and the key ring files.  Also note that
46
 
    they should normally have been automatically created.
47
 
*** DIAGNOSTICS
48
 
    Create this section
49
48
*** SECURITY
50
 
    Create this section
51
 
*** NOTES
52
 
    Create this section (if needed)
53
 
*** BUGS
54
 
    Create this section
55
49
*** SEE ALSO
56
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
57
 
** Use asprintf instead of malloc and memcpy?
 
50
    Update from mandos.xml
 
51
** [#B] Temporarily lower kernel log level
 
52
   for less printouts during sucessfull boot.
58
53
** IPv4 support
59
54
** use strsep instead of strtok?
60
 
** Do not depend on GPG key rings on disk
61
 
   This would mean creating new GPG key rings with GPGME by importing
62
 
   the key files from scratch on every program start.
 
55
** Do not depend on GnuPG key rings on disk
 
56
   This would mean creating new GnuPG key rings with GPGME by
 
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
63
60
 
64
 
* Password-prompt
65
 
** [#A] Man page: man8/password-prompt.8mandos
66
 
*** DESCRIPTION
67
 
    Move options to new OPTIONS section.
68
 
*** EXIT STATUS
69
 
    Create this section
70
 
*** EXAMPLES
71
 
    Examples of normal usage, debug usage, with a prefix, etc.
72
 
*** DIAGNOSTICS
73
 
    Create this section
74
 
*** SECURITY
75
 
    Create this section
76
 
    Not much to do here but it is noteworthy to state the danger of
77
 
    not having a fallback option.
78
 
*** NOTES
79
 
    Note that this is more or less a simple getpass(3) wrapper, even
80
 
    though actual use of getpass(3) is not guaranteed.
81
 
*** BUGS
82
 
    Create this section
83
 
*** SEE ALSO
84
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
85
 
** Use getpass(3)?
 
61
* password-prompt
 
62
** [#C] Use getpass(3)?
86
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
87
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
88
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
89
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?]]
90
67
 
91
 
* Mandos (server)
92
 
** [#A] Command man page: man8/mandos.8
93
 
*** DESCRIPTION
94
 
    Move options to new OPTIONS section
95
 
*** EXIT STATUS
96
 
    Create this section
97
 
*** EXAMPLES
98
 
    Create this section
99
 
*** FILES
100
 
    Describe briefly that the server gets global settings from
101
 
    mandos.conf and clients from clients.conf, but refer to their man
102
 
    pages for more details.
103
 
*** DIAGNOSTICS
104
 
    Create this section
105
 
*** SECURITY
106
 
    Create this section
107
 
*** NOTES
108
 
    Create this section (if needed)
109
 
*** BUGS
110
 
    Create this section
111
 
*** SEE ALSO
112
 
    Refer to the client man page
113
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
114
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
68
* mandos (server)
115
69
** [#A] /etc/init.d/mandos-server               :teddy:
116
 
** Log level
 
70
** [#B] Log level                               :bugs:
117
71
** /etc/mandos/clients.d/*.conf
118
72
   Watch this directory and add/remove/update clients?
119
73
** config for TXT record
120
 
** Run-time communication with server
 
74
** [#B] Run-time communication with server      :bugs:
121
75
   Probably using D-Bus
122
76
   See also [[*Mandos-tools]]
123
 
** Implement --foreground
 
77
** Implement --foreground                       :bugs:
124
78
   [[info:standards:Option%20Table][Table of Long Options]]
125
79
** Implement --socket
126
80
   [[info:standards:Option%20Table][Table of Long Options]]
 
81
** Date+time on console log messages            :bugs:
 
82
   Is this the default?
127
83
 
128
84
* Mandos-tools/utilities
129
85
  All of this probably using D-Bus
131
87
** Disable client
132
88
** Enable client
133
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
 
134
117
* Installer
135
 
** DONE [#A] Change initrd.img file to not be publically readable
136
 
   /etc/initramfs-tools/conf.d/mandos
137
 
   UMASK=027
138
 
** Update initrd.img after installation
139
 
** [#A] Create mandos user and group for server
140
 
** [#A] Create /var/run/mandos directory with perm and ownership
 
118
** Client-side
 
119
*** Update initrd.img after installation
 
120
    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
 
131
*** [#A] Create mandos user and group for server
 
132
*** [#A] Create /var/run/mandos directory with perm and ownership
141
133
 
142
134
* [#A] Package
 
135
** /usr/share/initramfs-tools/hooks/mandos
 
136
*** Do not install in initrd.img if configured not to.
 
137
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
138
    question.
143
139
** /etc/bash_completion.d/mandos
144
 
** /etc/initramfs-tools/hooks/mandos
145
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
146
 
*** Create GPG key ring files in initrd
 
140
   From XML sources directly?
147
141
** unperish
148
142
** bzr-builddeb
149
143