/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-31 10:44:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831104432-9hzi47foc7tlmade
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
                                           inside <option> tags.
                                           Moved long options before
                                           short.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
8
8
** [#B] Seperate more code to function for more readability
9
9
** [#A] Man page: man8/plugin-runner.8mandos
10
10
*** EXIT STATUS
11
 
*** EXAMPLES
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
12
14
    Examples of normal usage, debug usage, debugging single or all
13
15
    plugins, etc.
14
16
*** FILES
57
59
   Must create in preinst if not pre-depending on cryptsetup
58
60
 
59
61
* 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)?
 
62
** [#C] Use getpass(3)?
80
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
81
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
82
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
83
66
   [[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
67
 
85
68
* 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
69
** [#A] /etc/init.d/mandos-server               :teddy:
89
70
** [#B] Log level                               :bugs:
90
71
** /etc/mandos/clients.d/*.conf
106
87
** Disable client
107
88
** Enable client
108
89
 
 
90
* Man pages
 
91
** Tags
 
92
   Go through all man pages to conform to the style of tags chosen in
 
93
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
 
94
*** SYNOPSIS
 
95
    <arg> with inner <option> and <replaceable> tags
 
96
    Unify long and short options.
 
97
**** DONE mandos-clients.conf.xml
 
98
**** DONE mandos-keygen.xml
 
99
**** DONE mandos.conf.xml
 
100
**** DONE mandos.xml
 
101
**** DONE plugin-runner.xml
 
102
**** DONE plugins.d/password-prompt.xml
 
103
**** DONE plugins.d/password-request.xml
 
104
*** OPTIONS
 
105
    Separate <term> tags with <option> and <replaceable> tags.
 
106
**** DONE mandos-clients.conf.xml
 
107
**** DONE mandos-keygen.xml
 
108
**** DONE mandos.conf.xml
 
109
**** DONE mandos.xml
 
110
**** DONE plugin-runner.xml
 
111
**** DONE plugins.d/password-prompt.xml
 
112
**** TODO plugins.d/password-request.xml
 
113
** Use xinclude for common sections
 
114
   Like copyright, authors, etc.
 
115
 
 
116
 
109
117
* Installer
110
118
** Client-side
111
119
*** Update initrd.img after installation
112
120
    This seems to use some kind of "trigger" system
 
121
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
122
    dpkg-trigger(1), deb-triggers(5)
113
123
*** Keydir move: /etc/mandos -> /etc/keys/mandos
114
124
    Must create in preinst if not pre-depending on cryptsetup
115
125
*** mandos-keygen
116
 
**** [#A] Output cut-and-paste ready snippet for clients.conf.
 
126
**** "--passfile" option
 
127
     Using the "secfile" option instead of "secret"
 
128
**** [#A] "--test" option
 
129
     For testing decryption before rebooting.
117
130
** Server-side
118
131
*** [#A] Create mandos user and group for server
119
132
*** [#A] Create /var/run/mandos directory with perm and ownership