/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: 2016-02-21 14:24:01 UTC
  • Revision ID: teddy@recompile.se-20160221142401-j7glu6a2hg604d1e
Use AddressSanitizer and UndefinedBehaviorSanitizer.

* Makefile (SANITIZE): New; set to all sanitizing options depending on
                       GCC version.
  (CFLAGS): Added "$(SANITIZE)".

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 --server option which only adds to the server list.
 
24
   (Unlike --connect, which implicitly disables zeroconf.)
 
25
** TODO [#B] Use capabilities instead of seteuid().
 
26
   https://forums.grsecurity.net/viewtopic.php?f=7&t=2522
 
27
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
 
28
** TODO [#C] Make start_mandos_communication() take "struct server".
 
29
** TODO [#C] --interfaces=regex,eth*,noregex (bridge-utils-interfaces(5))
 
30
** TODO [#C] Remove code for GNU libc < 2.15
 
31
 
 
32
* splashy
 
33
** TODO [#B] use scandir(3) instead of readdir(3)
 
34
 
 
35
* usplash (Deprecated)
 
36
** TODO [#B] Make it work again
 
37
** TODO [#B] use scandir(3) instead of readdir(3)
 
38
 
 
39
* askpass-fifo
 
40
 
 
41
* password-prompt
 
42
** TODO [#B] lock stdin (with flock()?)
 
43
 
 
44
* plymouth
 
45
 
 
46
* TODO [#B] passdev
4
47
 
5
48
* 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?]]
 
49
** TODO handle printing for errors for plugins
 
50
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
51
** TODO [#C] use same file name rules as run-parts(8)
 
52
** kernel command line option for debug info
 
53
** TODO [#C] Remove code for GNU libc < 2.15
67
54
 
68
55
* 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
 
** Use xinclude for common sections
92
 
   Like copyright, authors, etc.
93
 
 
94
 
 
95
 
* Installer
96
 
** Client-side
97
 
*** Update initrd.img after installation
98
 
    This seems to use some kind of "trigger" system
99
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
100
 
    dpkg-trigger(1), deb-triggers(5)
101
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
102
 
    Must create in preinst if not pre-depending on cryptsetup
103
 
*** mandos-keygen
104
 
**** "--passfile" option
105
 
     Using the "secfile" option instead of "secret"
106
 
**** [#A] "--test" option
107
 
     For testing decryption before rebooting.
108
 
** Server-side
109
 
*** [#A] Create mandos user and group for server
110
 
*** [#A] Create /var/run/mandos directory with perm and ownership
111
 
 
112
 
* [#A] Package
 
56
** TODO [#B] --notify-command
 
57
   This would allow the mandos.service to use
 
58
   --notify-command="systemd-notify --pid READY=1"
 
59
** TODO [#B] Log level                                                    :BUGS:
 
60
*** TODO /etc/mandos/clients.d/*.conf
 
61
    Watch this directory and add/remove/update clients?
 
62
** TODO [#C] config for TXT record
 
63
** TODO Log level dbus option
 
64
   SetLogLevel D-Bus call
 
65
** TODO [#C] DBusServiceObjectUsingSuper
 
66
** TODO [#B] Global enable/disable flag
 
67
** TODO [#B] By-client countdown on number of secrets given
 
68
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
69
    + SetPass(u"gazonk", True) -> Approval, persistent
 
70
    + Approve(False) -> Close client connection immediately
 
71
** TODO [#C] python-parsedatetime
 
72
** TODO Separate logging logic to own object
 
73
** TODO [#B] 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
** TODO D-Bus AddClient() method on server object
 
79
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
80
** TODO Save state periodically to recover better from hard shutdowns
 
81
** TODO CheckerCompleted method, deprecate CheckedOK
 
82
** TODO Secret Service API?
 
83
   http://standards.freedesktop.org/secret-service/
 
84
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
85
** TODO Remove old string_to_delta format                                    :2:
 
86
** TODO http://0pointer.de/blog/projects/stateless.html
 
87
*** tmpfiles snippet to create /var/lib/mandos with right user+perms
 
88
*** File in /usr/lib/sysusers.d to create user+group "_mandos"
 
89
** TODO Error handling on error parsing config files
 
90
** TODO init.d script error handling
 
91
** TODO D-Bus server properties; address, port, interface, etc.              :2:
 
92
** TODO [#C] In Python 3.3, use shlex.quote() instead of re.escape()
 
93
 
 
94
* mandos.xml
 
95
** Add mandos contact info in manual pages
 
96
 
 
97
* mandos-ctl
 
98
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
99
*** [#B] --dump option
 
100
** TODO Remove old string_to_delta format                                    :2:
 
101
 
 
102
* TODO mandos-dispatch
 
103
  Listens for specified D-Bus signals and spawns shell commands with
 
104
  arguments.
 
105
 
 
106
* mandos-monitor
 
107
** TODO help should be toggleable
 
108
** Urwid client data displayer
 
109
   Better view of client data in the listing
 
110
*** Properties popup
 
111
** Print a nice "We are sorry" message, save stack trace to log.
 
112
** Rename module "gobject" to "GObject".
 
113
 
 
114
* mandos-keygen
 
115
** TODO "--secfile" option
 
116
   Using the "secfile" option instead of "secret"
 
117
** TODO [#B] "--test" option
 
118
   For testing decryption before rebooting.
 
119
 
 
120
* Package
113
121
** /usr/share/initramfs-tools/hooks/mandos
114
 
*** Do not install in initrd.img if configured not to.
115
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
116
 
    question.
117
 
** /etc/bash_completion.d/mandos
 
122
*** TODO [#C] use same file name rules as run-parts(8)
 
123
*** TODO [#C] Do not install in initrd.img if configured not to.
 
124
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
125
** TODO [#C] $(pkg-config --variable=completionsdir bash-completion)
118
126
   From XML sources directly?
119
 
** unperish
120
 
** bzr-builddeb
121
 
 
122
 
* INSTALL file
123
 
 
124
 
* Web site
125
 
 
126
 
* Mailing list
127
 
 
128
 
* Announce project on news
129
 
  [[news:comp.os.linux.announce]]
 
127
 
 
128
* Side Stuff
 
129
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
130
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
130
131
 
131
132
 
132
133
#+STARTUP: showall