/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-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
1
1
-*- org -*-
2
2
 
3
 
* mandos-client
4
 
** 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
*** EXAMPLES
 
12
    Examples of normal usage, debug usage, debugging single or all
 
13
    plugins, etc.
 
14
*** FILES
 
15
*** SECURITY
 
16
*** BUGS
 
17
*** SEE ALSO
 
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
 
21
 
 
22
* password-request
 
23
** [#A] Man page: man8/password-request.8mandos
 
24
*** SYNOPSIS
 
25
    Document short options
 
26
*** DESCRIPTION
 
27
    State that this command is not meant to be invoked directly, but
 
28
    is run as a plugin from mandos-client(8) and only run in the
 
29
    initrd environment, not the real system.
 
30
*** PURPOSE
 
31
    As in mandos.xml
 
32
*** OVERVIEW
 
33
    As in mandos.xml
 
34
*** EXIT STATUS
 
35
*** ENVIRONMENT
 
36
    Note that it does *not* currently use cryptsource or crypttarget.
 
37
*** FILES
 
38
    Describe the key files and the key ring files.  Also note that
 
39
    they should normally have been automatically created.
 
40
*** BUGS
 
41
*** EXAMPLE
 
42
    Examples of normal usage, debug usage, debugging by connecting
 
43
    directly, etc.
 
44
*** SECURITY
 
45
*** SEE ALSO
 
46
    Update from mandos.xml
 
47
** [#B] Temporarily lower kernel log level
5
48
   for less printouts during sucessfull boot.
6
 
   klogctl(6, NULL, 0); klogctl(7, NULL, 0);
7
 
** TODO [#C] IPv4 support
 
49
** IPv4 support
 
50
** use strsep instead of strtok?
 
51
** Do not depend on GnuPG key rings on disk
 
52
   This would mean creating new GnuPG key rings with GPGME by
 
53
   importing the key files from scratch on every program start.
8
54
 
9
 
* plugin-runner
10
 
** TODO [#B] use scandir(3) instead of readdir(3)
 
55
* password-prompt
 
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)?
 
76
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
77
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
78
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
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?]]
11
80
 
12
81
* mandos (server)
13
 
** TODO [#B] Log level                          :bugs:
14
 
** TODO /etc/mandos/clients.d/*.conf
 
82
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
83
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
84
** [#A] /etc/init.d/mandos-server               :teddy:
 
85
** [#B] Log level                               :bugs:
 
86
** /etc/mandos/clients.d/*.conf
15
87
   Watch this directory and add/remove/update clients?
16
 
** TODO config for TXT record
17
 
** TODO [#B] Run-time communication with server :bugs:
 
88
** config for TXT record
 
89
** [#B] Run-time communication with server      :bugs:
18
90
   Probably using D-Bus
19
91
   See also [[*Mandos-tools]]
20
 
*** Client class
21
 
*** Main server
22
 
    + SetLogLevel
23
 
      syslogger.setLevel(logging.WARNING)
24
 
    + Quit
25
 
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
26
 
** TODO Implement --foreground                  :bugs:
27
 
   [[info:standards:Option%20Table][Table of Long Options]]
28
 
** TODO Implement --socket
29
 
   [[info:standards:Option%20Table][Table of Long Options]]
30
 
** TODO Date+time on console log messages       :bugs:
 
92
** Implement --foreground                       :bugs:
 
93
   [[info:standards:Option%20Table][Table of Long Options]]
 
94
** Implement --socket
 
95
   [[info:standards:Option%20Table][Table of Long Options]]
 
96
** Date+time on console log messages            :bugs:
31
97
   Is this the default?
32
 
** TODO delete hook when clients fall out by timeout
33
 
   This will not be strictly necessary when the D-Bus interface is
34
 
   implemented.
35
 
 
36
 
* mandos.xml
37
 
** [[file:mandos.xml::XXX][Document D-Bus interface]]
38
 
 
39
 
* Provide and install /etc/dbus-1/system.d/mandos.conf
40
 
 
41
 
* mandos-list
42
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
43
 
*** [#B] --dump option
44
 
** TODO Disable client
45
 
** TODO Enable client
46
 
** TODO Reset timer
47
 
 
48
 
* Curses interface
49
 
 
50
 
* mandos-keygen
51
 
** TODO "--secfile" option
52
 
   Using the "secfile" option instead of "secret"
53
 
** TODO [#B] "--test" option
54
 
   For testing decryption before rebooting.
 
98
 
 
99
* Mandos-tools/utilities
 
100
  All of this probably using D-Bus
 
101
** List clients
 
102
** Disable client
 
103
** Enable client
 
104
 
 
105
* Installer
 
106
** Client
 
107
*** Update initrd.img after installation
 
108
    This seems to use some kind of "trigger" system
 
109
** Server
 
110
*** [#A] Create mandos user and group for server
 
111
*** [#A] Create /var/run/mandos directory with perm and ownership
 
112
 
 
113
** mandos-keygen
 
114
*** [#A] Output cut-and-paste ready snippet for clients.conf.
55
115
 
56
116
* [#A] Package
57
117
** /usr/share/initramfs-tools/hooks/mandos
58
 
*** TODO Do not install in initrd.img if configured not to.
 
118
*** Do not install in initrd.img if configured not to.
59
119
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
60
120
    question.
61
 
** TODO /etc/bash_completion.d/mandos
62
 
   From XML sources directly?
 
121
** /etc/bash_completion.d/mandos
 
122
*** From XML sources directly?
 
123
** unperish
 
124
** bzr-builddeb
 
125
 
 
126
* INSTALL file
 
127
 
 
128
* Web site
 
129
 
 
130
* Mailing list
 
131
 
 
132
* Announce project on news
 
133
  [[news:comp.os.linux.announce]]
63
134
 
64
135
 
65
136
#+STARTUP: showall