/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-25 07:52:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825075235-gq338t4ywhqhire8
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
                                         only configuration file of
                                         mandos(8).
  (OPTIONS): Note that unknown options are ignored.  When describing
             "checker", be more specific about exit codes, and refer
             to PATH.  When describing "secret", refer to
             mandos-keygen(8), and note the relationship with
             "secfile".  Added synopsis to "secfile", and note
             relationship with "secret".  Added synopsis and more text
             to "host".
  (EXAMPLE): Remove Radix-64 checksum from "secret" option value.
  (SEE ALSO): New section, refer to mandos(8), mandos-keygen(8), and
              mandos.conf(5).

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
** [#A] Man page: man8/password-prompt.8mandos
 
63
*** SYNOPSIS
 
64
    Document short options
 
65
*** DESCRIPTION
 
66
    Note that this is more or less a simple getpass(3) wrapper, even
 
67
    though actual use of getpass(3) is not guaranteed.
 
68
*** EXIT STATUS
 
69
*** ENVIRONMENT
 
70
    Document use of "cryptsource" and "crypttarget".
 
71
*** FILES
 
72
*** BUGS
 
73
*** EXAMPLE
 
74
    Examples of normal usage, debug usage, with a prefix, etc.
 
75
*** SECURITY
 
76
    Not much to do here but it is noteworthy to state the danger of
 
77
    not having a fallback option.
 
78
*** SEE ALSO
 
79
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
80
    and also, perhaps, to cryptsetup(8)?
 
81
** Use getpass(3)?
 
82
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
83
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
84
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
85
   [[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
86
 
14
87
* mandos (server)
15
 
** TODO [#B] Log level                          :bugs:
16
 
** TODO /etc/mandos/clients.d/*.conf
 
88
** [#A] /etc/init.d/mandos-server               :teddy:
 
89
** [#B] Log level                               :bugs:
 
90
** /etc/mandos/clients.d/*.conf
17
91
   Watch this directory and add/remove/update clients?
18
 
** TODO config for TXT record
19
 
** TODO [#B] Run-time communication with server :bugs:
 
92
** config for TXT record
 
93
** [#B] Run-time communication with server      :bugs:
20
94
   Probably using D-Bus
21
95
   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:
 
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:
27
101
   Is this the default?
28
 
** TODO delete hook when clients fall out by timeout
29
102
 
30
103
* Mandos-tools/utilities
31
104
  All of this probably using D-Bus
32
 
** TODO List clients
33
 
** TODO Disable client
34
 
** TODO Enable client
35
 
** TODO Reset timer
36
 
 
37
 
* Man pages
38
 
** TODO Use xinclude for all common sections
39
 
   Like authors, etc.
40
 
 
 
105
** List clients
 
106
** Disable client
 
107
** Enable client
41
108
 
42
109
* Installer
43
110
** Client-side
44
 
*** TODO Update initrd.img after installation
 
111
*** Update initrd.img after installation
45
112
    This seems to use some kind of "trigger" system
46
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
47
 
    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
48
115
*** mandos-keygen
49
 
**** TODO [#A] Ask for password twice for confirmation
50
 
**** TODO "--passfile" option
 
116
**** "--passfile" option
51
117
     Using the "secfile" option instead of "secret"
52
 
**** TODO [#B] "--test" option
 
118
**** [#A] "--test" option
53
119
     For testing decryption before rebooting.
54
120
** Server-side
55
 
*** TODO [#A] Create mandos user and group for server
56
 
 
 
121
*** [#A] Create mandos user and group for server
 
122
*** [#A] Create /var/run/mandos directory with perm and ownership
57
123
 
58
124
* [#A] Package
59
125
** /usr/share/initramfs-tools/hooks/mandos
60
 
*** TODO Do not install in initrd.img if configured not to.
 
126
*** Do not install in initrd.img if configured not to.
61
127
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
62
128
    question.
63
 
** TODO /etc/bash_completion.d/mandos
 
129
** /etc/bash_completion.d/mandos
64
130
   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
 
131
** unperish
 
132
** bzr-builddeb
 
133
 
 
134
* INSTALL file
 
135
 
 
136
* Web site
74
137
 
75
138
* Mailing list
76
 
** DONE mandos-dev
77
 
*** TODO http://gmane.org/subscribe.php
78
139
 
79
 
* TODO Announce project on Usenet
 
140
* Announce project on news
80
141
  [[news:comp.os.linux.announce]]
81
142
 
82
143