/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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
 
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
12
10
*** EXIT STATUS
13
 
    Text needed
14
11
*** EXAMPLES
15
12
    Examples of normal usage, debug usage, debugging single or all
16
 
    plugins, examples of crypttab lines with plus syntax, etc.
 
13
    plugins, etc.
17
14
*** FILES
18
 
    Text needed
19
15
*** SECURITY
20
 
    Text needed
21
 
*** NOTES
22
 
    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).
23
20
*** BUGS
24
 
    Text needed
25
21
*** 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.
 
22
    Explaining text on what you can read
34
23
 
35
 
* Password-request
 
24
* password-request
36
25
** [#A] Man page: man8/password-request.8mandos
 
26
*** SYNOPSIS
 
27
    Document short options
37
28
*** DESCRIPTION
38
 
    Move options to new OPTIONS section.
39
29
    State that this command is not meant to be invoked directly, but
40
30
    is run as a plugin from mandos-client(8) and only run in the
41
31
    initrd environment, not the real system.
 
32
*** PURPOSE
 
33
    As in mandos.xml
 
34
*** OVERVIEW
 
35
    As in mandos.xml
42
36
*** EXIT STATUS
43
 
    Create this section
44
 
*** 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
45
44
    Examples of normal usage, debug usage, debugging by connecting
46
45
    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
46
*** SECURITY
53
 
    Create this section
54
 
*** NOTES
55
 
    Create this section (if needed)
56
 
*** BUGS
57
 
    Create this section
58
47
*** SEE ALSO
59
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
60
 
** Use asprintf instead of malloc and memcpy?
 
48
    Update from mandos.xml
 
49
** [#B] Temporarily lower kernel log level
 
50
   for less printouts during sucessfull boot.
61
51
** IPv4 support
62
52
** 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.
 
53
** Do not depend on GnuPG key rings on disk
 
54
   This would mean creating new GnuPG key rings with GPGME by
 
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
66
58
 
67
 
* Password-prompt
 
59
* password-prompt
68
60
** [#A] Man page: man8/password-prompt.8mandos
 
61
*** SYNOPSIS
 
62
    Document short options
69
63
*** DESCRIPTION
70
 
    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.
71
66
*** EXIT STATUS
72
 
    Create this section
73
 
*** EXAMPLES
 
67
*** ENVIRONMENT
 
68
    Document use of "cryptsource" and "crypttarget".
 
69
*** FILES
 
70
*** BUGS
 
71
*** EXAMPLE
74
72
    Examples of normal usage, debug usage, with a prefix, etc.
75
 
*** DIAGNOSTICS
76
 
    Create this section
77
73
*** SECURITY
78
 
    Create this section
79
74
    Not much to do here but it is noteworthy to state the danger of
80
75
    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
76
*** SEE ALSO
87
77
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
78
    and also, perhaps, to cryptsetup(8)?
88
79
** Use getpass(3)?
89
80
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
90
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
91
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
92
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?]]
93
84
 
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
 
85
* mandos (server)
116
86
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
117
87
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
118
88
** [#A] /etc/init.d/mandos-server               :teddy:
119
 
** Log level
 
89
** [#B] Log level                               :bugs:
120
90
** /etc/mandos/clients.d/*.conf
121
91
   Watch this directory and add/remove/update clients?
122
92
** config for TXT record
123
 
** Run-time communication with server
 
93
** [#B] Run-time communication with server      :bugs:
124
94
   Probably using D-Bus
125
95
   See also [[*Mandos-tools]]
126
 
** Implement --foreground
 
96
** Implement --foreground                       :bugs:
127
97
   [[info:standards:Option%20Table][Table of Long Options]]
128
98
** Implement --socket
129
99
   [[info:standards:Option%20Table][Table of Long Options]]
 
100
** Date+time on console log messages            :bugs:
 
101
   Is this the default?
130
102
 
131
103
* Mandos-tools/utilities
132
104
  All of this probably using D-Bus
135
107
** Enable client
136
108
 
137
109
* 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
 
110
** Client-side
 
111
*** Update initrd.img after installation
 
112
    This seems to use some kind of "trigger" system
 
113
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
114
    Must create in preinst if not pre-depending on cryptsetup
 
115
*** mandos-keygen
 
116
**** [#A] Output cut-and-paste ready snippet for clients.conf.
 
117
** Server-side
 
118
*** [#A] Create mandos user and group for server
 
119
*** [#A] Create /var/run/mandos directory with perm and ownership
144
120
 
145
121
* [#A] Package
 
122
** /usr/share/initramfs-tools/hooks/mandos
 
123
*** Do not install in initrd.img if configured not to.
 
124
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
125
    question.
146
126
** /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
 
127
   From XML sources directly?
150
128
** unperish
151
129
** bzr-builddeb
152
130