/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-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
3
3
* [#A] README file
4
4
 
5
5
* Plugin-runner
6
 
** [#A] Change syntax for arguments
7
6
** [#B] Add more comments to code
8
7
** [#B] Add more if(debug) calls
9
8
** [#B] Seperate more code to function for more readability
10
9
** [#A] Man page: man8/plugin-runner.8mandos
11
 
*** DESCRIPTION
12
 
    Describe the plus sign syntax for passing options from crypttab
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
 
** Support in configuration file for environment variables
 
22
    Explaining text on what you can read
30
23
** Keydir move: /etc/mandos -> /etc/keys/mandos
31
24
   Must create in preinst if not pre-depending on cryptsetup
32
25
 
51
44
    Create this section
52
45
*** SECURITY
53
46
    Create this section
54
 
*** NOTES
55
 
    Create this section (if needed)
56
47
*** BUGS
57
48
    Create this section
58
49
*** SEE ALSO
59
50
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
51
*** ENVIRONMENT
 
52
    Document use of "cryptsource" and "crypttarget".
60
53
** IPv4 support
61
54
** use strsep instead of strtok?
62
55
** Do not depend on GnuPG key rings on disk
65
58
 
66
59
* Password-prompt
67
60
** [#A] Man page: man8/password-prompt.8mandos
68
 
** Show getenv("cryptsource") and getenv("crypttarget") if set
69
 
   cryptsource will be the device, like "/dev/sda3", and crypttarget
70
 
   will be the device mapper name, like "sda3_crypt".
71
61
*** DESCRIPTION
72
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.
73
65
*** EXIT STATUS
74
66
    Create this section
75
67
*** EXAMPLES
80
72
    Create this section
81
73
    Not much to do here but it is noteworthy to state the danger of
82
74
    not having a fallback option.
83
 
*** NOTES
84
 
    Note that this is more or less a simple getpass(3) wrapper, even
85
 
    though actual use of getpass(3) is not guaranteed.
86
75
*** BUGS
87
76
    Create this section
88
77
*** SEE ALSO
92
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
93
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
94
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?]]
95
 
** Replace completely with "/lib/cryptsetup/askpass"?
96
84
 
97
85
* Mandos (server)
98
86
** [#A] Command man page: man8/mandos.8
99
 
*** DESCRIPTION
100
 
    Move options to new OPTIONS section
101
 
*** EXIT STATUS
102
 
    Create this section
103
 
*** EXAMPLES
104
 
    Create this section
105
 
*** FILES
106
 
    Describe briefly that the server gets global settings from
107
 
    mandos.conf and clients from clients.conf, but refer to their man
108
 
    pages for more details.
109
 
*** DIAGNOSTICS
110
 
    Create this section
111
 
*** SECURITY
112
 
    Create this section
113
 
*** NOTES
114
 
    Create this section (if needed)
115
 
*** BUGS
116
 
    Create this section
117
 
*** SEE ALSO
118
 
    Refer to the client man page
119
87
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
120
88
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
121
89
** [#A] /etc/init.d/mandos-server               :teddy:
151
119
 
152
120
** mandos-keygen
153
121
*** [#A] Command man page: man8/mandos-keygen.8
 
122
**** EXIT STATUS
 
123
**** FILES
 
124
**** BUGS
 
125
**** EXAMPLES
 
126
**** SECURITY
154
127
*** [#A] Output cut-and-paste ready snippet for clients.conf.
155
128
 
156
129
* [#A] Package
157
130
** /usr/share/initramfs-tools/hooks/mandos
158
 
*** Do not install in initrd.img if configured not to
 
131
*** Do not install in initrd.img if configured not to.
159
132
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
160
133
    question.
161
134
** /etc/bash_completion.d/mandos
162
 
*** From xml sources directly?
 
135
*** From XML sources directly?
163
136
** unperish
164
137
** bzr-builddeb
165
138