/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-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

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
*** 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
 
25
 
 
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
5
52
   for less printouts during sucessfull boot.
6
 
   klogctl(6, NULL, 0); klogctl(7, NULL, 0);
7
 
** 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
8
60
 
9
 
* plugin-runner
10
 
** TODO [#B] use scandir(3) instead of readdir(3)
 
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?]]
11
67
 
12
68
* mandos (server)
13
 
** TODO [#B] Log level                          :bugs:
14
 
** 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
15
72
   Watch this directory and add/remove/update clients?
16
 
** TODO config for TXT record
17
 
** TODO [#B] Run-time communication with server :bugs:
 
73
** config for TXT record
 
74
** [#B] Run-time communication with server      :bugs:
18
75
   Probably using D-Bus
19
76
   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:
 
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:
31
82
   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.
 
83
 
 
84
* Mandos-tools/utilities
 
85
  All of this probably using D-Bus
 
86
** List clients
 
87
** Disable client
 
88
** Enable client
 
89
 
 
90
* Man pages tags
 
91
  Go through all man pages to conform to the style of tags chosen in 
 
92
  [[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]].
 
93
 
 
94
* Installer
 
95
** Client-side
 
96
*** Update initrd.img after installation
 
97
    This seems to use some kind of "trigger" system
 
98
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
99
    dpkg-trigger(1), deb-triggers(5)
 
100
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
101
    Must create in preinst if not pre-depending on cryptsetup
 
102
*** mandos-keygen
 
103
**** "--passfile" option
 
104
     Using the "secfile" option instead of "secret"
 
105
**** [#A] "--test" option
 
106
     For testing decryption before rebooting.
 
107
** Server-side
 
108
*** [#A] Create mandos user and group for server
 
109
*** [#A] Create /var/run/mandos directory with perm and ownership
55
110
 
56
111
* [#A] Package
57
112
** /usr/share/initramfs-tools/hooks/mandos
58
 
*** TODO [#C] Do not install in initrd.img if configured not to.
 
113
*** Do not install in initrd.img if configured not to.
59
114
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
60
115
    question.
61
 
** TODO [#C] /etc/bash_completion.d/mandos
 
116
** /etc/bash_completion.d/mandos
62
117
   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.
 
118
** unperish
 
119
** bzr-builddeb
 
120
 
 
121
* INSTALL file
 
122
 
 
123
* Web site
 
124
 
 
125
* Mailing list
 
126
 
 
127
* Announce project on news
 
128
  [[news:comp.os.linux.announce]]
66
129
 
67
130
 
68
131
#+STARTUP: showall