/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-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
 
3
* [#A] README file
 
4
 
3
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
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
 
14
    Examples of normal usage, debug usage, debugging single or all
 
15
    plugins, etc.
 
16
*** FILES
 
17
*** SECURITY
 
18
    Note the danger of using this program, since you might lock
 
19
    yourself out of your system without any means of entering the root
 
20
    file system password.  This is, however, very unlikely considering
 
21
    the fallback to getpass(3).
 
22
*** BUGS
 
23
*** SEE ALSO
 
24
    Explaining text on what you can read
4
25
 
5
26
* password-request
 
27
** [#A] Man page: man8/password-request.8mandos
 
28
*** SYNOPSIS
 
29
    Document short options
 
30
*** DESCRIPTION
 
31
    State that this command is not meant to be invoked directly, but
 
32
    is run as a plugin from mandos-client(8) and only run in the
 
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
 
38
*** EXIT STATUS
 
39
*** ENVIRONMENT
 
40
    Note that it does *not* currently use cryptsource or crypttarget.
 
41
*** FILES
 
42
    Describe the key files and the key ring files.  Also note that
 
43
    they should normally have been automatically created.
 
44
*** BUGS
 
45
*** EXAMPLE
 
46
    Examples of normal usage, debug usage, debugging by connecting
 
47
    directly, etc.
 
48
*** SECURITY
 
49
*** SEE ALSO
 
50
    Update from mandos.xml
6
51
** [#B] Temporarily lower kernel log level
7
52
   for less printouts during sucessfull boot.
8
53
** IPv4 support
14
59
   Must create in preinst if not pre-depending on cryptsetup
15
60
 
16
61
* password-prompt
 
62
** [#C] Use getpass(3)?
 
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
66
   [[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?]]
17
67
 
18
68
* mandos (server)
19
69
** [#A] /etc/init.d/mandos-server               :teddy:
30
80
   [[info:standards:Option%20Table][Table of Long Options]]
31
81
** Date+time on console log messages            :bugs:
32
82
   Is this the default?
33
 
** delete hook when clients fall out by timeout
34
83
 
35
84
* Mandos-tools/utilities
36
85
  All of this probably using D-Bus
37
86
** List clients
38
87
** Disable client
39
88
** Enable client
40
 
** Reboot timer
41
89
 
42
90
* Man pages
 
91
** Tags
 
92
   Go through all man pages to conform to the style of tags chosen in
 
93
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
 
94
*** SYNOPSIS
 
95
    <arg> with inner <option> and <replaceable> tags
 
96
    Unify long and short options.
 
97
**** DONE mandos-clients.conf.xml
 
98
**** DONE mandos-keygen.xml
 
99
**** DONE mandos.conf.xml
 
100
**** DONE mandos.xml
 
101
**** DONE plugin-runner.xml
 
102
**** DONE plugins.d/password-prompt.xml
 
103
**** DONE plugins.d/password-request.xml
 
104
*** OPTIONS
 
105
    Separate <term> tags with <option> and <replaceable> tags.
 
106
**** DONE mandos-clients.conf.xml
 
107
**** DONE mandos-keygen.xml
 
108
**** DONE mandos.conf.xml
 
109
**** TODO mandos.xml
 
110
**** TODO plugin-runner.xml
 
111
**** TODO plugins.d/password-prompt.xml
 
112
**** TODO plugins.d/password-request.xml
43
113
** Use xinclude for common sections
44
 
   Like authors, etc.
 
114
   Like copyright, authors, etc.
45
115
 
46
116
 
47
117
* Installer
50
120
    This seems to use some kind of "trigger" system
51
121
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
52
122
    dpkg-trigger(1), deb-triggers(5)
 
123
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
124
    Must create in preinst if not pre-depending on cryptsetup
53
125
*** mandos-keygen
54
126
**** "--passfile" option
55
127
     Using the "secfile" option instead of "secret"
58
130
** Server-side
59
131
*** [#A] Create mandos user and group for server
60
132
*** [#A] Create /var/run/mandos directory with perm and ownership
61
 
*** [#A] install rc.d script and do update-rc.d
62
 
    between config files and man pages
63
 
 
64
133
 
65
134
* [#A] Package
66
135
** /usr/share/initramfs-tools/hooks/mandos