/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-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* Use _attribute_((nonnull)) wherever possible.
4
 
 
5
 
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
6
 
 
7
 
* mandos-applet
8
 
 
9
 
* mandos-client
10
 
** TODO [#A] Document network hook functionality
11
 
** TODO [#B] Use capabilities instead of seteuid().
12
 
** TODO [#B] Use struct sockaddr_storage instead of a union
13
 
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
14
 
** TODO [#B] Use getnameinfo(serv=NULL, NI_NUMERICHOST) instead of inet_ntop()
15
 
** TODO [#B] Prefer /run/tmp over /tmp, if it exists
16
 
 
17
 
* splashy
18
 
** TODO [#B] use scandir(3) instead of readdir(3)
19
 
 
20
 
* usplash (Deprecated)
21
 
** TODO [#A] Make it work again
22
 
** TODO [#B] use scandir(3) instead of readdir(3)
23
 
** TODO Use [[info:libc:Argz%20Functions][argz_extract]]
24
 
 
25
 
* askpass-fifo
26
 
** 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
27
60
 
28
61
* password-prompt
29
 
** TODO [#B] lock stdin (with flock()?)
30
 
 
31
 
* plymouth
32
 
 
33
 
* TODO [#B] passdev
34
 
 
35
 
* plugin-runner
36
 
** TODO handle printing for errors for plugins
37
 
*** Hook up stderr of plugins, buffer them, and prepend mandos pluig [plugin name]
38
 
** TODO [#B] use scandir(3) instead of readdir(3)
39
 
** TODO [#C] use same file name rules as run-parts(8)
40
 
** kernel command line option for debug info
41
 
** 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?]]
42
67
 
43
68
* mandos (server)
44
 
** TODO [#B] Log level                                                    :BUGS:
45
 
** TODO Persistent state                                                  :BUGS:
46
 
   /var/lib/mandos/*
47
 
*** TODO /etc/mandos/clients.d/*.conf
48
 
    Watch this directory and add/remove/update clients?
49
 
** TODO [#C] config for TXT record
50
 
** TODO Log level option
51
 
   syslogger.setLevel(logging.WARNING)
52
 
   + SetLogLevel D-Bus call
53
 
** TODO Implement --foreground                                            :BUGS:
54
 
   [[info:standards:Option%20Table][Table of Long Options]]
55
 
** TODO Implement --socket
56
 
   [[info:standards:Option%20Table][Table of Long Options]]
57
 
** TODO Date+time on console log messages                                 :BUGS:
 
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:
58
82
   Is this the default?
59
 
** TODO [#C] DBusServiceObjectUsingSuper
60
 
** TODO [#B] Global enable/disable flag
61
 
** TODO [#B] By-client countdown on secrets given
62
 
** TODO [#B] Support RFC 3339 time duration syntax
63
 
** More D-Bus methods
64
 
*** NeedsPassword(50) - Timeout, default disapprove
65
 
    + SetPass(u"gazonk", True) -> Approval, persistent
66
 
    + Approve(False) -> Close client connection immediately
67
 
** TODO [#C] python-parsedatetime
68
 
** TODO [#C] systemd/launchd
69
 
   http://0pointer.de/blog/projects/systemd.html
70
 
   http://wiki.debian.org/systemd
71
 
** TODO Separate logging logic to own object
72
 
** TODO make clients to a dict!
73
 
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
74
 
** TODO [#B] break the wait on approval_delay if connection dies
75
 
** TODO Generate Client.runtime_expansions from client options + extra
76
 
** TODO Allow %%(checker)s as a runtime expansion
77
 
** TODO Use python-tlslite?
78
 
 
79
 
* mandos.xml
80
 
** Add mandos contact info in manual pages
81
 
 
82
 
* mandos-ctl
83
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
84
 
*** [#B] --dump option
85
 
** TODO Support RFC 3339 time duration syntax
86
 
** TODO Send milliseconds if bare integer is passed as time duration
87
 
 
88
 
* TODO mandos-dispatch
89
 
  Listens for specified D-Bus signals and spawns shell commands with
90
 
  arguments.
91
 
 
92
 
* mandos-monitor
93
 
** TODO help should be toggleable
94
 
** Urwid client data displayer
95
 
   Better view of client data in the listing
96
 
*** Properties popup
97
 
** Nicer crashes. Stack traces Messes up shell.
98
 
*** Print a nice "We are sorry" message, save stack trace to log.
99
 
** Show timeout countdown for approval
100
 
 
101
 
* mandos-keygen
102
 
** TODO "--secfile" option
103
 
   Using the "secfile" option instead of "secret"
104
 
** TODO [#B] "--test" option
105
 
   For testing decryption before rebooting.
106
 
 
107
 
* Makefile
108
 
** TODO [#C] Implement DEB_BUILD_OPTIONS
109
 
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
110
 
 
111
 
* Package
 
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 <replaceable> and <option> tags
 
96
**** DONE mandos-keygen.xml
 
97
**** DONE plugins.d/password-request.xml
 
98
**** TODO mandos.conf.xml
 
99
**** TODO mandos.xml
 
100
**** TODO plugin-runner.xml
 
101
**** TODO plugins.d/password-prompt.xml
 
102
*** OPTIONS
 
103
    Separate <term> tags with <option> and <replaceable> tags
 
104
**** DONE mandos-clients.conf.xml
 
105
**** TODO mandos-keygen.xml
 
106
**** DONE mandos.conf.xml
 
107
**** TODO mandos.xml
 
108
**** TODO plugin-runner.xml
 
109
**** TODO plugins.d/password-prompt.xml
 
110
**** TODO plugins.d/password-request.xml
 
111
** Use xinclude for common sections
 
112
   Like copyright, authors, etc.
 
113
 
 
114
 
 
115
* Installer
 
116
** Client-side
 
117
*** Update initrd.img after installation
 
118
    This seems to use some kind of "trigger" system
 
119
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
120
    dpkg-trigger(1), deb-triggers(5)
 
121
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
122
    Must create in preinst if not pre-depending on cryptsetup
 
123
*** mandos-keygen
 
124
**** "--passfile" option
 
125
     Using the "secfile" option instead of "secret"
 
126
**** [#A] "--test" option
 
127
     For testing decryption before rebooting.
 
128
** Server-side
 
129
*** [#A] Create mandos user and group for server
 
130
*** [#A] Create /var/run/mandos directory with perm and ownership
 
131
 
 
132
* [#A] Package
112
133
** /usr/share/initramfs-tools/hooks/mandos
113
 
*** TODO [#C] use same file name rules as run-parts(8)
114
 
*** TODO [#C] Do not install in initrd.img if configured not to.
115
 
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
116
 
** TODO [#C] /etc/bash_completion.d/mandos
 
134
*** Do not install in initrd.img if configured not to.
 
135
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
136
    question.
 
137
** /etc/bash_completion.d/mandos
117
138
   From XML sources directly?
118
 
 
119
 
* Side Stuff
120
 
** TODO Locate which package moves the other bin/sh when busybox is deactivated
121
 
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
139
** unperish
 
140
** bzr-builddeb
 
141
 
 
142
* INSTALL file
 
143
 
 
144
* Web site
 
145
 
 
146
* Mailing list
 
147
 
 
148
* Announce project on news
 
149
  [[news:comp.os.linux.announce]]
122
150
 
123
151
 
124
152
#+STARTUP: showall