/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-02 13:04:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902130442-ytnjsmllaph18e20
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
  (BUGS): Commented out.  There are no bugs.
  (EXAMPLE): Added lots of examples.
  (SECURITY): Added text.
  (SEE ALSO): Added "crypttab(5)" and "execve(2)".

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