/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-31 10:44:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831104432-9hzi47foc7tlmade
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
                                           inside <option> tags.
                                           Moved long options before
                                           short.

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
 
5
* plugin-runner
6
6
** [#B] Add more comments to code
7
7
** [#B] Add more if(debug) calls
8
8
** [#B] Seperate more code to function for more readability
9
9
** [#A] Man page: man8/plugin-runner.8mandos
10
10
*** EXIT STATUS
11
 
    Text needed
12
 
*** EXAMPLES
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
13
14
    Examples of normal usage, debug usage, debugging single or all
14
15
    plugins, etc.
15
16
*** FILES
16
 
    Text needed
17
17
*** SECURITY
18
 
    Text needed
 
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).
19
22
*** BUGS
20
 
    Text needed
21
23
*** SEE ALSO
22
24
    Explaining text on what you can read
23
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
24
 
   Must create in preinst if not pre-depending on cryptsetup
25
25
 
26
 
* Password-request
 
26
* password-request
27
27
** [#A] Man page: man8/password-request.8mandos
28
 
** [#B] Temporarily lower kernel log level
29
 
   for less printouts during sucessfull boot.
 
28
*** SYNOPSIS
 
29
    Document short options
30
30
*** DESCRIPTION
31
 
    Move options to new OPTIONS section.
32
31
    State that this command is not meant to be invoked directly, but
33
32
    is run as a plugin from mandos-client(8) and only run in the
34
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
35
38
*** EXIT STATUS
36
 
    Create this section
37
 
*** EXAMPLES
 
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
38
46
    Examples of normal usage, debug usage, debugging by connecting
39
47
    directly, etc.
40
 
*** FILES
41
 
    Describe the key files and the key ring files.  Also note that
42
 
    they should normally have been automatically created.
43
 
*** DIAGNOSTICS
44
 
    Create this section
45
48
*** SECURITY
46
 
    Create this section
47
 
*** BUGS
48
 
    Create this section
49
49
*** SEE ALSO
50
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
51
 
*** ENVIRONMENT
52
 
    Document use of "cryptsource" and "crypttarget".
 
50
    Update from mandos.xml
 
51
** [#B] Temporarily lower kernel log level
 
52
   for less printouts during sucessfull boot.
53
53
** IPv4 support
54
54
** use strsep instead of strtok?
55
55
** Do not depend on GnuPG key rings on disk
56
56
   This would mean creating new GnuPG key rings with GPGME by
57
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
58
60
 
59
 
* Password-prompt
60
 
** [#A] Man page: man8/password-prompt.8mandos
61
 
*** DESCRIPTION
62
 
    Move options to new OPTIONS section.
63
 
    Note that this is more or less a simple getpass(3) wrapper, even
64
 
    though actual use of getpass(3) is not guaranteed.
65
 
*** EXIT STATUS
66
 
    Create this section
67
 
*** EXAMPLES
68
 
    Examples of normal usage, debug usage, with a prefix, etc.
69
 
*** DIAGNOSTICS
70
 
    Create this section
71
 
*** SECURITY
72
 
    Create this section
73
 
    Not much to do here but it is noteworthy to state the danger of
74
 
    not having a fallback option.
75
 
*** BUGS
76
 
    Create this section
77
 
*** SEE ALSO
78
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
79
 
** Use getpass(3)?
 
61
* password-prompt
 
62
** [#C] Use getpass(3)?
80
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
81
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
82
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
83
66
   [[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?]]
84
67
 
85
 
* Mandos (server)
86
 
** [#A] Command man page: man8/mandos.8
87
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
88
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
68
* mandos (server)
89
69
** [#A] /etc/init.d/mandos-server               :teddy:
90
70
** [#B] Log level                               :bugs:
91
71
** /etc/mandos/clients.d/*.conf
107
87
** Disable client
108
88
** Enable client
109
89
 
 
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
 
95
    <arg> with inner <option> and <replaceable> tags
 
96
    Unify long and short options.
 
97
**** DONE mandos-clients.conf.xml
 
98
**** DONE mandos-keygen.xml
 
99
**** DONE mandos.conf.xml
 
100
**** DONE mandos.xml
 
101
**** DONE plugin-runner.xml
 
102
**** DONE plugins.d/password-prompt.xml
 
103
**** DONE plugins.d/password-request.xml
 
104
*** OPTIONS
 
105
    Separate <term> tags with <option> and <replaceable> tags.
 
106
**** DONE mandos-clients.conf.xml
 
107
**** DONE mandos-keygen.xml
 
108
**** DONE mandos.conf.xml
 
109
**** DONE mandos.xml
 
110
**** DONE plugin-runner.xml
 
111
**** DONE plugins.d/password-prompt.xml
 
112
**** TODO plugins.d/password-request.xml
 
113
** Use xinclude for common sections
 
114
   Like copyright, authors, etc.
 
115
 
 
116
 
110
117
* Installer
111
 
** Client
112
 
*** DONE [#A] Change initrd.img file to not be publically readable
113
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
114
 
    UMASK=027
 
118
** Client-side
115
119
*** Update initrd.img after installation
116
 
** Server
 
120
    This seems to use some kind of "trigger" system
 
121
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
122
    dpkg-trigger(1), deb-triggers(5)
 
123
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
124
    Must create in preinst if not pre-depending on cryptsetup
 
125
*** mandos-keygen
 
126
**** "--passfile" option
 
127
     Using the "secfile" option instead of "secret"
 
128
**** [#A] "--test" option
 
129
     For testing decryption before rebooting.
 
130
** Server-side
117
131
*** [#A] Create mandos user and group for server
118
132
*** [#A] Create /var/run/mandos directory with perm and ownership
119
133
 
120
 
** mandos-keygen
121
 
*** [#A] Command man page: man8/mandos-keygen.8
122
 
**** EXIT STATUS
123
 
**** FILES
124
 
**** BUGS
125
 
**** EXAMPLES
126
 
**** SECURITY
127
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
128
 
 
129
134
* [#A] Package
130
135
** /usr/share/initramfs-tools/hooks/mandos
131
136
*** Do not install in initrd.img if configured not to.
132
137
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
133
138
    question.
134
139
** /etc/bash_completion.d/mandos
135
 
*** From XML sources directly?
 
140
   From XML sources directly?
136
141
** unperish
137
142
** bzr-builddeb
138
143