/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: 2008-08-17 22:42:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817224228-nhor2yuv230if01i
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
                           not rely on a stylesheet declaration.

* mandos.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
              refers to "overview.xml". Changed all single quotes to
              double quotes for consistency.
  (DESCRIPTION): Use the term "TLS" and not "GnuTLS" for the protocol.
                 Refer to the "OVERVIEW" section for reason for IPv6
                 link-local addresses.
  (PURPOSE): Shortened a lot.  Refer to "OVERVIEW" section for details.
  (OVERVIEW): New section.  Include &OVERVIEW; and add a paragraph
              about what the role of this program is.
  (SECURITY/CLIENTS): Refer to the "CHECKING" section for details on
                      checking.
  (SEE ALSO): Changed from an <itemizedlist> to a <variablelist>.
              Added a short text for each entry.  Removed reference to
              plugin-runner(8mandos).  Add reference to RFC 4291 and
              RFC 4346.

* overview.xml: New file, containing a single <para>.  The idea is to
                use this in all the man pages.

* plugins.d/password-request.c: Updated comments about spurious
                                warnings.

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]]
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] --dh-params=FILE
24
 
** TODO [#B] Use capabilities instead of seteuid().
25
 
   https://forums.grsecurity.net/viewtopic.php?f=7&t=2522
26
 
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
27
 
** TODO [#C] Make start_mandos_communication() take "struct server".
28
 
** TODO [#C] --interfaces=regex,eth*,noregex (bridge-utils-interfaces(5))
29
 
 
30
 
* splashy
31
 
** TODO [#B] use scandir(3) instead of readdir(3)
32
 
 
33
 
* usplash (Deprecated)
34
 
** TODO [#A] Make it work again
35
 
** TODO [#B] use scandir(3) instead of readdir(3)
36
 
 
37
 
* askpass-fifo
38
 
 
39
 
* password-prompt
40
 
** TODO [#B] lock stdin (with flock()?)
41
 
 
42
 
* plymouth
43
 
 
44
 
* TODO [#B] passdev
45
 
 
46
 
* plugin-runner
47
 
** TODO handle printing for errors for plugins
48
 
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
49
 
** TODO [#C] use same file name rules as run-parts(8)
50
 
** kernel command line option for debug info
51
 
 
52
 
* mandos (server)
53
 
** TODO [#B] Work around Avahi issue
54
 
   Avahi does not announce link-local addresses if any global
55
 
   addresses exist: http://lists.freedesktop.org/archives/avahi/2010-March/001863.html
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 [#A] 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 Support [[http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager][org.freedesktop.DBus.ObjectManager]] interface on server object :2:
81
 
   Deprecate methods GetAllClients(), GetAllClientsWithProperties()
82
 
   and signals ClientAdded and ClientRemoved.
83
 
** TODO Save state periodically to recover better from hard shutdowns
84
 
** TODO CheckerCompleted method, deprecate CheckedOK
85
 
** TODO Secret Service API?
86
 
   http://standards.freedesktop.org/secret-service/
87
 
** TODO Remove D-Bus interfaces with old domain name                      :2:
88
 
** TODO Remove old string_to_delta format                                    :2:
89
 
** TODO http://0pointer.de/blog/projects/stateless.html
90
 
*** tmpfiles snippet to create /var/lib/mandos with right user+perms
91
 
*** File in /usr/lib/sysusers.d to create user+group "_mandos"
92
 
** TODO Error handling on error parsing config files
93
 
** TODO init.d script error handling
94
 
** TODO D-Bus server properties; address, port, interface, etc.              :2:
95
 
** TODO [#C] In Python 3.3, use shlex.quote() instead of re.escape()
96
 
 
97
 
* mandos.xml
98
 
** Add mandos contact info in manual pages
99
 
 
100
 
* mandos-ctl
101
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
102
 
*** [#B] --dump option
103
 
** TODO Remove old string_to_delta format                                    :2:
104
 
 
105
 
* TODO mandos-dispatch
106
 
  Listens for specified D-Bus signals and spawns shell commands with
107
 
  arguments.
108
 
 
109
 
* mandos-monitor
110
 
** TODO help should be toggleable
111
 
** Urwid client data displayer
112
 
   Better view of client data in the listing
113
 
*** Properties popup
114
 
** Print a nice "We are sorry" message, save stack trace to log.
115
 
** Rename module "gobject" to "GObject".
116
 
 
117
 
* mandos-keygen
118
 
** TODO "--secfile" option
119
 
   Using the "secfile" option instead of "secret"
120
 
** TODO [#B] "--test" option
121
 
   For testing decryption before rebooting.
122
 
 
123
 
* 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
*** EXIT STATUS
 
11
    Text needed
 
12
*** EXAMPLES
 
13
    Examples of normal usage, debug usage, debugging single or all
 
14
    plugins, etc.
 
15
*** FILES
 
16
    Text needed
 
17
*** SECURITY
 
18
    Text needed
 
19
*** BUGS
 
20
    Text needed
 
21
*** SEE ALSO
 
22
    Explaining text on what you can read
 
23
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
24
   Must create in preinst if not pre-depending on cryptsetup
 
25
 
 
26
* Password-request
 
27
** [#A] Man page: man8/password-request.8mandos
 
28
** [#B] Temporarily lower kernel log level
 
29
   for less printouts during sucessfull boot.
 
30
*** DESCRIPTION
 
31
    Move options to new OPTIONS section.
 
32
    State that this command is not meant to be invoked directly, but
 
33
    is run as a plugin from mandos-client(8) and only run in the
 
34
    initrd environment, not the real system.
 
35
*** EXIT STATUS
 
36
    Create this section
 
37
*** EXAMPLES
 
38
    Examples of normal usage, debug usage, debugging by connecting
 
39
    directly, etc.
 
40
*** FILES
 
41
    Describe the key files and the key ring files.  Also note that
 
42
    they should normally have been automatically created.
 
43
*** DIAGNOSTICS
 
44
    Create this section
 
45
*** SECURITY
 
46
    Create this section
 
47
*** BUGS
 
48
    Create this section
 
49
*** SEE ALSO
 
50
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
51
*** ENVIRONMENT
 
52
    Document use of "cryptsource" and "crypttarget".
 
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
 
 
59
* Password-prompt
 
60
** [#A] Man page: man8/password-prompt.8mandos
 
61
*** DESCRIPTION
 
62
    Move options to new OPTIONS section.
 
63
    Note that this is more or less a simple getpass(3) wrapper, even
 
64
    though actual use of getpass(3) is not guaranteed.
 
65
*** EXIT STATUS
 
66
    Create this section
 
67
*** EXAMPLES
 
68
    Examples of normal usage, debug usage, with a prefix, etc.
 
69
*** DIAGNOSTICS
 
70
    Create this section
 
71
*** SECURITY
 
72
    Create this section
 
73
    Not much to do here but it is noteworthy to state the danger of
 
74
    not having a fallback option.
 
75
*** BUGS
 
76
    Create this section
 
77
*** SEE ALSO
 
78
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
79
** Use getpass(3)?
 
80
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
81
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
82
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
83
   [[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?]]
 
84
 
 
85
* Mandos (server)
 
86
** [#A] Command man page: man8/mandos.8
 
87
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
88
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
89
** [#A] /etc/init.d/mandos-server               :teddy:
 
90
** Log level
 
91
** /etc/mandos/clients.d/*.conf
 
92
   Watch this directory and add/remove/update clients?
 
93
** config for TXT record
 
94
** Run-time communication with server
 
95
   Probably using D-Bus
 
96
   See also [[*Mandos-tools]]
 
97
** Implement --foreground
 
98
   [[info:standards:Option%20Table][Table of Long Options]]
 
99
** Implement --socket
 
100
   [[info:standards:Option%20Table][Table of Long Options]]
 
101
** Date+time on console log messages
 
102
   Is this the default?
 
103
 
 
104
* Mandos-tools/utilities
 
105
  All of this probably using D-Bus
 
106
** List clients
 
107
** Disable client
 
108
** Enable client
 
109
 
 
110
* Installer
 
111
** Client
 
112
*** DONE [#A] Change initrd.img file to not be publically readable
 
113
    /usr/share/initramfs-tools/conf-hooks.d/mandos
 
114
    UMASK=027
 
115
*** Update initrd.img after installation
 
116
** Server
 
117
*** [#A] Create mandos user and group for server
 
118
*** [#A] Create /var/run/mandos directory with perm and ownership
 
119
 
 
120
** mandos-keygen
 
121
*** [#A] Command man page: man8/mandos-keygen.8
 
122
**** EXIT STATUS
 
123
**** FILES
 
124
**** BUGS
 
125
**** EXAMPLES
 
126
**** SECURITY
 
127
*** [#A] Output cut-and-paste ready snippet for clients.conf.
 
128
 
 
129
* [#A] Package
124
130
** /usr/share/initramfs-tools/hooks/mandos
125
 
*** TODO [#C] use same file name rules as run-parts(8)
126
 
*** TODO [#C] Do not install in initrd.img if configured not to.
127
 
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
128
 
** TODO [#C] /etc/bash_completion.d/mandos
129
 
   From XML sources directly?
130
 
 
131
 
* Side Stuff
132
 
** TODO Locate which package moves the other bin/sh when busybox is deactivated
133
 
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
131
*** Do not install in initrd.img if configured not to.
 
132
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
133
    question.
 
134
** /etc/bash_completion.d/mandos
 
135
*** From XML sources directly?
 
136
** unperish
 
137
** bzr-builddeb
 
138
 
 
139
* INSTALL file
 
140
 
 
141
* Web site
 
142
 
 
143
* Mailing list
 
144
 
 
145
* Announce project on news
 
146
  [[news:comp.os.linux.announce]]
134
147
 
135
148
 
136
149
#+STARTUP: showall