/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 Makefile

  • Committer: Teddy Hogeborn
  • Date: 2019-07-25 22:44:36 UTC
  • Revision ID: teddy@recompile.se-20190725224436-19eyd06r7qmtowo6
Allow line breaks on long lines in plugin-runner manual

* debian/mandos-client.lintian-overrides
  (manpage-has-errors-from-man): Remove.
* plugin-runner.xml (EXAMPLE): Allow line breaks by adding ZERO WIDTH
                               SPACE characters.  Also correct
                               description of example command line.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
WARN=-O -Wall -Wformat=2 -Winit-self -Wmissing-include-dirs \
2
 
        -Wswitch-default -Wswitch-enum -Wunused-parameter \
3
 
        -Wstrict-aliasing=1 -Wextra -Wfloat-equal -Wundef -Wshadow \
 
1
WARN:=-O -Wall -Wextra -Wdouble-promotion -Wformat=2 -Winit-self \
 
2
        -Wmissing-include-dirs -Wswitch-default -Wswitch-enum \
 
3
        -Wunused -Wuninitialized -Wstrict-overflow=5 \
 
4
        -Wsuggest-attribute=pure -Wsuggest-attribute=const \
 
5
        -Wsuggest-attribute=noreturn -Wfloat-equal -Wundef -Wshadow \
4
6
        -Wunsafe-loop-optimizations -Wpointer-arith \
5
7
        -Wbad-function-cast -Wcast-qual -Wcast-align -Wwrite-strings \
6
 
        -Wconversion -Wstrict-prototypes -Wold-style-definition \
7
 
        -Wpacked -Wnested-externs -Winline -Wvolatile-register-var \
8
 
        -Wunreachable-code
9
 
#DEBUG=-ggdb3
 
8
        -Wconversion -Wlogical-op -Waggregate-return \
 
9
        -Wstrict-prototypes -Wold-style-definition \
 
10
        -Wmissing-format-attribute -Wnormalized=nfc -Wpacked \
 
11
        -Wredundant-decls -Wnested-externs -Winline -Wvla \
 
12
        -Wvolatile-register-var -Woverlength-strings
 
13
 
 
14
#DEBUG:=-ggdb3 -fsanitize=address $(SANITIZE)
 
15
## Check which sanitizing options can be used
 
16
#SANITIZE:=$(foreach option,$(ALL_SANITIZE_OPTIONS),$(shell \
 
17
#       echo 'int main(){}' | $(CC) --language=c $(option) \
 
18
#       /dev/stdin -o /dev/null >/dev/null 2>&1 && echo $(option)))
 
19
# <https://developerblog.redhat.com/2014/10/16/gcc-undefined-behavior-sanitizer-ubsan/>
 
20
ALL_SANITIZE_OPTIONS:=-fsanitize=leak -fsanitize=undefined \
 
21
        -fsanitize=shift -fsanitize=integer-divide-by-zero \
 
22
        -fsanitize=unreachable -fsanitize=vla-bound -fsanitize=null \
 
23
        -fsanitize=return -fsanitize=signed-integer-overflow \
 
24
        -fsanitize=bounds -fsanitize=alignment \
 
25
        -fsanitize=object-size -fsanitize=float-divide-by-zero \
 
26
        -fsanitize=float-cast-overflow -fsanitize=nonnull-attribute \
 
27
        -fsanitize=returns-nonnull-attribute -fsanitize=bool \
 
28
        -fsanitize=enum -fsanitize-address-use-after-scope
 
29
 
10
30
# For info about _FORTIFY_SOURCE, see feature_test_macros(7)
11
 
# and <http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html>.
12
 
FORTIFY=-D_FORTIFY_SOURCE=2 -fstack-protector-all -fPIC
13
 
LINK_FORTIFY_LD=-z relro -z now
14
 
LINK_FORTIFY=
 
31
# and <https://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html>.
 
