/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-11-26 23:21:16 UTC
  • Revision ID: teddy@recompile.se-20161126232116-nhqk9x1qij09b7cx
Add comment in documentation source with clarifying text.

* intro.xml (INTRODUCTION): Add comment with clarification.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
 
* Plugin-runner
6
 
** [#A] Free plugin name and args
7
 
   [[file:plugin-runner.c::free%20plugin_list][file:plugin-runner.c::free plugin_list]] (both places)
8
 
** [#A] Change syntax for arguments
9
 
** [#B] Add more comments to code
10
 
** [#B] Add more if(debug) calls
11
 
** [#B] Seperate more code to function for more readability
12
 
** [#B] Make free_plugin_list() function
13
 
** [#A] Man page: man8/plugin-runner.8mandos
14
 
*** DESCRIPTION
15
 
    Describe the plus sign syntax for passing options from crypttab
16
 
*** EXIT STATUS
17
 
    Text needed
18
 
*** EXAMPLES
19
 
    Examples of normal usage, debug usage, debugging single or all
20
 
    plugins, examples of crypttab lines with plus syntax, etc.
21
 
*** FILES
22
 
    Text needed
23
 
*** SECURITY
24
 
    Text needed
25
 
*** NOTES
26
 
    Text needed
27
 
*** BUGS
28
 
    Text needed
29
 
*** SEE ALSO
30
 
    Explaining test on what you can read
31
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
32
 
   Must create in preinst if not pre-depending on cryptsetup
33
 
 
34
 
* Password-request
35
 
** [#A] Man page: man8/password-request.8mandos
36
 
** [#B] Temporarily lower kernel log level
37
 
   for less printouts during sucessfull boot.
38
 
*** DESCRIPTION
39
 
    Move options to new OPTIONS section.
40
 
    State that this command is not meant to be invoked directly, but
41
 
    is run as a plugin from mandos-client(8) and only run in the
42
 
    initrd environment, not the real system.
43
 
*** EXIT STATUS
44
 
    Create this section
45
 
*** EXAMPLES
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** FILES
49
 
    Describe the key files and the key ring files.  Also note that
50
 
    they should normally have been automatically created.
51
 
*** DIAGNOSTICS
52
 
    Create this section
53
 
*** SECURITY
54
 
    Create this section
55
 
*** NOTES
56
 
    Create this section (if needed)
57
 
*** BUGS
58
 
    Create this section
59
 
*** SEE ALSO
60
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
61
 
*** ENVIRONMENT
62
 
    Document use of "cryptsource" and "crypttarget".
63
 
** IPv4 support
64
 
** use strsep instead of strtok?
65
 
** Do not depend on GnuPG key rings on disk
66
 
   This would mean creating new GnuPG key rings with GPGME by
67
 
   importing the key files from scratch on every program start.
68
 
 
69
 
* Password-prompt
70
 
** [#A] Man page: man8/password-prompt.8mandos
71
 
** Show getenv("cryptsource") and getenv("crypttarget") if set
72
 
   cryptsource will be the device, like "/dev/sda3", and crypttarget
73
 
   will be the device mapper name, like "sda3_crypt".
74
 
*** DESCRIPTION
75
 
    Move options to new OPTIONS section.
76
 
*** EXIT STATUS
77
 
    Create this section
78
 
*** EXAMPLES
79
 
    Examples of normal usage, debug usage, with a prefix, etc.
80
 
*** DIAGNOSTICS
81
 
    Create this section
82
 
*** SECURITY
83
 
    Create this section
84
 
    Not much to do here but it is noteworthy to state the danger of
85
 
    not having a fallback option.
86
 
*** NOTES
87
 
    Note that this is more or less a simple getpass(3) wrapper, even
88
 
    though actual use of getpass(3) is not guaranteed.
89
 
*** BUGS
90
 
    Create this section
91
 
*** SEE ALSO
92
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
93
 
** Use getpass(3)?
94
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
95
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
96
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
97
 
   [[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?]]
98
 
** Replace completely with "/lib/cryptsetup/askpass"?
99
 
 
100
 
* Mandos (server)
101
 
** [#A] Command man page: man8/mandos.8
102
 
*** DESCRIPTION
103
 
    Move options to new OPTIONS section
104
 
*** EXIT STATUS
105
 
    Create this section
106
 
*** EXAMPLES
107
 
    Create this section
108
 
*** FILES
109
 
    Describe briefly that the server gets global settings from
110
 
    mandos.conf and clients from clients.conf, but refer to their man
111
 
    pages for more details.
112
 
*** DIAGNOSTICS
113
 
    Create this section
114
 
*** SECURITY
115
 
    Create this section
116
 
*** NOTES
117
 
    Create this section (if needed)
118
 
*** BUGS
119
 
    Create this section
120
 
*** SEE ALSO
121
 
    Refer to the client man page
122
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
123
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
124
 
** [#A] /etc/init.d/mandos-server               :teddy:
125
 
** Log level
126
 
** /etc/mandos/clients.d/*.conf
127
 
   Watch this directory and add/remove/update clients?
128
 
** config for TXT record
129
 
** Run-time communication with server
130
 
   Probably using D-Bus
131
 
   See also [[*Mandos-tools]]
132
 
** Implement --foreground
133
 
   [[info:standards:Option%20Table][Table of Long Options]]
134
 
** Implement --socket
135
 
   [[info:standards:Option%20Table][Table of Long Options]]
136
 
** Date+time on console log messages
137
 
   Is this the default?
138
 
 
139
 
* Mandos-tools/utilities
140
 
  All of this probably using D-Bus
141
 
** List clients
142
 
** Disable client
143
 
** Enable client
144
 
 
145
 
* Installer
146
 
** Client
147
 
*** DONE [#A] Change initrd.img file to not be publically readable
148
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
149
 
    UMASK=027
150
 
*** Update initrd.img after installation
151
 
** Server
152
 
*** [#A] Create mandos user and group for server
153
 
*** [#A] Create /var/run/mandos directory with perm and ownership
154
 
 
155
 
** mandos-keygen
156
 
*** [#A] Command man page: man8/mandos-keygen.8
157
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
158
 
 
159
 
* [#A] Package
 
3
* Testing
 
4
** python-nemu
 
5
 
 
6
* mandos-applet
 
7
 
 
8
* mandos-client
 
9
** TODO A --server option which only adds to the server list.
 
10
   (Unlike --connect, which implicitly disables zeroconf.)
 
11
** TODO [#B] Use capabilities instead of seteuid().
 
12
   https://forums.grsecurity.net/viewtopic.php?f=7&t=2522
 
13
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
 
14
** TODO [#C] Make start_mandos_communication() take "struct server".
 
15
** TODO [#C] --interfaces=regex,eth*,noregex (bridge-utils-interfaces(5))
 
16
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
17
 
 
18
* splashy
 
19
** TODO [#B] use scandir(3) instead of readdir(3)
 
20
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
21
 
 
22
* usplash (Deprecated)
 
23
** TODO [#B] Make it work again
 
24
** TODO [#B] use scandir(3) instead of readdir(3)
 
25
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
26
 
 
27
* askpass-fifo
 
28
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
29
 
 
30
* password-prompt
 
31
** TODO [#B] lock stdin (with flock()?)
 
32
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
33
 
 
34
* plymouth
 
35
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
36
 
 
37
* TODO [#B] passdev
 
38
 
 
39
* plugin-runner
 
40
** TODO handle printing for errors for plugins
 
41
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
42
** TODO [#C] use same file name rules as run-parts(8)
 
43
** kernel command line option for debug info
 
44
** TODO [#A] Restart plugins which exit with EX_TEMPFAIL
 
45
 
 
46
* mandos (server)
 
47
** TODO [#B] --notify-command
 
48
   This would allow the mandos.service to use
 
49
   --notify-command="systemd-notify --pid --ready"
 
50
** TODO [#B] python-systemd
 
51
*** import systemd.daemon; systemd.daemon.notify()
 
52
** TODO [#B] Log level                                                    :BUGS:
 
53
*** TODO /etc/mandos/clients.d/*.conf
 
54
    Watch this directory and add/remove/update clients?
 
55
** TODO [#C] config for TXT record
 
56
** TODO Log level dbus option
 
57
   SetLogLevel D-Bus call
 
58
** TODO [#C] DBusServiceObjectUsingSuper
 
59
** TODO [#B] Global enable/disable flag
 
60
** TODO [#B] By-client countdown on number of secrets given
 
61
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
62
    + SetPass(u"gazonk", True) -> Approval, persistent
 
63
    + Approve(False) -> Close client connection immediately
 
64
** TODO [#C] python-parsedatetime
 
65
** TODO Separate logging logic to own object
 
66
** TODO [#B] Limit approval_delay to max gnutls/tls timeout value
 
67
** TODO [#B] break the wait on approval_delay if connection dies
 
68
** TODO Generate Client.runtime_expansions from client options + extra
 
69
** TODO Allow %%(checker)s as a runtime expansion
 
70
** TODO D-Bus AddClient() method on server object
 
71
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
72
** TODO Save state periodically to recover better from hard shutdowns
 
73
** TODO CheckerCompleted method, deprecate CheckedOK
 
74
** TODO Secret Service API?
 
75
   https://standards.freedesktop.org/secret-service/
 
76
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
77
** TODO Remove old string_to_delta format                                 :2:
 
78
** TODO http://0pointer.de/blog/projects/stateless.html
 
79
*** File in /usr/lib/sysusers.d to create user+group "_mandos"
 
80
** TODO Error handling on error parsing config files
 
81
** TODO init.d script error handling
 
82
** TODO D-Bus server properties; address, port, interface, etc.           :2:
 
83
** Python 3                                                               :2:
 
84
*** TODO [#C] In Python 3.3, use shlex.quote() instead of re.escape()
 
85
 
 
86
* mandos-ctl
 
87
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
88
** TODO Remove old string_to_delta format                                 :2:
 
89
 
 
90
* TODO mandos-dispatch
 
91
  Listens for specified D-Bus signals and spawns shell commands with
 
92
  arguments.
 
93
 
 
94
* mandos-monitor
 
95
** TODO --servicename                                                  :BUGS:
 
96
** TODO help should be toggleable
 
97
** Urwid client data displayer
 
98
   Better view of client data in the listing
 
99
*** Properties popup
 
100
** Print a nice "We are sorry" message, save stack trace to log.
 
101
 
 
102
* mandos-keygen
 
103
** TODO "--secfile" option
 
104
   Using the "secfile" option instead of "secret"
 
105
** TODO [#B] "--test" option
 
106
   For testing decryption before rebooting.
 
107
 
 
108
* Package
160
109
** /usr/share/initramfs-tools/hooks/mandos
161
 
*** Do not install in initrd.img if configured not to
162
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
163
 
    question.
164
 
** /etc/bash_completion.d/mandos
165
 
*** From xml sources directly?
166
 
** unperish
167
 
** bzr-builddeb
168
 
 
169
 
* INSTALL file
170
 
 
171
 
* Web site
172
 
 
173
 
* Mailing list
174
 
 
175
 
* Announce project on news
176
 
  [[news:comp.os.linux.announce]]
 
110
*** TODO [#C] use same file name rules as run-parts(8)
 
111
*** TODO [#C] Do not install in initrd.img if configured not to.
 
112
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
113
** TODO [#C] $(pkg-config --variable=completionsdir bash-completion)
 
114
   From XML sources directly?
 
115
 
 
116
* Side Stuff
 
117
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
118
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
119
 
 
120
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
177
121
 
178
122
 
179
123
#+STARTUP: showall