/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-18 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
2
2
 
3
3
* [#A] README file
4
4
 
5
 
* Plugin-runner
 
5
* plugin-runner
6
6
** [#B] Add more comments to code
7
7
** [#B] Add more if(debug) calls
8
8
** [#B] Seperate more code to function for more readability
9
9
** [#A] Man page: man8/plugin-runner.8mandos
10
10
*** EXIT STATUS
11
 
    Text needed
12
11
*** EXAMPLES
13
12
    Examples of normal usage, debug usage, debugging single or all
14
13
    plugins, etc.
15
14
*** FILES
16
 
    Text needed
17
15
*** SECURITY
18
 
    Text needed
19
16
*** BUGS
20
 
    Text needed
21
17
*** SEE ALSO
22
18
    Explaining text on what you can read
23
19
** Keydir move: /etc/mandos -> /etc/keys/mandos
24
20
   Must create in preinst if not pre-depending on cryptsetup
25
21
 
26
 
* Password-request
 
22
* password-request
27
23
** [#A] Man page: man8/password-request.8mandos
28
 
** [#B] Temporarily lower kernel log level
29
 
   for less printouts during sucessfull boot.
 
24
*** SYNOPSIS
 
25
    Document short options
30
26
*** DESCRIPTION
31
 
    Move options to new OPTIONS section.
32
27
    State that this command is not meant to be invoked directly, but
33
28
    is run as a plugin from mandos-client(8) and only run in the
34
29
    initrd environment, not the real system.
 
30
*** PURPOSE
 
31
    As in mandos.xml
 
32
*** OVERVIEW
 
33
    As in mandos.xml
35
34
*** EXIT STATUS
36
 
    Create this section
37
 
*** EXAMPLES
 
35
*** ENVIRONMENT
 
36
    Note that it does *not* currently use cryptsource or crypttarget.
 
37
*** FILES
 
38
    Describe the key files and the key ring files.  Also note that
 
39
    they should normally have been automatically created.
 
40
*** BUGS
 
41
*** EXAMPLE
38
42
    Examples of normal usage, debug usage, debugging by connecting
39
43
    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
44
*** SECURITY
46
 
    Create this section
47
 
*** BUGS
48
 
    Create this section
49
45
*** SEE ALSO
50
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
51
 
*** ENVIRONMENT
52
 
    Document use of "cryptsource" and "crypttarget".
 
46
    Update from mandos.xml
 
47
** [#B] Temporarily lower kernel log level
 
48
   for less printouts during sucessfull boot.
53
49
** IPv4 support
54
50
** use strsep instead of strtok?
55
51
** Do not depend on GnuPG key rings on disk
56
52
   This would mean creating new GnuPG key rings with GPGME by
57
53
   importing the key files from scratch on every program start.
58
54
 
59
 
* Password-prompt
 
55
* password-prompt
60
56
** [#A] Man page: man8/password-prompt.8mandos
 
57
*** SYNOPSIS
 
58
    Document short options
61
59
*** DESCRIPTION
62
 
    Move options to new OPTIONS section.
63
60
    Note that this is more or less a simple getpass(3) wrapper, even
64
61
    though actual use of getpass(3) is not guaranteed.
65
62
*** EXIT STATUS
66
 
    Create this section
67
 
*** EXAMPLES
 
63
*** ENVIRONMENT
 
64
    Document use of "cryptsource" and "crypttarget".
 
65
*** FILES
 
66
*** BUGS
 
67
*** EXAMPLE
68
68
    Examples of normal usage, debug usage, with a prefix, etc.
69
 
*** DIAGNOSTICS
70
 
    Create this section
71
69
*** SECURITY
72
 
    Create this section
73
70
    Not much to do here but it is noteworthy to state the danger of
74
71
    not having a fallback option.
75
 
*** BUGS
76
 
    Create this section
77
72
*** SEE ALSO
78
73
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
74
    and also, perhaps, to cryptsetup(8)?
79
75
** Use getpass(3)?
80
76
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
81
77
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
82
78
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
83
79
   [[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
80
 
85
 
* Mandos (server)
 
81
* mandos (server)
86
82
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
87
83
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
88
84
** [#A] /etc/init.d/mandos-server               :teddy:
115
111
*** [#A] Create /var/run/mandos directory with perm and ownership
116
112
 
117
113
** mandos-keygen
118
 
*** [#A] Command man page: man8/mandos-keygen.8
119
 
**** EXIT STATUS
120
 
**** FILES
121
 
**** BUGS
122
 
**** EXAMPLES
123
 
**** SECURITY
124
114
*** [#A] Output cut-and-paste ready snippet for clients.conf.
125
115
 
126
116
* [#A] Package