/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Teddy Hogeborn
  • Date: 2008-09-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): Improve wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
4
4
        -Wunsafe-loop-optimizations -Wpointer-arith \
5
5
        -Wbad-function-cast -Wcast-qual -Wcast-align -Wwrite-strings \
6
6
        -Wconversion -Wstrict-prototypes -Wold-style-definition \
7
 
        -Wpacked -Wnested-externs -Wunreachable-code -Winline \
8
 
        -Wvolatile-register-var
9
 
DEBUG=-ggdb3
 
7
        -Wpacked -Wnested-externs -Winline -Wvolatile-register-var
 
8
#       -Wunreachable-code 
 
9
#DEBUG=-ggdb3
10
10
# For info about _FORTIFY_SOURCE, see
11
11
# <http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html>
12
12
FORTIFY=-D_FORTIFY_SOURCE=2 # -fstack-protector-all
13
13
#COVERAGE=--coverage
14
14
OPTIMIZE=-Os
15
15
LANGUAGE=-std=gnu99
16
 
# PREFIX=/usr/local
17
 
PREFIX=/usr
18
 
# CONFDIR=/usr/local/lib/mandos
19
 
CONFDIR=/etc/mandos
20
 
# MANDIR=/usr/local/man
21
 
MANDIR=/usr/share/man
 
16
 
 
17
## Use these settings for a traditional /usr/local install
 
18
# PREFIX=$(DESTDIR)/usr/local
 
19
# CONFDIR=$(DESTDIR)/etc/mandos
 
20
# KEYDIR=$(DESTDIR)/etc/mandos/keys
 
21
# MANDIR=$(PREFIX)/man
 
22
# INITRAMFSTOOLS=$(DESTDIR)/etc/initramfs-tools
 
23
##
 
24
 
 
25
## These settings are for a package-type install
 
26
PREFIX=$(DESTDIR)/usr
 
27
CONFDIR=$(DESTDIR)/etc/mandos
 
28
KEYDIR=$(DESTDIR)/etc/keys/mandos
 
29
MANDIR=$(PREFIX)/share/man
 
30
INITRAMFSTOOLS=$(DESTDIR)/usr/share/initramfs-tools
 
31
##
 
32
 
 
33
GNUTLS_CFLAGS=$(shell libgnutls-config --cflags)
 
34
GNUTLS_LIBS=$(shell libgnutls-config --libs)
 
35
AVAHI_CFLAGS=$(shell pkg-config --cflags-only-I avahi-core)
 
36
AVAHI_LIBS=$(shell pkg-config --libs avahi-core)
 
37
GPGME_CFLAGS=$(shell gpgme-config --cflags)
 
38
GPGME_LIBS=$(shell gpgme-config --libs)
22
39
 
23
40
# Do not change these two
24
 
CFLAGS=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) $(OPTIMIZE) $(LANGUAGE)
 
41
CFLAGS=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) $(OPTIMIZE) \
 
42
        $(LANGUAGE) $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(GPGME_CFLAGS)
25
43
LDFLAGS=$(COVERAGE)
26
44
 
27
 
DOCBOOKTOMAN=xsltproc --nonet \
 
45
# Commands to format a DocBook <refentry> document into a manual page
 
46
DOCBOOKTOMAN=cd $(dir $<); xsltproc --nonet --xinclude \
28
47
        --param man.charmap.use.subset          0 \
29
48
        --param make.year.ranges                1 \
30
49
        --param make.single.year.ranges         1 \
31
50
        --param man.output.quietly              1 \
32
 
        --param man.authors.section.enabled     0
33
 
 
34
 
PLUGINS=plugins.d/password-prompt plugins.d/password-request
 
51
        --param man.authors.section.enabled     0 \
 
52
         /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
 
53
        $(notdir $<); \
 
54
        $(MANPOST) $(notdir $@)
 
55
# DocBook-to-man post-processing to fix a '\n' escape bug
 
56
MANPOST=sed --in-place --expression='s,\\\\en,\\en,g;s,\\n,\\en,g'
 
57
 
 
58
DOCBOOKTOHTML=xsltproc --nonet --xinclude \
 
59
        --param make.year.ranges                1 \
 
60
        --param make.single.year.ranges         1 \
 
61
        --param man.output.quietly              1 \
 
62
        --param man.authors.section.enabled     0 \
 
63
        --param citerefentry.link               1 \
 
64
        --output $@ \
 
65
        /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl \
 
66
        $<; $(HTMLPOST) $@
 
