/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-18 00:02:43 UTC
  • Revision ID: teddy@recompile.se-20190718000243-okz4s9xao1r1tfnx
Document bug in mandos-keygen which strips white space from passwords

Passwords, as read by mandos-keygen when given the --password or -p
options, are stripped of white space from the start and from the end
of the password.  This is because mandos-keygen is a shell script, and
the Bourne Shell "read" builtin does not seem to have a way to avoid
this.  Document this bug.

* manods-keygen.xml (OPTIONS): Document the white space-stripping
                               nature of the --password/-p option, and
                               also note in the description of
                               --passfile and -F that they avoid this
                               behavior.
  (BUGS): Again mention the problem with the --password and -p
          options, and suggest --passfile as a possible workaround.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
WARN=-O -Wall -Wextra -Wdouble-promotion -Wformat=2 -Winit-self \
 
1
WARN:=-O -Wall -Wextra -Wdouble-promotion -Wformat=2 -Winit-self \
2
2
        -Wmissing-include-dirs -Wswitch-default -Wswitch-enum \
3
3
        -Wunused -Wuninitialized -Wstrict-overflow=5 \
4
4
        -Wsuggest-attribute=pure -Wsuggest-attribute=const \
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
 
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
 
14
30
# For info about _FORTIFY_SOURCE, see feature_test_macros(7)
15
 
# and <http://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
 
# The sanitizing options are available in GCC 4.9 and above.
19
 
ifeq ($(shell test $(shell $(CC) -dumpversion) \> 4.9-; echo $$?),0)
20
 
SANITIZE:=-fsanitize=address -fsanitize=undefined -fsanitize=shift \
21
 
        -fsanitize=integer-divide-by-zero -fsanitize=unreachable \
22
 
        -fsanitize=vla-bound -fsanitize=null -fsanitize=return \
23
 
        -fsanitize=signed-integer-overflow
24
 
# GCC 5.3 has some more sanitizing options
25
 
ifeq ($(shell test $(shell $(CC) -dumpversion) \> 5.3-; echo $$?),0)
26
 
SANITIZE+=-fsanitize=bounds -fsanitize=alignment \
27
 
        -fsanitize=object-size -fsanitize=float-divide-by-zero \
28
 
        -fsanitize=float-cast-overflow -fsanitize=nonnull-attribute \
29
 
        -fsanitize=returns-nonnull-attribute -fsanitize=bool \
30
 
        -fsanitize=enum
31
 
endif
32
 
else
33
 
SANITIZE:=
34
 
endif
35
 
LINK_FORTIFY_LD=-z relro -z now
36
 
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:=
37
35
 
38
36
# If BROKEN_PIE is set, do not build with -pie
39
37
ifndef BROKEN_PIE
41
39
LINK_FORTIFY += -pie
42
40
endif
43
41
#COVERAGE=--coverage
44
 
OPTIMIZE=-Os -fno-strict-aliasing
45
 
LANGUAGE=-std=gnu11
46
 
htmldir=man
47
 
version=1.7.2
48
 
SED=sed
 
42
OPTIMIZE:=-Os -fno-strict-aliasing
 
43
LANGUAGE:=-std=gnu11
 
44
htmldir:=man
 
45
version:=1.8.4
 
46
SED:=sed
49
47
 
50
 
USER=$(firstword $(subst :, ,$(shell getent passwd _mandos || getent passwd nobody || echo 65534)))
51
 
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)))
52
52
 
53
53
## Use these settings for a traditional /usr/local install
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
 
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
61
61
##
62
62
 
63
63
## These settings are for a package-type install
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 \
 
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 \
71
71
        for d in \
72
72
        "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
73
73
        "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/lib; do \
78
78
        done)
79
79
##
80
80
 
81
 
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)
82
83
 
83
 
GNUTLS_CFLAGS=$(shell pkg-config --cflags-only-I gnutls)
84
 
GNUTLS_LIBS=$(shell pkg-config --libs gnutls)
85
 
AVAHI_CFLAGS=$(shell pkg-config --cflags-only-I avahi-core)
86
 
AVAHI_LIBS=$(shell pkg-config --libs avahi-core)
87
 
GPGME_CFLAGS=$(shell gpgme-config --cflags; getconf LFS_CFLAGS)
88
 
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; \
89
90
        getconf LFS_LDFLAGS)
90
 
LIBNL3_CFLAGS=$(shell pkg-config --cflags-only-I libnl-route-3.0)
91
 
