/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: 2019-07-18 00:02:43 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • 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
14
 
# 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
 
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
 
ALL_SANITIZE_OPTIONS:=-fsanitize=address -fsanitize=undefined \
 
20
ALL_SANITIZE_OPTIONS:=-fsanitize=leak -fsanitize=undefined \
19
21
        -fsanitize=shift -fsanitize=integer-divide-by-zero \
20
22
        -fsanitize=unreachable -fsanitize=vla-bound -fsanitize=null \
21
23
        -fsanitize=return -fsanitize=signed-integer-overflow \
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)))
31
 
LINK_FORTIFY_LD=-z relro -z now
32
 
LINK_FORTIFY=
 
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
 
33
LINK_FORTIFY_LD:=-z relro -z now
 
34
LINK_FORTIFY:=
33
35
 
34
36
# If BROKEN_PIE is set, do not build with -pie
35
37
ifndef BROKEN_PIE
37
39
LINK_FORTIFY += -pie
38
40
endif
39
41
#COVERAGE=--coverage
40
 
OPTIMIZE=-Os -fno-strict-aliasing
41
 
LANGUAGE=-std=gnu11
42
 
htmldir=man
43
 
version=1.7.4
44
 
SED=sed
 
42
OPTIMIZE:=-Os -fno-strict-aliasing
 
43
LANGUAGE:=-std=gnu11
 
44
htmldir:=man
 
45
version:=1.8.4
 
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)))
48
52
 
49
53
## Use these settings for a traditional /usr/local install
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
 
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
57
61
##
58
62
 
59
63
## These settings are for a package-type install
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 \
 
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 \
67
71
        for d in \
68
72
        "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
69
73
        "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/lib; do \
74
78
        done)
75
79
##
76
80
 
77
 
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)
78
83
 
79
 
GNUTLS_CFLAGS=$(shell pkg-config --cflags-only-I gnutls)
80
 
GNUTLS_LIBS=$(shell pkg-config --libs gnutls)
81
 
AVAHI_CFLAGS=$(shell pkg-config --cflags-only-I avahi-core)
82
 
AVAHI_LIBS=$(shell pkg-config --libs avahi-core)
83
 
GPGME_CFLAGS=$(shell gpgme-config --cflags; getconf LFS_CFLAGS)
84
 
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; \
85
90
        getconf LFS_LDFLAGS)
86
 
LIBNL3_CFLAGS=$(shell pkg-config --cflags-only-I libnl-route-3.0)
87
 
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)
88
93
 
89
94
# Do not change these two
90
 
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(SANITIZE) $(COVERAGE) \
91
 
        $(OPTIMIZE) $(LANGUAGE) $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) \
92
 
        $(GPGME_CFLAGS) -DVERSION='"$(version)"'
93
 
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))
94
99
 
95
100
# Commands to format a DocBook <refentry> document into a manual page
96
101
DOCBOOKTOMAN=$(strip cd $(dir $<); xsltproc --nonet --xinclude \
116
121
        /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl \
117
122
        $<; $(HTMLPOST) $@)
118
123
# Fix citerefentry links
119
 
HTMLPOST=$(SED) --in-place \
 
124
HTMLPOST:=$(SED) --in-place \
120
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'
121
126
 
122
 
PLUGINS=plugins.d/password-prompt plugins.d/mandos-client \
 
127
PLUGINS:=plugins.d/password-prompt plugins.d/mandos-client \
123
128
        plugins.d/usplash plugins.d/splashy plugins.d/askpass-fifo \
124
129
        plugins.d/plymouth
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 \
 
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 \
129
134
        mandos.conf.5 mandos-clients.conf.5 plugin-runner.8mandos \
130
135
        plugins.d/mandos-client.8mandos \
131
136
        plugins.d/password-prompt.8mandos plugins.d/usplash.8mandos \
132
137
        plugins.d/splashy.8mandos plugins.d/askpass-fifo.8mandos \
133
138
        plugins.d/plymouth.8mandos intro.8mandos
134
139
 
135
 
htmldocs=$(addsuffix .xhtml,$(DOCS))
 
140
htmldocs:=$(addsuffix .xhtml,$(DOCS))
136
141
 
137
 
objects=$(addsuffix .o,$(CPROGS))
 
142
objects:=$(addsuffix .o,$(CPROGS))
138
143
 
139
144
all: $(PROGS) mandos.lsm
140
145
 
252
257
                --expression='s/\(mandos_\)[0-9.]\+\(\.orig\.tar\.gz\)/\1$(version)\2/' \
253
258
                $@)
