/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-24 06:17:02 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824061702-zxrru4r1vxmx4tuq
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
  (install-server, install-client): Use "install --directory" instead
                                    of mkdir.

* mandos-keygen: New options --subtype and --sublength.
  (trap): Added semicolons and backslashes.
  (gpg): Added "--enable-dsa2" to all invocations.

* mandos-keygen.xml: Changed single quotes to double quotes for
                     consistency.
  (/refentry/refentryinfo/copyright) Split copyright holders.
  (SYNOPSIS): Added "--subtype", "--sublength", "-s", and "-L".
  (OPTIONS): Document the subtype and sublength options.
  (SECURITY): Also note the "--subtype" and "--sublength" options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
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
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
 
14
    Examples of normal usage, debug usage, debugging single or all
 
15
    plugins, etc.
 
16
*** FILES
 
17
*** 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).
 
22
*** BUGS
 
23
*** SEE ALSO
 
24
    Explaining text on what you can read
9
25
 
10
26
* password-request
11
27
** [#A] Man page: man8/password-request.8mandos
 
28
*** SYNOPSIS
 
29
    Document short options
 
30
*** DESCRIPTION
 
31
    State that this command is not meant to be invoked directly, but
 
32
    is run as a plugin from mandos-client(8) and only run in the
 
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
 
38
*** EXIT STATUS
 
39
*** ENVIRONMENT
 
40
    Note that it does *not* currently use cryptsource or crypttarget.
12
41
*** FILES
13
42
    Describe the key files and the key ring files.  Also note that
14
43
    they should normally have been automatically created.
30
59
   Must create in preinst if not pre-depending on cryptsetup
31
60
 
32
61
* password-prompt
33
 
** [#C] Use getpass(3)?
 
62
** [#A] Man page: man8/password-prompt.8mandos
 
63
*** SYNOPSIS
 
64
    Document short options
 
65
*** DESCRIPTION
 
66
    Note that this is more or less a simple getpass(3) wrapper, even
 
67
    though actual use of getpass(3) is not guaranteed.
 
68
*** EXIT STATUS
 
69
*** ENVIRONMENT
 
70
    Document use of "cryptsource" and "crypttarget".
 
71
*** FILES
 
72
*** BUGS
 
73
*** EXAMPLE
 
74
    Examples of normal usage, debug usage, with a prefix, etc.
 
75
*** SECURITY
 
76
    Not much to do here but it is noteworthy to state the danger of
 
77
    not having a fallback option.
 
78
*** SEE ALSO
 
79
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
80
    and also, perhaps, to cryptsetup(8)?
 
81
** Use getpass(3)?
34
82
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
35
83
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
36
84
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
37
85
   [[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?]]
38
86
 
39
87
* mandos (server)
 
88
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
89
*** For option "secret", document which program can help generate it.
40
90
** [#A] /etc/init.d/mandos-server               :teddy:
41
91
** [#B] Log level                               :bugs:
42
92
** /etc/mandos/clients.d/*.conf
58
108
** Disable client
59
109
** Enable client
60
110
 
61
 
* Man pages
62
 
** Use xinclude for common sections
63
 
   Like authors, etc.
64
 
 
65
 
 
66
111
* Installer
67
112
** Client-side
68
113
*** Update initrd.img after installation
69
114
    This seems to use some kind of "trigger" system
70
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
71
 
    dpkg-trigger(1), deb-triggers(5)
72
115
*** Keydir move: /etc/mandos -> /etc/keys/mandos
73
116
    Must create in preinst if not pre-depending on cryptsetup
74
117
*** mandos-keygen
75
 
**** "--passfile" option
76
 
     Using the "secfile" option instead of "secret"
77
 
**** [#A] "--test" option
78
 
     For testing decryption before rebooting.
 
118
**** [#A] Output cut-and-paste ready snippet for clients.conf.
79
119
** Server-side
80
120
*** [#A] Create mandos user and group for server
81
121
*** [#A] Create /var/run/mandos directory with perm and ownership