/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-09 01:39:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080809013909-n3i3ll1voycmmw7l
* clients.conf: Better comments.
  (foo): Commented out and changed into a better example client.
  (braxen_client): Removed.
  (bar): New commented-out example client.

* mandos: Changed all log messages to be unicode strings.
  (Client.fqdn): Renamed to "host".  All users and documentation
                 changed.
  (main): Exit immediately if no clients are defined.

* mandos.conf: Better comments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
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
 
3
* README file
 
4
 
 
5
* COPYING file
 
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
 
7
 
 
8
* Mandos-client
 
9
** [#A] Man page: man8/mandos-client.8mandos
 
10
** [#A] check return codes of all system calls
 
11
** [#B] header files/symbols tally
 
12
** use strsep instead of strtok?
 
13
** use config file in addition to arguments
 
14
** pass things in environment, like device name, etc
 
15
 
 
16
* Password-request
27
17
** [#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
52
 
   for less printouts during sucessfull boot.
 
18
** [#A] check return codes of all system calls
 
19
** [#B] header files/symbols tally
53
20
** IPv4 support
54
21
** 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
60
 
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
63
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
 
   [[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
 
 
68
 
* mandos (server)
69
 
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
 
22
** Do not depend on GPG key rings on disk
 
23
   This would mean creating new GPG key rings with GPGME by importing
 
24
   the key files from scratch on every program start.
 
25
 
 
26
* Password-prompt
 
27
** [#A] Man page: man8/password-prompt.8mandos
 
28
** Use getpass(3)?
 
29
   [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
30
 
 
31
* Server
 
32
** [#A] Command man page: man8/mandos.8
 
33
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
34
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
35
** [#A] /etc/init.d/mandos-server
 
36
** Log level
71
37
** /etc/mandos/clients.d/*.conf
72
38
   Watch this directory and add/remove/update clients?
73
39
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
75
 
   Probably using D-Bus
76
 
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
 
40
** Run-time communication with server
 
41
   probably using D-Bus
 
42
** Implement --foreground
78
43
   [[info:standards:Option%20Table][Table of Long Options]]
79
44
** Implement --socket
80
45
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
82
 
   Is this the default?
83
46
 
84
47
* Mandos-tools/utilities
85
48
  All of this probably using D-Bus
86
49
** List clients
 
50
** Enable client
87
51
** Disable client
88
 
** Enable client
89
 
 
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 <arg> and <option> tags
95
 
** Use xinclude for common sections
96
 
   Like copyright, authors, etc.
97
 
 
98
52
 
99
53
* Installer
100
 
** Client-side
101
 
*** Update initrd.img after installation
102
 
    This seems to use some kind of "trigger" system
103
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
104
 
    dpkg-trigger(1), deb-triggers(5)
105
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
106
 
    Must create in preinst if not pre-depending on cryptsetup
107
 
*** mandos-keygen
108
 
**** "--passfile" option
109
 
     Using the "secfile" option instead of "secret"
110
 
**** [#A] "--test" option
111
 
     For testing decryption before rebooting.
112
 
** Server-side
113
 
*** [#A] Create mandos user and group for server
114
 
*** [#A] Create /var/run/mandos directory with perm and ownership
115
 
 
116
 
* [#A] Package
117
 
** /usr/share/initramfs-tools/hooks/mandos
118
 
*** Do not install in initrd.img if configured not to.
119
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
120
 
    question.
121
 
** /etc/bash_completion.d/mandos
122
 
   From XML sources directly?
123
 
** unperish
124
 
** bzr-builddeb
125
 
 
126
 
* INSTALL file
127
 
 
128
 
* Web site
129
 
 
130
 
* Mailing list
131
 
 
132
 
* Announce project on news
133
 
  [[news:comp.os.linux.announce]]
 
54
** [#A] Change initrd.img file to not be publically readable
 
55
** [#A] Create GPG key ring files in initrd
 
56
** [#A] Create mandos user and group for server
 
57
** [#A] Create /var/run/mandos directory with perm and ownership
134
58
 
135
59
 
136
60
#+STARTUP: showall