/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-04-10 20:33:13 UTC
  • Revision ID: teddy@recompile.se-20190410203313-d3ufer20hfws7i3h
Improve language in intro(8mandos) manual page

* intro.xml (INTRODUCTION): Replace "it" with "the data" to fix bad
                            reference, and clarify that it is the
                            client which continues booting.

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
#DEBUG:=-ggdb3 -fsanitize=address 
10
14
# 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=
 
15
# and <https://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html>.
 
16
FORTIFY:=-D_FORTIFY_SOURCE=2 -fstack-protector-all -fPIC
 
17
# <https://developerblog.redhat.com/2014/10/16/gcc-undefined-behavior-sanitizer-ubsan/>
 
18
ALL_SANITIZE_OPTIONS:=-fsanitize=leak -fsanitize=undefined \
 
19
        -fsanitize=shift -fsanitize=integer-divide-by-zero \
 
20
        -fsanitize=unreachable -fsanitize=vla-bound -fsanitize=null \
 
21
        -fsanitize=return -fsanitize=signed-integer-overflow \
 
22
        -fsanitize=bounds -fsanitize=alignment \
 
23
        -fsanitize=object-size -fsanitize=float-divide-by-zero \
 
24
        -fsanitize=float-cast-overflow -fsanitize=nonnull-attribute \
 
25
        -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)))
 
31
LINK_FORTIFY_LD:=-z relro -z now
 
32
LINK_FORTIFY:=
15
33
 
16
34
# If BROKEN_PIE is set, do not build with -pie
17
35
ifndef BROKEN_PIE
19
37
LINK_FORTIFY += -pie
20
38
endif
21
39
#COVERAGE=--coverage
22
 
OPTIMIZE=-Os
23
 
LANGUAGE=-std=gnu99
24
 
htmldir=man
25
 
version=1.6.4
26
 
SED=sed
 
40
OPTIMIZE:=-Os -fno-strict-aliasing
 
41
LANGUAGE:=-std=gnu11
 
42
htmldir:=man
 
43
version:=1.8.4
 
44
SED:=sed
27
45
 
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)))
 
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)))
30
48
 
31
49
## 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
 
50
# PREFIX:=$(DESTDIR)/usr/local
 
51
# CONFDIR:=$(DESTDIR)/etc/mandos
 
52
# KEYDIR:=$(DESTDIR)/etc/mandos/keys
 
53
# MANDIR:=$(PREFIX)/man
 
54
# INITRAMFSTOOLS:=$(DESTDIR)/etc/initramfs-tools
 
55
# STATEDIR:=$(DESTDIR)/var/lib/mandos
 
56
# LIBDIR:=$(PREFIX)/lib
39
57
##
40
58
 
41
59
## 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 \
 
60
PREFIX:=$(DESTDIR)/usr
 
61
CONFDIR:=$(DESTDIR)/etc/mandos
 
62
KEYDIR:=$(DESTDIR)/etc/keys/mandos
 
63
MANDIR:=$(PREFIX)/share/man
 
64
INITRAMFSTOOLS:=$(DESTDIR)/usr/share/initramfs-tools
 
65
STATEDIR:=$(DESTDIR)/var/lib/mandos
 
66
LIBDIR:=$(shell \
49
67
        for d in \
50
68
        "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
51
69
        "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/lib; do \
56
74
        done)
57
75
##
58
76
 
59
 
SYSTEMD=$(DESTDIR)$(shell pkg-config systemd --variable=systemdsystemunitdir)
 
77
SYSTEMD:=$(DESTDIR)$(shell pkg-config systemd --variable=systemdsystemunitdir)
 
78
TMPFILES:=$(DESTDIR)$(shell pkg-config systemd --variable=tmpfilesdir)
60
79
 
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; \
 
80
GNUTLS_CFLAGS:=$(shell pkg-config --cflags-only-I gnutls)
 
81
GNUTLS_LIBS:=$(shell pkg-config --libs gnutls)
 
