/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-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
4
 
 
5
 
* mandos-applet
6
 
 
7
 
* mandos-client
8
 
** TODO [#A] Wireless network hook
9
 
** TODO [#B] Use capabilities instead of seteuid().
10
 
** TODO [#B] Use struct sockaddr_storage instead of a union
11
 
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
12
 
** TODO [#B] Use getnameinfo(serv=NULL, NI_NUMERICHOST) instead of inet_ntop()
13
 
** TODO [#B] Prefer /run/tmp over /tmp, if it exists
14
 
 
15
 
* splashy
16
 
** TODO [#B] use scandir(3) instead of readdir(3)
17
 
 
18
 
* usplash (Deprecated)
19
 
** TODO [#A] Make it work again
20
 
** TODO [#B] use scandir(3) instead of readdir(3)
21
 
** TODO Use [[info:libc:Argz%20Functions][argz_extract]]
22
 
 
23
 
* askpass-fifo
24
 
** TODO [#B] Drop privileges after opening FIFO.
 
3
* [#A] README file
 
4
 
 
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
 
 
26
* 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
** [#B] Temporarily lower kernel log level
 
52
   for less printouts during sucessfull boot.
 
53
** IPv4 support
 
54
** use strsep instead of strtok?
 
55
** Do not depend on GnuPG key rings on disk
 
56
   This would mean creating new GnuPG key rings with GPGME by
 
57
   importing the key files from scratch on every program start.
 
58
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
59
   Must create in preinst if not pre-depending on cryptsetup
25
60
 
26
61
* password-prompt
27
 
** TODO [#B] lock stdin (with flock()?)
28
 
 
29
 
* plymouth
30
 
 
31
 
* TODO [#B] passdev
32
 
 
33
 
* plugin-runner
34
 
** TODO handle printing for errors for plugins
35
 
*** Hook up stderr of plugins, buffer them, and prepend mandos pluig [plugin name]
36
 
** TODO [#B] use scandir(3) instead of readdir(3)
37
 
** TODO [#C] use same file name rules as run-parts(8)
38
 
** kernel command line option for debug info
39
 
** TODO [#B] Use openat()
 
62
** [#C] Use getpass(3)?
 
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
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?]]
40
67
 
41
68
* mandos (server)
42
 
** TODO Document why we ignore sigint
43
 
** TODO [#B] Log level                                                    :BUGS:
44
 
*** TODO /etc/mandos/clients.d/*.conf
45
 
    Watch this directory and add/remove/update clients?
46
 
** TODO [#C] config for TXT record
47
 
** TODO Log level dbus option
48
 
   SetLogLevel D-Bus call
49
 
** TODO Implement --foreground                                            :BUGS:
50
 
   [[info:standards:Option%20Table][Table of Long Options]]
51
 
** TODO Implement --socket
52
 
   [[info:standards:Option%20Table][Table of Long Options]]
53
 
** TODO [#C] DBusServiceObjectUsingSuper
54
 
** TODO [#B] Global enable/disable flag
55
 
** TODO [#B] By-client countdown on number of secrets given
56
 
** TODO [#B] Support RFC 3339 time duration syntax
57
 
** More D-Bus methods
58
 
*** NeedsPassword(50) - Timeout, default disapprove
59
 
    + SetPass(u"gazonk", True) -> Approval, persistent
60
 
    + Approve(False) -> Close client connection immediately
61
 
** TODO [#C] python-parsedatetime
62
 
** TODO [#C] systemd/launchd
63
 
   http://0pointer.de/blog/projects/systemd.html
64
 
   http://wiki.debian.org/systemd
65
 
** TODO Separate logging logic to own object
66
 
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
67
 
** TODO [#B] break the wait on approval_delay if connection dies
68
 
** TODO Generate Client.runtime_expansions from client options + extra
69
 
** TODO Allow %%(checker)s as a runtime expansion
70
 
** TODO Use python-tlslite?
71
 
** TODO D-Bus AddClient() method on server object
72
 
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods.
73
 
** TODO Emit [[http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties][org.freedesktop.DBus.Properties.PropertiesChanged]] signal
74
 
   TODO Deprecate se.recompile.Mandos.Client.PropertyChanged - annotate!
75
 
   TODO Can use "invalidates" annotation to also emit on changed secret.
76
 
** TODO Support [[http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager][org.freedesktop.DBus.ObjectManager]] interface on server object
77
 
   Deprecate methods GetAllClients(), GetAllClientsWithProperties()
78
 
   and signals ClientAdded and ClientRemoved.
79
 
** TODO Save state periodically to recover better from hard shutdowns
80
 
** TODO CheckerCompleted method, deprecate CheckedOK
81
 
 
82
 
* mandos.xml
83
 
** Add mandos contact info in manual pages
84
 
 
85
 
* mandos-ctl
86
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
87
 
*** [#B] --dump option
88
 
** TODO Support RFC 3339 time duration syntax
89
 
 
90
 
* TODO mandos-dispatch
91
 
  Listens for specified D-Bus signals and spawns shell commands with
92
 
  arguments.
93
 
 
94
 
* mandos-monitor
95
 
** TODO help should be toggleable
96
 
** Urwid client data displayer
97
 
   Better view of client data in the listing
98
 
*** Properties popup
99
 
** Print a nice "We are sorry" message, save stack trace to log.
100
 
** Show timeout countdown for approval
101
 
 
102
 
* mandos-keygen
103
 
** TODO "--secfile" option
104
 
   Using the "secfile" option instead of "secret"
105
 
** TODO [#B] "--test" option
106
 
   For testing decryption before rebooting.
107
 
 
108
 
* Makefile
109
 
** TODO [#C] Implement DEB_BUILD_OPTIONS
110
 
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
111
 
 
112
 
* Package
 
69
** [#A] /etc/init.d/mandos-server               :teddy:
 
70
** [#B] Log level                               :bugs:
 
71
** /etc/mandos/clients.d/*.conf
 
72
   Watch this directory and add/remove/update clients?
 
73
** config for TXT record
 
74
** [#B] Run-time communication with server      :bugs:
 
75
   Probably using D-Bus
 
76
   See also [[*Mandos-tools]]
 
77
** Implement --foreground                       :bugs:
 
78
   [[info:standards:Option%20Table][Table of Long Options]]
 
79
** Implement --socket
 
80
   [[info:standards:Option%20Table][Table of Long Options]]
 
81
** Date+time on console log messages            :bugs:
 
82
   Is this the default?
 
83
 
 
84
* Mandos-tools/utilities
 
85
  All of this probably using D-Bus
 
86
** List clients
 
87
** Disable client
 
88
** Enable client
 
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
**** 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
 
 
117
* Installer
 
118
** Client-side
 
119
*** Update initrd.img after installation
 
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)
 
123
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
124
    Must create in preinst if not pre-depending on cryptsetup
 
125
*** mandos-keygen
 
126
**** "--passfile" option
 
127
     Using the "secfile" option instead of "secret"
 
128
**** [#A] "--test" option
 
129
     For testing decryption before rebooting.
 
130
** Server-side
 
131
*** [#A] Create mandos user and group for server
 
132
*** [#A] Create /var/run/mandos directory with perm and ownership
 
133
 
 
134
* [#A] Package
113
135
** /usr/share/initramfs-tools/hooks/mandos
114
 
*** TODO [#C] use same file name rules as run-parts(8)
115
 
*** TODO [#C] Do not install in initrd.img if configured not to.
116
 
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
117
 
** TODO [#C] /etc/bash_completion.d/mandos
 
136
*** Do not install in initrd.img if configured not to.
 
137
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
138
    question.
 
139
** /etc/bash_completion.d/mandos
118
140
   From XML sources directly?
119
 
 
120
 
* Side Stuff
121
 
** TODO Locate which package moves the other bin/sh when busybox is deactivated
122
 
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
141
** unperish
 
142
** bzr-builddeb
 
143
 
 
144
* INSTALL file
 
145
 
 
146
* Web site
 
147
 
 
148
* Mailing list
 
149
 
 
150
* Announce project on news
 
151
  [[news:comp.os.linux.announce]]
123
152
 
124
153
 
125
154
#+STARTUP: showall