/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-09-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

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
 
*** 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
9
 
24
10
* password-request
25
11
** [#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
12
*** FILES
40
13
    Describe the key files and the key ring files.  Also note that
41
14
    they should normally have been automatically created.
57
30
   Must create in preinst if not pre-depending on cryptsetup
58
31
 
59
32
* 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)?
 
33
** [#C] Use getpass(3)?
80
34
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
81
35
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
82
36
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
83
37
   [[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
38
 
85
39
* mandos (server)
86
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
87
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
88
40
** [#A] /etc/init.d/mandos-server               :teddy:
89
41
** [#B] Log level                               :bugs:
90
42
** /etc/mandos/clients.d/*.conf
106
58
** Disable client
107
59
** Enable client
108
60
 
 
61
* Man pages
 
62
** Use xinclude for common sections
 
63
   Like authors, etc.
 
64
 
 
65
 
109
66
* Installer
110
67
** Client-side
111
68
*** Update initrd.img after installation
112
69
    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)
113
72
*** Keydir move: /etc/mandos -> /etc/keys/mandos
114
73
    Must create in preinst if not pre-depending on cryptsetup
115
74
*** mandos-keygen
116
 
**** [#A] Output cut-and-paste ready snippet for clients.conf.
 
75
**** "--passfile" option
 
76
     Using the "secfile" option instead of "secret"
 
77
**** [#A] "--test" option
 
78
     For testing decryption before rebooting.
117
79
** Server-side
118
80
*** [#A] Create mandos user and group for server
119
81
*** [#A] Create /var/run/mandos directory with perm and ownership