/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-19 13:50:22 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080919135022-214t21hetv8jgv0y
* debian/mandos-client.docs: New.  Add README and TODO file.
* debian/mandos.docs: - '' -

* debian/mandos-client.links: New.  Create plugin-runner.conf(5) link.

* debian/rules (DH_VERBOSE): Commented out.
               Removed commented-out unused dh_* stuff.  Removed
               "dh_makeshlibs".

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
3
* 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
10
 
*** EXIT STATUS
11
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
14
 
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
16
 
*** FILES
17
 
*** 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
 
*** BUGS
23
 
*** SEE ALSO
24
 
    Explaining text on what you can read
 
4
** TODO Man page  for plugin-runner.conf.5
 
5
   link to plugin-runner.8
25
6
 
26
 
* password-request
27
 
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
30
 
*** DESCRIPTION
31
 
    State that this command is not meant to be invoked directly, but
32
 
    is run as a plugin from mandos-client(8) and only run in the
33
 
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
 
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
41
 
*** FILES
42
 
    Describe the key files and the key ring files.  Also note that
43
 
    they should normally have been automatically created.
44
 
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
49
 
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
 
7
* mandos-client
 
8
** TODO [#B] Temporarily lower kernel log level
52
9
   for less printouts during sucessfull boot.
53
 
** IPv4 support
54
 
** 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
 
10
** TODO [#C] IPv4 support
60
11
 
61
 
* password-prompt
62
 
** [#A] Man page: man8/password-prompt.8mandos
63
 
*** SYNOPSIS
64
 
    Document short options
65
 
*** DESCRIPTION
66
 
    Note that this is more or less a simple getpass(3) wrapper, even
67
 
    though actual use of getpass(3) is not guaranteed.
68
 
*** EXIT STATUS
69
 
*** ENVIRONMENT
70
 
    Document use of "cryptsource" and "crypttarget".
71
 
*** FILES
72
 
*** BUGS
73
 
*** EXAMPLE
74
 
    Examples of normal usage, debug usage, with a prefix, etc.
75
 
*** SECURITY
76
 
    Not much to do here but it is noteworthy to state the danger of
77
 
    not having a fallback option.
78
 
*** SEE ALSO
79
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
80
 
    and also, perhaps, to cryptsetup(8)?
81
 
** Use getpass(3)?
82
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
83
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
84
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
85
 
   [[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?]]
 
12
* DONE password-prompt
86
13
 
87
14
* mandos (server)
88
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
89
 
*** For option "secret", document which program can help generate it.
90
 
** [#A] /etc/init.d/mandos-server               :teddy:
91
 
** [#B] Log level                               :bugs:
92
 
** /etc/mandos/clients.d/*.conf
 
15
** TODO [#B] Log level                          :bugs:
 
16
** TODO /etc/mandos/clients.d/*.conf
93
17
   Watch this directory and add/remove/update clients?
94
 
** config for TXT record
95
 
** [#B] Run-time communication with server      :bugs:
 
18
** TODO config for TXT record
 
19
** TODO [#B] Run-time communication with server :bugs:
96
20
   Probably using D-Bus
97
21
   See also [[*Mandos-tools]]
98
 
** Implement --foreground                       :bugs:
99
 
   [[info:standards:Option%20Table][Table of Long Options]]
100
 
** Implement --socket
101
 
   [[info:standards:Option%20Table][Table of Long Options]]
102
 
** Date+time on console log messages            :bugs:
 
22
** TODO Implement --foreground                  :bugs:
 
23
   [[info:standards:Option%20Table][Table of Long Options]]
 
24
** TODO Implement --socket
 
25
   [[info:standards:Option%20Table][Table of Long Options]]
 
26
** TODO Date+time on console log messages       :bugs:
103
27
   Is this the default?
 
28
** TODO delete hook when clients fall out by timeout
104
29
 
105
30
* Mandos-tools/utilities
106
31
  All of this probably using D-Bus
107
 
** List clients
108
 
** Disable client
109
 
** Enable client
 
32
** TODO List clients
 
33
** TODO Disable client
 
34
** TODO Enable client
 
35
** TODO Reset timer
 
36
 
 
37
* Man pages
 
38
** TODO Use xinclude for all common sections
 
39
   Like authors, etc.
 
40
 
110
41
 
111
42
* Installer
112
43
** Client-side
113
 
*** Update initrd.img after installation
 
44
*** TODO Update initrd.img after installation
114
45
    This seems to use some kind of "trigger" system
115
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
116
 
    Must create in preinst if not pre-depending on cryptsetup
 
46
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
47
    dpkg-trigger(1), deb-triggers(5)
117
48
*** mandos-keygen
118
 
**** [#A] "--test" option
 
49
**** TODO [#A] Ask for password twice for confirmation
 
50
**** TODO "--passfile" option
 
51
     Using the "secfile" option instead of "secret"
 
52
**** TODO [#B] "--test" option
119
53
     For testing decryption before rebooting.
120
54
** Server-side
121
 
*** [#A] Create mandos user and group for server
122
 
*** [#A] Create /var/run/mandos directory with perm and ownership
 
55
*** TODO [#A] Create mandos user and group for server
 
56
 
123
57
 
124
58
* [#A] Package
125
59
** /usr/share/initramfs-tools/hooks/mandos
126
 
*** Do not install in initrd.img if configured not to.
 
60
*** TODO Do not install in initrd.img if configured not to.
127
61
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
128
62
    question.
129
 
** /etc/bash_completion.d/mandos
 
63
** TODO /etc/bash_completion.d/mandos
130
64
   From XML sources directly?
131
 
** unperish
132
 
** bzr-builddeb
133
 
 
134
 
* INSTALL file
135
 
 
136
 
* Web site
 
65
** TODO unperish
 
66
** DONE bzr-builddeb
 
67
** DONE mandos user/group creation              :test:
 
68
** DONE Key creation in postinst                :test:
 
69
 
 
70
* TODO Web site
 
71
** DONE http://www.fukt.bsnet.se/mandos
 
72
   Redirects to the wiki page
 
73
** TODO http://wiki.fukt.bsnet.se/wiki/Mandos
137
74
 
138
75
* Mailing list
 
76
** DONE mandos-dev
 
77
*** TODO http://gmane.org/subscribe.php
139
78
 
140
 
* Announce project on news
 
79
* TODO Announce project on Usenet
141
80
  [[news:comp.os.linux.announce]]
142
81
 
143
82