/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-20 00:35:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820003541-zxymabnc6yfj8y7t
* mandos-keygen.xml (SEE ALSO): Remove "and".

* mandos.conf.xml (SEE ALSO): New section.

* mandos.xml (SEE ALSO): Changed man page references to a comma-
                         separated list, as per man-pages(7).  Added
                         reference to sh(1).

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
*** EXAMPLES
 
12
    Examples of normal usage, debug usage, debugging single or all
 
13
    plugins, etc.
 
14
*** FILES
 
15
*** SECURITY
 
16
    Note the danger of using this program, since you might lock
 
17
    yourself out of your system without any means of entering the root
 
18
    file system password.  This is, however, very unlikely considering
 
19
    the fallback to getpass(3).
 
20
*** BUGS
 
21
*** SEE ALSO
 
22
    Explaining text on what you can read
6
23
 
7
 
* mandos-client
8
 
** TODO [#B] Temporarily lower kernel log level
 
24
* password-request
 
25
** [#A] Man page: man8/password-request.8mandos
 
26
*** SYNOPSIS
 
27
    Document short options
 
28
*** DESCRIPTION
 
29
    State that this command is not meant to be invoked directly, but
 
30
    is run as a plugin from mandos-client(8) and only run in the
 
31
    initrd environment, not the real system.
 
32
*** PURPOSE
 
33
    As in mandos.xml
 
34
*** OVERVIEW
 
35
    As in mandos.xml
 
36
*** EXIT STATUS
 
37
*** ENVIRONMENT
 
38
    Note that it does *not* currently use cryptsource or crypttarget.
 
39
*** FILES
 
40
    Describe the key files and the key ring files.  Also note that
 
41
    they should normally have been automatically created.
 
42
*** BUGS
 
43
*** EXAMPLE
 
44
    Examples of normal usage, debug usage, debugging by connecting
 
45
    directly, etc.
 
46
*** SECURITY
 
47
*** SEE ALSO
 
48
    Update from mandos.xml
 
49
** [#B] Temporarily lower kernel log level
9
50
   for less printouts during sucessfull boot.
10
 
** TODO IPv4 support
11
 
** TODO use strsep instead of strtok?
 
51
** IPv4 support
 
52
** use strsep instead of strtok?
 
53
** Do not depend on GnuPG key rings on disk
 
54
   This would mean creating new GnuPG key rings with GPGME by
 
55
   importing the key files from scratch on every program start.
 
56
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
57
   Must create in preinst if not pre-depending on cryptsetup
12
58
 
13
 
* DONE password-prompt
 
59
* password-prompt
 
60
** [#A] Man page: man8/password-prompt.8mandos
 
61
*** SYNOPSIS
 
62
    Document short options
 
63
*** DESCRIPTION
 
64
    Note that this is more or less a simple getpass(3) wrapper, even
 
65
    though actual use of getpass(3) is not guaranteed.
 
66
*** EXIT STATUS
 
67
*** ENVIRONMENT
 
68
    Document use of "cryptsource" and "crypttarget".
 
69
*** FILES
 
70
*** BUGS
 
71
*** EXAMPLE
 
72
    Examples of normal usage, debug usage, with a prefix, etc.
 
73
*** SECURITY
 
74
    Not much to do here but it is noteworthy to state the danger of
 
75
    not having a fallback option.
 
76
*** SEE ALSO
 
77
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
78
    and also, perhaps, to cryptsetup(8)?
 
79
** Use getpass(3)?
 
80
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
83
   [[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
84
 
15
85
* mandos (server)
16
 
** TODO [#B] Log level                          :bugs:
17
 
** TODO /etc/mandos/clients.d/*.conf
 
86
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
87
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
88
** [#A] /etc/init.d/mandos-server               :teddy:
 
89
** [#B] Log level                               :bugs:
 
90
** /etc/mandos/clients.d/*.conf
18
91
   Watch this directory and add/remove/update clients?
19
 
** TODO config for TXT record
20
 
** TODO [#B] Run-time communication with server :bugs:
 
92
** config for TXT record
 
93
** [#B] Run-time communication with server      :bugs:
21
94
   Probably using D-Bus
22
95
   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:
 
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:
28
101
   Is this the default?
29
 
** TODO delete hook when clients fall out by timeout
30
102
 
31
103
* Mandos-tools/utilities
32
104
  All of this probably using D-Bus
33
 
** TODO List clients
34
 
** TODO Disable client
35
 
** TODO Enable client
36
 
** TODO Reset timer
37
 
 
38
 
* Man pages
39
 
** TODO Use xinclude for all common sections
40
 
   Like authors, etc.
41
 
 
 
105
** List clients
 
106
** Disable client
 
107
** Enable client
42
108
 
43
109
* Installer
44
110
** Client-side
45
 
*** TODO Update initrd.img after installation
 
111
*** Update initrd.img after installation
46
112
    This seems to use some kind of "trigger" system
47
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
48
 
    dpkg-trigger(1), deb-triggers(5)
 
113
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
114
    Must create in preinst if not pre-depending on cryptsetup
49
115
*** mandos-keygen
50
 
**** TODO [#A] Ask for password twice for confirmation
51
 
**** TODO "--passfile" option
52
 
     Using the "secfile" option instead of "secret"
53
 
**** TODO [#B] "--test" option
54
 
     For testing decryption before rebooting.
 
116
**** [#A] Output cut-and-paste ready snippet for clients.conf.
55
117
** Server-side
56
 
*** TODO [#A] Create mandos user and group for server
57
 
 
 
118
*** [#A] Create mandos user and group for server
 
119
*** [#A] Create /var/run/mandos directory with perm and ownership
58
120
 
59
121
* [#A] Package
60
122
** /usr/share/initramfs-tools/hooks/mandos
61
 
*** TODO Do not install in initrd.img if configured not to.
 
123
*** Do not install in initrd.img if configured not to.
62
124
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
63
125
    question.
64
 
** TODO /etc/bash_completion.d/mandos
 
126
** /etc/bash_completion.d/mandos
65
127
   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
 
128
** unperish
 
129
** bzr-builddeb
 
130
 
 
131
* INSTALL file
 
132
 
 
133
* Web site
75
134
 
76
135
* Mailing list
77
 
** DONE mandos-dev
78
 
*** TODO http://gmane.org/subscribe.php
79
136
 
80
 
* TODO Announce project on Usenet
 
137
* Announce project on news
81
138
  [[news:comp.os.linux.announce]]
82
139
 
83
140