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