/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

* README (The Plugin System): Improve wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
 
3
* mandos-client
 
4
** TODO [#A] Clean up /tmp directory on signal
4
5
 
5
6
* 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
10
 
*** EXIT STATUS
11
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
14
 
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
16
 
*** FILES
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).
22
 
*** BUGS
23
 
*** SEE ALSO
24
 
    Explaining text on what you can read
25
 
 
26
 
* password-request
27
 
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
30
 
*** DESCRIPTION
31
 
    State that this command is not meant to be invoked directly, but
32
 
    is run as a plugin from mandos-client(8) and only run in the
33
 
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
 
*** EXIT STATUS
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
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
49
 
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
53
 
** IPv4 support
54
 
** use strsep instead of strtok?
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
60
 
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
63
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
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?]]
 
7
** TODO [#B] use scandir(3) instead of readdir(3)
67
8
 
68
9
* mandos (server)
69
 
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
71
 
** /etc/mandos/clients.d/*.conf
 
10
** TODO [#B] Log level                          :BUGS:
 
11
** TODO /etc/mandos/clients.d/*.conf
72
12
   Watch this directory and add/remove/update clients?
73
 
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
 
13
** TODO config for TXT record
 
14
** TODO [#B] Run-time communication with server :BUGS:
75
15
   Probably using D-Bus
76
 
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
78
 
   [[info:standards:Option%20Table][Table of Long Options]]
79
 
** Implement --socket
80
 
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
 
16
*** Client class
 
17
*** Main server
 
18
    + SetLogLevel
 
19
      syslogger.setLevel(logging.WARNING)
 
20
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
 
21
** TODO Implement --foreground                  :BUGS:
 
22
   [[info:standards:Option%20Table][Table of Long Options]]
 
23
** TODO Implement --socket
 
24
   [[info:standards:Option%20Table][Table of Long Options]]
 
25
** TODO Date+time on console log messages       :BUGS:
82
26
   Is this the default?
83
27
 
84
 
* Mandos-tools/utilities
85
 
  All of this probably using D-Bus
86
 
** List clients
87
 
** Disable client
88
 
** Enable client
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
 
**** TODO 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
 
 
117
 
* Installer
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
133
 
 
134
 
* [#A] Package
 
28
* mandos.xml
 
29
** [[file:mandos.xml::XXX][Document D-Bus interface]]
 
30
 
 
31
* Provide and install /etc/dbus-1/system.d/mandos.conf
 
32
 
 
33
* mandos-ctl
 
34
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
35
*** [#B] --dump option
 
36
 
 
37
* Curses interface
 
38
 
 
39
* mandos-keygen
 
40
** TODO Loop until passwords match when run interactively
 
41
** TODO "--secfile" option
 
42
   Using the "secfile" option instead of "secret"
 
43
** TODO [#B] "--test" option
 
44
   For testing decryption before rebooting.
 
45
 
 
46
* Package
135
47
** /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.
139
 
** /etc/bash_completion.d/mandos
 
48
*** TODO [#C] Do not install in initrd.img if configured not to.
 
49
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
50
** TODO [#C] /etc/bash_completion.d/mandos
140
51
   From XML sources directly?
141
 
** unperish
142
 
** bzr-builddeb
143
 
 
144
 
* INSTALL file
145
 
 
146
 
* Web site
147
 
 
148
 
* Mailing list
149
 
 
150
 
* Announce project on news
151
 
  [[news:comp.os.linux.announce]]
152
52
 
153
53
 
154
54
#+STARTUP: showall