67
# Fix citerefentry links
 
68
HTMLPOST=sed --in-place --expression='s/\(<a class="citerefentry" href="\)\("><span class="citerefentry"><span class="refentrytitle">\)\([^<]*\)\(<\/span>(\)\([^)]*\)\()<\/span><\/a>\)/\1\3.\5\2\3\4\5\6/g'
 
69
 
 
70
PLUGINS=plugins.d/password-prompt plugins.d/mandos-client \
 
71
        plugins.d/usplash plugins.d/splashy plugins.d/askpass-fifo
35
72
PROGS=plugin-runner $(PLUGINS)
36
73
DOCS=mandos.8 plugin-runner.8mandos mandos-keygen.8 \
37
 
        plugins.d/password-request.8mandos \
 
74
        plugins.d/mandos-client.8mandos \
38
75
        plugins.d/password-prompt.8mandos mandos.conf.5 \
39
76
        mandos-clients.conf.5
40
77
 
41
 
objects=$(shell for p in $(PROGS); do echo $${p}.o; done)
 
78
htmldocs=$(addsuffix .xhtml,$(DOCS))
 
79
 
 
80
objects=$(addsuffix .o,$(PROGS))
42
81
 
43
82
all: $(PROGS)
44
83
 
45
84
doc: $(DOCS)
46
85
 
47
 
%.5: %.xml
48
 
        cd $(dir $^); $(DOCBOOKTOMAN) $(notdir $^)
49
 
 
50
 
%.8: %.xml
51
 
        cd $(dir $^); $(DOCBOOKTOMAN) $(notdir $^)
52
 
 
53
 
%.8mandos: %.xml
54
 
        cd $(dir $^); $(DOCBOOKTOMAN) $(notdir $^)
55
 
 
56
 
plugin-runner: plugin-runner.o
57
 
        $(LINK.o) -lgnutls $(COMMON) $^ $(LOADLIBES) $(LDLIBS) -o $@
58
 
 
59
 
plugins.d/password-request: plugins.d/password-request.o
60
 
        $(LINK.o) -lgnutls -lavahi-core -lgpgme $(COMMON) $^ \
61
 
                $(LOADLIBES) $(LDLIBS) -o $@
62
 
 
63
 
plugins.d/password-prompt: plugins.d/password-prompt.o
64
 
        $(LINK.o) $(COMMON) $^ $(LOADLIBES) $(LDLIBS) -o $@
65
 
 
66
 
.PHONY : all clean distclean run-client run-server install \
 
86
html: $(htmldocs)
 
87
 
 
88
%.5: %.xml legalnotice.xml
 
89
        $(DOCBOOKTOMAN)
 
90
%.5.xhtml: %.xml legalnotice.xml
 
91
        $(DOCBOOKTOHTML)
 
92
 
 
93
%.8: %.xml legalnotice.xml
 
94
        $(DOCBOOKTOMAN)
 
95
%.8.xhtml: %.xml legalnotice.xml
 
96
        $(DOCBOOKTOHTML)
 
97
 
 
98
%.8mandos: %.xml legalnotice.xml
 
99
        $(DOCBOOKTOMAN)
 
100
%.8mandos.xhtml: %.xml legalnotice.xml
 
101
        $(DOCBOOKTOHTML)
 
102
 
 
103
mandos.8: mandos.xml mandos-options.xml overview.xml legalnotice.xml
 
104
        $(DOCBOOKTOMAN)
 
105
mandos.8.xhtml: mandos.xml mandos-options.xml overview.xml \
 
106
                legalnotice.xml
 
107
        $(DOCBOOKTOHTML)
 
108
 
 
109
mandos-keygen.8: mandos-keygen.xml overview.xml legalnotice.xml
 
110
        $(DOCBOOKTOMAN)
 
111
mandos-keygen.8.xhtml: mandos-keygen.xml overview.xml legalnotice.xml
 
112
        $(DOCBOOKTOHTML)
 
113
 
 
114
mandos.conf.5: mandos.conf.xml mandos-options.xml legalnotice.xml
 
115
        $(DOCBOOKTOMAN)
 
116
mandos.conf.5.xhtml: mandos.conf.xml mandos-options.xml legalnotice.xml
 
117
        $(DOCBOOKTOHTML)
 
118
 
 
119
plugin-runner.8mandos: plugin-runner.xml overview.xml legalnotice.xml
 
120
        $(DOCBOOKTOMAN)
 
