/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-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

Show diffs side-by-side

added added

removed removed

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