/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-09 04:56:00 UTC
  • mfrom: (24.1.27 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080809045600-m7jx3tj4wwunaffa
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
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
 
3
* README file
 
4
 
 
5
* COPYING file
 
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
 
7
 
 
8
* Mandos-client
 
9
** [#A] Man page: man8/mandos-client.8mandos
 
10
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
11
** use strsep instead of strtok?
 
12
** use config file in addition to arguments
 
13
** pass things in environment, like device name, etc
 
14
 
 
15
* Password-request
27
16
** [#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.
 
17
** [#A] check return codes of all system calls
 
18
** [#B] header files/symbols tally
 
19
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
53
20
** IPv4 support
54
21
** 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
 
22
** Do not depend on GPG key rings on disk
 
23
   This would mean creating new GPG key rings with GPGME by importing
 
24
   the key files from scratch on every program start.
60
25
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
 
26
* Password-prompt
 
27
** [#A] Man page: man8/password-prompt.8mandos
 
28
** Use getpass(3)?
63
29
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
30
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
31
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
32
   [[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
33
 
68
 
* mandos (server)
 
34
* Server
 
35
** [#A] Command man page: man8/mandos.8
 
36
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
37
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
69
38
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
 
39
** Log level
71
40
** /etc/mandos/clients.d/*.conf
72
41
   Watch this directory and add/remove/update clients?
73
42
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
 
43
** Run-time communication with server
75
44
   Probably using D-Bus
76
45
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
 
46
** Implement --foreground
78
47
   [[info:standards:Option%20Table][Table of Long Options]]
79
48
** Implement --socket
80
49
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
82
 
   Is this the default?
83
50
 
84
51
* Mandos-tools/utilities
85
52
  All of this probably using D-Bus
87
54
** Disable client
88
55
** Enable client
89
56
 
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-clients.conf.xml
97
 
**** DONE mandos-keygen.xml
98
 
**** DONE mandos.conf.xml
99
 
**** DONE mandos.xml
100
 
**** TODO plugin-runner.xml
101
 
**** TODO plugins.d/password-prompt.xml
102
 
**** DONE plugins.d/password-request.xml
103
 
*** OPTIONS
104
 
    Separate <term> tags with <option> and <replaceable> tags
105
 
**** DONE mandos-clients.conf.xml
106
 
**** TODO mandos-keygen.xml
107
 
**** DONE mandos.conf.xml
108
 
**** TODO mandos.xml
109
 
**** TODO plugin-runner.xml
110
 
**** TODO plugins.d/password-prompt.xml
111
 
**** TODO plugins.d/password-request.xml
112
 
** Use xinclude for common sections
113
 
   Like copyright, authors, etc.
114
 
 
115
 
 
116
57
* Installer
117
 
** Client-side
118
 
*** Update initrd.img after installation
119
 
    This seems to use some kind of "trigger" system
120
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
121
 
    dpkg-trigger(1), deb-triggers(5)
122
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
123
 
    Must create in preinst if not pre-depending on cryptsetup
124
 
*** mandos-keygen
125
 
**** "--passfile" option
126
 
     Using the "secfile" option instead of "secret"
127
 
**** [#A] "--test" option
128
 
     For testing decryption before rebooting.
129
 
** Server-side
130
 
*** [#A] Create mandos user and group for server
131
 
*** [#A] Create /var/run/mandos directory with perm and ownership
132
 
 
133
 
* [#A] Package
134
 
** /usr/share/initramfs-tools/hooks/mandos
135
 
*** Do not install in initrd.img if configured not to.
136
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
137
 
    question.
138
 
** /etc/bash_completion.d/mandos
139
 
   From XML sources directly?
140
 
** unperish
141
 
** bzr-builddeb
142
 
 
143
 
* INSTALL file
144
 
 
145
 
* Web site
146
 
 
147
 
* Mailing list
148
 
 
149
 
* Announce project on news
150
 
  [[news:comp.os.linux.announce]]
 
58
** [#A] Change initrd.img file to not be publically readable
 
59
** [#A] Create /etc/initramfs-tools/hooks/mandos
 
60
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
61
** [#A] Create GPG key ring files in initrd
 
62
** [#A] Create mandos user and group for server
 
63
** [#A] Create /var/run/mandos directory with perm and ownership
 
64
 
 
65
* [[http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/][Software Release Practice HOWTO]]
151
66
 
152
67
 
153
68
#+STARTUP: showall