/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • 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:
TODO
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
 
* [#A] COPYING file
6
 
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
 
 
8
 
* Mandos-client
9
 
** [#A] Man page: man8/mandos-client.8mandos
10
 
*** DESCRIPTION
11
 
    Describe the plus sign syntax for passing options from crypttab
12
 
*** EXIT STATUS
13
 
    Text needed
14
 
*** EXAMPLES
15
 
    Examples of normal usage, debug usage, debugging single or all
16
 
    plugins, examples of crypttab lines with plus syntax, etc.
17
 
*** FILES
18
 
    Text needed
19
 
*** SECURITY
20
 
    Text needed
21
 
*** NOTES
22
 
    Text needed
23
 
*** BUGS
24
 
    Text needed
25
 
*** SEE ALSO
26
 
    Explaining test on what you can read
27
 
** Use asprintf instead of malloc and strcat?
28
 
** use strsep instead of strtok?
29
 
** use config file in addition to arguments
30
 
** pass things in environment, like device name, etc
31
 
 
32
 
* Password-request
33
 
** [#A] Man page: man8/password-request.8mandos
34
 
*** DESCRIPTION
35
 
    Move options to new OPTIONS section.
36
 
    State that this command is not meant to be invoked directly, but
37
 
    is run as a plugin from mandos-client(8) and only run in the
38
 
    initrd environment, not the real system.
39
 
*** EXIT STATUS
40
 
    Create this section
41
 
*** EXAMPLES
42
 
    Examples of normal usage, debug usage, debugging by connecting
43
 
    directly, etc.
44
 
*** FILES
45
 
    Describe the key files and the key ring files.  Also note that
46
 
    they should normally have been automatically created.
47
 
*** DIAGNOSTICS
48
 
    Create this section
49
 
*** SECURITY
50
 
    Create this section
51
 
*** NOTES
52
 
    Create this section (if needed)
53
 
*** BUGS
54
 
    Create this section
55
 
*** SEE ALSO
56
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
57
 
** Use asprintf instead of malloc and memcpy?
58
 
** IPv4 support
59
 
** use strsep instead of strtok?
60
 
** Do not depend on GPG key rings on disk
61
 
   This would mean creating new GPG key rings with GPGME by importing
62
 
   the key files from scratch on every program start.
63
 
 
64
 
* Password-prompt
65
 
** [#A] Man page: man8/password-prompt.8mandos
66
 
*** DESCRIPTION
67
 
    Move options to new OPTIONS section.
68
 
*** EXIT STATUS
69
 
    Create this section
70
 
*** EXAMPLES
71
 
    Examples of normal usage, debug usage, with a prefix, etc.
72
 
*** DIAGNOSTICS
73
 
    Create this section
74
 
*** SECURITY
75
 
    Create this section
76
 
    Not much to do here but it is noteworthy to state the danger of
77
 
    not having a fallback option.
78
 
*** NOTES
79
 
    Note that this is more or less a simple getpass(3) wrapper, even
80
 
    though actual use of getpass(3) is not guaranteed.
81
 
*** BUGS
82
 
    Create this section
83
 
*** SEE ALSO
84
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
85
 
** Use getpass(3)?
86
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
87
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
88
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
89
 
   [[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?]]
90
 
** Replace completely with "/lib/cryptsetup/askpass"?
91
 
 
92
 
* Mandos (server)
93
 
** [#A] Command man page: man8/mandos.8
94
 
*** DESCRIPTION
95
 
    Move options to new OPTIONS section
96
 
*** EXIT STATUS
97
 
    Create this section
98
 
*** EXAMPLES
99
 
    Create this section
100
 
*** FILES
101
 
    Describe briefly that the server gets global settings from
102
 
    mandos.conf and clients from clients.conf, but refer to their man
103
 
    pages for more details.
104
 
*** DIAGNOSTICS
105
 
    Create this section
106
 
*** SECURITY
107
 
    Create this section
108
 
*** NOTES
109
 
    Create this section (if needed)
110
 
*** BUGS
111
 
    Create this section
112
 
*** SEE ALSO
113
 
    Refer to the client man page
114
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
115
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
116
 
** [#A] /etc/init.d/mandos-server               :teddy:
117
 
** Log level
118
 
** /etc/mandos/clients.d/*.conf
119
 
   Watch this directory and add/remove/update clients?
120
 
** config for TXT record
121
 
** Run-time communication with server
122
 
   Probably using D-Bus
123
 
   See also [[*Mandos-tools]]
124
 
** Implement --foreground
125
 
   [[info:standards:Option%20Table][Table of Long Options]]
126
 
** Implement --socket
127
 
   [[info:standards:Option%20Table][Table of Long Options]]
128
 
** Date+time on console log messages
129
 
   Is this the default?
130
 
 
131
 
* Mandos-tools/utilities
132
 
  All of this probably using D-Bus
133
 
** List clients
134
 
** Disable client
135
 
** Enable client
136
 
 
137
 
* Installer
138
 
** DONE [#A] Change initrd.img file to not be publically readable
139
 
   /etc/initramfs-tools/conf.d/mandos
140
 
   UMASK=027
141
 
** Update initrd.img after installation
142
 
** [#A] Create mandos user and group for server
143
 
** [#A] Create /var/run/mandos directory with perm and ownership
144
 
 
145
 
* [#A] Package
146
 
** /etc/bash_completion.d/mandos
 
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
 
43
 
 
44
* plugin-runner
 
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
 
49
 
 
50
* mandos (server)
 
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
147
118
** /usr/share/initramfs-tools/hooks/mandos
148
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
149
 
*** Create GPG key ring files in initrd
150
 
** unperish
151
 
** bzr-builddeb
152
 
 
153
 
* INSTALL file
154
 
 
155
 
* Web site
156
 
 
157
 
* Mailing list
158
 
 
159
 
* Announce project on news
160
 
  [[news:comp.os.linux.announce]]
 
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
 
123
   From XML sources directly?
 
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
161
128
 
162
129
 
163
130
#+STARTUP: showall