/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-16 03:29:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080816032908-ihw7c05r2mnyk389
Add feature to specify custom environment variables for plugins.

* plugin-runner.c (plugin): New members "environ" and "envc" to
                            contain possible custom environment.
  (getplugin): Return NULL on failure instead of doing exit(); all
               callers changed.
  (add_to_char_array): New helper function for "add_argument" and
                       "add_environment".
  (addargument): Renamed to "add_argument".  Return bool.  Call
                 "add_to_char_array" to actually do things.
  (add_environment): New; analogous to "add_argument".
  (addcustomargument): Renamed to "add_to_argv" to avoid confusion
                       with "add_argument".
  (main): New options "--global-envs" and "--envs-for" to specify
          custom environment for plugins.  Print environment for
          plugins in debug mode.  Use asprintf instead of strcpy and
          strcat.  Use execve() for plugins with custom environments.
          Free environment for plugin when freeing plugin list.

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