/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-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
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
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
11
 
** use strsep instead of strtok?
12
 
** use config file in addition to arguments
13
 
** pass things in environment, like device name, etc
14
 
 
15
 
* Password-request
 
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
*** 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
 
23
 
 
24
* password-request
16
25
** [#A] Man page: man8/password-request.8mandos
17
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
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
 
50
   for less printouts during sucessfull boot.
18
51
** IPv4 support
19
52
** use strsep instead of strtok?
20
 
** Do not depend on GPG key rings on disk
21
 
   This would mean creating new GPG key rings with GPGME by importing
22
 
   the key files from scratch on every program start.
 
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
23
58
 
24
 
* Password-prompt
 
59
* password-prompt
25
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)?
26
79
** Use getpass(3)?
27
80
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
28
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
29
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
30
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?]]
31
84
 
32
 
* Server
33
 
** [#A] Command man page: man8/mandos.8
34
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
85
* mandos (server)
35
86
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
36
87
** [#A] /etc/init.d/mandos-server               :teddy:
37
 
** Log level
 
88
** [#B] Log level                               :bugs:
38
89
** /etc/mandos/clients.d/*.conf
39
90
   Watch this directory and add/remove/update clients?
40
91
** config for TXT record
41
 
** Run-time communication with server
 
92
** [#B] Run-time communication with server      :bugs:
42
93
   Probably using D-Bus
43
94
   See also [[*Mandos-tools]]
44
 
** Implement --foreground
 
95
** Implement --foreground                       :bugs:
45
96
   [[info:standards:Option%20Table][Table of Long Options]]
46
97
** Implement --socket
47
98
   [[info:standards:Option%20Table][Table of Long Options]]
 
99
** Date+time on console log messages            :bugs:
 
100
   Is this the default?
48
101
 
49
102
* Mandos-tools/utilities
50
103
  All of this probably using D-Bus
53
106
** Enable client
54
107
 
55
108
* Installer
56
 
** [#A] Change initrd.img file to not be publically readable
57
 
** [#A] Create /etc/initramfs-tools/hooks/mandos
58
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
59
 
** [#A] Create GPG key ring files in initrd
60
 
** [#A] Create mandos user and group for server
61
 
** [#A] Create /var/run/mandos directory with perm and ownership
 
109
** Client-side
 
110
*** Update initrd.img after installation
 
111
    This seems to use some kind of "trigger" system
 
112
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
113
    Must create in preinst if not pre-depending on cryptsetup
 
114
*** mandos-keygen
 
115
**** [#A] Output cut-and-paste ready snippet for clients.conf.
 
116
** Server-side
 
117
*** [#A] Create mandos user and group for server
 
118
*** [#A] Create /var/run/mandos directory with perm and ownership
 
119
 
 
120
* [#A] Package
 
121
** /usr/share/initramfs-tools/hooks/mandos
 
122
*** Do not install in initrd.img if configured not to.
 
123
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
124
    question.
 
125
** /etc/bash_completion.d/mandos
 
126
   From XML sources directly?
 
127
** unperish
 
128
** bzr-builddeb
62
129
 
63
130
* INSTALL file
64
131
 
65
 
* Website
 
132
* Web site
66
133
 
67
134
* Mailing list
68
135
 
69
136
* Announce project on news
70
 
  news:comp.os.linux.announce
71
 
 
72
 
* [[http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/][Software Release Practice HOWTO]]
 
137
  [[news:comp.os.linux.announce]]
73
138
 
74
139
 
75
140
#+STARTUP: showall