121
plugin-runner.8mandos.xhtml: plugin-runner.xml overview.xml \
 
122
                legalnotice.xml
 
123
        $(DOCBOOKTOHTML)
 
124
 
 
125
plugins.d/mandos-client.8mandos: plugins.d/mandos-client.xml \
 
126
                                        mandos-options.xml \
 
127
                                        overview.xml legalnotice.xml
 
128
        $(DOCBOOKTOMAN)
 
129
plugins.d/mandos-client.8mandos.xhtml: plugins.d/mandos-client.xml \
 
130
                                        mandos-options.xml \
 
131
                                        overview.xml legalnotice.xml
 
132
        $(DOCBOOKTOHTML)
 
133
 
 
134
plugins.d/mandos-client: plugins.d/mandos-client.o
 
135
        $(LINK.o) $(GNUTLS_LIBS) $(AVAHI_LIBS) $(GPGME_LIBS) \
 
136
                $(COMMON) $^ $(LOADLIBES) $(LDLIBS) -o $@
 
137
 
 
138
.PHONY : all doc html clean distclean run-client run-server install \
67
139
        install-server install-client uninstall uninstall-server \
68
140
        uninstall-client purge purge-server purge-client
69
141
 
70
142
clean:
71
 
        -rm --force $(PROGS) $(objects) $(DOCS) core
 
143
        -rm --force $(PROGS) $(objects) $(htmldocs) $(DOCS) core
72
144
 
73
145
distclean: clean
74
146
mostlyclean: clean
75
147
maintainer-clean: clean
76
 
        -rm --force --recursive keydir
 
148
        -rm --force --recursive keydir confdir
77
149
 
78
150
check:
79
151
        ./mandos --check
80
152
 
81
 
run-client: all
82
 
        -mkdir keydir
83
 
        -./mandos-keygen --dir keydir
 
153
# Run the client with a local config and key
 
154
run-client: all keydir/seckey.txt keydir/pubkey.txt
84
155
        ./plugin-runner --plugin-dir=plugins.d \
85
 
                --options-for=password-request:--keydir=keydir
86
 
 
87
 
run-server:
88
 
        ./mandos --debug --configdir=.
89
 
 
90
 
install: install-server install-client
 
156
                --config-file=plugin-runner.conf \
 
157
                --options-for=mandos-client:--seckey=keydir/seckey.txt,--pubkey=keydir/pubkey.txt
 
158
 
 
159
# Used by run-client
 
160
keydir/seckey.txt keydir/pubkey.txt: mandos-keygen
 
161
        install --directory keydir
 
162
        ./mandos-keygen --dir keydir --force
 
163
 
 
164
# Run the server with a local config
 
165
run-server: confdir/mandos.conf confdir/clients.conf
 
166
        ./mandos --debug --configdir=confdir
 
167
 
 
168
# Used by run-server
 
169
confdir/mandos.conf: mandos.conf
 
170
        install --directory confdir
 
171
        install --mode=u=rw,go=r $^ $@
 
172
confdir/clients.conf: clients.conf keydir/seckey.txt
 
173
        install --directory confdir
 
174
        install --mode=u=rw $< $@
 
175
# Add a client password
 
176
        ./mandos-keygen --dir keydir --password >> $@
 
177
 
 
178
install: install-server install-client-nokey
 
179
 
 
180
install-html: $(htmldocs)
 
181
        install --directory man
 
182
        install --mode=u=rw,go=r --target-directory=man $(htmldocs)
91
183
 
92
184
install-server: doc
93
 
        mkdir --mode=0755 --parents $(CONFDIR) $(MANDIR)/man5 \
94
 
                $(MANDIR)/man8
95
 
        install --mode=0755 mandos $(PREFIX)/sbin/mandos
96
 
        install --mode=0644 --target-directory=$(CONFDIR) mandos.conf
97
 
        install --mode=0640 --target-directory=$(CONFDIR) \
 
185
        install --directory $(CONFDIR)
 
186
        install --mode=u=rwx,go=rx mandos $(PREFIX)/sbin/mandos
 
187
        install --mode=u=rw,go=r --target-directory=$(CONFDIR) \
 
188
                mandos.conf
 
189
        install --mode=u=rw --target-directory=$(CONFDIR) \
98
190
                clients.conf
 
191
        install --mode=u=rwx,go=rx init.d-mandos \
 
192
                $(DESTDIR)/etc/init.d/mandos
 
193
        install --mode=u=rw,go=r default-mandos \
 