82
AVAHI_CFLAGS:=$(shell pkg-config --cflags-only-I avahi-core)
 
83
AVAHI_LIBS:=$(shell pkg-config --libs avahi-core)
 
84
GPGME_CFLAGS:=$(shell gpgme-config --cflags; getconf LFS_CFLAGS)
 
85
GPGME_LIBS:=$(shell gpgme-config --libs; getconf LFS_LIBS; \
67
86
        getconf LFS_LDFLAGS)
 
87
LIBNL3_CFLAGS:=$(shell pkg-config --cflags-only-I libnl-route-3.0)
 
88
LIBNL3_LIBS:=$(shell pkg-config --libs libnl-route-3.0)
68
89
 
69
90
# Do not change these two
70
 
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) $(OPTIMIZE) \
71
 
        $(LANGUAGE) $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(GPGME_CFLAGS) \
72
 
        -DVERSION='"$(version)"'
 
91
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(SANITIZE) $(COVERAGE) \
 
92
        $(OPTIMIZE) $(LANGUAGE) -DVERSION='"$(version)"'
73
93
LDFLAGS+=-Xlinker --as-needed $(COVERAGE) $(LINK_FORTIFY) $(foreach flag,$(LINK_FORTIFY_LD),-Xlinker $(flag))
74
94
 
75
95
# Commands to format a DocBook <refentry> document into a manual page
81
101
        --param man.authors.section.enabled     0 \
82
102
        /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
83
103
        $(notdir $<); \
84
 
        $(MANPOST) $(notdir $@);\
85
104
        if locale --all 2>/dev/null | grep --regexp='^en_US\.utf8$$' \
86
105
        && type man 2>/dev/null; then LANG=en_US.UTF-8 MANWIDTH=80 \
87
106
        man --warnings --encoding=UTF-8 --local-file $(notdir $@); \
88
107
        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'
91
108
 
92
109
DOCBOOKTOHTML=$(strip xsltproc --nonet --xinclude \
93
110
        --param make.year.ranges                1 \
99
116
        /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl \
100
117
        $<; $(HTMLPOST) $@)
101
118
# Fix citerefentry links
102
 
HTMLPOST=$(SED) --in-place \
 
119
HTMLPOST:=$(SED) --in-place \
103
120
        --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
121
 
105
 
PLUGINS=plugins.d/password-prompt plugins.d/mandos-client \
 
122
PLUGINS:=plugins.d/password-prompt plugins.d/mandos-client \
106
123
        plugins.d/usplash plugins.d/splashy plugins.d/askpass-fifo \
107
124
        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 \
 
125
PLUGIN_HELPERS:=plugin-helpers/mandos-client-iprouteadddel
 
126
CPROGS:=plugin-runner $(PLUGINS) $(PLUGIN_HELPERS)
 
127
PROGS:=mandos mandos-keygen mandos-ctl mandos-monitor $(CPROGS)
 
128
DOCS:=mandos.8 mandos-keygen.8 mandos-monitor.8 mandos-ctl.8 \
111
129
        mandos.conf.5 mandos-clients.conf.5 plugin-runner.8mandos \
112
130
        plugins.d/mandos-client.8mandos \
113
131
        plugins.d/password-prompt.8mandos plugins.d/usplash.8mandos \
114
132
        plugins.d/splashy.8mandos plugins.d/askpass-fifo.8mandos \
115
133
        plugins.d/plymouth.8mandos intro.8mandos
116
134
 
117
 
htmldocs=$(addsuffix .xhtml,$(DOCS))
 
135
htmldocs:=$(addsuffix .xhtml,$(DOCS))
118
136
 
119
 
objects=$(addsuffix .o,$(CPROGS))
 
137
objects:=$(addsuffix .o,$(CPROGS))
120
138
 
121
139
all: $(PROGS) mandos.lsm
122
140
 
234
252
                --expression='s/\(mandos_\)[0-9.]\+\(\.orig\.tar\.gz\)/\1$(version)\2/' \
235
253
                $@)
