/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-14 02:24:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080814022459-rq3jt4q409l3qbj3
* Makefile (PREFIX, CONFDIR): New.

* initramfs-tools-hook: Search for Mandos in /usr/local as well as in
                        /usr.  Also copy plugin-runner.  Also chmod
                        the config dir.
  (DESTCONFDIR): Removed.
  (MANDOSDIR): New.
  (PLUGINDIR): Changed to "${MANDOSDIR}/plugins.d".

* initramfs-tools-script: New.

* mandos-client.c: Renamed to "plugin-runner.c".  All references
                   changed.
  (plugindir): Changed to "/lib/mandos/plugins.d".

* plugins.d/usplash: New.

Show diffs side-by-side

added added

removed removed

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