/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 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* mandos-client
4
 
** TODO [#B] Temporarily lower kernel log level
 
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
*** 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
 
23
 
 
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
5
50
   for less printouts during sucessfull boot.
6
 
   klogctl(6, NULL, 0); klogctl(7, NULL, 0);
7
 
** TODO [#C] IPv4 support
 
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
8
58
 
9
 
* plugin-runner
10
 
** TODO [#B] use scandir(3) instead of readdir(3)
 
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?]]
11
84
 
12
85
* mandos (server)
13
 
** TODO [#B] Log level                          :bugs:
14
 
** TODO /etc/mandos/clients.d/*.conf
 
86
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
87
** [#A] /etc/init.d/mandos-server               :teddy:
 
88
** [#B] Log level                               :bugs:
 
89
** /etc/mandos/clients.d/*.conf
15
90
   Watch this directory and add/remove/update clients?
16
 
** TODO config for TXT record
17
 
** TODO [#B] Run-time communication with server :bugs:
 
91
** config for TXT record
 
92
** [#B] Run-time communication with server      :bugs:
18
93
   Probably using D-Bus
19
94
   See also [[*Mandos-tools]]
20
 
*** Client class
21
 
*** Main server
22
 
    + SetLogLevel
23
 
      syslogger.setLevel(logging.WARNING)
24
 
    + Quit
25
 
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
26
 
** TODO Implement --foreground                  :bugs:
27
 
   [[info:standards:Option%20Table][Table of Long Options]]
28
 
** TODO Implement --socket
29
 
   [[info:standards:Option%20Table][Table of Long Options]]
30
 
** TODO Date+time on console log messages       :bugs:
 
95
** Implement --foreground                       :bugs:
 
96
   [[info:standards:Option%20Table][Table of Long Options]]
 
97
** Implement --socket
 
98
   [[info:standards:Option%20Table][Table of Long Options]]
 
99
** Date+time on console log messages            :bugs:
31
100
   Is this the default?
32
 
** TODO delete hook when clients fall out by timeout
33
 
   This will not be strictly necessary when the D-Bus interface is
34
 
   implemented.
35
 
 
36
 
* mandos.xml
37
 
** [[file:mandos.xml::XXX][Document D-Bus interface]]
38
 
 
39
 
* Provide and install /etc/dbus-1/system.d/mandos.conf
40
 
 
41
 
* mandos-list
42
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
43
 
*** [#B] --dump option
44
 
** TODO Disable client
45
 
** TODO Enable client
46
 
** TODO Reset timer
47
 
 
48
 
* Curses interface
49
 
 
50
 
* mandos-keygen
51
 
** TODO "--secfile" option
52
 
   Using the "secfile" option instead of "secret"
53
 
** TODO [#B] "--test" option
54
 
   For testing decryption before rebooting.
 
101
 
 
102
* Mandos-tools/utilities
 
103
  All of this probably using D-Bus
 
104
** List clients
 
105
** Disable client
 
106
** Enable client
 
107
 
 
108
* Installer
 
109
** Client-side
 
110
*** Update initrd.img after installation
 
111
    This seems to use some kind of "trigger" system
 
112
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
113
    Must create in preinst if not pre-depending on cryptsetup
 
114
*** mandos-keygen
 
115
**** [#A] Output cut-and-paste ready snippet for clients.conf.
 
116
** Server-side
 
117
*** [#A] Create mandos user and group for server
 
118
*** [#A] Create /var/run/mandos directory with perm and ownership
55
119
 
56
120
* [#A] Package
57
121
** /usr/share/initramfs-tools/hooks/mandos
58
 
*** TODO [#C] Do not install in initrd.img if configured not to.
 
122
*** Do not install in initrd.img if configured not to.
59
123
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
60
124
    question.
61
 
** TODO [#C] /etc/bash_completion.d/mandos
 
125
** /etc/bash_completion.d/mandos
62
126
   From XML sources directly?
63
 
** TODO initramfs-tools-script                                            :test:
64
 
   Do not insert plugin-runner as keyscript if a kernel parameter
65
 
   "mandos=off" is passed.
 
127
** unperish
 
128
** bzr-builddeb
 
129
 
 
130
* INSTALL file
 
131
 
 
132
* Web site
 
133
 
 
134
* Mailing list
 
135
 
 
136
* Announce project on news
 
137
  [[news:comp.os.linux.announce]]
66
138
 
67
139
 
68
140
#+STARTUP: showall