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