/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

updated some partial manual pages

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