/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-17 06:01:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817060158-o5xakkih6t3br9yq
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
            GPGME_CFLAGS, GPGME_LIBS): New; use libgnutls-config,
                                       pkg-config, and gpgme-config to
                                       get the correct compiler and
                                       linker flags.
  (MANPOST): New post-processing stage to man pages to fix a bug with
             having "\n" in the DocBook pages.
  (objects): Use $(addsuffix) instead of a for loop in a subshell.
  (plugin-runner, plugins.d/password-prompt): Removed; targets no
                                              longer necessary.
  (.PHONY): Added "doc".

* mandos.xml: Much improved.

* plugins.d/password-request.xml: Improved SEE ALSO section.

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