254
259
 
 
260
# Need to add the GnuTLS, Avahi and GPGME libraries
255
261
plugins.d/mandos-client: plugins.d/mandos-client.c
256
 
        $(LINK.c) $^ -lrt $(GNUTLS_LIBS) $(AVAHI_LIBS) $(strip\
257
 
                ) $(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 $@
258
266
 
 
267
# Need to add the libnl-route library
259
268
plugin-helpers/mandos-client-iprouteadddel: plugin-helpers/mandos-client-iprouteadddel.c
260
269
        $(LINK.c) $(LIBNL3_CFLAGS) $^ $(LIBNL3_LIBS) $(strip\
261
270
                ) $(LOADLIBES) $(LDLIBS) -o $@
274
283
maintainer-clean: clean
275
284
        -rm --force --recursive keydir confdir statedir
276
285
 
277
 
check:  all
 
286
check: all
278
287
        ./mandos --check
279
288
        ./mandos-ctl --check
 
289
        ./mandos-keygen --version
 
290
        ./plugin-runner --version
 
291
        ./plugin-helpers/mandos-client-iprouteadddel --version
280
292
 
281
293
# Run the client with a local config and key
282
 
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
283
295
        @echo "###################################################################"
284
296
        @echo "# The following error messages are harmless and can be safely     #"
285
 
        @echo "# ignored.  The messages are caused by not running as root, but   #"
286
 
        @echo "# you should NOT run \"make run-client\" as root unless you also    #"
287
 
        @echo "# unpacked and compiled Mandos as root, which is NOT recommended. #"
 
297
        @echo "# ignored:                                                        #"
288
298
        @echo "# From plugin-runner: setgid: Operation not permitted             #"
289
299
        @echo "#                     setuid: Operation not permitted             #"
290
300
        @echo "# From askpass-fifo:  mkfifo: Permission denied                   #"
291
301
        @echo "# From mandos-client:                                             #"
292
302
        @echo "#             Failed to raise privileges: Operation not permitted #"
293
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.)        #"
294
308
        @echo "###################################################################"
295
309
# We set GNOME_KEYRING_CONTROL to block pam_gnome_keyring
296
310
        ./plugin-runner --plugin-dir=plugins.d \
297
311
                --plugin-helper-dir=plugin-helpers \
298
312
                --config-file=plugin-runner.conf \
299
 
                --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 \
300
314
                --env-for=mandos-client:GNOME_KEYRING_CONTROL= \
301
315
                $(CLIENTARGS)
302
316
 
303
317
# Used by run-client
304
 
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
305
319
        install --directory keydir
306
320
        ./mandos-keygen --dir keydir --force
307
321
 
314
328
confdir/mandos.conf: mandos.conf
315
329
        install --directory confdir
316
330
        install --mode=u=rw,go=r $^ $@
317
 
confdir/clients.conf: clients.conf keydir/seckey.txt
 
331
confdir/clients.conf: clients.conf keydir/seckey.txt keydir/tls-pubkey.pem
318
332
        install --directory confdir
319
333
        install --mode=u=rw $< $@
320
334
# Add a client password
337
351
        elif install --directory --mode=u=rwx $(STATEDIR); then \
338
352
                chown -- $(USER):$(GROUP) $(STATEDIR) || :; \
339
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
340
358
        install --mode=u=rwx,go=rx mandos $(PREFIX)/sbin/mandos
341
359
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
342
360
                mandos-ctl
378
396
                $(LIBDIR)/mandos/plugin-helpers
379
397
        if [ "$(CONFDIR)" != "$(LIBDIR)/mandos" ]; then \
380
398
                install --mode=u=rwx \
381
 
                        --directory "$(CONFDIR)/plugins.d"; \
382
 
                install --directory "$(CONFDIR)/plugin-helpers"; \
 
399
                        --directory "$(CONFDIR)/plugins.d" \
 
400
                        "$(CONFDIR)/plugin-helpers"; \
383
401
        fi
384
402
        install --mode=u=rwx,go=rx --directory \
385
403
                "$(CONFDIR)/network-hooks.d"
386
404
        install --mode=u=rwx,go=rx \
387
405
                --target-directory=$(LIBDIR)/mandos plugin-runner
 
406
        install --mode=u=rwx,go=rx \
 
407
                --target-directory=$(LIBDIR)/mandos mandos-to-cryptroot-unlock
388
408
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
389
409
                mandos-keygen
390
410
        install --mode=u=rwx,go=rx \
405
425
        install --mode=u=rwxs,go=rx \
406
426
                --target-directory=$(LIBDIR)/mandos/plugins.d \
407
427
                plugins.d/plymouth
408
 
        install --mode=u=rwxs,go=rx \
 
428
        install --mode=u=rwx,go=rx \
409
429
                --target-directory=$(LIBDIR)/mandos/plugin-helpers \
410
430
                plugin-helpers/mandos-client-iprouteadddel
411
431
        install initramfs-tools-hook \
412
432
                $(INITRAMFSTOOLS)/hooks/mandos
413
 
        install --mode=u=rw,go=r initramfs-tools-hook-conf \
414
 
                $(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
415
437
        install initramfs-tools-script \
416
438
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos
 
439
        install initramfs-tools-script-stop \
 
440
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos
417
441
        install --mode=u=rw,go=r plugin-runner.conf $(CONFDIR)
418
442
        gzip --best --to-stdout mandos-keygen.8 \
419
443
                > $(MANDIR)/man8/mandos-keygen.8.gz
493
517
        -rmdir $(CONFDIR)
494
518
 
495
519
purge-client: uninstall-client
496
 
        -shred --remove $(KEYDIR)/seckey.txt
 
520
        -shred --remove $(KEYDIR)/seckey.txt $(KEYDIR)/tls-privkey.pem
497
521
        -rm --force $(CONFDIR)/plugin-runner.conf \
498
 
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt
 
522
                $(KEYDIR)/pubkey.txt $(KEYDIR)/seckey.txt \
 
523
                $(KEYDIR)/tls-pubkey.txt $(KEYDIR)/tls-privkey.txt
499
524
        -rmdir $(KEYDIR) $(CONFDIR)/plugins.d $(CONFDIR)