/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-29 06:38:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829063827-hbjl6t92tyjl5305
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New.  Automatically
                                              updated by Emacs
                                              time-stamp by using
                                              Emacs local variables.
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

Show diffs side-by-side

added added

removed removed

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