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