/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-09-03 20:39:51 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903203951-kfos9y97xktm6zvx
* README: New file.

Show diffs side-by-side

added added

removed removed

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