/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-30 07:23:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930072339-jn15gyrtfpdk2dhx
* .bzrignore: Added "man" directory (created by "make install-html").

* Makefile: Add "common.ent" dependency to all manual pages.
  (htmldir, version, SED): New variables.
  (CFLAGS): Add -D option to define VERSION to $(version).
  (MANPOST, HTMLPOST): Use $(SED).
  (PROGS): Use $(CPROGS)
  (CPROGS): New; C-only programs.
  (objects): Use $(CPROGS).
  (common.ent, mandos, mandos-keygen): New targets; update version
                                       number to $(version).
  (clean): Use $(CPROGS).
  (check): Depend on "all".
  (install-html): Install to $(htmldir).

* common.ent: New file with "version" entity.

* mandos-clients.conf.xml: Use "common.ent".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.xml: - '' -

* plugin-runner.c (argp_program_version): Use VERSION.
* plugins.d/mandos-client.c (argp_program_version): - '' -
* plugins.d/password-prompt.c (argp_program_version): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
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
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
25
 
 
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
 
3
* DONE plugin-runner
 
4
 
 
5
* mandos-client
 
6
** TODO [#B] Temporarily lower kernel log level
52
7
   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
 
8
** TODO [#C] IPv4 support
60
9
 
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?]]
 
10
* DONE password-prompt
86
11
 
87
12
* mandos (server)
88
 
** [#A] /etc/init.d/mandos-server               :teddy:
89
 
** [#B] Log level                               :bugs:
90
 
** /etc/mandos/clients.d/*.conf
 
13
** TODO [#B] Log level                          :bugs:
 
14
** TODO /etc/mandos/clients.d/*.conf
91
15
   Watch this directory and add/remove/update clients?
92
 
** config for TXT record
93
 
** [#B] Run-time communication with server      :bugs:
 
16
** TODO config for TXT record
 
17
** TODO [#B] Run-time communication with server :bugs:
94
18
   Probably using D-Bus
95
19
   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:
 
20
** TODO Implement --foreground                  :bugs:
 
21
   [[info:standards:Option%20Table][Table of Long Options]]
 
22
** TODO Implement --socket
 
23
   [[info:standards:Option%20Table][Table of Long Options]]
 
24
** TODO Date+time on console log messages       :bugs:
101
25
   Is this the default?
 
26
** TODO delete hook when clients fall out by timeout
102
27
 
103
28
* Mandos-tools/utilities
104
29
  All of this probably using D-Bus
105
 
** List clients
106
 
** Disable client
107
 
** Enable client
108
 
 
109
 
* Man pages tags
110
 
  Go through all man pages to conform to the style of tags chosen in 
111
 
  [[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]].
 
30
** TODO List clients
 
31
** TODO Disable client
 
32
** TODO Enable client
 
33
** TODO Reset timer
 
34
 
 
35
* Man pages
 
36
** TODO Use xinclude for all common sections
 
37
   Like authors, etc.
 
38
 
112
39
 
113
40
* Installer
114
41
** Client-side
115
 
*** Update initrd.img after installation
116
 
    This seems to use some kind of "trigger" system
117
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
118
 
    dpkg-trigger(1), deb-triggers(5)
119
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
120
 
    Must create in preinst if not pre-depending on cryptsetup
121
42
*** mandos-keygen
122
 
**** "--passfile" option
 
43
**** TODO "--secfile" option
123
44
     Using the "secfile" option instead of "secret"
124
 
**** [#A] "--test" option
 
45
**** TODO [#B] "--test" option
125
46
     For testing decryption before rebooting.
126
 
** Server-side
127
 
*** [#A] Create mandos user and group for server
128
 
*** [#A] Create /var/run/mandos directory with perm and ownership
 
47
 
129
48
 
130
49
* [#A] Package
131
50
** /usr/share/initramfs-tools/hooks/mandos
132
 
*** Do not install in initrd.img if configured not to.
 
51
*** TODO Do not install in initrd.img if configured not to.
133
52
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
134
53
    question.
135
 
** /etc/bash_completion.d/mandos
 
54
** TODO /etc/bash_completion.d/mandos
136
55
   From XML sources directly?
137
 
** unperish
138
 
** bzr-builddeb
139
 
 
140
 
* INSTALL file
141
 
 
142
 
* Web site
 
56
** TODO unperish
 
57
 
 
58
* TODO Web site
 
59
** DONE http://www.fukt.bsnet.se/mandos
 
60
   Redirects to the wiki page
 
61
** TODO http://wiki.fukt.bsnet.se/wiki/Mandos
 
62
   http://liw.fi/free-software-website/
143
63
 
144
64
* Mailing list
 
65
** DONE mandos-dev
 
66
*** TODO http://gmane.org/subscribe.php
145
67
 
146
 
* Announce project on news
 
68
* TODO Announce project on Usenet
147
69
  [[news:comp.os.linux.announce]]
148
70
 
149
71