/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: Björn Påhlsson
  • Date: 2008-08-08 01:31:58 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 50.
  • Revision ID: belorn@braxen-20080808013158-weqgqkxni7du1ke5
Added manual pages for:
      clients.conf
      mandos.conf
      mandos
      mandos-client
      password-prompt
      password-request

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
 
*** 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
 
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
25
17
** [#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
50
 
   for less printouts during sucessfull boot.
 
18
** [#A] check return codes of all system calls
 
19
** [#B] header files/symbols tally
51
20
** IPv4 support
52
21
** 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
 
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.
58
25
 
59
 
* password-prompt
 
26
* Password-prompt
60
27
** [#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
28
** 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?]]
 
29
   [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
84
30
 
85
 
* mandos (server)
 
31
* Server
 
32
** [#A] Command man page: man8/mandos.8
 
33
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
86
34
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
87
 
** [#A] /etc/init.d/mandos-server               :teddy:
88
 
** [#B] Log level                               :bugs:
 
35
** [#A] write PID file
 
36
** [#A] /etc/init.d/mandos-server
 
37
** Better comments in config files
 
38
** Log level
89
39
** /etc/mandos/clients.d/*.conf
90
40
   Watch this directory and add/remove/update clients?
91
41
** config for TXT record
92
 
** [#B] Run-time communication with server      :bugs:
93
 
   Probably using D-Bus
94
 
   See also [[*Mandos-tools]]
95
 
** Implement --foreground                       :bugs:
 
42
** Run-time communication with server
 
43
   probably using D-Bus
 
44
** Implement --foreground
96
45
   [[info:standards:Option%20Table][Table of Long Options]]
97
46
** Implement --socket
98
47
   [[info:standards:Option%20Table][Table of Long Options]]
99
 
** Date+time on console log messages            :bugs:
100
 
   Is this the default?
101
48
 
102
49
* Mandos-tools/utilities
103
50
  All of this probably using D-Bus
104
51
** List clients
 
52
** Enable client
105
53
** Disable client
106
 
** Enable client
107
54
 
108
55
* Installer
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
129
 
 
130
 
* INSTALL file
131
 
 
132
 
* Web site
133
 
 
134
 
* Mailing list
135
 
 
136
 
* Announce project on news
137
 
  [[news:comp.os.linux.announce]]
 
56
** [#A] Change initrd.img file to not be publically readable
 
57
** [#A] Create GPG key ring files in initrd
138
58
 
139
59
 
140
60
#+STARTUP: showall