32
FORTIFY:=-D_FORTIFY_SOURCE=2 -fstack-protector-all -fPIC
 
33
LINK_FORTIFY_LD:=-z relro -z now
 
34
LINK_FORTIFY:=
15
35
 
16
36
# If BROKEN_PIE is set, do not build with -pie
17
37
ifndef BROKEN_PIE
19
39
LINK_FORTIFY += -pie
20
40
endif
21
41
#COVERAGE=--coverage
22
 
OPTIMIZE=-Os -fno-strict-aliasing
23
 
LANGUAGE=-std=gnu99
24
 
htmldir=man
25
 
version=1.6.4
26
 
SED=sed
 
42
OPTIMIZE:=-Os -fno-strict-aliasing
 
43
LANGUAGE:=-std=gnu11
 
44
htmldir:=man
 
45
version:=1.8.4
 
46
SED:=sed
27
47
 
28
 
USER=$(firstword $(subst :, ,$(shell getent passwd _mandos || getent passwd nobody || echo 65534)))
29
 
GROUP=$(firstword $(subst :, ,$(shell getent group _mandos || getent group nobody || echo 65534)))
 
48
USER:=$(firstword $(subst :, ,$(shell getent passwd _mandos \
 
49
        || getent passwd nobody || echo 65534)))
 
50
GROUP:=$(firstword $(subst :, ,$(shell getent group _mandos \
 
51
        || getent group nogroup || echo 65534)))
30
52
 
31
53
## Use these settings for a traditional /usr/local install
32
 
# PREFIX=$(DESTDIR)/usr/local
33
 
# CONFDIR=$(DESTDIR)/etc/mandos
34
 
# KEYDIR=$(DESTDIR)/etc/mandos/keys
35
 
# MANDIR=$(PREFIX)/man
36
 
# INITRAMFSTOOLS=$(DESTDIR)/etc/initramfs-tools
37
 
# STATEDIR=$(DESTDIR)/var/lib/mandos
38
 
# LIBDIR=$(PREFIX)/lib
 
54
# PREFIX:=$(DESTDIR)/usr/local
 
55
# CONFDIR:=$(DESTDIR)/etc/mandos
 
56
# KEYDIR:=$(DESTDIR)/etc/mandos/keys
 
57
# MANDIR:=$(PREFIX)/man
 
58
# INITRAMFSTOOLS:=$(DESTDIR)/etc/initramfs-tools
 
59
# STATEDIR:=$(DESTDIR)/var/lib/mandos
 
60
# LIBDIR:=$(PREFIX)/lib
39
61
##
40
62
 
41
63
## These settings are for a package-type install
42
 
PREFIX=$(DESTDIR)/usr
43
 
CONFDIR=$(DESTDIR)/etc/mandos
44
 
KEYDIR=$(DESTDIR)/etc/keys/mandos
45
 
MANDIR=$(PREFIX)/share/man
46
 
INITRAMFSTOOLS=$(DESTDIR)/usr/share/initramfs-tools
47
 
STATEDIR=$(DESTDIR)/var/lib/mandos
48
 
