/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-09-01 16:19:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901161932-ostp7tulh9aijulh
* plugin-runner.c (add_environment): Never insert existing environment
                                     variables.
  (main): Rename "--global-envs" to "--global-env" and "--envs-for" to
          "--env-for".

* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
                                "--global-env" and "--envs-for" to
                                "--env-for".
  (OPTIONS): Added "--global-env" and "--env-for".
  (FALLBACK): Add id attribute.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): New section.
  (FILES): Document configuration file.

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