/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: 2015-06-28 16:35:27 UTC
  • mto: (237.7.307 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
 
3
* GIT
 
4
** General: [[https://www.atlassian.com/git/workflows][Git Workflows]], [[http://gitimmersion.com/][Git Immersion]], [[https://news.ycombinator.com/item?id=7036628][Simple git workflow is simple]]
 
5
** Intro: [[http://www.eyrie.org/~eagle/notes/debian/git.html#combine][Using Git for Debian Packaging]]
 
6
** Use: [[https://honk.sigxcpu.org/piki/projects/git-buildpackage/][git-buildpackage]]
 
7
** Migration
 
8
   tailor?
 
9
   Using bzr-fastimport: [[http://www.fusonic.net/en/blog/2013/03/26/migrating-from-bazaar-to-git/][Migrating from Bazaar to Git]]
 
10
** Unresolved: [[http://jameswestby.net/bzr/builddeb/user_manual/split.html][bzr builddeb split mode]]
 
11
   Maybe: [[http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.import.html#GBP.IMPORT.UPSTREAM.GIT.NOTARBALL][git-buildpackage - No upstream tarballs]]
 
12
   [[http://www.python.org/dev/peps/pep-0374/][PEP 374 - Choosing a distributed VCS for the Python project]]
 
13
   [[http://www.emacswiki.org/emacs/GitForEmacsDevs][Git For Emacs Devs]]
 
14
 
 
15
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
 
16
 
 
17
* Testing
 
18
** python-nemu
 
19
 
 
20
* mandos-applet
 
21
 
 
22
* mandos-client
 
23
** TODO [#B] Use capabilities instead of seteuid().
 
24
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
 
25
** TODO [#C] Make start_mandos_communication() take "struct server".
 
26
** TODO [#C] --interfaces=regex,eth*,noregex (bridge-utils-interfaces(5))
 
27
 
 
28
* splashy
 
29
** TODO [#B] use scandir(3) instead of readdir(3)
 
30
 
 
31
* usplash (Deprecated)
 
32
** TODO [#A] Make it work again
 
33
** TODO [#B] use scandir(3) instead of readdir(3)
 
34
 
 
35
* askpass-fifo
 
36
 
 
37
* password-prompt
 
38
** TODO [#B] lock stdin (with flock()?)
 
39
 
 
40
* plymouth
 
41
 
 
42
* TODO [#B] passdev
4
43
 
5
44
* 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
60
 
 
61
 
* password-prompt
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?]]
 
45
** TODO handle printing for errors for plugins
 
46
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
47
** TODO [#C] use same file name rules as run-parts(8)
 
48
** kernel command line option for debug info
67
49
 
68
50
* mandos (server)
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 <arg> and <option> tags
95
 
*** EXAMPLES &COMMANDNAME;
96
 
** Use xinclude for common sections
97
 
   Like copyright, authors, etc.
98
 
** SEE ALSO
99
 
   Alphabetize
100
 
 
101
 
 
102
 
* Installer
103
 
** Client-side
104
 
*** Update initrd.img after installation
105
 
    This seems to use some kind of "trigger" system
106
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
107
 
    dpkg-trigger(1), deb-triggers(5)
108
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
109
 
    Must create in preinst if not pre-depending on cryptsetup
110
 
*** mandos-keygen
111
 
**** "--passfile" option
112
 
     Using the "secfile" option instead of "secret"
113
 
**** [#A] "--test" option
114
 
     For testing decryption before rebooting.
115
 
** Server-side
116
 
*** [#A] Create mandos user and group for server
117
 
*** [#A] Create /var/run/mandos directory with perm and ownership
118
 
 
119
 
* [#A] Package
 
51
** TODO [#B] Work around Avahi issue
 
52
   Avahi does not announce link-local addresses if any global
 
53
   addresses exist: http://lists.freedesktop.org/archives/avahi/2010-March/001863.html
 
54
** TODO [#B] Log level                                                    :BUGS:
 
55
*** TODO /etc/mandos/clients.d/*.conf
 
56
    Watch this directory and add/remove/update clients?
 
57
** TODO [#C] config for TXT record
 
58
** TODO Log level dbus option
 
59
   SetLogLevel D-Bus call
 
60
** TODO [#C] DBusServiceObjectUsingSuper
 
61
** TODO [#B] Global enable/disable flag
 
62
** TODO [#B] By-client countdown on number of secrets given
 
63
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
64
    + SetPass(u"gazonk", True) -> Approval, persistent
 
65
    + Approve(False) -> Close client connection immediately
 
66
** TODO [#C] python-parsedatetime
 
67
** TODO Separate logging logic to own object
 
68
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
 
69
** TODO [#B] break the wait on approval_delay if connection dies
 
70
** TODO Generate Client.runtime_expansions from client options + extra
 
71
** TODO Allow %%(checker)s as a runtime expansion
 
72
** TODO Use python-tlslite?
 
73
** TODO D-Bus AddClient() method on server object
 
74
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
75
** TODO Support [[http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager][org.freedesktop.DBus.ObjectManager]] interface on server object :2:
 
76
   Deprecate methods GetAllClients(), GetAllClientsWithProperties()
 
77
   and signals ClientAdded and ClientRemoved.
 
78
** TODO Save state periodically to recover better from hard shutdowns
 
79
** TODO CheckerCompleted method, deprecate CheckedOK
 
80
** TODO Secret Service API?
 
81
   http://standards.freedesktop.org/secret-service/
 
82
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
83
** TODO Remove old string_to_delta format                                    :2:
 
84
** TODO http://0pointer.de/blog/projects/stateless.html
 
85
*** tmpfiles snippet to create /var/lib/mandos with right user+perms
 
86
*** File in /usr/lib/sysusers.d to create user+group "_mandos"
 
87
** TODO Error handling on error parsing config files
 
88
** TODO init.d script error handling
 
89
** TODO D-Bus server properties; address, port, interface, etc.              :2:
 
90
 
 
91
* mandos.xml
 
92
** Add mandos contact info in manual pages
 
93
 
 
94
* mandos-ctl
 
95
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
96
*** [#B] --dump option
 
97
** TODO Remove old string_to_delta format                                    :2:
 
98
 
 
99
* TODO mandos-dispatch
 
100
  Listens for specified D-Bus signals and spawns shell commands with
 
101
  arguments.
 
102
 
 
103
* mandos-monitor
 
104
** TODO help should be toggleable
 
105
** Urwid client data displayer
 
106
   Better view of client data in the listing
 
107
*** Properties popup
 
108
** Print a nice "We are sorry" message, save stack trace to log.
 
109
** Rename module "gobject" to "GObject".
 
110
 
 
111
* mandos-keygen
 
112
** TODO "--secfile" option
 
113
   Using the "secfile" option instead of "secret"
 
114
** TODO [#B] "--test" option
 
115
   For testing decryption before rebooting.
 
116
 
 
117
* Package
120
118
** /usr/share/initramfs-tools/hooks/mandos
121
 
*** Do not install in initrd.img if configured not to.
122
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
123
 
    question.
124
 
** /etc/bash_completion.d/mandos
 
119
*** TODO [#C] use same file name rules as run-parts(8)
 
120
*** TODO [#C] Do not install in initrd.img if configured not to.
 
121
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
122
** TODO [#C] /etc/bash_completion.d/mandos
125
123
   From XML sources directly?
126
 
** unperish
127
 
** bzr-builddeb
128
 
 
129
 
* INSTALL file
130
 
 
131
 
* Web site
132
 
 
133
 
* Mailing list
134
 
 
135
 
* Announce project on news
136
 
  [[news:comp.os.linux.announce]]
 
124
 
 
125
* Side Stuff
 
126
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
127
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
137
128
 
138
129
 
139
130
#+STARTUP: showall