/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-09-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): Improve wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
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
 
3
* DONE plugin-runner
 
4
 
 
5
* mandos-client
 
6
** TODO [#B] Temporarily lower kernel log level
52
7
   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
 
8
** TODO [#C] IPv4 support
60
9
 
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?]]
 
10
* DONE password-prompt
67
11
 
68
12
* mandos (server)
69
 
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
71
 
** /etc/mandos/clients.d/*.conf
 
13
** TODO [#B] Log level                          :bugs:
 
14
** TODO /etc/mandos/clients.d/*.conf
72
15
   Watch this directory and add/remove/update clients?
73
 
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
 
16
** TODO config for TXT record
 
17
** TODO [#B] Run-time communication with server :bugs:
75
18
   Probably using D-Bus
76
19
   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:
 
20
** TODO Implement --foreground                  :bugs:
 
21
   [[info:standards:Option%20Table][Table of Long Options]]
 
22
** TODO Implement --socket
 
23
   [[info:standards:Option%20Table][Table of Long Options]]
 
24
** TODO Date+time on console log messages       :bugs:
82
25
   Is this the default?
 
26
** TODO delete hook when clients fall out by timeout
83
27
 
84
28
* Mandos-tools/utilities
85
29
  All of this probably using D-Bus
86
 
** List clients
87
 
** Disable client
88
 
** Enable client
 
30
** TODO List clients
 
31
** TODO Disable client
 
32
** TODO Enable client
 
33
** TODO Reset timer
89
34
 
90
35
* 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 <replaceable> and <option> tags
96
 
**** DONE mandos-clients.conf.xml
97
 
**** DONE mandos-keygen.xml
98
 
**** DONE mandos.conf.xml
99
 
**** DONE mandos.xml
100
 
**** DONE plugin-runner.xml
101
 
**** TODO plugins.d/password-prompt.xml
102
 
**** DONE plugins.d/password-request.xml
103
 
*** OPTIONS
104
 
    Separate <term> tags with <option> and <replaceable> tags
105
 
**** DONE mandos-clients.conf.xml
106
 
**** TODO mandos-keygen.xml
107
 
**** DONE mandos.conf.xml
108
 
**** TODO mandos.xml
109
 
**** TODO plugin-runner.xml
110
 
**** TODO plugins.d/password-prompt.xml
111
 
**** TODO plugins.d/password-request.xml
112
 
** Use xinclude for common sections
113
 
   Like copyright, authors, etc.
 
36
** TODO Use xinclude for all common sections
 
37
   Like authors, etc.
114
38
 
115
39
 
116
40
* Installer
117
41
** Client-side
118
 
*** Update initrd.img after installation
119
 
    This seems to use some kind of "trigger" system
120
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
121
 
    dpkg-trigger(1), deb-triggers(5)
122
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
123
 
    Must create in preinst if not pre-depending on cryptsetup
124
42
*** mandos-keygen
125
 
**** "--passfile" option
 
43
**** TODO "--secfile" option
126
44
     Using the "secfile" option instead of "secret"
127
 
**** [#A] "--test" option
 
45
**** TODO [#B] "--test" option
128
46
     For testing decryption before rebooting.
129
 
** Server-side
130
 
*** [#A] Create mandos user and group for server
131
 
*** [#A] Create /var/run/mandos directory with perm and ownership
 
47
 
132
48
 
133
49
* [#A] Package
134
50
** /usr/share/initramfs-tools/hooks/mandos
135
 
*** Do not install in initrd.img if configured not to.
 
51
*** TODO Do not install in initrd.img if configured not to.
136
52
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
137
53
    question.
138
 
** /etc/bash_completion.d/mandos
 
54
** TODO /etc/bash_completion.d/mandos
139
55
   From XML sources directly?
140
 
** unperish
141
 
** bzr-builddeb
142
 
 
143
 
* INSTALL file
144
 
 
145
 
* Web site
 
56
** TODO unperish
 
57
 
 
58
* TODO Web site
 
59
** DONE http://www.fukt.bsnet.se/mandos
 
60
   Redirects to the wiki page
 
61
** TODO http://wiki.fukt.bsnet.se/wiki/Mandos
 
62
   http://liw.fi/free-software-website/
146
63
 
147
64
* Mailing list
 
65
** DONE mandos-dev
 
66
*** TODO http://gmane.org/subscribe.php
148
67
 
149
 
* Announce project on news
 
68
* TODO Announce project on Usenet
150
69
  [[news:comp.os.linux.announce]]
151
70
 
152
71