/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

updated mandos-client sections and added see also stuff

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