194
                $(DESTDIR)/etc/default/mandos
 
195
        if [ -z $(DESTDIR) ]; then \
 
196
                update-rc.d mandos defaults 25 15;\
 
197
        fi
99
198
        gzip --best --to-stdout mandos.8 \
100
199
                > $(MANDIR)/man8/mandos.8.gz
101
200
        gzip --best --to-stdout mandos.conf.5 \
103
202
        gzip --best --to-stdout mandos-clients.conf.5 \
104
203
                > $(MANDIR)/man5/mandos-clients.conf.5.gz
105
204
 
106
 
install-client: all doc /usr/share/initramfs-tools/hooks/.
107
 
        mkdir --mode=0755 --parents $(PREFIX)/lib/mandos $(CONFDIR) \
108
 
                $(MANDIR)/man8
109
 
        -mkdir --mode=0700 $(PREFIX)/lib/mandos/plugins.d
110
 
        chmod u=rwx,g=,o= $(PREFIX)/lib/mandos/plugins.d
111
 
        install --mode=0755 --target-directory=$(PREFIX)/lib/mandos \
112
 
                plugin-runner
113
 
        install --mode=0755 --target-directory=$(PREFIX)/sbin \
 
205
install-client-nokey: all doc
 
206
        install --directory $(PREFIX)/lib/mandos $(CONFDIR)
 
207
        install --directory --mode=u=rwx $(KEYDIR) \
 
208
                $(PREFIX)/lib/mandos/plugins.d
 
209
        if [ "$(CONFDIR)" != "$(PREFIX)/lib/mandos" ]; then \
 
210
                install --mode=u=rwx \
 
211
                        --directory "$(CONFDIR)/plugins.d"; \
 
212
        fi
 
213
        install --mode=u=rwx,go=rx \
 
214
                --target-directory=$(PREFIX)/lib/mandos plugin-runner
 
215
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
114
216
                mandos-keygen
115
 
        install --mode=0755 \
 
217
        install --mode=u=rwx,go=rx \
116
218
                --target-directory=$(PREFIX)/lib/mandos/plugins.d \
117
219
                plugins.d/password-prompt
118
 
        install --mode=4755 \
119
 
                --target-directory=$(PREFIX)/lib/mandos/plugins.d \
120
 
                plugins.d/password-request
 
220
        install --mode=u=rwxs,go=rx \
 
221
                --target-directory=$(PREFIX)/lib/mandos/plugins.d \
 
222
                plugins.d/mandos-client
 
223
        install --mode=u=rwxs,go=rx \
 
224
                --target-directory=$(PREFIX)/lib/mandos/plugins.d \
 
225
                plugins.d/usplash
 
226
        install --mode=u=rwxs,go=rx \
 
227
                --target-directory=$(PREFIX)/lib/mandos/plugins.d \
 
228
                plugins.d/splashy
 
229
        install --mode=u=rwxs,go=rx \
 
230
                --target-directory=$(PREFIX)/lib/mandos/plugins.d \
 
231
                plugins.d/askpass-fifo
121
232
        install initramfs-tools-hook \
122
 
                /usr/share/initramfs-tools/hooks/mandos
123
 
        install initramfs-tools-hook-conf \
124
 
                /usr/share/initramfs-tools/conf-hooks.d/mandos
 
233
                $(INITRAMFSTOOLS)/hooks/mandos
 
234
        install --mode=u=rw,go=r initramfs-tools-hook-conf \
 
235
                $(INITRAMFSTOOLS)/conf-hooks.d/mandos
125
236
        install initramfs-tools-script \
126
 
                /usr/share/initramfs-tools/scripts/local-top/mandos
 
237
                $(INITRAMFSTOOLS)/scripts/local-top/mandos
 
238
        install --mode=u=rw,go=r plugin-runner.conf $(CONFDIR)
127
239
        gzip --best --to-stdout mandos-keygen.8 \
128
240
                > $(MANDIR)/man8/mandos-keygen.8.gz
129
241
        gzip --best --to-stdout plugin-runner.8mandos \
130
242
                > $(MANDIR)/man8/plugin-runner.8mandos.gz
131
243
        gzip --best --to-stdout plugins.d/password-prompt.8mandos \
132
244
                > $(MANDIR)/man8/password-prompt.8mandos.gz
133
 
        gzip --best --to-stdout plugins.d/password-request.8mandos \
134
 
                > $(MANDIR)/man8/password-request.8mandos.gz
