/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-08-25 17:37:05 UTC
  • Revision ID: teddy@recompile.se-20160825173705-q2v6lban8ph9uw75
PEP8 compliance: mandos

* mandos: Add PEP8 compliance (as per the "pycodestyle" tool).

Show diffs side-by-side

added added

removed removed

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