/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-25 07:52:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825075235-gq338t4ywhqhire8
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
                                         only configuration file of
                                         mandos(8).
  (OPTIONS): Note that unknown options are ignored.  When describing
             "checker", be more specific about exit codes, and refer
             to PATH.  When describing "secret", refer to
             mandos-keygen(8), and note the relationship with
             "secfile".  Added synopsis to "secfile", and note
             relationship with "secret".  Added synopsis and more text
             to "host".
  (EXAMPLE): Remove Radix-64 checksum from "secret" option value.
  (SEE ALSO): New section, refer to mandos(8), mandos-keygen(8), and
              mandos.conf(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* mandos-client
4
 
** TODO [#A] Clean up /tmp directory on signal
5
 
** TODO [#B] Temporarily lower kernel log level
 
3
* [#A] README file
 
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
 
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
6
52
   for less printouts during sucessfull boot.
7
 
   klogctl(6, NULL, 0); klogctl(7, NULL, 0);
8
 
** TODO [#C] IPv4 support
 
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
9
60
 
10
 
* plugin-runner
11
 
** TODO [#B] use scandir(3) instead of readdir(3)
 
61
* password-prompt
 
62
** [#A] Man page: man8/password-prompt.8mandos
 
63
*** SYNOPSIS
 
64
    Document short options
 
65
*** DESCRIPTION
 
66
    Note that this is more or less a simple getpass(3) wrapper, even
 
67
    though actual use of getpass(3) is not guaranteed.
 
68
*** EXIT STATUS
 
69
*** ENVIRONMENT
 
70
    Document use of "cryptsource" and "crypttarget".
 
71
*** FILES
 
72
*** BUGS
 
73
*** EXAMPLE
 
74
    Examples of normal usage, debug usage, with a prefix, etc.
 
75
*** SECURITY
 
76
    Not much to do here but it is noteworthy to state the danger of
 
77
    not having a fallback option.
 
78
*** SEE ALSO
 
79
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
80
    and also, perhaps, to cryptsetup(8)?
 
81
** Use getpass(3)?
 
82
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
83
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
84
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
85
   [[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?]]
12
86
 
13
87
* mandos (server)
14
 
** TODO [#B] Log level                          :bugs:
15
 
** TODO /etc/mandos/clients.d/*.conf
 
88
** [#A] /etc/init.d/mandos-server               :teddy:
 
89
** [#B] Log level                               :bugs:
 
90
** /etc/mandos/clients.d/*.conf
16
91
   Watch this directory and add/remove/update clients?
17
 
** TODO config for TXT record
18
 
** TODO [#B] Run-time communication with server :bugs:
 
92
** config for TXT record
 
93
** [#B] Run-time communication with server      :bugs:
19
94
   Probably using D-Bus
20
95
   See also [[*Mandos-tools]]
21
 
*** Client class
22
 
*** Main server
23
 
    + SetLogLevel
24
 
      syslogger.setLevel(logging.WARNING)
25
 
    + Quit
26
 
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
27
 
** TODO Implement --foreground                  :bugs:
28
 
   [[info:standards:Option%20Table][Table of Long Options]]
29
 
** TODO Implement --socket
30
 
   [[info:standards:Option%20Table][Table of Long Options]]
31
 
** TODO Date+time on console log messages       :bugs:
 
96
** Implement --foreground                       :bugs:
 
97
   [[info:standards:Option%20Table][Table of Long Options]]
 
98
** Implement --socket
 
99
   [[info:standards:Option%20Table][Table of Long Options]]
 
100
** Date+time on console log messages            :bugs:
32
101
   Is this the default?
33
 
** TODO delete hook when clients fall out by timeout
34
 
   This will not be strictly necessary when the D-Bus interface is
35
 
   implemented.
36
 
 
37
 
* mandos.xml
38
 
** [[file:mandos.xml::XXX][Document D-Bus interface]]
39
 
 
40
 
* Provide and install /etc/dbus-1/system.d/mandos.conf
41
 
 
42
 
* mandos-list
43
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
44
 
*** [#B] --dump option
45
 
** TODO Disable client
46
 
** TODO Enable client
47
 
** TODO Reset timer
48
 
 
49
 
* Curses interface
50
 
 
51
 
* mandos-keygen
52
 
** TODO "--secfile" option
53
 
   Using the "secfile" option instead of "secret"
54
 
** TODO [#B] "--test" option
55
 
   For testing decryption before rebooting.
56
 
 
57
 
* Package
 
102
 
 
103
* Mandos-tools/utilities
 
104
  All of this probably using D-Bus
 
105
** List clients
 
106
** Disable client
 
107
** Enable client
 
108
 
 
109
* Installer
 
110
** Client-side
 
111
*** Update initrd.img after installation
 
112
    This seems to use some kind of "trigger" system
 
113
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
114
    Must create in preinst if not pre-depending on cryptsetup
 
115
*** mandos-keygen
 
116
**** "--passfile" option
 
117
     Using the "secfile" option instead of "secret"
 
118
**** [#A] "--test" option
 
119
     For testing decryption before rebooting.
 
120
** Server-side
 
121
*** [#A] Create mandos user and group for server
 
122
*** [#A] Create /var/run/mandos directory with perm and ownership
 
123
 
 
124
* [#A] Package
58
125
** /usr/share/initramfs-tools/hooks/mandos
59
 
*** TODO [#C] Do not install in initrd.img if configured not to.
 
126
*** Do not install in initrd.img if configured not to.
60
127
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
61
128
    question.
62
 
** TODO [#C] /etc/bash_completion.d/mandos
 
129
** /etc/bash_completion.d/mandos
63
130
   From XML sources directly?
 
131
** unperish
 
132
** bzr-builddeb
 
133
 
 
134
* INSTALL file
 
135
 
 
136
* Web site
 
137
 
 
138
* Mailing list
 
139
 
 
140
* Announce project on news
 
141
  [[news:comp.os.linux.announce]]
64
142
 
65
143
 
66
144
#+STARTUP: showall