LIBDIR=$(shell \
 
64
PREFIX:=$(DESTDIR)/usr
 
65
CONFDIR:=$(DESTDIR)/etc/mandos
 
66
KEYDIR:=$(DESTDIR)/etc/keys/mandos
 
67
MANDIR:=$(PREFIX)/share/man
 
68
INITRAMFSTOOLS:=$(DESTDIR)/usr/share/initramfs-tools
 
69
STATEDIR:=$(DESTDIR)/var/lib/mandos
 
70
LIBDIR:=$(shell \
49
71
        for d in \
50
72
        "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
51
73
        "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/lib; do \
56
78
        done)
57
79
##
58
80
 
59
 
SYSTEMD=$(DESTDIR)$(shell pkg-config systemd --variable=systemdsystemunitdir)
 
81
SYSTEMD:=$(DESTDIR)$(shell pkg-config systemd --variable=systemdsystemunitdir)
 
82
TMPFILES:=$(DESTDIR)$(shell pkg-config systemd --variable=tmpfilesdir)
60
83
 
61
 
GNUTLS_CFLAGS=$(shell pkg-config --cflags-only-I gnutls)
62
 
GNUTLS_LIBS=$(shell pkg-config --libs gnutls)
63
 
AVAHI_CFLAGS=$(shell pkg-config --cflags-only-I avahi-core)
64
 
AVAHI_LIBS=$(shell pkg-config --libs avahi-core)
65
 
GPGME_CFLAGS=$(shell gpgme-config --cflags; getconf LFS_CFLAGS)
66
 
GPGME_LIBS=$(shell gpgme-config --libs; getconf LFS_LIBS; \
 
84
GNUTLS_CFLAGS:=$(shell pkg-config --cflags-only-I gnutls)
 
85
GNUTLS_LIBS:=$(shell pkg-config --libs gnutls)
 
86
AVAHI_CFLAGS:=$(shell pkg-config --cflags-only-I avahi-core)
 
87
AVAHI_LIBS:=$(shell pkg-config --libs avahi-core)
 
88
GPGME_CFLAGS:=$(shell gpgme-config --cflags; getconf LFS_CFLAGS)
 
89
GPGME_LIBS:=$(shell gpgme-config --libs; getconf LFS_LIBS; \
67
90
        getconf LFS_LDFLAGS)
 
91
LIBNL3_CFLAGS:=$(shell pkg-config --cflags-only-I libnl-route-3.0)
 
92
LIBNL3_LIBS:=$(shell pkg-config --libs libnl-route-3.0)
68
93
 
69
94
# Do not change these two
70
 
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) $(OPTIMIZE) \
71
 
        $(LANGUAGE) $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(GPGME_CFLAGS) \
72
 
        -DVERSION='"$(version)"'
73
 
LDFLAGS+=-Xlinker --as-needed $(COVERAGE) $(LINK_FORTIFY) $(foreach flag,$(LINK_FORTIFY_LD),-Xlinker $(flag))
 
95
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) \
 
96
        $(OPTIMIZE) $(LANGUAGE) -DVERSION='"$(version)"'
 
97
LDFLAGS+=-Xlinker --as-needed $(COVERAGE) $(LINK_FORTIFY) $(strip \
 
98
        ) $(foreach flag,$(LINK_FORTIFY_LD),-Xlinker $(flag))
74
99
 
75
100
# Commands to format a DocBook <refentry> document into a manual page
76
101
DOCBOOKTOMAN=$(strip cd $(dir $<); xsltproc --nonet --xinclude \
81
106
        --param man.authors.section.enabled     0 \
82
107
        /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
83
108
        $(notdir $<); \
84
 
        $(MANPOST) $(notdir $@);\
85
109
        if locale --all 2>/dev/null | grep --regexp='^en_US\.utf8$$' \
86
 
        && type man 2>/dev/null; then LANG=en_US.UTF-8 MANWIDTH=80 \
87
 
        man --warnings --encoding=UTF-8 --local-file $(notdir $@); \
88
 
        fi >/dev/null)
89
 
# DocBook-to-man post-processing to fix a '\n' escape bug
90
 
MANPOST=$(SED) --in-place --expression='s,\\\\en,\\en,g;s,\\n,\\en,g'
 
110
        && command -v man >/dev/null; then LANG=en_US.UTF-8 \
 
111
        MANWIDTH=80 man --warnings --encoding=UTF-8 --local-file \
 
112
        $(notdir $@); fi >/dev/null)
91
113
 
92
114
DOCBOOKTOHTML=$(strip xsltproc --nonet --xinclude \
93
115
        --param make.year.ranges                1 \
99
121
        /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl \
100
122
        $<; $(HTMLPOST) $@)
