/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-17 22:42:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817224228-nhor2yuv230if01i
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
                           not rely on a stylesheet declaration.

* mandos.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
              refers to "overview.xml". Changed all single quotes to
              double quotes for consistency.
  (DESCRIPTION): Use the term "TLS" and not "GnuTLS" for the protocol.
                 Refer to the "OVERVIEW" section for reason for IPv6
                 link-local addresses.
  (PURPOSE): Shortened a lot.  Refer to "OVERVIEW" section for details.
  (OVERVIEW): New section.  Include &OVERVIEW; and add a paragraph
              about what the role of this program is.
  (SECURITY/CLIENTS): Refer to the "CHECKING" section for details on
                      checking.
  (SEE ALSO): Changed from an <itemizedlist> to a <variablelist>.
              Added a short text for each entry.  Removed reference to
              plugin-runner(8mandos).  Add reference to RFC 4291 and
              RFC 4346.

* overview.xml: New file, containing a single <para>.  The idea is to
                use this in all the man pages.

* plugins.d/password-request.c: Updated comments about spurious
                                warnings.

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
** [#A] Man page: man8/plugin-runner.8mandos
 
10
*** EXIT STATUS
 
11
    Text needed
 
12
*** EXAMPLES
 
13
    Examples of normal usage, debug usage, debugging single or all
 
14
    plugins, etc.
 
15
*** FILES
 
16
    Text needed
 
17
*** SECURITY
 
18
    Text needed
 
19
*** BUGS
 
20
    Text needed
 
21
*** SEE ALSO
 
22
    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
9
25
 
10
 
* password-request
 
26
* Password-request
11
27
** [#A] Man page: man8/password-request.8mandos
 
28
** [#B] Temporarily lower kernel log level
 
29
   for less printouts during sucessfull boot.
12
30
*** DESCRIPTION
 
31
    Move options to new OPTIONS section.
13
32
    State that this command is not meant to be invoked directly, but
14
33
    is run as a plugin from mandos-client(8) and only run in the
15
34
    initrd environment, not the real system.
16
 
*** PURPOSE
17
 
    As in mandos.xml
18
 
*** OVERVIEW
19
 
    As in mandos.xml
20
35
*** EXIT STATUS
21
 
*** ENVIRONMENT
22
 
    Note that it does *not* currently use cryptsource or crypttarget.
 
36
    Create this section
 
37
*** EXAMPLES
 
38
    Examples of normal usage, debug usage, debugging by connecting
 
39
    directly, etc.
23
40
*** FILES
24
41
    Describe the key files and the key ring files.  Also note that
25
42
    they should normally have been automatically created.
 
43
*** DIAGNOSTICS
 
44
    Create this section
 
45
*** SECURITY
 
46
    Create this section
26
47
*** BUGS
27
 
*** EXAMPLE
28
 
    Examples of normal usage, debug usage, debugging by connecting
29
 
    directly, etc.
30
 
*** SECURITY
 
48
    Create this section
31
49
*** SEE ALSO
32
 
    Update from mandos.xml
33
 
** [#B] Temporarily lower kernel log level
34
 
   for less printouts during sucessfull boot.
 
50
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
51
*** ENVIRONMENT
 
52
    Document use of "cryptsource" and "crypttarget".
35
53
** IPv4 support
36
54
** use strsep instead of strtok?
37
55
** Do not depend on GnuPG key rings on disk
38
56
   This would mean creating new GnuPG key rings with GPGME by
39
57
   importing the key files from scratch on every program start.
40
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
41
 
   Must create in preinst if not pre-depending on cryptsetup
42
58
 
43
 
* password-prompt
44
 
** [#C] Use getpass(3)?
 
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)?
45
80
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
46
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
47
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
48
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?]]
49
84
 
50
 
* mandos (server)
 
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)
51
89
** [#A] /etc/init.d/mandos-server               :teddy:
52
 
** [#B] Log level                               :bugs:
 
90
** Log level
53
91
** /etc/mandos/clients.d/*.conf
54
92
   Watch this directory and add/remove/update clients?
55
93
** config for TXT record
56
 
** [#B] Run-time communication with server      :bugs:
 
94
** Run-time communication with server
57
95
   Probably using D-Bus
58
96
   See also [[*Mandos-tools]]
59
 
** Implement --foreground                       :bugs:
 
97
** Implement --foreground
60
98
   [[info:standards:Option%20Table][Table of Long Options]]
61
99
** Implement --socket
62
100
   [[info:standards:Option%20Table][Table of Long Options]]
63
 
** Date+time on console log messages            :bugs:
 
101
** Date+time on console log messages
64
102
   Is this the default?
65
103
 
66
104
* Mandos-tools/utilities
69
107
** Disable client
70
108
** Enable client
71
109
 
72
 
* Man pages
73
 
** Use xinclude for common sections
74
 
   Like authors, etc.
75
 
 
76
 
 
77
110
* Installer
78
 
** Client-side
 
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
79
115
*** Update initrd.img after installation
80
 
    This seems to use some kind of "trigger" system
81
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
82
 
    dpkg-trigger(1), deb-triggers(5)
83
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
84
 
    Must create in preinst if not pre-depending on cryptsetup
85
 
*** mandos-keygen
86
 
**** "--passfile" option
87
 
     Using the "secfile" option instead of "secret"
88
 
**** [#A] "--test" option
89
 
     For testing decryption before rebooting.
90
 
** Server-side
 
116
** Server
91
117
*** [#A] Create mandos user and group for server
92
118
*** [#A] Create /var/run/mandos directory with perm and ownership
93
119
 
 
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
 
94
129
* [#A] Package
95
130
** /usr/share/initramfs-tools/hooks/mandos
96
131
*** Do not install in initrd.img if configured not to.
97
132
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
98
133
    question.
99
134
** /etc/bash_completion.d/mandos
100
 
   From XML sources directly?
 
135
*** From XML sources directly?
101
136
** unperish
102
137
** bzr-builddeb
103
138