/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: Teddy Hogeborn
  • Date: 2008-08-10 20:35:01 UTC
  • mfrom: (24.1.42 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080810203501-euh3qcf1nopilksm
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
2
2
 
3
3
* [#A] README file
4
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
 
5
* [#A] COPYING file
 
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
 
7
 
 
8
* Mandos-client
 
9
** [#A] Man page: man8/mandos-client.8mandos
 
10
*** DESCRIPTION
 
11
    Describe the plus sign syntax for passing options from crypttab
10
12
*** EXIT STATUS
11
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
13
    Text needed
 
14
*** EXAMPLES
14
15
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
 
16
    plugins, examples of crypttab lines with plus syntax, etc.
16
17
*** FILES
 
18
    Text needed
17
19
*** 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).
 
20
    Text needed
 
21
*** NOTES
 
22
    Text needed
22
23
*** BUGS
 
24
    Text needed
23
25
*** SEE ALSO
24
 
    Explaining text on what you can read
 
26
    Explaining test on what you can read
 
27
** Use asprintf instead of malloc and strcat?
 
28
** use strsep instead of strtok?
 
29
** use config file in addition to arguments
 
30
** pass things in environment, like device name, etc
25
31
 
26
 
* password-request
 
32
* Password-request
27
33
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
30
34
*** DESCRIPTION
 
35
    Move options to new OPTIONS section.
31
36
    State that this command is not meant to be invoked directly, but
32
37
    is run as a plugin from mandos-client(8) and only run in the
33
38
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
39
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
 
40
    Create this section
 
41
*** EXAMPLES
 
42
    Examples of normal usage, debug usage, debugging by connecting
 
43
    directly, etc.
41
44
*** FILES
42
45
    Describe the key files and the key ring files.  Also note that
43
46
    they should normally have been automatically created.
 
47
*** DIAGNOSTICS
 
48
    Create this section
 
49
*** SECURITY
 
50
    Create this section
 
51
*** NOTES
 
52
    Create this section (if needed)
44
53
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
 
54
    Create this section
49
55
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
 
56
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
57
** Use asprintf instead of malloc and memcpy?
53
58
** IPv4 support
54
59
** 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
** Do not depend on GPG key rings on disk
 
61
   This would mean creating new GPG key rings with GPGME by importing
 
62
   the key files from scratch on every program start.
60
63
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
 
64
* Password-prompt
 
65
** [#A] Man page: man8/password-prompt.8mandos
 
66
*** DESCRIPTION
 
67
    Move options to new OPTIONS section.
 
68
*** EXIT STATUS
 
69
    Create this section
 
70
*** EXAMPLES
 
71
    Examples of normal usage, debug usage, with a prefix, etc.
 
72
*** DIAGNOSTICS
 
73
    Create this section
 
74
*** SECURITY
 
75
    Create this section
 
76
    Not much to do here but it is noteworthy to state the danger of
 
77
    not having a fallback option.
 
78
*** NOTES
 
79
    Note that this is more or less a simple getpass(3) wrapper, even
 
80
    though actual use of getpass(3) is not guaranteed.
 
81
*** BUGS
 
82
    Create this section
 
83
*** SEE ALSO
 
84
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
85
** Use getpass(3)?
63
86
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
87
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
88
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
89
   [[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
90
 
68
 
* mandos (server)
 
91
* Mandos (server)
 
92
** [#A] Command man page: man8/mandos.8
 
93
*** DESCRIPTION
 
94
    Move options to new OPTIONS section
 
95
*** EXIT STATUS
 
96
    Create this section
 
97
*** EXAMPLES
 
98
    Create this section
 
99
*** FILES
 
100
    Describe briefly that the server gets global settings from
 
101
    mandos.conf and clients from clients.conf, but refer to their man
 
102
    pages for more details.
 
103
*** DIAGNOSTICS
 
104
    Create this section
 
105
*** SECURITY
 
106
    Create this section
 
107
*** NOTES
 
108
    Create this section (if needed)
 
109
*** BUGS
 
110
    Create this section
 
111
*** SEE ALSO
 
112
    Refer to the client man page
 
113
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
114
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
69
115
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
 
116
** Log level
71
117
** /etc/mandos/clients.d/*.conf
72
118
   Watch this directory and add/remove/update clients?
73
119
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
 
120
** Run-time communication with server
75
121
   Probably using D-Bus
76
122
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
 
123
** Implement --foreground
78
124
   [[info:standards:Option%20Table][Table of Long Options]]
79
125
** Implement --socket
80
126
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
82
 
   Is this the default?
83
127
 
84
128
* Mandos-tools/utilities
85
129
  All of this probably using D-Bus
87
131
** Disable client
88
132
** Enable client
89
133
 
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
 
*** EXAMPLES &COMMANDNAME;
96
 
** Use xinclude for common sections
97
 
   Like copyright, authors, etc.
98
 
** SEE ALSO
99
 
   Alphabetize
100
 
 
101
 
 
102
134
* Installer
103
 
** Client-side
104
 
*** Update initrd.img after installation
105
 
    This seems to use some kind of "trigger" system
106
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
107
 
    dpkg-trigger(1), deb-triggers(5)
108
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
109
 
    Must create in preinst if not pre-depending on cryptsetup
110
 
*** mandos-keygen
111
 
**** "--passfile" option
112
 
     Using the "secfile" option instead of "secret"
113
 
**** [#A] "--test" option
114
 
     For testing decryption before rebooting.
115
 
** Server-side
116
 
*** [#A] Create mandos user and group for server
117
 
*** [#A] Create /var/run/mandos directory with perm and ownership
 
135
** DONE [#A] Change initrd.img file to not be publically readable
 
136
   /etc/initramfs-tools/conf.d/mandos
 
137
   UMASK=027
 
138
** Update initrd.img after installation
 
139
** [#A] Create mandos user and group for server
 
140
** [#A] Create /var/run/mandos directory with perm and ownership
118
141
 
119
142
* [#A] Package
120
 
** /usr/share/initramfs-tools/hooks/mandos
121
 
*** Do not install in initrd.img if configured not to.
122
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
123
 
    question.
124
143
** /etc/bash_completion.d/mandos
125
 
   From XML sources directly?
 
144
** /etc/initramfs-tools/hooks/mandos
 
145
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
146
*** Create GPG key ring files in initrd
126
147
** unperish
127
148
** bzr-builddeb
128
149