101
123
# Fix citerefentry links
102
 
HTMLPOST=$(SED) --in-place \
 
124
HTMLPOST:=$(SED) --in-place \
103
125
        --expression='s/\(<a class="citerefentry" href="\)\("><span class="citerefentry"><span class="refentrytitle">\)\([^<]*\)\(<\/span>(\)\([^)]*\)\()<\/span><\/a>\)/\1\3.\5\2\3\4\5\6/g'
104
126
 
105
 
PLUGINS=plugins.d/password-prompt plugins.d/mandos-client \
 
127
PLUGINS:=plugins.d/password-prompt plugins.d/mandos-client \
106
128
        plugins.d/usplash plugins.d/splashy plugins.d/askpass-fifo \
107
129
        plugins.d/plymouth
108
 
CPROGS=plugin-runner $(PLUGINS)
109
 
PROGS=mandos mandos-keygen mandos-ctl mandos-monitor $(CPROGS)
110
 
DOCS=mandos.8 mandos-keygen.8 mandos-monitor.8 mandos-ctl.8 \
 
130
PLUGIN_HELPERS:=plugin-helpers/mandos-client-iprouteadddel
 
131
CPROGS:=plugin-runner $(PLUGINS) $(PLUGIN_HELPERS)
 
132
PROGS:=mandos mandos-keygen mandos-ctl mandos-monitor $(CPROGS)
 
133
DOCS:=mandos.8 mandos-keygen.8 mandos-monitor.8 mandos-ctl.8 \
111
134
        mandos.conf.5 mandos-clients.conf.5 plugin-runner.8mandos \
112
135
        plugins.d/mandos-client.8mandos \
113
136
        plugins.d/password-prompt.8mandos plugins.d/usplash.8mandos \
114
137
        plugins.d/splashy.8mandos plugins.d/askpass-fifo.8mandos \
115
138
        plugins.d/plymouth.8mandos intro.8mandos
116
139
 
117
 
htmldocs=$(addsuffix .xhtml,$(DOCS))
 
140
htmldocs:=$(addsuffix .xhtml,$(DOCS))
118
141
 
119
 
objects=$(addsuffix .o,$(CPROGS))
 
142
objects:=$(addsuffix .o,$(CPROGS))
120
143
 
121
144
all: $(PROGS) mandos.lsm
122
145
 
234
257
                --expression='s/\(mandos_\)[0-9.]\+\(\.orig\.tar\.gz\)/\1$(version)\2/' \
235
258
                $@)
236
259
 
 
260
# Need to add the GnuTLS, Avahi and GPGME libraries
237
261
plugins.d/mandos-client: plugins.d/mandos-client.c
238
 
        $(LINK.c) $^ -lrt $(GNUTLS_LIBS) $(AVAHI_LIBS) $(strip\
239
 
                ) $(GPGME_LIBS) $(LOADLIBES) $(LDLIBS) -o $@
 
262
        $(LINK.c) $^ $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(strip\
 
263
                ) $(GPGME_CFLAGS) $(GNUTLS_LIBS) $(strip\
 
264
                ) $(AVAHI_LIBS) $(GPGME_LIBS) $(LOADLIBES) $(strip\
 
265
                ) $(LDLIBS) -o $@
 
266
 
 
267
# Need to add the libnl-route library
 
268
plugin-helpers/mandos-client-iprouteadddel: plugin-helpers/mandos-client-iprouteadddel.c
 
269
        $(LINK.c) $(LIBNL3_CFLAGS) $^ $(LIBNL3_LIBS) $(strip\
 
270
                ) $(LOADLIBES) $(LDLIBS) -o $@
240
271
 
241
272
.PHONY : all doc html clean distclean mostlyclean maintainer-clean \
242
273
        check run-client run-server install install-html \
252
283
maintainer-clean: clean
253
284
        -rm --force --recursive keydir confdir statedir
