/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-17 22:42:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817224228-nhor2yuv230if01i
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
                           not rely on a stylesheet declaration.

* mandos.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
              refers to "overview.xml". Changed all single quotes to
              double quotes for consistency.
  (DESCRIPTION): Use the term "TLS" and not "GnuTLS" for the protocol.
                 Refer to the "OVERVIEW" section for reason for IPv6
                 link-local addresses.
  (PURPOSE): Shortened a lot.  Refer to "OVERVIEW" section for details.
  (OVERVIEW): New section.  Include &OVERVIEW; and add a paragraph
              about what the role of this program is.
  (SECURITY/CLIENTS): Refer to the "CHECKING" section for details on
                      checking.
  (SEE ALSO): Changed from an <itemizedlist> to a <variablelist>.
              Added a short text for each entry.  Removed reference to
              plugin-runner(8mandos).  Add reference to RFC 4291 and
              RFC 4346.

* overview.xml: New file, containing a single <para>.  The idea is to
                use this in all the man pages.

* plugins.d/password-request.c: Updated comments about spurious
                                warnings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* plugin-runner
4
 
** TODO Man page  for plugin-runner.conf.5
5
 
   link to plugin-runner.8
6
 
 
7
 
* mandos-client
8
 
** 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
    Text needed
 
12
*** EXAMPLES
 
13
    Examples of normal usage, debug usage, debugging single or all
 
14
    plugins, etc.
 
15
*** FILES
 
16
    Text needed
 
17
*** SECURITY
 
18
    Text needed
 
19
*** BUGS
 
20
    Text needed
 
21
*** SEE ALSO
 
22
    Explaining text on what you can read
 
23
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
24
   Must create in preinst if not pre-depending on cryptsetup
 
25
 
 
26
* Password-request
 