LIBNL3_LIBS=$(shell pkg-config --libs libnl-route-3.0)
 
91
LIBNL3_CFLAGS:=$(shell pkg-config --cflags-only-I libnl-route-3.0)
 
92
LIBNL3_LIBS:=$(shell pkg-config --libs libnl-route-3.0)
92
93
 
93
94
# Do not change these two
94
 
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(SANITIZE) $(COVERAGE) \
95
 
        $(OPTIMIZE) $(LANGUAGE) $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) \
96
 
        $(GPGME_CFLAGS) -DVERSION='"$(version)"'
97
 
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))
98
99
 
99
100
# Commands to format a DocBook <refentry> document into a manual page
100
101
DOCBOOKTOMAN=$(strip cd $(dir $<); xsltproc --nonet --xinclude \
120
121
        /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl \
121
122
        $<; $(HTMLPOST) $@)
122
123
# Fix citerefentry links
123
 
HTMLPOST=$(SED) --in-place \
 
124
HTMLPOST:=$(SED) --in-place \
124
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'
125
126
 
126
 
PLUGINS=plugins.d/password-prompt plugins.d/mandos-client \
 
127
PLUGINS:=plugins.d/password-prompt plugins.d/mandos-client \
127
128
        plugins.d/usplash plugins.d/splashy plugins.d/askpass-fifo \
128
129
        plugins.d/plymouth
129
 
PLUGIN_HELPERS=plugin-helpers/mandos-client-iprouteadddel
130
 
CPROGS=plugin-runner $(PLUGINS) $(PLUGIN_HELPERS)
131
 
PROGS=mandos mandos-keygen mandos-ctl mandos-monitor $(CPROGS)
132
 
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 \
133
134
        mandos.conf.5 mandos-clients.conf.5 plugin-runner.8mandos \
134
135
        plugins.d/mandos-client.8mandos \
135
136
        plugins.d/password-prompt.8mandos plugins.d/usplash.8mandos \
136
137
        plugins.d/splashy.8mandos plugins.d/askpass-fifo.8mandos \
137
138
        plugins.d/plymouth.8mandos intro.8mandos
138
139
 
139
 
htmldocs=$(addsuffix .xhtml,$(DOCS))
 
140
htmldocs:=$(addsuffix .xhtml,$(DOCS))
140
141
 
141
 
objects=$(addsuffix .o,$(CPROGS))
 
142
objects:=$(addsuffix .o,$(CPROGS))
142
143
 
143
144
all: $(PROGS) mandos.lsm
144
145
 
256
257
                --expression='s/\(mandos_\)[0-9.]\+\(\.orig\.tar\.gz\)/\1$(version)\2/' \
257
258
                $@)
258
259
 
 
260
# Need to add the GnuTLS, Avahi and GPGME libraries
259
261
plugins.d/mandos-client: plugins.d/mandos-client.c
260
 
        $(LINK.c) $^ -lrt $(GNUTLS_LIBS) $(AVAHI_LIBS) $(strip\
261
 
                ) $(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 $@
262
266
 
 
267
# Need to add the libnl-route library
263
268
plugin-helpers/mandos-client-iprouteadddel: plugin-helpers/mandos-client-iprouteadddel.c
264
269
        $(LINK.c) $(LIBNL3_CFLAGS) $^ $(LIBNL3_LIBS) $(strip\
265
270
                ) $(LOADLIBES) $(LDLIBS) -o $@
278
283
maintainer-clean: clean
279
284
        -rm --force --recursive keydir confdir statedir
280
285
 
281
 
check:  all
 
286
check: all
282
287
        ./mandos --check
283
288
        ./mandos-ctl --check
 
289
        ./mandos-keygen --version
 
290
        ./plugin-runner --version
 
291
        ./plugin-helpers/mandos-client-iprouteadddel --version
284
292
 
285
293
# Run the client with a local config and key
286
 
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
287
295
        @echo "###################################################################"
288
296
        @echo "# The following error messages are harmless and can be safely     #"
289
 
        @echo "# ignored.  The messages are caused by not running as root, but   #"
290
 
        @echo "# you should NOT run \"make run-client\" as root unless you also    #"
291
 
        @echo "# unpacked and compiled Mandos as root, which is NOT recommended. #"
 
297
        @echo "# ignored:                                                        #"
292
298
        @echo "# From plugin-runner: setgid: Operation not permitted             #"
293
299
        @echo "#                     setuid: Operation not permitted             #"
294
300
        @echo "# From askpass-fifo:  mkfifo: Permission denied                   #"
295
301
        @echo "# From mandos-client:                                             #"
296
302
        @echo "#             Failed to raise privileges: Operation not permitted #"
297
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.)        #"
298
308
        @echo "###################################################################"
