/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:31:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903203119-0q6dii46hj3uf4ni
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
  (OPTIONS): Removed "--keydir" and changed text of "--pubkey" and
             "--seckey".
  (EXAMPLE): Altered not to use "--keydir" anymore.

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
 
*** 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
25
6
 
26
7
* password-request
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.
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
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
49
 
*** SEE ALSO
50
 
    Update from mandos.xml
51
8
** [#B] Temporarily lower kernel log level
52
9
   for less printouts during sucessfull boot.
53
10
** IPv4 support
59
16
   Must create in preinst if not pre-depending on cryptsetup
60
17
 
61
18
* password-prompt
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)?
82
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
83
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
84
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
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?]]
86
19
 
87
20
* 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.
90
21
** [#A] /etc/init.d/mandos-server               :teddy:
91
22
** [#B] Log level                               :bugs:
92
23
** /etc/mandos/clients.d/*.conf
107
38
** List clients
108
39
** Disable client
109
40
** Enable client
 
41
** Reboot timer
 
42
 
 
43
* Man pages
 
44
** Use xinclude for common sections
 
45
   Like authors, etc.
 
46
 
110
47
 
111
48
* Installer
112
49
** Client-side
113
50
*** Update initrd.img after installation
114
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)
115
54
*** Keydir move: /etc/mandos -> /etc/keys/mandos
116
55
    Must create in preinst if not pre-depending on cryptsetup
117
56
*** mandos-keygen
 
57
**** "--passfile" option
 
58
     Using the "secfile" option instead of "secret"
118
59
**** [#A] "--test" option
119
60
     For testing decryption before rebooting.
120
61
** Server-side