/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
2
2
 
3
3
* [#A] README file
4
4
 
5
 
* [#A] COPYING file
6
 
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
 
 
8
 
* Mandos-client
9
 
** [#A] Change syntax for arguments
10
 
** [#A] Man page: man8/mandos-client.8mandos
11
 
*** DESCRIPTION
12
 
    Describe the plus sign syntax for passing options from crypttab
 
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
13
10
*** EXIT STATUS
14
11
    Text needed
15
12
*** EXAMPLES
16
13
    Examples of normal usage, debug usage, debugging single or all
17
 
    plugins, examples of crypttab lines with plus syntax, etc.
 
14
    plugins, etc.
18
15
*** FILES
19
16
    Text needed
20
17
*** SECURITY
21
18
    Text needed
22
 
*** NOTES
23
 
    Text needed
24
19
*** BUGS
25
20
    Text needed
26
21
*** SEE ALSO
27
 
    Explaining test on what you can read
28
 
** Use asprintf instead of malloc and strcat?
29
 
** use strsep instead of strtok?
30
 
** use config file in addition to arguments
31
 
** pass things in environment, like device name, etc
 
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
32
25
 
33
26
* Password-request
34
27
** [#A] Man page: man8/password-request.8mandos
 
28
** [#B] Temporarily lower kernel log level
 
29
   for less printouts during sucessfull boot.
35
30
*** DESCRIPTION
36
31
    Move options to new OPTIONS section.
37
32
    State that this command is not meant to be invoked directly, but
49
44
    Create this section
50
45
*** SECURITY
51
46
    Create this section
52
 
*** NOTES
53
 
    Create this section (if needed)
54
47
*** BUGS
55
48
    Create this section
56
49
*** SEE ALSO
57
50
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
58
 
** Use asprintf instead of malloc and memcpy?
 
51
*** ENVIRONMENT
 
52
    Document use of "cryptsource" and "crypttarget".
59
53
** IPv4 support
60
54
** use strsep instead of strtok?
61
 
** Do not depend on GPG key rings on disk
62
 
   This would mean creating new GPG key rings with GPGME by importing
63
 
   the key files from scratch on every program start.
 
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.
64
58
 
65
59
* Password-prompt
66
60
** [#A] Man page: man8/password-prompt.8mandos
67
61
*** DESCRIPTION
68
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.
69
65
*** EXIT STATUS
70
66
    Create this section
71
67
*** EXAMPLES
76
72
    Create this section
77
73
    Not much to do here but it is noteworthy to state the danger of
78
74
    not having a fallback option.
79
 
*** NOTES
80
 
    Note that this is more or less a simple getpass(3) wrapper, even
81
 
    though actual use of getpass(3) is not guaranteed.
82
75
*** BUGS
83
76
    Create this section
84
77
*** SEE ALSO
88
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
89
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
90
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?]]
91
 
** Replace completely with "/lib/cryptsetup/askpass"?
92
84
 
93
85
* Mandos (server)
94
86
** [#A] Command man page: man8/mandos.8
95
 
*** DESCRIPTION
96
 
    Move options to new OPTIONS section
97
 
*** EXIT STATUS
98
 
    Create this section
99
 
*** EXAMPLES
100
 
    Create this section
101
 
*** FILES
102
 
    Describe briefly that the server gets global settings from
103
 
    mandos.conf and clients from clients.conf, but refer to their man
104
 
    pages for more details.
105
 
*** DIAGNOSTICS
106
 
    Create this section
107
 
*** SECURITY
108
 
    Create this section
109
 
*** NOTES
110
 
    Create this section (if needed)
111
 
*** BUGS
112
 
    Create this section
113
 
*** SEE ALSO
114
 
    Refer to the client man page
115
87
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
116
88
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
117
89
** [#A] /etc/init.d/mandos-server               :teddy:
147
119
 
148
120
** mandos-keygen
149
121
*** [#A] Command man page: man8/mandos-keygen.8
 
122
**** EXIT STATUS
 
123
**** FILES
 
124
**** BUGS
 
125
**** EXAMPLES
 
126
**** SECURITY
150
127
*** [#A] Output cut-and-paste ready snippet for clients.conf.
151
128
 
152
129
* [#A] Package
153
130
** /usr/share/initramfs-tools/hooks/mandos
154
 
*** Do not install in initrd.img if configured not to
 
131
*** Do not install in initrd.img if configured not to.
155
132
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
156
133
    question.
157
134
** /etc/bash_completion.d/mandos
158
 
*** From xml sources directly?
 
135
*** From XML sources directly?
159
136
** unperish
160
137
** bzr-builddeb
161
138