/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-08-01 19:52:59 UTC
  • Revision ID: teddy@recompile.se-20190801195259-nhu15rxjx3wz2kos
Break some long lines and refine documentation

* Makefile (LINUXVERSION): New.
  (LIBDIR): Break long line.
  (SYSTEMD, TMPFILES): Change ":=" to "=" to not run unless required.
  (run-client): Break long lines, and add two more harmless warnings
                to informational message.
  (install-server): Break long line.
  (install-client-nokey): - '' -
  (install-client): Shorten long line by using $(LINUXVERSION).
  (uninstall-client): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
10
10
        -Wmissing-format-attribute -Wnormalized=nfc -Wpacked \
11
11
        -Wredundant-decls -Wnested-externs -Winline -Wvla \
12
12
        -Wvolatile-register-var -Woverlength-strings
13
 
#DEBUG:=-ggdb3 -fsanitize=address 
14
 
# For info about _FORTIFY_SOURCE, see feature_test_macros(7)
15
 
# and <https://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html>.
16
 
FORTIFY:=-D_FORTIFY_SOURCE=2 -fstack-protector-all -fPIC
 
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)))
17
19
# <https://developerblog.redhat.com/2014/10/16/gcc-undefined-behavior-sanitizer-ubsan/>
18
20
ALL_SANITIZE_OPTIONS:=-fsanitize=leak -fsanitize=undefined \
19
21
        -fsanitize=shift -fsanitize=integer-divide-by-zero \
23
25
        -fsanitize=object-size -fsanitize=float-divide-by-zero \
24
26
        -fsanitize=float-cast-overflow -fsanitize=nonnull-attribute \
25
27
        -fsanitize=returns-nonnull-attribute -fsanitize=bool \
26
 
        -fsanitize=enum
27
 
# Check which sanitizing options can be used
28
 
SANITIZE:=$(foreach option,$(ALL_SANITIZE_OPTIONS),$(shell \
29
 
        echo 'int main(){}' | $(CC) --language=c $(option) /dev/stdin \
30
 
        -o /dev/null >/dev/null 2>&1 && echo $(option)))
 
28
        -fsanitize=enum -fsanitize-address-use-after-scope
 
29
 
 
30
# For info about _FORTIFY_SOURCE, see feature_test_macros(7)
 
31
# and <https://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html>.
 
32
FORTIFY:=-D_FORTIFY_SOURCE=2 -fstack-protector-all -fPIC
31
33
LINK_FORTIFY_LD:=-z relro -z now
32
34
LINK_FORTIFY:=
33
35
 
40
42
OPTIMIZE:=-Os -fno-strict-aliasing
41
43
LANGUAGE:=-std=gnu11
42
44
htmldir:=man
43
 
version:=1.7.16
 
45
version:=1.8.5
44
46
SED:=sed
45
47
 
46
 
USER:=$(firstword $(subst :, ,$(shell getent passwd _mandos || getent passwd nobody || echo 65534)))
47
 
GROUP:=$(firstword $(subst :, ,$(shell getent group _mandos || getent group nogroup || 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)))
 
52
 
 
53
LINUXVERSION:=$(shell uname --kernel-release)
48
54
 
49
55
## Use these settings for a traditional /usr/local install
50
56
# PREFIX:=$(DESTDIR)/usr/local
52
58
# KEYDIR:=$(DESTDIR)/etc/mandos/keys
53
59
# MANDIR:=$(PREFIX)/man
54
60
# INITRAMFSTOOLS:=$(DESTDIR)/etc/initramfs-tools
 
61
# DRACUTMODULE:=$(DESTDIR)/usr/lib/dracut/modules.d/90mandos
55
62
# STATEDIR:=$(DESTDIR)/var/lib/mandos
56
63
# LIBDIR:=$(PREFIX)/lib
57
64
##
62
69
KEYDIR:=$(DESTDIR)/etc/keys/mandos
63
70
MANDIR:=$(PREFIX)/share/man
64
71
INITRAMFSTOOLS:=$(DESTDIR)/usr/share/initramfs-tools
 