27
** [#A] Man page: man8/password-request.8mandos
 
28
** [#B] Temporarily lower kernel log level
9
29
   for less printouts during sucessfull boot.
10
 
** TODO IPv4 support
11
 
** TODO use strsep instead of strtok?
12
 
 
13
 
* DONE password-prompt
14
 
 
15
 
* mandos (server)
16
 
** TODO [#B] Log level                          :bugs:
17
 
** TODO /etc/mandos/clients.d/*.conf
 
30
*** DESCRIPTION
 
31
    Move options to new OPTIONS section.
 
32
    State that this command is not meant to be invoked directly, but
 
33
    is run as a plugin from mandos-client(8) and only run in the
 
34
    initrd environment, not the real system.
 
35
*** EXIT STATUS
 
36
    Create this section
 
37
*** EXAMPLES
 
38
    Examples of normal usage, debug usage, debugging by connecting
 
39
    directly, etc.
 
40
*** FILES
 
41
    Describe the key files and the key ring files.  Also note that
 
42
    they should normally have been automatically created.
 
43
*** DIAGNOSTICS
 
44
    Create this section
 
45
*** SECURITY
 
46
    Create this section
 
47
*** BUGS
 
48
    Create this section
 
49
*** SEE ALSO
 
50
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
51
*** ENVIRONMENT
 
52
    Document use of "cryptsource" and "crypttarget".
 
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
 
 
59
* Password-prompt
 
60
** [#A] Man page: man8/password-prompt.8mandos
 
61
*** DESCRIPTION
 
62
    Move options to new OPTIONS section.
 
63
    Note that this is more or less a simple getpass(3) wrapper, even
 
64
    though actual use of getpass(3) is not guaranteed.
 
65
*** EXIT STATUS
 
66
    Create this section
 
67
*** EXAMPLES
 
68
    Examples of normal usage, debug usage, with a prefix, etc.
 
69
*** DIAGNOSTICS
 
70
    Create this section
 
71
*** SECURITY
 
72
    Create this section
 
73
    Not much to do here but it is noteworthy to state the danger of
 
74
    not having a fallback option.
 
75
*** BUGS
 
76
    Create this section
 
77
*** SEE ALSO
 
78
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
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?]]
 
84
 
 
85
* Mandos (server)
 
86
** [#A] Command man page: man8/mandos.8
 
87
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
88
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
89
** [#A] /etc/init.d/mandos-server               :teddy:
 
90
** Log level
 
91
** /etc/mandos/clients.d/*.conf
18
92
   Watch this directory and add/remove/update clients?
19
 
** TODO config for TXT record
20
 
** TODO [#B] Run-time communication with server :bugs:
 
93
** config for TXT record
 
94
** Run-time communication with server
21
95
   Probably using D-Bus
22
96
   See also [[*Mandos-tools]]
23
 
** TODO Implement --foreground                  :bugs:
24
 
   [[info:standards:Option%20Table][Table of Long Options]]
25
 
** TODO Implement --socket
26
 
   [[info:standards:Option%20Table][Table of Long Options]]
27
 
** TODO Date+time on console log messages       :bugs:
 
97
** Implement --foreground
 
98
   [[info:standards:Option%20Table][Table of Long Options]]
 
99
** Implement --socket
 
100
   [[info:standards:Option%20Table][Table of Long Options]]
 
101
** Date+time on console log messages
28
102
   Is this the default?
29
 
** TODO delete hook when clients fall out by timeout
30
103
 
31
104
* Mandos-tools/utilities
32
105
  All of this probably using D-Bus
33
 
** TODO List clients
34
 
** TODO Disable client
35
 
** TODO Enable client
36
 
** TODO Reset timer
37
 
 
38
 
* Man pages
39
 
** TODO Use xinclude for all common sections
40
 
   Like authors, etc.
41
 
 
 
106
** List clients
 
107
** Disable client
 
108
** Enable client
42
109
 
43
110
* Installer
44
 
** Client-side
45
 
*** TODO Update initrd.img after installation
46
 
    This seems to use some kind of "trigger" system
47
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
48
 
    dpkg-trigger(1), deb-triggers(5)
49
 
*** mandos-keygen
50
 
**** TODO [#A] Ask for password twice for confirmation
51
 
**** TODO "--passfile" option
52
 
     Using the "secfile" option instead of "secret"
53
 
**** TODO [#B] "--test" option
54
 
     For testing decryption before rebooting.
55
 
** Server-side
56
 
*** TODO [#A] Create mandos user and group for server
 
111
** Client
 
112
*** DONE [#A] Change initrd.img file to not be publically readable
 
113
    /usr/share/initramfs-tools/conf-hooks.d/mandos
 
114
    UMASK=027
 
115
*** Update initrd.img after installation
 
116
** Server
 
117
*** [#A] Create mandos user and group for server
 
118
*** [#A] Create /var/run/mandos directory with perm and ownership
57
119
 
 
120
** mandos-keygen
 
121
*** [#A] Command man page: man8/mandos-keygen.8
 
122
**** EXIT STATUS
 
123
**** FILES
 
124
**** BUGS
 
125
**** EXAMPLES
 
126
**** SECURITY
 
127
*** [#A] Output cut-and-paste ready snippet for clients.conf.
58
128
 
59
129
* [#A] Package
60
130
** /usr/share/initramfs-tools/hooks/mandos
61
 
*** TODO Do not install in initrd.img if configured not to.
 
131
*** Do not install in initrd.img if configured not to.
62
132
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
63
133
    question.
64
 
** TODO /etc/bash_completion.d/mandos
65
 
   From XML sources directly?
66
 
** TODO unperish
67
 
** DONE bzr-builddeb
68
 
** TODO mandos user/group creation
69
 
** TODO Key creation in postinst
70
 
 
71
 
* TODO Web site
72
 
** DONE http://www.fukt.bsnet.se/mandos
73
 
   Redirects to the wiki page
74
 
** TODO http://wiki.fukt.bsnet.se/wiki/Mandos
 
134
** /etc/bash_completion.d/mandos
 
135
*** From XML sources directly?
 
136
** unperish
 
137
** bzr-builddeb
 
138
 
 
139
* INSTALL file
 
140
 
 
141
* Web site
75
142
 
76
143
* Mailing list
77
 
** DONE mandos-dev
78
 
*** TODO http://gmane.org/subscribe.php
79
144
 
80
 
* TODO Announce project on Usenet
 
145
* Announce project on news
81
146
  [[news:comp.os.linux.announce]]
82
147
 
83
148