299
309
# We set GNOME_KEYRING_CONTROL to block pam_gnome_keyring
300
310
        ./plugin-runner --plugin-dir=plugins.d \
301
311
                --plugin-helper-dir=plugin-helpers \
302
312
                --config-file=plugin-runner.conf \
303
 
                --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 \
304
314
                --env-for=mandos-client:GNOME_KEYRING_CONTROL= \
305
315
                $(CLIENTARGS)
306
316
 
307
317
# Used by run-client
308
 
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
309
319
        install --directory keydir
310
320
        ./mandos-keygen --dir keydir --force
311
321
 
318
328
confdir/mandos.conf: mandos.conf
319
329
        install --directory confdir
320
330
        install --mode=u=rw,go=r $^ $@
321
 
confdir/clients.conf: clients.conf keydir/seckey.txt
 
331
confdir/clients.conf: clients.conf keydir/seckey.txt keydir/tls-pubkey.pem
322
332
        install --directory confdir
323
333
        install --mode=u=rw $< $@
324
334
# Add a client password
341
351
        elif install --directory --mode=u=rwx $(STATEDIR); then \
342
352
                chown -- $(USER):$(GROUP) $(STATEDIR) || :; \
343
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
344
358
        install --mode=u=rwx,go=rx mandos $(PREFIX)/sbin/mandos
345
359
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
346
360
                mandos-ctl
382
396
                $(LIBDIR)/mandos/plugin-helpers
383
397
        if [ "$(CONFDIR)" != "$(LIBDIR)/mandos" ]; then \
384
398
                install --mode=u=rwx \
385
 
                        --directory "$(CONFDIR)/plugins.d"; \
386
 
                install --directory "$(CONFDIR)/plugin-helpers"; \
 
399
                        --directory "$(CONFDIR)/plugins.d" \
 
400
                        "$(CONFDIR)/plugin-helpers"; \
387
401
        fi
388
402
        install --mode=u=rwx,go=rx --directory \
389
403
                "$(CONFDIR)/network-hooks.d"
390
404
        install --mode=u=rwx,go=rx \
391
405
                --target-directory=$(LIBDIR)/mandos plugin-runner
 
406
        install --mode=u=rwx,go=rx \
 
407
                --target-directory=$(LIBDIR)/mandos mandos-to-cryptroot-unlock
392
408
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
393
409
                mandos-keygen
394
410
        install --mode=u=rwx,go=rx \
409
425
        install --mode=u=rwxs,go=rx \
410
426
                --target-directory=$(LIBDIR)/mandos/plugins.d \
411
427
                plugins.d/plymouth
412
 
        install --mode=u=rwxs,go=rx \
 
428
        install --mode=u=rwx,go=rx \
413
429
                --target-directory=$(LIBDIR)/mandos/plugin-helpers \
414
430
                plugin-helpers/mandos-client-iprouteadddel
415
431
        install initramfs-tools-hook \
416
432
                $(INITRAMFSTOOLS)/hooks/mandos
417
 
        install --mode=u=rw,go=r initramfs-tools-hook-conf \
418
 
                $(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
419
437
        install initramfs-tools-script \
420
438
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos
 
439
        install initramfs-tools-script-stop \
 
440
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos
421
441
        install --mode=u=rw,go=r plugin-runner.conf $(CONFDIR)
422
442
        gzip --best --to-stdout mandos-keygen.8 \
423
443
                > $(MANDIR)/man8/mandos-keygen.8.gz
497
517
        -rmdir $(CONFDIR)
498
518
 
499
519
purge-client: uninstall-client
500
 
        -shred --remove $(KEYDIR)/seckey.txt
 
520
        -shred --remove $(KEYDIR)/seckey.txt $(KEYDIR)/tls-privkey.pem
501
521
        -rm --force $(CONFDIR)/plugin-runner.conf \
502
 
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt
 
522
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt \
 
523
                $(KEYDIR)/tls-pubkey.txt $(KEYDIR)/tls-privkey.txt
503
524
        -rmdir $(KEYDIR) $(CONFDIR)/plugins.d $(CONFDIR)