/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-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

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