/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-09-04 13:36:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904133659-0omre4j6luosb20q
* mandos-clients.conf.xml (OPTIONS): Improved spelling.

* mandos.conf.xml (BUGS): - '' -

* mandos.xml (BUGS): - '' -

* plugin-runner.xml (NAME): Fix spelling by changing wording.
  (OPTIONS): Improved spelling.
  (EXAMPLE): Do not use obsolete "--keydir" option.  Improved wording.

* plugins.d/password-prompt.xml (DESCRIPTION): Improved spelling.
  (EXAMPLE): Add <acronym> tag.
  (SECURITY): Improved spelling.

* plugins.d/password-request.xml (SYNOPSIS): Changed replaceable to
                                             match OPTIONS section.
  (DESCRIPTION, OVERVIEW): Improved spelling.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
3
* 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
21
4
 
22
5
* 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
47
6
** [#B] Temporarily lower kernel log level
48
7
   for less printouts during sucessfull boot.
49
8
** IPv4 support
51
10
** Do not depend on GnuPG key rings on disk
52
11
   This would mean creating new GnuPG key rings with GPGME by
53
12
   importing the key files from scratch on every program start.
 
13
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
14
   Must create in preinst if not pre-depending on cryptsetup
54
15
 
55
16
* 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?]]
80
17
 
81
18
* 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)
84
19
** [#A] /etc/init.d/mandos-server               :teddy:
85
20
** [#B] Log level                               :bugs:
86
21
** /etc/mandos/clients.d/*.conf
95
30
   [[info:standards:Option%20Table][Table of Long Options]]
96
31
** Date+time on console log messages            :bugs:
97
32
   Is this the default?
 
33
** delete hook when clients fall out by timeout
98
34
 
99
35
* Mandos-tools/utilities
100
36
  All of this probably using D-Bus
101
37
** List clients
102
38
** Disable client
103
39
** Enable client
 
40
** Reboot timer
 
41
 
 
42
* Man pages
 
43
** Use xinclude for common sections
 
44
   Like authors, etc.
 
45
 
104
46
 
105
47
* Installer
106
 
** Client
 
48
** Client-side
107
49
*** Update initrd.img after installation
108
50
    This seems to use some kind of "trigger" system
109
 
** Server
 
51
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
52
    dpkg-trigger(1), deb-triggers(5)
 
53
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
54
    Must create in preinst if not pre-depending on cryptsetup
 
55
*** mandos-keygen
 
56
**** "--passfile" option
 
57
     Using the "secfile" option instead of "secret"
 
58
**** [#A] "--test" option
 
59
     For testing decryption before rebooting.
 
60
** Server-side
110
61
*** [#A] Create mandos user and group for server
111
62
*** [#A] Create /var/run/mandos directory with perm and ownership
112
63
 
113
 
** mandos-keygen
114
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
115
 
 
116
64
* [#A] Package
117
65
** /usr/share/initramfs-tools/hooks/mandos
118
66
*** Do not install in initrd.img if configured not to.
119
67
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
120
68
    question.
121
69
** /etc/bash_completion.d/mandos
122
 
*** From XML sources directly?
 
70
   From XML sources directly?
123
71
** unperish
124
72
** bzr-builddeb
125
73