/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
 
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.
60
25
 
61
 
* password-prompt
 
26
* Password-prompt
62
27
** [#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
28
** 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?]]
 
29
   [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
86
30
 
87
 
* mandos (server)
88
 
** [#A] /etc/init.d/mandos-server               :teddy:
89
 
** [#B] Log level                               :bugs:
 
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
90
37
** /etc/mandos/clients.d/*.conf
91
38
   Watch this directory and add/remove/update clients?
92
39
** config for TXT record
93
 
** [#B] Run-time communication with server      :bugs:
94
 
   Probably using D-Bus
95
 
   See also [[*Mandos-tools]]
96
 
** Implement --foreground                       :bugs:
 
40
** Run-time communication with server
 
41
   probably using D-Bus
 
42
** Implement --foreground
97
43
   [[info:standards:Option%20Table][Table of Long Options]]
98
44
** Implement --socket
99
45
   [[info:standards:Option%20Table][Table of Long Options]]
100
 
** Date+time on console log messages            :bugs:
101
 
   Is this the default?
102
46
 
103
47
* Mandos-tools/utilities
104
48
  All of this probably using D-Bus
105
49
** List clients
 
50
** Enable client
106
51
** 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]].
112
52
 
113
53
* Installer
114
 
** 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
 
*** mandos-keygen
122
 
**** "--passfile" option
123
 
     Using the "secfile" option instead of "secret"
124
 
**** [#A] "--test" option
125
 
     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
129
 
 
130
 
* [#A] Package
131
 
** /usr/share/initramfs-tools/hooks/mandos
132
 
*** Do not install in initrd.img if configured not to.
133
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
134
 
    question.
135
 
** /etc/bash_completion.d/mandos
136
 
   From XML sources directly?
137
 
** unperish
138
 
** bzr-builddeb
139
 
 
140
 
* INSTALL file
141
 
 
142
 
* Web site
143
 
 
144
 
* Mailing list
145
 
 
146
 
* Announce project on news
147
 
  [[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
148
58
 
149
59
 
150
60
#+STARTUP: showall