/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
 
* 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
 
    Text needed
12
 
*** EXAMPLES
13
 
    Examples of normal usage, debug usage, debugging single or all
14
 
    plugins, examples of crypttab lines with plus syntax, etc.
15
 
*** FILES
16
 
    Text needed
17
 
*** SECURITY
18
 
    Text needed
19
 
*** BUGS
20
 
    Text needed
21
 
*** SEE ALSO
22
 
    Explaining text on what you can read
23
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
24
 
   Must create in preinst if not pre-depending on cryptsetup
25
 
 
26
 
* Password-request
27
 
** [#A] Man page: man8/password-request.8mandos
28
 
** [#B] Temporarily lower kernel log level
29
 
   for less printouts during sucessfull boot.
30
 
*** DESCRIPTION
31
 
    Move options to new OPTIONS section.
32
 
    State that this command is not meant to be invoked directly, but
33
 
    is run as a plugin from mandos-client(8) and only run in the
34
 
    initrd environment, not the real system.
35
 
*** EXIT STATUS
36
 
    Create this section
37
 
*** EXAMPLES
38
 
    Examples of normal usage, debug usage, debugging by connecting
39
 
    directly, etc.
40
 
*** FILES
41
 
    Describe the key files and the key ring files.  Also note that
42
 
    they should normally have been automatically created.
43
 
*** DIAGNOSTICS
44
 
    Create this section
45
 
*** SECURITY
46
 
    Create this section
47
 
*** BUGS
48
 
    Create this section
49
 
*** SEE ALSO
50
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
51
 
*** ENVIRONMENT
52
 
    Document use of "cryptsource" and "crypttarget".
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
 
 
59
 
* Password-prompt
60
 
** [#A] Man page: man8/password-prompt.8mandos
61
 
*** DESCRIPTION
62
 
    Move options to new OPTIONS section.
63
 
    Note that this is more or less a simple getpass(3) wrapper, even
64
 
    though actual use of getpass(3) is not guaranteed.
65
 
*** EXIT STATUS
66
 
    Create this section
67
 
*** EXAMPLES
68
 
    Examples of normal usage, debug usage, with a prefix, etc.
69
 
*** DIAGNOSTICS
70
 
    Create this section
71
 
*** SECURITY
72
 
    Create this section
73
 
    Not much to do here but it is noteworthy to state the danger of
74
 
    not having a fallback option.
75
 
*** BUGS
76
 
    Create this section
77
 
*** SEE ALSO
78
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
79
 
** Use getpass(3)?
80
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
81
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
82
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
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?]]
84
 
 
85
 
* Mandos (server)
86
 
** [#A] Command man page: man8/mandos.8
87
 
*** EXAMPLES
88
 
    Create this section
89
 
*** FILES
90
 
    Describe briefly that the server gets global settings from
91
 
    mandos.conf and clients from clients.conf, but refer to their man
92
 
    pages for more details.
93
 
*** DIAGNOSTICS
94
 
    Create this section
95
 
*** SECURITY
96
 
    Create this section
97
 
*** BUGS
98
 
    Create this section
99
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
100
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
101
 
** [#A] /etc/init.d/mandos-server               :teddy:
102
 
** Log level
103
 
** /etc/mandos/clients.d/*.conf
104
 
   Watch this directory and add/remove/update clients?
105
 
** config for TXT record
106
 
** Run-time communication with server
107
 
   Probably using D-Bus
108
 
   See also [[*Mandos-tools]]
109
 
** Implement --foreground
110
 
   [[info:standards:Option%20Table][Table of Long Options]]
111
 
** Implement --socket
112
 
   [[info:standards:Option%20Table][Table of Long Options]]
113
 
** Date+time on console log messages
114
 
   Is this the default?
115
 
 
116
 
* Mandos-tools/utilities
117
 
  All of this probably using D-Bus
118
 
** List clients
119
 
** Disable client
120
 
** Enable client
121
 
 
122
 
* Installer
123
 
** Client
124
 
*** DONE [#A] Change initrd.img file to not be publically readable
125
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
126
 
    UMASK=027
127
 
*** Update initrd.img after installation
128
 
** Server
129
 
*** [#A] Create mandos user and group for server
130
 
*** [#A] Create /var/run/mandos directory with perm and ownership
131
 
 
132
 
** mandos-keygen
133
 
*** [#A] Command man page: man8/mandos-keygen.8
134
 
**** EXIT STATUS
135
 
**** FILES
136
 
**** BUGS
137
 
**** EXAMPLES
138
 
**** SECURITY
139
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
140
 
 
141
 
* [#A] Package
 
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
142
118
** /usr/share/initramfs-tools/hooks/mandos
143
 
*** Do not install in initrd.img if configured not to.
144
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
145
 
    question.
146
 
** /etc/bash_completion.d/mandos
147
 
*** From XML sources directly?
148
 
** unperish
149
 
** bzr-builddeb
150
 
 
151
 
* INSTALL file
152
 
 
153
 
* Web site
154
 
 
155
 
* Mailing list
156
 
 
157
 
* Announce project on news
158
 
  [[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
159
128
 
160
129
 
161
130
#+STARTUP: showall