135
 
        -$(PREFIX)/sbin/mandos-keygen
 
245
        gzip --best --to-stdout plugins.d/mandos-client.8mandos \
 
246
                > $(MANDIR)/man8/mandos-client.8mandos.gz
 
247
 
 
248
install-client: install-client-nokey
 
249
# Post-installation stuff
 
250
        -$(PREFIX)/sbin/mandos-keygen --dir "$(KEYDIR)"
136
251
        update-initramfs -k all -u
 
252
        echo "Now run mandos-keygen --password --dir $(KEYDIR)"
137
253
 
138
254
uninstall: uninstall-server uninstall-client
139
255
 
140
 
uninstall-server: $(PREFIX)/sbin/mandos
 
256
uninstall-server:
141
257
        -rm --force $(PREFIX)/sbin/mandos \
142
258
                $(MANDIR)/man8/mandos.8.gz \
143
259
                $(MANDIR)/man5/mandos.conf.5.gz \
144
260
                $(MANDIR)/man5/mandos-clients.conf.5.gz
 
261
        update-rc.d -f mandos remove
145
262
        -rmdir $(CONFDIR)
146
263
 
147
264
uninstall-client:
148
265
# Refuse to uninstall client if /etc/crypttab is explicitly configured
149
266
# to use it.
150
267
        ! grep --regexp='^ *[^ #].*keyscript=[^,=]*/mandos/' \
151
 
                /etc/crypttab
 
268
                $(DESTDIR)/etc/crypttab
152
269
        -rm --force $(PREFIX)/sbin/mandos-keygen \
153
270
                $(PREFIX)/lib/mandos/plugin-runner \
154
271
                $(PREFIX)/lib/mandos/plugins.d/password-prompt \
155
 
                $(PREFIX)/lib/mandos/plugins.d/password-request \
156
 
                /usr/share/initramfs-tools/hooks/mandos \
157
 
                /usr/share/initramfs-tools/conf-hooks.d/mandos \
 
272
                $(PREFIX)/lib/mandos/plugins.d/mandos-client \
 
273
                $(PREFIX)/lib/mandos/plugins.d/usplash \
 
274
                $(PREFIX)/lib/mandos/plugins.d/splashy \
 
275
                $(INITRAMFSTOOLS)/hooks/mandos \
 
276
                $(INITRAMFSTOOLS)/conf-hooks.d/mandos \
 
277
                $(INITRAMFSTOOLS)/scripts/local-top/mandos \
158
278
                $(MANDIR)/man8/plugin-runner.8mandos.gz \
159
279
                $(MANDIR)/man8/mandos-keygen.8.gz \
160
280
                $(MANDIR)/man8/password-prompt.8mandos.gz \
161
 
                $(MANDIR)/man8/password-request.8mandos.gz
 
281
                $(MANDIR)/man8/mandos-client.8mandos.gz
 
282
        if [ "$(CONFDIR)" != "$(PREFIX)/lib/mandos" ]; then \
 
283
                rm --force $(CONFDIR)/plugins.d/README; \
 
284
        fi
162
285
        -rmdir $(PREFIX)/lib/mandos/plugins.d $(CONFDIR)/plugins.d \
163
 
                 $(PREFIX)/lib/mandos $(CONFDIR)
 
286
                 $(PREFIX)/lib/mandos $(CONFDIR) $(KEYDIR)
164
287
        update-initramfs -k all -u
165
288
 
166
289
purge: purge-server purge-client
167
290
 
168
291
purge-server: uninstall-server
169
 
        -rm --force $(CONFDIR)/mandos.conf $(CONFDIR)/clients.conf
 
292
        -rm --force $(CONFDIR)/mandos.conf $(CONFDIR)/clients.conf \
 
293
                $(DESTDIR)/etc/default/mandos \
 
294
                $(DESTDIR)/etc/init.d/mandos \
 
295
                $(DESTDIR)/var/run/mandos.pid
170
296
        -rmdir $(CONFDIR)
171
297
 
172
298
purge-client: uninstall-client
173
 
        -rm --force $(CONFDIR)/seckey.txt $(CONFDIR)/pubkey.txt
174
 
        -rmdir $(CONFDIR) $(CONFDIR)/plugins.d
 
299
        -shred --remove $(KEYDIR)/seckey.txt
 
300
        -rm --force $(CONFDIR)/plugin-runner.conf \
 
301
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt
 
302
        -rmdir $(KEYDIR) $(CONFDIR)/plugins.d $(CONFDIR)