/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-07-06 20:14:45 UTC
  • Revision ID: teddy@recompile.se-20150706201445-kq3o6qozigmiqsp9
plugin-runner.xml (EXAMPLE): Use the /usr/lib/<arch> directory.
                             Also explain used options in order.

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]] [[https://news.ycombinator.com/item?id=9661349][On undoing, fixing, or removing commits in git]]
 
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 [#A] --dh-params=FILE
 
24
** TODO [#B] Use capabilities instead of seteuid().
 
25
   https://forums.grsecurity.net/viewtopic.php?f=7&t=2522
 
26
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
 
27
** TODO [#C] Make start_mandos_communication() take "struct server".
 
28
** TODO [#C] --interfaces=regex,eth*,noregex (bridge-utils-interfaces(5))
 
29
** TODO [#C] Remove code for GNU libc < 2.15
 
30
 
 
31
* splashy
 
32
** TODO [#B] use scandir(3) instead of readdir(3)
 
33
 
 
34
* usplash (Deprecated)
 
35
** TODO [#A] Make it work again
 
36
** TODO [#B] use scandir(3) instead of readdir(3)
 
37
 
 
38
* askpass-fifo
 
39
 
 
40
* password-prompt
 
41
** TODO [#B] lock stdin (with flock()?)
 
42
 
 
43
* plymouth
 
44
 
 
45
* TODO [#B] passdev
4
46
 
5
47
* 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
 
** [#A] Man page: man8/password-prompt.8mandos
63
 
*** SYNOPSIS
64
 
    Document short options
65
 
*** DESCRIPTION
66
 
    Note that this is more or less a simple getpass(3) wrapper, even
67
 
    though actual use of getpass(3) is not guaranteed.
68
 
*** EXIT STATUS
69
 
*** ENVIRONMENT
70
 
    Document use of "cryptsource" and "crypttarget".
71
 
*** FILES
72
 
*** BUGS
73
 
*** EXAMPLE
74
 
    Examples of normal usage, debug usage, with a prefix, etc.
75
 
*** SECURITY
76
 
    Not much to do here but it is noteworthy to state the danger of
77
 
    not having a fallback option.
78
 
*** SEE ALSO
79
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
80
 
    and also, perhaps, to cryptsetup(8)?
81
 
** Use getpass(3)?
82
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
83
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
84
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
85
 
   [[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?]]
 
48
** TODO handle printing for errors for plugins
 
49
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
50
** TODO [#C] use same file name rules as run-parts(8)
 
51
** kernel command line option for debug info
 
52
** TODO [#C] Remove code for GNU libc < 2.15
86
53
 
87
54
* mandos (server)
88
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
89
 
*** For option "secret", document which program can help generate it.
90
 
** [#A] /etc/init.d/mandos-server               :teddy:
91
 
** [#B] Log level                               :bugs:
92
 
** /etc/mandos/clients.d/*.conf
93
 
   Watch this directory and add/remove/update clients?
94
 
** config for TXT record
95
 
** [#B] Run-time communication with server      :bugs:
96
 
   Probably using D-Bus
97
 
   See also [[*Mandos-tools]]
98
 
** Implement --foreground                       :bugs:
99
 
   [[info:standards:Option%20Table][Table of Long Options]]
100
 
** Implement --socket
101
 
   [[info:standards:Option%20Table][Table of Long Options]]
102
 
** Date+time on console log messages            :bugs:
103
 
   Is this the default?
104
 
 
105
 
* Mandos-tools/utilities
106
 
  All of this probably using D-Bus
107
 
** List clients
108
 
** Disable client
109
 
** Enable client
110
 
 
111
 
* Installer
112
 
** Client-side
113
 
*** Update initrd.img after installation
114
 
    This seems to use some kind of "trigger" system
115
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
116
 
    Must create in preinst if not pre-depending on cryptsetup
117
 
*** mandos-keygen
118
 
**** [#A] "--test" option
119
 
     For testing decryption before rebooting.
120
 
** Server-side
121
 
*** [#A] Create mandos user and group for server
122
 
*** [#A] Create /var/run/mandos directory with perm and ownership
123
 
 
124
 
* [#A] Package
 
55
** TODO [#B] Work around Avahi issue
 
56
   Avahi does not announce link-local addresses if any global
 
57
   addresses exist: http://lists.freedesktop.org/archives/avahi/2010-March/001863.html
 
58
** TODO [#B] --notify-command
 
59
   This would allow the mandos.service to use
 
60
   --notify-command="systemd-notify --pid READY=1"
 
61
** TODO [#B] Log level                                                    :BUGS:
 
62
*** TODO /etc/mandos/clients.d/*.conf
 
63
    Watch this directory and add/remove/update clients?
 
64
** TODO [#C] config for TXT record
 
65
** TODO Log level dbus option
 
66
   SetLogLevel D-Bus call
 
67
** TODO [#C] DBusServiceObjectUsingSuper
 
68
** TODO [#B] Global enable/disable flag
 
69
** TODO [#B] By-client countdown on number of secrets given
 
70
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
71
    + SetPass(u"gazonk", True) -> Approval, persistent
 
72
    + Approve(False) -> Close client connection immediately
 
73
** TODO [#C] python-parsedatetime
 
74
** TODO Separate logging logic to own object
 
75
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
 
76
** TODO [#B] break the wait on approval_delay if connection dies
 
77
** TODO Generate Client.runtime_expansions from client options + extra
 
78
** TODO Allow %%(checker)s as a runtime expansion
 
79
** TODO Use python-tlslite?
 
80
** TODO D-Bus AddClient() method on server object
 
81
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
82
** TODO Support [[http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager][org.freedesktop.DBus.ObjectManager]] interface on server object :2:
 
83
   Deprecate methods GetAllClients(), GetAllClientsWithProperties()
 
84
   and signals ClientAdded and ClientRemoved.
 
85
** TODO Save state periodically to recover better from hard shutdowns
 
86
** TODO CheckerCompleted method, deprecate CheckedOK
 
87
** TODO Secret Service API?
 
88
   http://standards.freedesktop.org/secret-service/
 
89
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
90
** TODO Remove old string_to_delta format                                    :2:
 
91
** TODO http://0pointer.de/blog/projects/stateless.html
 
92
*** tmpfiles snippet to create /var/lib/mandos with right user+perms
 
93
*** File in /usr/lib/sysusers.d to create user+group "_mandos"
 
94
** TODO Error handling on error parsing config files
 
95
** TODO init.d script error handling
 
96
** TODO D-Bus server properties; address, port, interface, etc.              :2:
 
97
** TODO [#C] In Python 3.3, use shlex.quote() instead of re.escape()
 
98
** TODO [#A] USe systemd Type=dbus
 
99
 
 
100
* mandos.xml
 
101
** Add mandos contact info in manual pages
 
102
 
 
103
* mandos-ctl
 
104
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
105
*** [#B] --dump option
 
106
** TODO Remove old string_to_delta format                                    :2:
 
107
 
 
108
* TODO mandos-dispatch
 
109
  Listens for specified D-Bus signals and spawns shell commands with
 
110
  arguments.
 
111
 
 
112
* mandos-monitor
 
113
** TODO help should be toggleable
 
114
** Urwid client data displayer
 
115
   Better view of client data in the listing
 
116
*** Properties popup
 
117
** Print a nice "We are sorry" message, save stack trace to log.
 
118
** Rename module "gobject" to "GObject".
 
119
 
 
120
* mandos-keygen
 
121
** TODO "--secfile" option
 
122
   Using the "secfile" option instead of "secret"
 
123
** TODO [#B] "--test" option
 
124
   For testing decryption before rebooting.
 
125
 
 
126
* Package
125
127
** /usr/share/initramfs-tools/hooks/mandos
126
 
*** Do not install in initrd.img if configured not to.
127
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
128
 
    question.
129
 
** /etc/bash_completion.d/mandos
 
128
*** TODO [#C] use same file name rules as run-parts(8)
 
129
*** TODO [#C] Do not install in initrd.img if configured not to.
 
130
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
131
** TODO [#C] $(pkg-config --variable=completionsdir bash-completion)
130
132
   From XML sources directly?
131
 
** unperish
132
 
** bzr-builddeb
133
 
 
134
 
* INSTALL file
135
 
 
136
 
* Web site
137
 
 
138
 
* Mailing list
139
 
 
140
 
* Announce project on news
141
 
  [[news:comp.os.linux.announce]]
 
133
 
 
134
* Side Stuff
 
135
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
136
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
142
137
 
143
138
 
144
139
#+STARTUP: showall