/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:
41
41
#COVERAGE=--coverage
42
42
OPTIMIZE:=-Os -fno-strict-aliasing
43
43
LANGUAGE:=-std=gnu11
44
 
FEATURES:=-D_FILE_OFFSET_BITS=64
45
44
htmldir:=man
46
 
version:=1.8.9
 
45
version:=1.8.4
47
46
SED:=sed
48
 
PKG_CONFIG?=pkg-config
49
47
 
50
48
USER:=$(firstword $(subst :, ,$(shell getent passwd _mandos \
51
49
        || getent passwd nobody || echo 65534)))
52
50
GROUP:=$(firstword $(subst :, ,$(shell getent group _mandos \
53
51
        || getent group nogroup || echo 65534)))
54
52
 
55
 
LINUXVERSION:=$(shell uname --kernel-release)
56
 
 
57
53
## Use these settings for a traditional /usr/local install
58
54
# PREFIX:=$(DESTDIR)/usr/local
59
55
# CONFDIR:=$(DESTDIR)/etc/mandos
60
56
# KEYDIR:=$(DESTDIR)/etc/mandos/keys
61
57
# MANDIR:=$(PREFIX)/man
62
58
# INITRAMFSTOOLS:=$(DESTDIR)/etc/initramfs-tools
63
 
# DRACUTMODULE:=$(DESTDIR)/usr/lib/dracut/modules.d/90mandos
64
59
# STATEDIR:=$(DESTDIR)/var/lib/mandos
65
60
# LIBDIR:=$(PREFIX)/lib
66
61
##
71
66
KEYDIR:=$(DESTDIR)/etc/keys/mandos
72
67
MANDIR:=$(PREFIX)/share/man
73
68
INITRAMFSTOOLS:=$(DESTDIR)/usr/share/initramfs-tools
74
 
