/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-08-18 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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