/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 06:17:10 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817061710-epkw87paysoo9g7w
* mandos-keygen.xml (NOTES): Removed section, since it is
                             automatically created for footnotes.

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
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
11
    Text needed
 
12
*** EXAMPLES
14
13
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
 
14
    plugins, examples of crypttab lines with plus syntax, etc.
16
15
*** FILES
 
16
    Text needed
17
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).
 
18
    Text needed
22
19
*** BUGS
 
20
    Text needed
23
21
*** SEE ALSO
24
22
    Explaining text on what you can read
 
23
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
24
   Must create in preinst if not pre-depending on cryptsetup
25
25
 
26
 
* password-request
 
26
* Password-request
27
27
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
 
28
** [#B] Temporarily lower kernel log level
 
29
   for less printouts during sucessfull boot.
30
30
*** DESCRIPTION
 
31
    Move options to new OPTIONS section.
31
32
    State that this command is not meant to be invoked directly, but
32
33
    is run as a plugin from mandos-client(8) and only run in the
33
34
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
35
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
 
36
    Create this section
 
37
*** EXAMPLES
 
38
    Examples of normal usage, debug usage, debugging by connecting
 
39
    directly, etc.
41
40
*** FILES
42
41
    Describe the key files and the key ring files.  Also note that
43
42
    they should normally have been automatically created.
 
43
*** DIAGNOSTICS
 
44
    Create this section
 
45
*** SECURITY
 
46
    Create this section
44
47
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
 
48
    Create this section
49
49
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
 
50
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
51
*** ENVIRONMENT
 
52
    Document use of "cryptsource" and "crypttarget".
53
53
** IPv4 support
54
54
** use strsep instead of strtok?
55
55
** Do not depend on GnuPG key rings on disk
56
56
   This would mean creating new GnuPG key rings with GPGME by
57
57
   importing the key files from scratch on every program start.
58
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
59
 
   Must create in preinst if not pre-depending on cryptsetup
60
58
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
 
59
* Password-prompt
 
60
** [#A] Man page: man8/password-prompt.8mandos
 
61
*** DESCRIPTION
 
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.
 
65
*** EXIT STATUS
 
66
    Create this section
 
67
*** EXAMPLES
 
68
    Examples of normal usage, debug usage, with a prefix, etc.
 
69
*** DIAGNOSTICS
 
70
    Create this section
 
71
*** SECURITY
 
72
    Create this section
 
73
    Not much to do here but it is noteworthy to state the danger of
 
74
    not having a fallback option.
 
75
*** BUGS
 
76
    Create this section
 
77
*** SEE ALSO
 
78
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
79
** Use getpass(3)?
63
80
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
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?]]
67
84
 
68
 
* mandos (server)
 
85
* Mandos (server)
 
86
** [#A] Command man page: man8/mandos.8
 
87
*** EXAMPLES
 
88
    Create this section
 
89
*** FILES
 
90
    Describe briefly that the server gets global settings from
 
91
    mandos.conf and clients from clients.conf, but refer to their man
 
92
    pages for more details.
 
93
*** DIAGNOSTICS
 
94
    Create this section
 
95
*** SECURITY
 
96
    Create this section
 
97
*** BUGS
 
98
    Create this section
 
99
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
100
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
69
101
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
 
102
** Log level
71
103
** /etc/mandos/clients.d/*.conf
72
104
   Watch this directory and add/remove/update clients?
73
105
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
 
106
** Run-time communication with server
75
107
   Probably using D-Bus
76
108
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
 
109
** Implement --foreground
78
110
   [[info:standards:Option%20Table][Table of Long Options]]
79
111
** Implement --socket
80
112
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
 
113
** Date+time on console log messages
82
114
   Is this the default?
83
115
 
84
116
* Mandos-tools/utilities
87
119
** Disable client
88
120
** Enable client
89
121
 
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
113
 
** Use xinclude for common sections
114
 
   Like copyright, authors, etc.
115
 
 
116
 
 
117
122
* Installer
118
 
** Client-side
 
123
** Client
 
124
*** DONE [#A] Change initrd.img file to not be publically readable
 
125
    /usr/share/initramfs-tools/conf-hooks.d/mandos
 
126
    UMASK=027
119
127
*** Update initrd.img after installation
120
 
    This seems to use some kind of "trigger" system
121
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
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
125
 
*** mandos-keygen
126
 
**** "--passfile" option
127
 
     Using the "secfile" option instead of "secret"
128
 
**** [#A] "--test" option
129
 
     For testing decryption before rebooting.
130
 
** Server-side
 
128
** Server
131
129
*** [#A] Create mandos user and group for server
132
130
*** [#A] Create /var/run/mandos directory with perm and ownership
133
131
 
 
132
** mandos-keygen
 
133
*** [#A] Command man page: man8/mandos-keygen.8
 
134
**** EXIT STATUS
 
135
**** FILES
 
136
**** BUGS
 
137
**** EXAMPLES
 
138
**** SECURITY
 
139
*** [#A] Output cut-and-paste ready snippet for clients.conf.
 
140
 
134
141
* [#A] Package
135
142
** /usr/share/initramfs-tools/hooks/mandos
136
143
*** Do not install in initrd.img if configured not to.
137
144
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
138
145
    question.
139
146
** /etc/bash_completion.d/mandos
140
 
   From XML sources directly?
 
147
*** From XML sources directly?
141
148
** unperish
142
149
** bzr-builddeb
143
150