/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
 
*** BUGS
17
 
*** SEE ALSO
18
 
    Explaining text on what you can read
19
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
20
 
   Must create in preinst if not pre-depending on cryptsetup
21
 
 
22
 
* 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
23
17
** [#A] Man page: man8/password-request.8mandos
24
 
*** SYNOPSIS
25
 
    Document short options
26
 
*** DESCRIPTION
27
 
    State that this command is not meant to be invoked directly, but
28
 
    is run as a plugin from mandos-client(8) and only run in the
29
 
    initrd environment, not the real system.
30
 
*** PURPOSE
31
 
    As in mandos.xml
32
 
*** OVERVIEW
33
 
    As in mandos.xml
34
 
*** EXIT STATUS
35
 
*** ENVIRONMENT
36
 
    Note that it does *not* currently use cryptsource or crypttarget.
37
 
*** FILES
38
 
    Describe the key files and the key ring files.  Also note that
39
 
    they should normally have been automatically created.
40
 
*** BUGS
41
 
*** EXAMPLE
42
 
    Examples of normal usage, debug usage, debugging by connecting
43
 
    directly, etc.
44
 
*** SECURITY
45
 
*** SEE ALSO
46
 
    Update from mandos.xml
47
 
** [#B] Temporarily lower kernel log level
48
 
   for less printouts during sucessfull boot.
 
18
** [#A] check return codes of all system calls
 
19
** [#B] header files/symbols tally
49
20
** IPv4 support
50
21
** use strsep instead of strtok?
51
 
** Do not depend on GnuPG key rings on disk
52
 
   This would mean creating new GnuPG key rings with GPGME by
53
 
   importing the key files from scratch on every program start.
 
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.
54
25
 
55
 
* password-prompt
 
26
* Password-prompt
56
27
** [#A] Man page: man8/password-prompt.8mandos
57
 
*** SYNOPSIS
58
 
    Document short options
59
 
*** DESCRIPTION
60
 
    Note that this is more or less a simple getpass(3) wrapper, even
61
 
    though actual use of getpass(3) is not guaranteed.
62
 
*** EXIT STATUS
63
 
*** ENVIRONMENT
64
 
    Document use of "cryptsource" and "crypttarget".
65
 
*** FILES
66
 
*** BUGS
67
 
*** EXAMPLE
68
 
    Examples of normal usage, debug usage, with a prefix, etc.
69
 
*** SECURITY
70
 
    Not much to do here but it is noteworthy to state the danger of
71
 
    not having a fallback option.
72
 
*** SEE ALSO
73
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
74
 
    and also, perhaps, to cryptsetup(8)?
75
28
** Use getpass(3)?
76
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
77
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
78
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
79
 
   [[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]]
80
30
 
81
 
* mandos (server)
 
31
* Server
 
32
** [#A] Command man page: man8/mandos.8
82
33
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
83
34
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
84
 
** [#A] /etc/init.d/mandos-server               :teddy:
85
 
** [#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
86
39
** /etc/mandos/clients.d/*.conf
87
40
   Watch this directory and add/remove/update clients?
88
41
** config for TXT record
89
 
** [#B] Run-time communication with server      :bugs:
90
 
   Probably using D-Bus
91
 
   See also [[*Mandos-tools]]
92
 
** Implement --foreground                       :bugs:
 
42
** Run-time communication with server
 
43
   probably using D-Bus
 
44
** Implement --foreground
93
45
   [[info:standards:Option%20Table][Table of Long Options]]
94
46
** Implement --socket
95
47
   [[info:standards:Option%20Table][Table of Long Options]]
96
 
** Date+time on console log messages            :bugs:
97
 
   Is this the default?
98
48
 
99
49
* Mandos-tools/utilities
100
50
  All of this probably using D-Bus
101
51
** List clients
 
52
** Enable client
102
53
** Disable client
103
 
** Enable client
104
54
 
105
55
* Installer
106
 
** Client
107
 
*** Update initrd.img after installation
108
 
    This seems to use some kind of "trigger" system
109
 
** Server
110
 
*** [#A] Create mandos user and group for server
111
 
*** [#A] Create /var/run/mandos directory with perm and ownership
112
 
 
113
 
** mandos-keygen
114
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
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]]
 
56
** [#A] Change initrd.img file to not be publically readable
 
57
** [#A] Create GPG key ring files in initrd
134
58
 
135
59
 
136
60
#+STARTUP: showall