/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

synopsis changed

Show diffs side-by-side

added added

removed removed

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