DRACUTMODULE:=$(DESTDIR)/usr/lib/dracut/modules.d/90mandos
75
69
STATEDIR:=$(DESTDIR)/var/lib/mandos
76
70
LIBDIR:=$(shell \
77
71
        for d in \
78
 
        "/usr/lib/`dpkg-architecture \
79
 
                        -qDEB_HOST_MULTIARCH 2>/dev/null`" \
 
72
        "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
80
73
        "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/lib; do \
81
74
                if [ -d "$$d" -a "$$d" = "$${d%/}" ]; then \
82
75
                        echo "$(DESTDIR)$$d"; \
85
78
        done)
86
79
##
87
80
 
88
 
SYSTEMD:=$(DESTDIR)$(shell $(PKG_CONFIG) systemd \
89
 
                        --variable=systemdsystemunitdir)
90
 
TMPFILES:=$(DESTDIR)$(shell $(PKG_CONFIG) systemd \
91
 
                        --variable=tmpfilesdir)
92
 
SYSUSERS:=$(DESTDIR)$(shell $(PKG_CONFIG) systemd \
93
 
                        --variable=sysusersdir)
 
81
SYSTEMD:=$(DESTDIR)$(shell pkg-config systemd --variable=systemdsystemunitdir)
 
82
TMPFILES:=$(DESTDIR)$(shell pkg-config systemd --variable=tmpfilesdir)
94
83
 
95
 
GNUTLS_CFLAGS:=$(shell $(PKG_CONFIG) --cflags-only-I gnutls)
96
 
GNUTLS_LIBS:=$(shell $(PKG_CONFIG) --libs gnutls)
97
 
AVAHI_CFLAGS:=$(shell $(PKG_CONFIG) --cflags-only-I avahi-core)
98
 
AVAHI_LIBS:=$(shell $(PKG_CONFIG) --libs avahi-core)
 
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)
99
88
GPGME_CFLAGS:=$(shell gpgme-config --cflags; getconf LFS_CFLAGS)
100
89
GPGME_LIBS:=$(shell gpgme-config --libs; getconf LFS_LIBS; \
101
90
        getconf LFS_LDFLAGS)
102
 
LIBNL3_CFLAGS:=$(shell $(PKG_CONFIG) --cflags-only-I libnl-route-3.0)
103
 
LIBNL3_LIBS:=$(shell $(PKG_CONFIG) --libs libnl-route-3.0)
104
 
GLIB_CFLAGS:=$(shell $(PKG_CONFIG) --cflags glib-2.0)
105
 
GLIB_LIBS:=$(shell $(PKG_CONFIG) --libs glib-2.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)
106
93
 
107
94
# Do not change these two
108
 
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) $(OPTIMIZE) \
109
 
        $(LANGUAGE) $(FEATURES) -DVERSION='"$(version)"'
 
95
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) \
 
96
        $(OPTIMIZE) $(LANGUAGE) -DVERSION='"$(version)"'
110
97
LDFLAGS+=-Xlinker --as-needed $(COVERAGE) $(LINK_FORTIFY) $(strip \
111
98
        ) $(foreach flag,$(LINK_FORTIFY_LD),-Xlinker $(flag))
112
99
 
120
107
        /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
121
108
        $(notdir $<); \
122
109
        if locale --all 2>/dev/null | grep --regexp='^en_US\.utf8$$' \
123
 
        && command -v man >/dev/null; then LANG=en_US.UTF-8 \
124
 
        MANWIDTH=80 man --warnings --encoding=UTF-8 --local-file \
125
 
        $(notdir $@); fi >/dev/null)
 
110
        && type man 2>/dev/null; then LANG=en_US.UTF-8 MANWIDTH=80 \
 
111
        man --warnings --encoding=UTF-8 --local-file $(notdir $@); \
 
112
        fi >/dev/null)
126
113
 
127
114
DOCBOOKTOHTML=$(strip xsltproc --nonet --xinclude \
128
115
        --param make.year.ranges                1 \
141
128
        plugins.d/usplash plugins.d/splashy plugins.d/askpass-fifo \
142
129
        plugins.d/plymouth
143
130
PLUGIN_HELPERS:=plugin-helpers/mandos-client-iprouteadddel
144
 
CPROGS:=plugin-runner dracut-module/password-agent $(PLUGINS) \
145
 
        $(PLUGIN_HELPERS)
 
131
CPROGS:=plugin-runner $(PLUGINS) $(PLUGIN_HELPERS)
146
132
PROGS:=mandos mandos-keygen mandos-ctl mandos-monitor $(CPROGS)
147
133
DOCS:=mandos.8 mandos-keygen.8 mandos-monitor.8 mandos-ctl.8 \
148
134
        mandos.conf.5 mandos-clients.conf.5 plugin-runner.8mandos \
149
 
        dracut-module/password-agent.8mandos \
150
135
        plugins.d/mandos-client.8mandos \
151
136
        plugins.d/password-prompt.8mandos plugins.d/usplash.8mandos \
152
137
        plugins.d/splashy.8mandos plugins.d/askpass-fifo.8mandos \
156
141
 
157
142
objects:=$(addsuffix .o,$(CPROGS))
158
143
 
159
 
.PHONY: all
160
144
all: $(PROGS) mandos.lsm
161
145
 
162
 
.PHONY: doc
163
146
doc: $(DOCS)
164
147
 
165
 
.PHONY: html
166
148
html: $(htmldocs)
167
149
 
168
150
%.5: %.xml common.ent legalnotice.xml
227
209
                overview.xml legalnotice.xml
228
210
        $(DOCBOOKTOHTML)
229
211
 
230
 
dracut-module/password-agent.8mandos: \
231
 
                dracut-module/password-agent.xml common.ent \
232
 
                overview.xml legalnotice.xml
233
 
        $(DOCBOOKTOMAN)
234
 
dracut-module/password-agent.8mandos.xhtml: \
235
 
                dracut-module/password-agent.xml common.ent \
236
 
                overview.xml legalnotice.xml
237
 
        $(DOCBOOKTOHTML)
238
 
 
239
212
plugins.d/mandos-client.8mandos: plugins.d/mandos-client.xml \
240
213
                                        common.ent \
241
214
                                        mandos-options.xml \
285
258
                $@)
286
259
 
287
260
# Need to add the GnuTLS, Avahi and GPGME libraries
288
 
plugins.d/mandos-client: CFLAGS += $(GNUTLS_CFLAGS) $(strip \
289
 
        ) $(AVAHI_CFLAGS) $(GPGME_CFLAGS)
290
 
plugins.d/mandos-client: LDLIBS += $(GNUTLS_LIBS) $(strip \
291
 
        ) $(AVAHI_LIBS) $(GPGME_LIBS)
 
261
plugins.d/mandos-client: plugins.d/mandos-client.c
 
262
        $(LINK.c) $^ $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(strip\
 
263
                ) $(GPGME_CFLAGS) $(GNUTLS_LIBS) $(strip\
 
264
                ) $(AVAHI_LIBS) $(GPGME_LIBS) $(LOADLIBES) $(strip\
 
265
                ) $(LDLIBS) -o $@
292
266
 
293
267
# Need to add the libnl-route library
294
 
plugin-helpers/mandos-client-iprouteadddel: CFLAGS += $(LIBNL3_CFLAGS)
295
 
plugin-helpers/mandos-client-iprouteadddel: LDLIBS += $(LIBNL3_LIBS)
296
 
 
297
 
# Need to add the GLib and pthread libraries
298
 
dracut-module/password-agent: CFLAGS += $(GLIB_CFLAGS)
299
 
dracut-module/password-agent: LDLIBS += $(GLIB_LIBS) -lpthread
300
 
 
301
 
.PHONY: clean
 
268
plugin-helpers/mandos-client-iprouteadddel: plugin-helpers/mandos-client-iprouteadddel.c
 
269
        $(LINK.c) $(LIBNL3_CFLAGS) $^ $(LIBNL3_LIBS) $(strip\
 
270
                ) $(LOADLIBES) $(LDLIBS) -o $@
 
271
 
 
272
.PHONY : all doc html clean distclean mostlyclean maintainer-clean \
 
273
        check run-client run-server install install-html \
 
274
        install-server install-client-nokey install-client uninstall \
 
275
        uninstall-server uninstall-client purge purge-server \
 
276
        purge-client
 
277
 
302
278
clean:
303
279
        -rm --force $(CPROGS) $(objects) $(htmldocs) $(DOCS) core
304
280
 
305
 
.PHONY: distclean
306
281
distclean: clean
307
 
.PHONY: mostlyclean
308
282
mostlyclean: clean
309
 
.PHONY: maintainer-clean
310
283
maintainer-clean: clean
311
284
        -rm --force --recursive keydir confdir statedir
312
285
 
313
 
.PHONY: check
314
286
check: all
315
287
        ./mandos --check
316
288
        ./mandos-ctl --check
317
289
        ./mandos-keygen --version
318
290
        ./plugin-runner --version
319
291
        ./plugin-helpers/mandos-client-iprouteadddel --version
320
 
        ./dracut-module/password-agent --test
321
292
 
322
293
# Run the client with a local config and key
323
 
.PHONY: run-client
324
 
run-client: all keydir/seckey.txt keydir/pubkey.txt \
325
 
                        keydir/tls-privkey.pem keydir/tls-pubkey.pem
326
 
        @echo '######################################################'
327
 
        @echo '# The following error messages are harmless and can  #'
328
 
        @echo '#  be safely ignored:                                #'
329
 
        @echo '## From plugin-runner:                               #'
330
 
        @echo '# setgid: Operation not permitted                    #'
331
 
        @echo '# setuid: Operation not permitted                    #'
332
 
        @echo '## From askpass-fifo:                                #'
333
 
        @echo '# mkfifo: Permission denied                          #'
334
 
        @echo '## From mandos-client:                               #'
335
 
        @echo '# Failed to raise privileges: Operation not permi... #'
336
 
        @echo '# Warning: network hook "*" exited with status *     #'
337
 
        @echo '# ioctl SIOCSIFFLAGS +IFF_UP: Operation not permi... #'
338
 
        @echo '# Failed to bring up interface "*": Operation not... #'
339
 
        @echo '#                                                    #'
340
 
        @echo '# (The messages are caused by not running as root,   #'
341
 
        @echo '# but you should NOT run "make run-client" as root   #'
342
 
        @echo '# unless you also unpacked and compiled Mandos as    #'
343
 
        @echo '# root, which is also NOT recommended.)              #'
344
 
        @echo '######################################################'
 
294
run-client: all keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem
 
295
        @echo "###################################################################"
 
296
        @echo "# The following error messages are harmless and can be safely     #"
 
297
        @echo "# ignored:                                                        #"
 
298
        @echo "# From plugin-runner: setgid: Operation not permitted             #"
 
299
        @echo "#                     setuid: Operation not permitted             #"
 
300
        @echo "# From askpass-fifo:  mkfifo: Permission denied                   #"
 
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.)        #"
 
308
        @echo "###################################################################"
345
309
# We set GNOME_KEYRING_CONTROL to block pam_gnome_keyring
346
310
        ./plugin-runner --plugin-dir=plugins.d \
347
311
                --plugin-helper-dir=plugin-helpers \
356
320
        ./mandos-keygen --dir keydir --force
357
321
 
358
322
# Run the server with a local config
359
 
.PHONY: run-server
360
323
run-server: confdir/mandos.conf confdir/clients.conf statedir
361
324
        ./mandos --debug --no-dbus --configdir=confdir \
362
325
                --statedir=statedir $(SERVERARGS)
373
336
statedir:
374
337
        install --directory statedir
375
338
 
376
 
.PHONY: install
377
339
install: install-server install-client-nokey
378
340
 
379
 
.PHONY: install-html
380
341
install-html: html
381
342
        install --directory $(htmldir)
382
343
        install --mode=u=rw,go=r --target-directory=$(htmldir) \
383
344
                $(htmldocs)
384
345
 
385
 
.PHONY: install-server
386
346
install-server: doc
387
347
        install --directory $(CONFDIR)
388
348
        if install --directory --mode=u=rwx --owner=$(USER) \
391
351
        elif install --directory --mode=u=rwx $(STATEDIR); then \
392
352
                chown -- $(USER):$(GROUP) $(STATEDIR) || :; \
393
353
        fi
394
 
        if [ "$(TMPFILES)" != "$(DESTDIR)" \
395
 
                        -a -d "$(TMPFILES)" ]; then \
 
354
        if [ "$(TMPFILES)" != "$(DESTDIR)" -a -d "$(TMPFILES)" ]; then \
396
355
                install --mode=u=rw,go=r tmpfiles.d-mandos.conf \
397
356
                        $(TMPFILES)/mandos.conf; \
398
357
        fi
399
 
        if [ "$(SYSUSERS)" != "$(DESTDIR)" \
400
 
                        -a -d "$(SYSUSERS)" ]; then \
401
 
                install --mode=u=rw,go=r sysusers.d-mandos.conf \
402
 
                        $(SYSUSERS)/mandos.conf; \
403
 
        fi
404
358
        install --mode=u=rwx,go=rx mandos $(PREFIX)/sbin/mandos
405
359
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
406
360
                mandos-ctl
435
389
        gzip --best --to-stdout intro.8mandos \
436
390
                > $(MANDIR)/man8/intro.8mandos.gz
437
391
 
438
 
.PHONY: install-client-nokey
439
392
install-client-nokey: all doc
440
393
        install --directory $(LIBDIR)/mandos $(CONFDIR)
441
394
        install --directory --mode=u=rwx $(KEYDIR) \
442
395
                $(LIBDIR)/mandos/plugins.d \
443
396
                $(LIBDIR)/mandos/plugin-helpers
444
 
        if [ "$(SYSUSERS)" != "$(DESTDIR)" \
445
 
                        -a -d "$(SYSUSERS)" ]; then \
446
 
                install --mode=u=rw,go=r sysusers.d-mandos.conf \
447
 
                        $(SYSUSERS)/mandos-client.conf; \
448
 
        fi
449
397
        if [ "$(CONFDIR)" != "$(LIBDIR)/mandos" ]; then \
450
398
                install --mode=u=rwx \
451
399
                        --directory "$(CONFDIR)/plugins.d" \
456
404
        install --mode=u=rwx,go=rx \
457
405
                --target-directory=$(LIBDIR)/mandos plugin-runner
458
406
        install --mode=u=rwx,go=rx \
459
 
                --target-directory=$(LIBDIR)/mandos \
460
 
                mandos-to-cryptroot-unlock
 
407
                --target-directory=$(LIBDIR)/mandos mandos-to-cryptroot-unlock
461
408
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
462
409
                mandos-keygen
463
410
        install --mode=u=rwx,go=rx \
491
438
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos
492
439
        install initramfs-tools-script-stop \
493
440
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos
494
 
        install --directory $(DRACUTMODULE)
495
 
        install --mode=u=rw,go=r --target-directory=$(DRACUTMODULE) \
496
 
                dracut-module/ask-password-mandos.path \
497
 
                dracut-module/ask-password-mandos.service
498
 
        install --mode=u=rwxs,go=rx \
499
 
                --target-directory=$(DRACUTMODULE) \
500
 
                dracut-module/module-setup.sh \
501
 
                dracut-module/cmdline-mandos.sh \
502
 
                dracut-module/password-agent
503
441
        install --mode=u=rw,go=r plugin-runner.conf $(CONFDIR)
504
442
        gzip --best --to-stdout mandos-keygen.8 \
505
443
                > $(MANDIR)/man8/mandos-keygen.8.gz
517
455
                > $(MANDIR)/man8/askpass-fifo.8mandos.gz
518
456
        gzip --best --to-stdout plugins.d/plymouth.8mandos \
519
457
                > $(MANDIR)/man8/plymouth.8mandos.gz
520
 
        gzip --best --to-stdout dracut-module/password-agent.8mandos \
521
 
                > $(MANDIR)/man8/password-agent.8mandos.gz
522
458
 
523
 
.PHONY: install-client
524
459
install-client: install-client-nokey
525
460
# Post-installation stuff
526
461
        -$(PREFIX)/sbin/mandos-keygen --dir "$(KEYDIR)"
527
 
        if command -v update-initramfs >/dev/null; then \
528
 
            update-initramfs -k all -u; \
529
 
        elif command -v dracut >/dev/null; then \
530
 
            for initrd in $(DESTDIR)/boot/initr*-$(LINUXVERSION); do \
531
 
                if [ -w "$$initrd" ]; then \
532
 
                    chmod go-r "$$initrd"; \
533
 
                    dracut --force "$$initrd"; \
534
 
                fi; \
535
 
            done; \
536
 
        fi
 
462
        update-initramfs -k all -u
537
463
        echo "Now run mandos-keygen --password --dir $(KEYDIR)"
538
464
 
539
 
.PHONY: uninstall
540
465
uninstall: uninstall-server uninstall-client
541
466
 
542
 
.PHONY: uninstall-server
543
467
uninstall-server:
544
468
        -rm --force $(PREFIX)/sbin/mandos \
545
469
                $(PREFIX)/sbin/mandos-ctl \
552
476
        update-rc.d -f mandos remove
553
477
        -rmdir $(CONFDIR)
554
478
 
555
 
.PHONY: uninstall-client
556
479
uninstall-client:
557
480
# Refuse to uninstall client if /etc/crypttab is explicitly configured
558
481
# to use it.
569
492
                $(INITRAMFSTOOLS)/hooks/mandos \
570
493
                $(INITRAMFSTOOLS)/conf-hooks.d/mandos \
571
494
                $(INITRAMFSTOOLS)/scripts/init-premount/mandos \
572
 
                $(INITRAMFSTOOLS)/scripts/local-premount/mandos \
573
 
                $(DRACUTMODULE)/ask-password-mandos.path \
574
 
                $(DRACUTMODULE)/ask-password-mandos.service \
575
 
                $(DRACUTMODULE)/module-setup.sh \
576
 
                $(DRACUTMODULE)/cmdline-mandos.sh \
577
 
                $(DRACUTMODULE)/password-agent \
578
495
                $(MANDIR)/man8/mandos-keygen.8.gz \
579
496
                $(MANDIR)/man8/plugin-runner.8mandos.gz \
580
497
                $(MANDIR)/man8/mandos-client.8mandos.gz
583
500
                $(MANDIR)/man8/splashy.8mandos.gz \
584
501
                $(MANDIR)/man8/askpass-fifo.8mandos.gz \
585
502
                $(MANDIR)/man8/plymouth.8mandos.gz \
586
 
                $(MANDIR)/man8/password-agent.8mandos.gz \
587
503
        -rmdir $(LIBDIR)/mandos/plugins.d $(CONFDIR)/plugins.d \
588
 
                 $(LIBDIR)/mandos $(CONFDIR) $(KEYDIR) $(DRACUTMODULE)
589
 
        if command -v update-initramfs >/dev/null; then \
590
 
            update-initramfs -k all -u; \
591
 
        elif command -v dracut >/dev/null; then \
592
 
            for initrd in $(DESTDIR)/boot/initr*-$(LINUXVERSION); do \
593
 
                test -w "$$initrd" && dracut --force "$$initrd"; \
594
 
            done; \
595
 
        fi
 
504
                 $(LIBDIR)/mandos $(CONFDIR) $(KEYDIR)
 
505
        update-initramfs -k all -u
596
506
 
597
 
.PHONY: purge
598
507
purge: purge-server purge-client
599
508
 
600
 
.PHONY: purge-server
601
509
purge-server: uninstall-server
602
510
        -rm --force $(CONFDIR)/mandos.conf $(CONFDIR)/clients.conf \
603
511
                $(DESTDIR)/etc/dbus-1/system.d/mandos.conf
608
516
                $(DESTDIR)/var/run/mandos.pid
609
517
        -rmdir $(CONFDIR)
610
518
 
611
 
.PHONY: purge-client
612
519
purge-client: uninstall-client
613
520
        -shred --remove $(KEYDIR)/seckey.txt $(KEYDIR)/tls-privkey.pem
614
521
        -rm --force $(CONFDIR)/plugin-runner.conf \