254
285
 
255
 
check:  all
 
286
check: all
256
287
        ./mandos --check
257
288
        ./mandos-ctl --check
 
289
        ./mandos-keygen --version
 
290
        ./plugin-runner --version
 
291
        ./plugin-helpers/mandos-client-iprouteadddel --version
258
292
 
259
293
# Run the client with a local config and key
260
 
run-client: all keydir/seckey.txt keydir/pubkey.txt
 
294
run-client: all keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem
261
295
        @echo "###################################################################"
262
296
        @echo "# The following error messages are harmless and can be safely     #"
263
 
        @echo "# ignored.  The messages are caused by not running as root, but   #"
264
 
        @echo "# you should NOT run \"make run-client\" as root unless you also    #"
265
 
        @echo "# unpacked and compiled Mandos as root, which is NOT recommended. #"
266
 
        @echo "# From plugin-runner: setuid: Operation not permitted             #"
 
297
        @echo "# ignored:                                                        #"
 
298
        @echo "# From plugin-runner: setgid: Operation not permitted             #"
 
299
        @echo "#                     setuid: Operation not permitted             #"
267
300
        @echo "# From askpass-fifo:  mkfifo: Permission denied                   #"
268
 
        @echo "# From mandos-client: setuid: Operation not permitted             #"
269
 
        @echo "#                     seteuid: Operation not permitted            #"
270
 
        @echo "#                     klogctl: Operation not permitted            #"
 
301
        @echo "# From mandos-client:                                             #"
 
302
        @echo "#             Failed to raise privileges: Operation not permitted #"
 
303
        @echo "#             Warning: network hook \"*\" exited with status *      #"
 
304
        @echo "#                                                                 #"
 
305
        @echo "# (The messages are caused by not running as root, but you should #"
 
306
        @echo "# NOT run \"make run-client\" as root unless you also unpacked and  #"
 
307
        @echo "# compiled Mandos as root, which is also NOT recommended.)        #"
271
308
        @echo "###################################################################"
 
309
# We set GNOME_KEYRING_CONTROL to block pam_gnome_keyring
272
310
        ./plugin-runner --plugin-dir=plugins.d \
 
311
                --plugin-helper-dir=plugin-helpers \
273
312
                --config-file=plugin-runner.conf \
274
 
                --options-for=mandos-client:--seckey=keydir/seckey.txt,--pubkey=keydir/pubkey.txt,--network-hook-dir=network-hooks.d \
 
313
                --options-for=mandos-client:--seckey=keydir/seckey.txt,--pubkey=keydir/pubkey.txt,--tls-privkey=keydir/tls-privkey.pem,--tls-pubkey=keydir/tls-pubkey.pem,--network-hook-dir=network-hooks.d \
 
314
                --env-for=mandos-client:GNOME_KEYRING_CONTROL= \
275
315
                $(CLIENTARGS)
276
316
 
277
317
# Used by run-client
278
 
keydir/seckey.txt keydir/pubkey.txt: mandos-keygen
 
318
keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem: mandos-keygen
279
319
        install --directory keydir
280
320
        ./mandos-keygen --dir keydir --force
281
321
 
288
328
confdir/mandos.conf: mandos.conf
289
329
        install --directory confdir
290
330
        install --mode=u=rw,go=r $^ $@
291
 
confdir/clients.conf: clients.conf keydir/seckey.txt
 
331
confdir/clients.conf: clients.conf keydir/seckey.txt keydir/tls-pubkey.pem
292
332
        install --directory confdir
293
333
        install --mode=u=rw $< $@
294
334
# Add a client password
295
 
        ./mandos-keygen --dir keydir --password >> $@
 
335
        ./mandos-keygen --dir keydir --password --no-ssh >> $@
296
336
statedir:
297
337
        install --directory statedir
298
338
 
311
351
        elif install --directory --mode=u=rwx $(STATEDIR); then \