72
DRACUTMODULE:=$(DESTDIR)/usr/lib/dracut/modules.d/90mandos
65
73
STATEDIR:=$(DESTDIR)/var/lib/mandos
66
74
LIBDIR:=$(shell \
67
75
        for d in \
68
 
        "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
 
76
        "/usr/lib/`dpkg-architecture \
 
77
                        -qDEB_HOST_MULTIARCH 2>/dev/null`" \
69
78
        "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/lib; do \
70
79
                if [ -d "$$d" -a "$$d" = "$${d%/}" ]; then \
71
80
                        echo "$(DESTDIR)$$d"; \
74
83
        done)
75
84
##
76
85
 
77
 
SYSTEMD:=$(DESTDIR)$(shell pkg-config systemd --variable=systemdsystemunitdir)
 
86
SYSTEMD:=$(DESTDIR)$(shell pkg-config systemd \
 
87
                        --variable=systemdsystemunitdir)
78
88
TMPFILES:=$(DESTDIR)$(shell pkg-config systemd --variable=tmpfilesdir)
79
89
 
80
90
GNUTLS_CFLAGS:=$(shell pkg-config --cflags-only-I gnutls)
86
96
        getconf LFS_LDFLAGS)
87
97
LIBNL3_CFLAGS:=$(shell pkg-config --cflags-only-I libnl-route-3.0)
88
98
LIBNL3_LIBS:=$(shell pkg-config --libs libnl-route-3.0)
 
99
GLIB_CFLAGS:=$(shell pkg-config --cflags glib-2.0)
 
100
GLIB_LIBS:=$(shell pkg-config --libs glib-2.0)
89
101
 
90
102
# Do not change these two
91
 
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(SANITIZE) $(COVERAGE) \
92
 
        $(OPTIMIZE) $(LANGUAGE) $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) \
93
 
        $(GPGME_CFLAGS) -DVERSION='"$(version)"'
94
 
LDFLAGS+=-Xlinker --as-needed $(COVERAGE) $(LINK_FORTIFY) $(foreach flag,$(LINK_FORTIFY_LD),-Xlinker $(flag))
 
103
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) \
 
104
        $(OPTIMIZE) $(LANGUAGE) -DVERSION='"$(version)"'
 
105
LDFLAGS+=-Xlinker --as-needed $(COVERAGE) $(LINK_FORTIFY) $(strip \
 
106
        ) $(foreach flag,$(LINK_FORTIFY_LD),-Xlinker $(flag))
95
107
 
96
108
# Commands to format a DocBook <refentry> document into a manual page
97
109
DOCBOOKTOMAN=$(strip cd $(dir $<); xsltproc --nonet --xinclude \
103
115
        /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
104
116
        $(notdir $<); \
105
117
        if locale --all 2>/dev/null | grep --regexp='^en_US\.utf8$$' \
106
 
        && type man 2>/dev/null; then LANG=en_US.UTF-8 MANWIDTH=80 \
107
 
        man --warnings --encoding=UTF-8 --local-file $(notdir $@); \
108
 
        fi >/dev/null)
 
118
        && command -v man >/dev/null; then LANG=en_US.UTF-8 \
 
119
        MANWIDTH=80 man --warnings --encoding=UTF-8 --local-file \
 
120
        $(notdir $@); fi >/dev/null)
109
121
 
110
122
DOCBOOKTOHTML=$(strip xsltproc --nonet --xinclude \
111
123
        --param make.year.ranges                1 \
124
136
        plugins.d/usplash plugins.d/splashy plugins.d/askpass-fifo \
125
137
        plugins.d/plymouth
126
138
PLUGIN_HELPERS:=plugin-helpers/mandos-client-iprouteadddel
127
 
CPROGS:=plugin-runner $(PLUGINS) $(PLUGIN_HELPERS)
 
139
CPROGS:=plugin-runner dracut-module/password-agent $(PLUGINS) \
 
140
        $(PLUGIN_HELPERS)
128
141
PROGS:=mandos mandos-keygen mandos-ctl mandos-monitor $(CPROGS)
129
142
DOCS:=mandos.8 mandos-keygen.8 mandos-monitor.8 mandos-ctl.8 \
130
143
        mandos.conf.5 mandos-clients.conf.5 plugin-runner.8mandos \
 
144
        dracut-module/password-agent.8mandos \
131
145
        plugins.d/mandos-client.8mandos \
132
146
        plugins.d/password-prompt.8mandos plugins.d/usplash.8mandos \
133
147
        plugins.d/splashy.8mandos plugins.d/askpass-fifo.8mandos \
205
219
                overview.xml legalnotice.xml
206
220
        $(DOCBOOKTOHTML)
207
221
 
 
222
dracut-module/password-agent.8mandos: \
 
223
                dracut-module/password-agent.xml common.ent \
 
224
                overview.xml legalnotice.xml
 
225
        $(DOCBOOKTOMAN)
 
226
dracut-module/password-agent.8mandos.xhtml: \
 
227
                dracut-module/password-agent.xml common.ent \
 
228
                overview.xml legalnotice.xml
 
229
        $(DOCBOOKTOHTML)
 
230
 
208
231
plugins.d/mandos-client.8mandos: plugins.d/mandos-client.xml \
209
232
                                        common.ent \
210
233
                                        mandos-options.xml \
253
276
                --expression='s/\(mandos_\)[0-9.]\+\(\.orig\.tar\.gz\)/\1$(version)\2/' \
254
277
                $@)
255
278
 
 
279
# Need to add the GnuTLS, Avahi and GPGME libraries
256
280
plugins.d/mandos-client: plugins.d/mandos-client.c
257
 
        $(LINK.c) $^ -lrt $(GNUTLS_LIBS) $(AVAHI_LIBS) $(strip\
258
 
                ) $(GPGME_LIBS) $(LOADLIBES) $(LDLIBS) -o $@
 
281
        $(LINK.c) $^ $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(strip\
 
282
                ) $(GPGME_CFLAGS) $(GNUTLS_LIBS) $(strip\
 
283
                ) $(AVAHI_LIBS) $(GPGME_LIBS) $(LOADLIBES) $(strip\
 
284
                ) $(LDLIBS) -o $@
259
285
 
 
286
# Need to add the libnl-route library
260
287
plugin-helpers/mandos-client-iprouteadddel: plugin-helpers/mandos-client-iprouteadddel.c
261
288
        $(LINK.c) $(LIBNL3_CFLAGS) $^ $(LIBNL3_LIBS) $(strip\
262
289
                ) $(LOADLIBES) $(LDLIBS) -o $@
263
290
 
 
291
# Need to add the GLib and pthread libraries
 
292
dracut-module/password-agent: dracut-module/password-agent.c
 
293
        $(LINK.c) $(GLIB_CFLAGS) $^ $(GLIB_LIBS) -lpthread $(strip\
 
294
                ) $(LOADLIBES) $(LDLIBS) -o $@
 
295
 
264
296
.PHONY : all doc html clean distclean mostlyclean maintainer-clean \
265
297
        check run-client run-server install install-html \
266
298
        install-server install-client-nokey install-client uninstall \
275
307
maintainer-clean: clean
276
308
        -rm --force --recursive keydir confdir statedir
277
309
 
278
 
check:  all
 
310
check: all
279
311
        ./mandos --check
280
312
        ./mandos-ctl --check
 
313
        ./mandos-keygen --version
 
314
        ./plugin-runner --version
 
315
        ./plugin-helpers/mandos-client-iprouteadddel --version
 
316
        ./dracut-module/password-agent --test
281
317
 
282
318
# Run the client with a local config and key
283
 
run-client: all keydir/seckey.txt keydir/pubkey.txt
284
 
        @echo "###################################################################"
285
 
        @echo "# The following error messages are harmless and can be safely     #"
286
 
        @echo "# ignored:                                                        #"
287
 
        @echo "# From plugin-runner: setgid: Operation not permitted             #"
288
 
        @echo "#                     setuid: Operation not permitted             #"
289
 
        @echo "# From askpass-fifo:  mkfifo: Permission denied                   #"
290
 
        @echo "# From mandos-client:                                             #"
291
 
        @echo "#             Failed to raise privileges: Operation not permitted #"
292
 
        @echo "#             Warning: network hook \"*\" exited with status *      #"
293
 
        @echo "#                                                                 #"
294
 
        @echo "# (The messages are caused by not running as root, but you should #"
295
 
        @echo "# NOT run \"make run-client\" as root unless you also unpacked and  #"
296
 
        @echo "# compiled Mandos as root, which is also NOT recommended.)        #"
297
 
        @echo "###################################################################"
 
319
run-client: all keydir/seckey.txt keydir/pubkey.txt \
 
320
                        keydir/tls-privkey.pem keydir/tls-pubkey.pem
 
321
        @echo '######################################################'
 
322
        @echo '# The following error messages are harmless and can  #'
 
323
        @echo '#  be safely ignored:                                #'
 
324
        @echo '## From plugin-runner:                               #'
 
325
        @echo '# setgid: Operation not permitted                    #'
 
326
        @echo '# setuid: Operation not permitted                    #'
 
327
        @echo '## From askpass-fifo:                                #'
 
328
        @echo '# mkfifo: Permission denied                          #'
 
329
        @echo '## From mandos-client:                               #'
 
330
        @echo '# Failed to raise privileges: Operation not permi... #'
 
331
        @echo '# Warning: network hook "*" exited with status *     #'
 
332
        @echo '# ioctl SIOCSIFFLAGS +IFF_UP: Operation not permi... #'
 
333
        @echo '# Failed to bring up interface "*": Operation not... #'
 
334
        @echo '#                                                    #'
 
335
        @echo '# (The messages are caused by not running as root,   #'
 
336
        @echo '# but you should NOT run "make run-client" as root   #'
 
337
        @echo '# unless you also unpacked and compiled Mandos as    #'
 
338
        @echo '# root, which is also NOT recommended.)              #'
 
339
        @echo '######################################################'
298
340
# We set GNOME_KEYRING_CONTROL to block pam_gnome_keyring
299
341
        ./plugin-runner --plugin-dir=plugins.d \
300
342
                --plugin-helper-dir=plugin-helpers \
301
343
                --config-file=plugin-runner.conf \
302
 
                --options-for=mandos-client:--seckey=keydir/seckey.txt,--pubkey=keydir/pubkey.txt,--network-hook-dir=network-hooks.d \
 
344
                --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 \
303
345
                --env-for=mandos-client:GNOME_KEYRING_CONTROL= \
304
346
                $(CLIENTARGS)
305
347
 
306
348
# Used by run-client
307
 
keydir/seckey.txt keydir/pubkey.txt: mandos-keygen
 
349
keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem: mandos-keygen
308
350
        install --directory keydir
309
351
        ./mandos-keygen --dir keydir --force
310
352
 
317
359
confdir/mandos.conf: mandos.conf
318
360
        install --directory confdir
319
361
        install --mode=u=rw,go=r $^ $@
320
 
confdir/clients.conf: clients.conf keydir/seckey.txt
 
362
confdir/clients.conf: clients.conf keydir/seckey.txt keydir/tls-pubkey.pem
321
363
        install --directory confdir
322
364
        install --mode=u=rw $< $@
323
365
# Add a client password
340
382
        elif install --directory --mode=u=rwx $(STATEDIR); then \
341
383
                chown -- $(USER):$(GROUP) $(STATEDIR) || :; \
342
384
        fi
343
 
        if [ "$(TMPFILES)" != "$(DESTDIR)" -a -d "$(TMPFILES)" ]; then \
 
385
        if [ "$(TMPFILES)" != "$(DESTDIR)" \
 
386
                        -a -d "$(TMPFILES)" ]; then \
344
387
                install --mode=u=rw,go=r tmpfiles.d-mandos.conf \
345
388
                        $(TMPFILES)/mandos.conf; \
346
389
        fi
392
435
                "$(CONFDIR)/network-hooks.d"
393
436
        install --mode=u=rwx,go=rx \
394
437
                --target-directory=$(LIBDIR)/mandos plugin-runner
 
438
        install --mode=u=rwx,go=rx \
 
439
                --target-directory=$(LIBDIR)/mandos \
 
440
                mandos-to-cryptroot-unlock
395
441
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
396
442
                mandos-keygen
397
443
        install --mode=u=rwx,go=rx \
417
463
                plugin-helpers/mandos-client-iprouteadddel
418
464
        install initramfs-tools-hook \
419
465
                $(INITRAMFSTOOLS)/hooks/mandos
420
 
        install --mode=u=rw,go=r initramfs-tools-hook-conf \
421
 
                $(INITRAMFSTOOLS)/conf-hooks.d/mandos
 
466
        install --mode=u=rw,go=r initramfs-tools-conf \
 
467
                $(INITRAMFSTOOLS)/conf.d/mandos-conf
 
468
        install --mode=u=rw,go=r initramfs-tools-conf-hook \
 
469
                $(INITRAMFSTOOLS)/conf-hooks.d/zz-mandos
422
470
        install initramfs-tools-script \
423
471
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos
 
472
        install initramfs-tools-script-stop \
 
473
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos
 
474
        install --directory $(DRACUTMODULE)
 
475
        install --mode=u=rw,go=r --target-directory=$(DRACUTMODULE) \
 
476
                dracut-module/ask-password-mandos.path \
 
477
                dracut-module/ask-password-mandos.service
 
478
        install --mode=u=rwxs,go=rx \
 
479
                --target-directory=$(DRACUTMODULE) \
 
480
                dracut-module/module-setup.sh \
 
481
                dracut-module/cmdline-mandos.sh \
 
482
                dracut-module/password-agent
424
483
        install --mode=u=rw,go=r plugin-runner.conf $(CONFDIR)
425
484
        gzip --best --to-stdout mandos-keygen.8 \
426
485
                > $(MANDIR)/man8/mandos-keygen.8.gz
438
497
                > $(MANDIR)/man8/askpass-fifo.8mandos.gz
439
498
        gzip --best --to-stdout plugins.d/plymouth.8mandos \
440
499
                > $(MANDIR)/man8/plymouth.8mandos.gz
 
500
        gzip --best --to-stdout dracut-module/password-agent.8mandos \
 
501
                > $(MANDIR)/man8/password-agent.8mandos.gz
441
502
 
442
503
install-client: install-client-nokey
443
504
# Post-installation stuff
444
505
        -$(PREFIX)/sbin/mandos-keygen --dir "$(KEYDIR)"
445
 
        update-initramfs -k all -u
 
506
        if command -v update-initramfs >/dev/null; then \
 
507
            update-initramfs -k all -u; \
 
508
        elif command -v dracut >/dev/null; then \
 
509
            for initrd in $(DESTDIR)/boot/initr*-$(LINUXVERSION); do \
 
510
                if [ -w "$$initrd" ]; then \
 
511
                    chmod go-r "$$initrd"; \
 
512
                    dracut --force "$$initrd"; \
 
513
                fi; \
 
514
            done; \
 
515
        fi
446
516
        echo "Now run mandos-keygen --password --dir $(KEYDIR)"
447
517
 
448
518
uninstall: uninstall-server uninstall-client
475
545
                $(INITRAMFSTOOLS)/hooks/mandos \
476
546
                $(INITRAMFSTOOLS)/conf-hooks.d/mandos \
477
547
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos \
 
548
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos \
 
549
                $(DRACUTMODULE)/ask-password-mandos.path \
 
550
                $(DRACUTMODULE)/ask-password-mandos.service \
 
551
                $(DRACUTMODULE)/module-setup.sh \
 
552
                $(DRACUTMODULE)/cmdline-mandos.sh \
 
553
                $(DRACUTMODULE)/password-agent \
478
554
                $(MANDIR)/man8/mandos-keygen.8.gz \
479
555
                $(MANDIR)/man8/plugin-runner.8mandos.gz \
480
556
                $(MANDIR)/man8/mandos-client.8mandos.gz
483
559
                $(MANDIR)/man8/splashy.8mandos.gz \
484
560
                $(MANDIR)/man8/askpass-fifo.8mandos.gz \
485
561
                $(MANDIR)/man8/plymouth.8mandos.gz \
 
562
                $(MANDIR)/man8/password-agent.8mandos.gz \
486
563
        -rmdir $(LIBDIR)/mandos/plugins.d $(CONFDIR)/plugins.d \
487
 
                 $(LIBDIR)/mandos $(CONFDIR) $(KEYDIR)
488
 
        update-initramfs -k all -u
 
564
                 $(LIBDIR)/mandos $(CONFDIR) $(KEYDIR) $(DRACUTMODULE)
 
565
        if command -v update-initramfs >/dev/null; then \
 
566
            update-initramfs -k all -u; \
 
567
        elif command -v dracut >/dev/null; then \
 
568
            for initrd in $(DESTDIR)/boot/initr*-$(LINUXVERSION); do \
 
569
                test -w "$$initrd" && dracut --force "$$initrd"; \
 
570
            done; \
 
571
        fi
489
572
 
490
573
purge: purge-server purge-client
491
574
 
500
583
        -rmdir $(CONFDIR)
501
584
 
502
585
purge-client: uninstall-client
503
 
        -shred --remove $(KEYDIR)/seckey.txt
 
586
        -shred --remove $(KEYDIR)/seckey.txt $(KEYDIR)/tls-privkey.pem
504
587
        -rm --force $(CONFDIR)/plugin-runner.conf \
505
 
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt
 
588
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt \
 
589
                $(KEYDIR)/tls-pubkey.txt $(KEYDIR)/tls-privkey.txt
506
590
        -rmdir $(KEYDIR) $(CONFDIR)/plugins.d $(CONFDIR)