/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 07:32:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831073205-9hggg03i1iird264
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
* mandos.xml (SYNOPSIS): - '' -
* plugins.d/password-prompt.xml (SYNOPSIS): - '' -
* plugins.d/password-request.xml (SYNOPSIS): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
59
59
   Must create in preinst if not pre-depending on cryptsetup
60
60
 
61
61
* 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)?
 
62
** [#C] Use getpass(3)?
82
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
83
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
84
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
85
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?]]
86
67
 
87
68
* 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
69
** [#A] /etc/init.d/mandos-server               :teddy:
91
70
** [#B] Log level                               :bugs:
92
71
** /etc/mandos/clients.d/*.conf
108
87
** Disable client
109
88
** Enable client
110
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
**** TODO mandos-keygen.xml
 
108
**** DONE mandos.conf.xml
 
109
**** TODO mandos.xml
 
110
**** TODO plugin-runner.xml
 
111
**** TODO 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
 
111
117
* Installer
112
118
** Client-side
113
119
*** Update initrd.img after installation
114
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)
115
123
*** Keydir move: /etc/mandos -> /etc/keys/mandos
116
124
    Must create in preinst if not pre-depending on cryptsetup
117
125
*** mandos-keygen
118
 
**** [#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.
119
130
** Server-side
120
131
*** [#A] Create mandos user and group for server
121
132
*** [#A] Create /var/run/mandos directory with perm and ownership