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