312
352
                chown -- $(USER):$(GROUP) $(STATEDIR) || :; \
313
353
        fi
 
354
        if [ "$(TMPFILES)" != "$(DESTDIR)" -a -d "$(TMPFILES)" ]; then \
 
355
                install --mode=u=rw,go=r tmpfiles.d-mandos.conf \
 
356
                        $(TMPFILES)/mandos.conf; \
 
357
        fi
314
358
        install --mode=u=rwx,go=rx mandos $(PREFIX)/sbin/mandos
315
359
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
316
360
                mandos-ctl
348
392
install-client-nokey: all doc
349
393
        install --directory $(LIBDIR)/mandos $(CONFDIR)
350
394
        install --directory --mode=u=rwx $(KEYDIR) \
351
 
                $(LIBDIR)/mandos/plugins.d
 
395
                $(LIBDIR)/mandos/plugins.d \
 
396
                $(LIBDIR)/mandos/plugin-helpers
352
397
        if [ "$(CONFDIR)" != "$(LIBDIR)/mandos" ]; then \
353
398
                install --mode=u=rwx \
354
 
                        --directory "$(CONFDIR)/plugins.d"; \
 
399
                        --directory "$(CONFDIR)/plugins.d" \
 
400
                        "$(CONFDIR)/plugin-helpers"; \
355
401
        fi
356
402
        install --mode=u=rwx,go=rx --directory \
357
403
                "$(CONFDIR)/network-hooks.d"
358
404
        install --mode=u=rwx,go=rx \
359
405
                --target-directory=$(LIBDIR)/mandos plugin-runner
 
406
        install --mode=u=rwx,go=rx \
 
407
                --target-directory=$(LIBDIR)/mandos mandos-to-cryptroot-unlock
360
408
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
361
409
                mandos-keygen
362
410
        install --mode=u=rwx,go=rx \
377
425
        install --mode=u=rwxs,go=rx \
378
426
                --target-directory=$(LIBDIR)/mandos/plugins.d \
379
427
                plugins.d/plymouth
 
428
        install --mode=u=rwx,go=rx \
 
429
                --target-directory=$(LIBDIR)/mandos/plugin-helpers \
 
430
                plugin-helpers/mandos-client-iprouteadddel
380
431
        install initramfs-tools-hook \
381
432
                $(INITRAMFSTOOLS)/hooks/mandos
382
 
        install --mode=u=rw,go=r initramfs-tools-hook-conf \
383
 
                $(INITRAMFSTOOLS)/conf-hooks.d/mandos
 
433
        install --mode=u=rw,go=r initramfs-tools-conf \
 
434
                $(INITRAMFSTOOLS)/conf.d/mandos-conf
 
435
        install --mode=u=rw,go=r initramfs-tools-conf-hook \
 
436
                $(INITRAMFSTOOLS)/conf-hooks.d/zz-mandos
384
437
        install initramfs-tools-script \
385
438
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos
 
439
        install initramfs-tools-script-stop \
 
440
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos
386
441
        install --mode=u=rw,go=r plugin-runner.conf $(CONFDIR)
387
442
        gzip --best --to-stdout mandos-keygen.8 \
388
443
                > $(MANDIR)/man8/mandos-keygen.8.gz
462
517
        -rmdir $(CONFDIR)
463
518
 
464
519
purge-client: uninstall-client
465
 
        -shred --remove $(KEYDIR)/seckey.txt
 
520
        -shred --remove $(KEYDIR)/seckey.txt $(KEYDIR)/tls-privkey.pem
466
521
        -rm --force $(CONFDIR)/plugin-runner.conf \
467
 
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt
 
522
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt \
 
523
                $(KEYDIR)/tls-pubkey.txt $(KEYDIR)/tls-privkey.txt
468
524
        -rmdir $(KEYDIR) $(CONFDIR)/plugins.d $(CONFDIR)