/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:
3
3
* [#A] README file
4
4
 
5
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
*** EXAMPLES
 
12
    Examples of normal usage, debug usage, debugging single or all
 
13
    plugins, etc.
 
14
*** FILES
 
15
*** SECURITY
 
16
*** BUGS
 
17
*** SEE ALSO
 
18
    Explaining text on what you can read
 
19
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
20
   Must create in preinst if not pre-depending on cryptsetup
6
21
 
7
22
* password-request
 
23
** [#A] Man page: man8/password-request.8mandos
 
24
*** SYNOPSIS
 
25
    Document short options
 
26
*** DESCRIPTION
 
27
    State that this command is not meant to be invoked directly, but
 
28
    is run as a plugin from mandos-client(8) and only run in the
 
29
    initrd environment, not the real system.
 
30
*** PURPOSE
 
31
    As in mandos.xml
 
32
*** OVERVIEW
 
33
    As in mandos.xml
 
34
*** EXIT STATUS
 
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
 
42
    Examples of normal usage, debug usage, debugging by connecting
 
43
    directly, etc.
 
44
*** SECURITY
 
45
*** SEE ALSO
 
46
    Update from mandos.xml
8
47
** [#B] Temporarily lower kernel log level
9
48
   for less printouts during sucessfull boot.
10
49
** IPv4 support
12
51
** Do not depend on GnuPG key rings on disk
13
52
   This would mean creating new GnuPG key rings with GPGME by
14
53
   importing the key files from scratch on every program start.
15
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
16
 
   Must create in preinst if not pre-depending on cryptsetup
17
54
 
18
55
* password-prompt
 
56
** [#A] Man page: man8/password-prompt.8mandos
 
57
*** SYNOPSIS
 
58
    Document short options
 
59
*** DESCRIPTION
 
60
    Note that this is more or less a simple getpass(3) wrapper, even
 
61
    though actual use of getpass(3) is not guaranteed.
 
62
*** EXIT STATUS
 
63
*** ENVIRONMENT
 
64
    Document use of "cryptsource" and "crypttarget".
 
65
*** FILES
 
66
*** BUGS
 
67
*** EXAMPLE
 
68
    Examples of normal usage, debug usage, with a prefix, etc.
 
69
*** SECURITY
 
70
    Not much to do here but it is noteworthy to state the danger of
 
71
    not having a fallback option.
 
72
*** SEE ALSO
 
73
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
74
    and also, perhaps, to cryptsetup(8)?
 
75
** Use getpass(3)?
 
76
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
77
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
78
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
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?]]
19
80
 
20
81
* mandos (server)
 
82
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
83
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
21
84
** [#A] /etc/init.d/mandos-server               :teddy:
22
85
** [#B] Log level                               :bugs:
23
86
** /etc/mandos/clients.d/*.conf
38
101
** List clients
39
102
** Disable client
40
103
** Enable client
41
 
** Reboot timer
42
 
 
43
 
* Man pages
44
 
** Use xinclude for common sections
45
 
   Like authors, etc.
46
 
 
47
104
 
48
105
* Installer
49
 
** Client-side
 
106
** Client
50
107
*** Update initrd.img after installation
51
108
    This seems to use some kind of "trigger" system
52
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
53
 
    dpkg-trigger(1), deb-triggers(5)
54
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
55
 
    Must create in preinst if not pre-depending on cryptsetup
56
 
*** mandos-keygen
57
 
**** "--passfile" option
58
 
     Using the "secfile" option instead of "secret"
59
 
**** [#A] "--test" option
60
 
     For testing decryption before rebooting.
61
 
** Server-side
 
109
** Server
62
110
*** [#A] Create mandos user and group for server
63
111
*** [#A] Create /var/run/mandos directory with perm and ownership
64
112
 
 
113
** mandos-keygen
 
114
*** [#A] Output cut-and-paste ready snippet for clients.conf.
 
115
 
65
116
* [#A] Package
66
117
** /usr/share/initramfs-tools/hooks/mandos
67
118
*** Do not install in initrd.img if configured not to.
68
119
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
69
120
    question.
70
121
** /etc/bash_completion.d/mandos
71
 
   From XML sources directly?
 
122
*** From XML sources directly?
72
123
** unperish
73
124
** bzr-builddeb
74
125