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