/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-19 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
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
 
** [#A] check return codes of all system calls
11
 
** [#B] header files/symbols tally
12
 
** use strsep instead of strtok?
13
 
** use config file in addition to arguments
14
 
** pass things in environment, like device name, etc
15
 
 
16
 
* Password-request
 
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
17
25
** [#A] Man page: man8/password-request.8mandos
18
 
** [#A] check return codes of all system calls
19
 
** [#B] header files/symbols tally
 
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
 
50
   for less printouts during sucessfull boot.
20
51
** IPv4 support
21
52
** use strsep instead of strtok?
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.
 
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
25
58
 
26
 
* Password-prompt
 
59
* password-prompt
27
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)?
28
79
** Use getpass(3)?
29
 
   [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
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?]]
30
84
 
31
 
* Server
32
 
** [#A] Command man page: man8/mandos.8
 
85
* mandos (server)
33
86
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
34
87
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
35
 
** [#A] write PID file
36
 
** [#A] /etc/init.d/mandos-server
37
 
** Better comments in config files
38
 
** Log level
 
88
** [#A] /etc/init.d/mandos-server               :teddy:
 
89
** [#B] Log level                               :bugs:
39
90
** /etc/mandos/clients.d/*.conf
40
91
   Watch this directory and add/remove/update clients?
41
92
** config for TXT record
42
 
** Run-time communication with server
43
 
   probably using D-Bus
44
 
** Implement --foreground
 
93
** [#B] Run-time communication with server      :bugs:
 
94
   Probably using D-Bus
 
95
   See also [[*Mandos-tools]]
 
96
** Implement --foreground                       :bugs:
45
97
   [[info:standards:Option%20Table][Table of Long Options]]
46
98
** Implement --socket
47
99
   [[info:standards:Option%20Table][Table of Long Options]]
 
100
** Date+time on console log messages            :bugs:
 
101
   Is this the default?
48
102
 
49
103
* Mandos-tools/utilities
50
104
  All of this probably using D-Bus
51
105
** List clients
 
106
** Disable client
52
107
** Enable client
53
 
** Disable client
54
108
 
55
109
* Installer
56
 
** [#A] Change initrd.img file to not be publically readable
57
 
** [#A] Create GPG key ring files in initrd
 
110
** Client-side
 
111
*** Update initrd.img after installation
 
112
    This seems to use some kind of "trigger" system
 
113
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
114
    Must create in preinst if not pre-depending on cryptsetup
 
115
*** mandos-keygen
 
116
**** [#A] Output cut-and-paste ready snippet for clients.conf.
 
117
** Server-side
 
118
*** [#A] Create mandos user and group for server
 
119
*** [#A] Create /var/run/mandos directory with perm and ownership
 
120
 
 
121
* [#A] Package
 
122
** /usr/share/initramfs-tools/hooks/mandos
 
123
*** Do not install in initrd.img if configured not to.
 
124
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
125
    question.
 
126
** /etc/bash_completion.d/mandos
 
127
   From XML sources directly?
 
128
** unperish
 
129
** bzr-builddeb
 
130
 
 
131
* INSTALL file
 
132
 
 
133
* Web site
 
134
 
 
135
* Mailing list
 
136
 
 
137
* Announce project on news
 
138
  [[news:comp.os.linux.announce]]
58
139
 
59
140
 
60
141
#+STARTUP: showall