/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-08-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
11
*** EXAMPLES
14
12
    Examples of normal usage, debug usage, debugging single or all
15
13
    plugins, etc.
16
14
*** FILES
59
57
   Must create in preinst if not pre-depending on cryptsetup
60
58
 
61
59
* password-prompt
62
 
** [#C] Use getpass(3)?
 
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)?
63
80
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
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?]]
67
84
 
68
85
* 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)
69
88
** [#A] /etc/init.d/mandos-server               :teddy:
70
89
** [#B] Log level                               :bugs:
71
90
** /etc/mandos/clients.d/*.conf
87
106
** Disable client
88
107
** Enable client
89
108
 
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 <arg> and <option> tags
95
 
** Use xinclude for common sections
96
 
   Like copyright, authors, etc.
97
 
** SEE ALSO
98
 
   Alphabetize
99
 
 
100
 
 
101
109
* Installer
102
110
** Client-side
103
111
*** Update initrd.img after installation
104
112
    This seems to use some kind of "trigger" system
105
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
106
 
    dpkg-trigger(1), deb-triggers(5)
107
113
*** Keydir move: /etc/mandos -> /etc/keys/mandos
108
114
    Must create in preinst if not pre-depending on cryptsetup
109
115
*** mandos-keygen
110
 
**** "--passfile" option
111
 
     Using the "secfile" option instead of "secret"
112
 
**** [#A] "--test" option
113
 
     For testing decryption before rebooting.
 
116
**** [#A] Output cut-and-paste ready snippet for clients.conf.
114
117
** Server-side
115
118
*** [#A] Create mandos user and group for server
116
119
*** [#A] Create /var/run/mandos directory with perm and ownership