236
254
 
 
255
# Need to add the GnuTLS, Avahi and GPGME libraries, and can't use
 
256
# -fsanitize=leak because GnuTLS and GPGME both leak memory.
237
257
plugins.d/mandos-client: plugins.d/mandos-client.c
238
 
        $(LINK.c) $^ -lrt $(GNUTLS_LIBS) $(AVAHI_LIBS) $(strip\
 
258
        $(CC) $(filter-out -fsanitize=leak,$(CFLAGS)) $(strip\
 
259
        ) $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(GPGME_CFLAGS) $(strip\
 
260
                ) $(CPPFLAGS) $(LDFLAGS) $(TARGET_ARCH) $^ $(strip\
 
261
                ) -lrt $(GNUTLS_LIBS) $(AVAHI_LIBS) $(strip\
239
262
                ) $(GPGME_LIBS) $(LOADLIBES) $(LDLIBS) -o $@
240
263
 
 
264
plugin-helpers/mandos-client-iprouteadddel: plugin-helpers/mandos-client-iprouteadddel.c
 
265
        $(LINK.c) $(LIBNL3_CFLAGS) $^ $(LIBNL3_LIBS) $(strip\
 
266
                ) $(LOADLIBES) $(LDLIBS) -o $@
 
267
 
241
268
.PHONY : all doc html clean distclean mostlyclean maintainer-clean \
242
269
        check run-client run-server install install-html \
243
270
        install-server install-client-nokey install-client uninstall \
257
284
        ./mandos-ctl --check
258
285
 
259
286
# Run the client with a local config and key
260
 
run-client: all keydir/seckey.txt keydir/pubkey.txt
 
287
run-client: all keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem
261
288
        @echo "###################################################################"
262
289
        @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             #"
 
290
        @echo "# ignored:                                                        #"
 
291
        @echo "# From plugin-runner: setgid: Operation not permitted             #"
 
292
        @echo "#                     setuid: Operation not permitted             #"
267
293
        @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            #"
 
294
        @echo "# From mandos-client:                                             #"
 
295
        @echo "#             Failed to raise privileges: Operation not permitted #"
 
296
        @echo "#             Warning: network hook \"*\" exited with status *      #"
 
297
        @echo "#                                                                 #"
 
298
        @echo "# (The messages are caused by not running as root, but you should #"
 
299
        @echo "# NOT run \"make run-client\" as root unless you also unpacked and  #"
 
300
        @echo "# compiled Mandos as root, which is also NOT recommended.)        #"
271
301
        @echo "###################################################################"
 
302
# We set GNOME_KEYRING_CONTROL to block pam_gnome_keyring
272
303
        ./plugin-runner --plugin-dir=plugins.d \
 
304
                --plugin-helper-dir=plugin-helpers \
273
305
                --config-file=plugin-runner.conf \
274
 
                --options-for=mandos-client:--seckey=keydir/seckey.txt,--pubkey=keydir/pubkey.txt,--network-hook-dir=network-hooks.d \
 
306
                --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 \
 
307
                --env-for=mandos-client:GNOME_KEYRING_CONTROL= \
275
308
                $(CLIENTARGS)
276
309
 
277
310
# Used by run-client
278
 
keydir/seckey.txt keydir/pubkey.txt: mandos-keygen
 
311
keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem: mandos-keygen
279
312
        install --directory keydir
280
313
        ./mandos-keygen --dir keydir --force
281
314
 
288
321
confdir/mandos.conf: mandos.conf
289
322
        install --directory confdir
290
323
        install --mode=u=rw,go=r $^ $@
291
 
confdir/clients.conf: clients.conf keydir/seckey.txt
 
324
confdir/clients.conf: clients.conf keydir/seckey.txt keydir/tls-pubkey.pem
292
325
        install --directory confdir
293
326
        install --mode=u=rw $< $@
294
327
# Add a client password
295
 
        ./mandos-keygen --dir keydir --password >> $@
 
328
        ./mandos-keygen --dir keydir --password --no-ssh >> $@
296
329
statedir:
297
330
        install --directory statedir
298
331
 
311
344
        elif install --directory --mode=u=rwx $(STATEDIR); then \
312
345
                chown -- $(USER):$(GROUP) $(STATEDIR) || :; \
313
346
        fi
 
347
        if [ "$(TMPFILES)" != "$(DESTDIR)" -a -d "$(TMPFILES)" ]; then \
 
348
                install --mode=u=rw,go=r tmpfiles.d-mandos.conf \
 
349
                        $(TMPFILES)/mandos.conf; \
 
350
        fi
314
351
        install --mode=u=rwx,go=rx mandos $(PREFIX)/sbin/mandos
315
352
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
316
353
                mandos-ctl
348
385
install-client-nokey: all doc
349
386
        install --directory $(LIBDIR)/mandos $(CONFDIR)
350
387
        install --directory --mode=u=rwx $(KEYDIR) \
351
 
                $(LIBDIR)/mandos/plugins.d
 
388
                $(LIBDIR)/mandos/plugins.d \
 
389
                $(LIBDIR)/mandos/plugin-helpers
352
390
        if [ "$(CONFDIR)" != "$(LIBDIR)/mandos" ]; then \
353
391
                install --mode=u=rwx \
354
 
                        --directory "$(CONFDIR)/plugins.d"; \
 
392
                        --directory "$(CONFDIR)/plugins.d" \
 
393
                        "$(CONFDIR)/plugin-helpers"; \
355
394
        fi
356
395
        install --mode=u=rwx,go=rx --directory \
357
396
                "$(CONFDIR)/network-hooks.d"
358
397
        install --mode=u=rwx,go=rx \
359
398
                --target-directory=$(LIBDIR)/mandos plugin-runner
 
399
        install --mode=u=rwx,go=rx \
 
400
                --target-directory=$(LIBDIR)/mandos mandos-to-cryptroot-unlock
360
401
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
361
402
                mandos-keygen
362
403
        install --mode=u=rwx,go=rx \
377
418
        install --mode=u=rwxs,go=rx \
378
419
                --target-directory=$(LIBDIR)/mandos/plugins.d \
379
420
                plugins.d/plymouth
 
421
        install --mode=u=rwx,go=rx \
 
422
                --target-directory=$(LIBDIR)/mandos/plugin-helpers \
 
423
                plugin-helpers/mandos-client-iprouteadddel
380
424
        install initramfs-tools-hook \
381
425
                $(INITRAMFSTOOLS)/hooks/mandos
382
 
        install --mode=u=rw,go=r initramfs-tools-hook-conf \
383
 
                $(INITRAMFSTOOLS)/conf-hooks.d/mandos
 
426
        install --mode=u=rw,go=r initramfs-tools-conf \
 
427
                $(INITRAMFSTOOLS)/conf.d/mandos-conf
 
428
        install --mode=u=rw,go=r initramfs-tools-conf-hook \
 
429
                $(INITRAMFSTOOLS)/conf-hooks.d/zz-mandos
384
430
        install initramfs-tools-script \
385
431
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos
 
432
        install initramfs-tools-script-stop \
 
433
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos
386
434
        install --mode=u=rw,go=r plugin-runner.conf $(CONFDIR)
387
435
        gzip --best --to-stdout mandos-keygen.8 \
388
436
                > $(MANDIR)/man8/mandos-keygen.8.gz
462
510
        -rmdir $(CONFDIR)
463
511
 
464
512
purge-client: uninstall-client
465
 
        -shred --remove $(KEYDIR)/seckey.txt
 
513
        -shred --remove $(KEYDIR)/seckey.txt $(KEYDIR)/tls-privkey.pem
466
514
        -rm --force $(CONFDIR)/plugin-runner.conf \
467
 
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt
 
515
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt \
 
516
                $(KEYDIR)/tls-pubkey.txt $(KEYDIR)/tls-privkey.txt
468
517
        -rmdir $(KEYDIR) $(CONFDIR)/plugins.d $(CONFDIR)