/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
1
-*- org -*-
2
54 by Teddy Hogeborn
Merge.
3
* [#A] README file
44 by Teddy Hogeborn
* ca.pem: Removed.
4
54 by Teddy Hogeborn
Merge.
5
* [#A] COPYING file
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
8
* Mandos-client
9
** [#A] Man page: man8/mandos-client.8mandos
55 by Teddy Hogeborn
* TODO: More notes.
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)
53 by Teddy Hogeborn
Merge.
38
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
39
** use strsep instead of strtok?
40
** use config file in addition to arguments
41
** pass things in environment, like device name, etc
55 by Teddy Hogeborn
* TODO: More notes.
42
** Fallback
43
   As a fallback, if no plugins can be found or if all of them failed,
44
   run getpass(3) itself.
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
45
46
* Password-request
47
** [#A] Man page: man8/password-request.8mandos
55 by Teddy Hogeborn
* TODO: More notes.
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)
53 by Teddy Hogeborn
Merge.
73
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
54 by Teddy Hogeborn
Merge.
74
** start_mandos_communication: loop around gnutls_handshake
75
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
44 by Teddy Hogeborn
* ca.pem: Removed.
76
** IPv4 support
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
77
** use strsep instead of strtok?
44 by Teddy Hogeborn
* ca.pem: Removed.
78
** Do not depend on GPG key rings on disk
79
   This would mean creating new GPG key rings with GPGME by importing
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
80
   the key files from scratch on every program start.
81
82
* Password-prompt
83
** [#A] Man page: man8/password-prompt.8mandos
55 by Teddy Hogeborn
* TODO: More notes.
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)
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
105
** Use getpass(3)?
53 by Teddy Hogeborn
Merge.
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?]]
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
110
55 by Teddy Hogeborn
* TODO: More notes.
111
* Mandos (server)
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
112
** [#A] Command man page: man8/mandos.8
55 by Teddy Hogeborn
* TODO: More notes.
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
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
135
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
136
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
53 by Teddy Hogeborn
Merge.
137
** [#A] /etc/init.d/mandos-server		:teddy:
44 by Teddy Hogeborn
* ca.pem: Removed.
138
** Log level
139
** /etc/mandos/clients.d/*.conf
140
   Watch this directory and add/remove/update clients?
141
** config for TXT record
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
142
** Run-time communication with server
53 by Teddy Hogeborn
Merge.
143
   Probably using D-Bus
144
   See also [[*Mandos-tools]]
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
145
** Implement --foreground
146
   [[info:standards:Option%20Table][Table of Long Options]]
147
** Implement --socket
148
   [[info:standards:Option%20Table][Table of Long Options]]
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
149
150
* Mandos-tools/utilities
151
  All of this probably using D-Bus
152
** List clients
53 by Teddy Hogeborn
Merge.
153
** Disable client
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
154
** Enable client
155
156
* Installer
55 by Teddy Hogeborn
* TODO: More notes.
157
** DONE [#A] Change initrd.img file to not be publically readable
54 by Teddy Hogeborn
Merge.
158
   /etc/initramfs-tools/conf.d/mandos
159
   UMASK=027
53 by Teddy Hogeborn
Merge.
160
** [#A] Create /etc/initramfs-tools/hooks/mandos
161
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
162
** [#A] Create GPG key ring files in initrd
50 by Teddy Hogeborn
* Makefile: Do DocBook manual conversion in a better way.
163
** [#A] Create mandos user and group for server
164
** [#A] Create /var/run/mandos directory with perm and ownership
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
165
55 by Teddy Hogeborn
* TODO: More notes.
166
* Package
167
** /etc/bash_completion.d/mandos
168
53 by Teddy Hogeborn
Merge.
169
* [[http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/][Software Release Practice HOWTO]]
170
36 by Teddy Hogeborn
* TODO: Converted to org-mode style
171

172
#+STARTUP: showall