/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* Mandos client
4
 
** Use argp instead of getopt_long
5
 
** header files/symbols tally
6
 
** check exit codes of all system calls
 
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
 
52
   for less printouts during sucessfull boot.
7
53
** IPv4 support
8
54
** use strsep instead of strtok?
9
 
 
10
 
* Pluginbasedclient
11
 
** header files/symbols tally
12
 
** check exit codes of all system calls
13
 
** [#C] pass things in environment, like device name, etc
14
 
** use strsep instead of strtok?
15
 
** use config file in addition to arguments
16
 
 
17
 
* Server
18
 
** config for:
19
 
*** TXT record
20
 
** protocol version header
21
 
** Run-time communication with server
22
 
   probably using D-Bus
 
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
 
60
 
 
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?]]
 
67
 
 
68
* mandos (server)
 
69
** [#A] /etc/init.d/mandos-server               :teddy:
 
70
** [#B] Log level                               :bugs:
 
71
** /etc/mandos/clients.d/*.conf
 
72
   Watch this directory and add/remove/update clients?
 
73
** config for TXT record
 
74
** [#B] Run-time communication with server      :bugs:
 
75
   Probably using D-Bus
 
76
   See also [[*Mandos-tools]]
 
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:
 
82
   Is this the default?
23
83
 
24
84
* Mandos-tools/utilities
25
85
  All of this probably using D-Bus
26
86
** List clients
 
87
** Disable client
27
88
** Enable client
28
 
** Disable client
 
89
 
 
90
* Man pages
 
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-keygen.xml
 
97
**** DONE plugins.d/password-request.xml
 
98
**** TODO mandos.conf.xml
 
99
**** TODO mandos.xml
 
100
**** TODO plugin-runner.xml
 
101
**** TODO plugins.d/password-prompt.xml
 
102
*** OPTIONS
 
103
    Separate <term> tags with <option> and <replaceable> tags
 
104
**** DONE mandos-clients.conf.xml
 
105
**** TODO mandos-keygen.xml
 
106
**** DONE mandos.conf.xml
 
107
**** TODO mandos.xml
 
108
**** TODO plugin-runner.xml
 
109
**** TODO plugins.d/password-prompt.xml
 
110
**** TODO plugins.d/password-request.xml
 
111
** Use xinclude for common sections
 
112
   Like copyright, authors, etc.
 
113
 
29
114
 
30
115
* Installer
 
116
** Client-side
 
117
*** Update initrd.img after installation
 
118
    This seems to use some kind of "trigger" system
 
119
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
120
    dpkg-trigger(1), deb-triggers(5)
 
121
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
122
    Must create in preinst if not pre-depending on cryptsetup
 
123
*** mandos-keygen
 
124
**** "--passfile" option
 
125
     Using the "secfile" option instead of "secret"
 
126
**** [#A] "--test" option
 
127
     For testing decryption before rebooting.
 
128
** Server-side
 
129
*** [#A] Create mandos user and group for server
 
130
*** [#A] Create /var/run/mandos directory with perm and ownership
 
131
 
 
132
* [#A] Package
 
133
** /usr/share/initramfs-tools/hooks/mandos
 
134
*** Do not install in initrd.img if configured not to.
 
135
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
136
    question.
 
137
** /etc/bash_completion.d/mandos
 
138
   From XML sources directly?
 
139
** unperish
 
140
** bzr-builddeb
 
141
 
 
142
* INSTALL file
 
143
 
 
144
* Web site
 
145
 
 
146
* Mailing list
 
147
 
 
148
* Announce project on news
 
149
  [[news:comp.os.linux.announce]]
31
150
 
32
151
 
33
152
#+STARTUP: showall