/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: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
29
29
 
30
30
# For info about _FORTIFY_SOURCE, see feature_test_macros(7)
31
31
# and <https://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html>.
32
 
FORTIFY:=-D_FORTIFY_SOURCE=2 -fstack-protector-all -fPIC
 
32
FORTIFY:=-fstack-protector-all -fPIC
 
33
CPPFLAGS+=-D_FORTIFY_SOURCE=3
33
34
LINK_FORTIFY_LD:=-z relro -z now
34
35
LINK_FORTIFY:=
35
36
 
41
42
#COVERAGE=--coverage
42
43
OPTIMIZE:=-Os -fno-strict-aliasing
43
44
LANGUAGE:=-std=gnu11
 
45
CPPFLAGS+=-D_FILE_OFFSET_BITS=64
44
46
htmldir:=man
45
 
version:=1.8.4
 
47
version:=1.8.16
46
48
SED:=sed
 
49
PKG_CONFIG?=pkg-config
47
50
 
48
51
USER:=$(firstword $(subst :, ,$(shell getent passwd _mandos \
49
52
        || getent passwd nobody || echo 65534)))
50
53
GROUP:=$(firstword $(subst :, ,$(shell getent group _mandos \
51
54
        || getent group nogroup || echo 65534)))
52
55
 
 
56
LINUXVERSION:=$(shell uname --kernel-release)
 
57
 
53
58
## Use these settings for a traditional /usr/local install
54
59
# PREFIX:=$(DESTDIR)/usr/local
55
60
# CONFDIR:=$(DESTDIR)/etc/mandos
59
64
# DRACUTMODULE:=$(DESTDIR)/usr/lib/dracut/modules.d/90mandos
60
65
# STATEDIR:=$(DESTDIR)/var/lib/mandos
61
66
# LIBDIR:=$(PREFIX)/lib
 
67
# DBUSPOLICYDIR:=$(DESTDIR)/etc/dbus-1/system.d
62
68
##
63
69
 
64
70
## These settings are for a package-type install
71
77
STATEDIR:=$(DESTDIR)/var/lib/mandos
72
78
LIBDIR:=$(shell \
73
79
        for d in \
74
 
        "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
 
80
        "/usr/lib/`dpkg-architecture \
 
81
                        -qDEB_HOST_MULTIARCH 2>/dev/null`" \
75
82
        "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/lib; do \
76
83
                if [ -d "$$d" -a "$$d" = "$${d%/}" ]; then \
77
84
                        echo "$(DESTDIR)$$d"; \
78
85
                        break; \
79
86
                fi; \
80
87
        done)
 
88
DBUSPOLICYDIR:=$(DESTDIR)/usr/share/dbus-1/system.d
81
89
##
82
90
 
83
 
SYSTEMD:=$(DESTDIR)$(shell pkg-config systemd --variable=systemdsystemunitdir)
84
 
TMPFILES:=$(DESTDIR)$(shell pkg-config systemd --variable=tmpfilesdir)
 
91
SYSTEMD:=$(DESTDIR)$(shell $(PKG_CONFIG) systemd \
 
92
                        --variable=systemdsystemunitdir)
 
93
TMPFILES:=$(DESTDIR)$(shell $(PKG_CONFIG) systemd \
 
94
                        --variable=tmpfilesdir)
 
95
SYSUSERS:=$(DESTDIR)$(shell $(PKG_CONFIG) systemd \
 
96
                        --variable=sysusersdir)
85
97
 
86
 
GNUTLS_CFLAGS:=$(shell pkg-config --cflags-only-I gnutls)
87
 
GNUTLS_LIBS:=$(shell pkg-config --libs gnutls)
88
 
AVAHI_CFLAGS:=$(shell pkg-config --cflags-only-I avahi-core)
89
 
AVAHI_LIBS:=$(shell pkg-config --libs avahi-core)
90
 
GPGME_CFLAGS:=$(shell gpgme-config --cflags; getconf LFS_CFLAGS)
91
 
GPGME_LIBS:=$(shell gpgme-config --libs; getconf LFS_LIBS; \
 
98
GNUTLS_CFLAGS:=$(shell $(PKG_CONFIG) --cflags-only-I gnutls)
 
99
GNUTLS_LIBS:=$(shell $(PKG_CONFIG) --libs gnutls)
 
100
AVAHI_CFLAGS:=$(shell $(PKG_CONFIG) --cflags-only-I avahi-core)
 
101
AVAHI_LIBS:=$(shell $(PKG_CONFIG) --libs avahi-core)
 
102
GPGME_CFLAGS:=$(shell $(PKG_CONFIG) --cflags-only-I gpgme 2>/dev/null \
 
103
        || gpgme-config --cflags; getconf LFS_CFLAGS)
 
104
GPGME_LIBS:=$(shell $(PKG_CONFIG) --libs gpgme 2>/dev/null \
 
105
        || gpgme-config --libs; getconf LFS_LIBS; \
92
106
        getconf LFS_LDFLAGS)
93
 
LIBNL3_CFLAGS:=$(shell pkg-config --cflags-only-I libnl-route-3.0)
94
 
LIBNL3_LIBS:=$(shell pkg-config --libs libnl-route-3.0)
95
 
GLIB_CFLAGS:=$(shell pkg-config --cflags glib-2.0)
96
 
GLIB_LIBS:=$(shell pkg-config --libs glib-2.0)
 
107
LIBNL3_CFLAGS:=$(shell $(PKG_CONFIG) --cflags-only-I libnl-route-3.0)
 
108
LIBNL3_LIBS:=$(shell $(PKG_CONFIG) --libs libnl-route-3.0)
 
109
GLIB_CFLAGS:=$(shell $(PKG_CONFIG) --cflags glib-2.0)
 
110
GLIB_LIBS:=$(shell $(PKG_CONFIG) --libs glib-2.0)
97
111
 
98
112
# Do not change these two
99
 
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) \
100
 
        $(OPTIMIZE) $(LANGUAGE) -DVERSION='"$(version)"'
 
113
CFLAGS+=$(WARN) $(DEBUG) $(FORTIFY) $(COVERAGE) $(OPTIMIZE) \
 
114
        $(LANGUAGE) -DVERSION='"$(version)"'
101
115
LDFLAGS+=-Xlinker --as-needed $(COVERAGE) $(LINK_FORTIFY) $(strip \
102
116
        ) $(foreach flag,$(LINK_FORTIFY_LD),-Xlinker $(flag))
103
117
 
147
161
 
148
162
objects:=$(addsuffix .o,$(CPROGS))
149
163
 
 
164
.PHONY: all
150
165
all: $(PROGS) mandos.lsm
151
166
 
 
167
.PHONY: doc
152
168
doc: $(DOCS)
153
169
 
 
170
.PHONY: html
154
171
html: $(htmldocs)
155
172
 
156
173
%.5: %.xml common.ent legalnotice.xml
273
290
                $@)
274
291
 
275
292
# Need to add the GnuTLS, Avahi and GPGME libraries
276
 
plugins.d/mandos-client: plugins.d/mandos-client.c
277
 
        $(LINK.c) $^ $(GNUTLS_CFLAGS) $(AVAHI_CFLAGS) $(strip\
278
 
                ) $(GPGME_CFLAGS) $(GNUTLS_LIBS) $(strip\
279
 
                ) $(AVAHI_LIBS) $(GPGME_LIBS) $(LOADLIBES) $(strip\
280
 
                ) $(LDLIBS) -o $@
 
293
plugins.d/mandos-client: CFLAGS += $(GNUTLS_CFLAGS) $(strip \
 
294
        ) $(AVAHI_CFLAGS) $(GPGME_CFLAGS)
 
295
plugins.d/mandos-client: LDLIBS += $(GNUTLS_LIBS) $(strip \
 
296
        ) $(AVAHI_LIBS) $(GPGME_LIBS)
281
297
 
282
298
# Need to add the libnl-route library
283
 
plugin-helpers/mandos-client-iprouteadddel: plugin-helpers/mandos-client-iprouteadddel.c
284
 
        $(LINK.c) $(LIBNL3_CFLAGS) $^ $(LIBNL3_LIBS) $(strip\
285
 
                ) $(LOADLIBES) $(LDLIBS) -o $@
 
299
plugin-helpers/mandos-client-iprouteadddel: CFLAGS += $(LIBNL3_CFLAGS)
 
300
plugin-helpers/mandos-client-iprouteadddel: LDLIBS += $(LIBNL3_LIBS)
286
301
 
287
302
# Need to add the GLib and pthread libraries
288
 
dracut-module/password-agent: dracut-module/password-agent.c
289
 
        $(LINK.c) $(GLIB_CFLAGS) $^ $(GLIB_LIBS) -lpthread $(strip\
290
 
                ) $(LOADLIBES) $(LDLIBS) -o $@
291
 
 
292
 
.PHONY : all doc html clean distclean mostlyclean maintainer-clean \
293
 
        check run-client run-server install install-html \
294
 
        install-server install-client-nokey install-client uninstall \
295
 
        uninstall-server uninstall-client purge purge-server \
296
 
        purge-client
297
 
 
 
303
dracut-module/password-agent: CFLAGS += $(GLIB_CFLAGS)
 
304
# Note: -lpthread is unnecessary with the GNU C library 2.34 or later
 
305
dracut-module/password-agent: LDLIBS += $(GLIB_LIBS) -lpthread
 
306
 
 
307
.PHONY: clean
298
308
clean:
299
309
        -rm --force $(CPROGS) $(objects) $(htmldocs) $(DOCS) core
300
310
 
 
311
.PHONY: distclean
301
312
distclean: clean
 
313
.PHONY: mostlyclean
302
314
mostlyclean: clean
 
315
.PHONY: maintainer-clean
303
316
maintainer-clean: clean
304
317
        -rm --force --recursive keydir confdir statedir
305
318
 
 
319
.PHONY: check
306
320
check: all
307
321
        ./mandos --check
308
322
        ./mandos-ctl --check
312
326
        ./dracut-module/password-agent --test
313
327
 
314
328
# Run the client with a local config and key
315
 
run-client: all keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem
316
 
        @echo "###################################################################"
317
 
        @echo "# The following error messages are harmless and can be safely     #"
318
 
        @echo "# ignored:                                                        #"
319
 
        @echo "# From plugin-runner: setgid: Operation not permitted             #"
320
 
        @echo "#                     setuid: Operation not permitted             #"
321
 
        @echo "# From askpass-fifo:  mkfifo: Permission denied                   #"
322
 
        @echo "# From mandos-client:                                             #"
323
 
        @echo "#             Failed to raise privileges: Operation not permitted #"
324
 
        @echo "#             Warning: network hook \"*\" exited with status *      #"
325
 
        @echo "#                                                                 #"
326
 
        @echo "# (The messages are caused by not running as root, but you should #"
327
 
        @echo "# NOT run \"make run-client\" as root unless you also unpacked and  #"
328
 
        @echo "# compiled Mandos as root, which is also NOT recommended.)        #"
329
 
        @echo "###################################################################"
 
329
.PHONY: run-client
 
330
run-client: all keydir/seckey.txt keydir/pubkey.txt \
 
331
                        keydir/tls-privkey.pem keydir/tls-pubkey.pem
 
332
        @echo '######################################################'
 
333
        @echo '# The following error messages are harmless and can  #'
 
334
        @echo '#  be safely ignored:                                #'
 
335
        @echo '## From plugin-runner:                               #'
 
336
        @echo '# setgid: Operation not permitted                    #'
 
337
        @echo '# setuid: Operation not permitted                    #'
 
338
        @echo '## From askpass-fifo:                                #'
 
339
        @echo '# mkfifo: Permission denied                          #'
 
340
        @echo '## From mandos-client:                               #'
 
341
        @echo '# Failed to raise privileges: Operation not permi... #'
 
342
        @echo '# Warning: network hook "*" exited with status *     #'
 
343
        @echo '# ioctl SIOCSIFFLAGS +IFF_UP: Operation not permi... #'
 
344
        @echo '# Failed to bring up interface "*": Operation not... #'
 
345
        @echo '#                                                    #'
 
346
        @echo '# (The messages are caused by not running as root,   #'
 
347
        @echo '# but you should NOT run "make run-client" as root   #'
 
348
        @echo '# unless you also unpacked and compiled Mandos as    #'
 
349
        @echo '# root, which is also NOT recommended.)              #'
 
350
        @echo '######################################################'
330
351
# We set GNOME_KEYRING_CONTROL to block pam_gnome_keyring
331
352
        ./plugin-runner --plugin-dir=plugins.d \
332
353
                --plugin-helper-dir=plugin-helpers \
339
360
keydir/seckey.txt keydir/pubkey.txt keydir/tls-privkey.pem keydir/tls-pubkey.pem: mandos-keygen
340
361
        install --directory keydir
341
362
        ./mandos-keygen --dir keydir --force
 
363
        if ! [ -e keydir/tls-privkey.pem ]; then \
 
364
                install --mode=u=rw /dev/null keydir/tls-privkey.pem; \
 
365
        fi
 
366
        if ! [ -e keydir/tls-pubkey.pem ]; then \
 
367
                install --mode=u=rw /dev/null keydir/tls-pubkey.pem; \
 
368
        fi
342
369
 
343
370
# Run the server with a local config
 
371
.PHONY: run-server
344
372
run-server: confdir/mandos.conf confdir/clients.conf statedir
345
373
        ./mandos --debug --no-dbus --configdir=confdir \
346
374
                --statedir=statedir $(SERVERARGS)
357
385
statedir:
358
386
        install --directory statedir
359
387
 
 
388
.PHONY: install
360
389
install: install-server install-client-nokey
361
390
 
 
391
.PHONY: install-html
362
392
install-html: html
363
393
        install --directory $(htmldir)
364
394
        install --mode=u=rw,go=r --target-directory=$(htmldir) \
365
395
                $(htmldocs)
366
396
 
 
397
.PHONY: install-server
367
398
install-server: doc
368
399
        install --directory $(CONFDIR)
369
400
        if install --directory --mode=u=rwx --owner=$(USER) \
372
403
        elif install --directory --mode=u=rwx $(STATEDIR); then \
373
404
                chown -- $(USER):$(GROUP) $(STATEDIR) || :; \
374
405
        fi
375
 
        if [ "$(TMPFILES)" != "$(DESTDIR)" -a -d "$(TMPFILES)" ]; then \
 
406
        if [ "$(TMPFILES)" != "$(DESTDIR)" \
 
407
                        -a -d "$(TMPFILES)" ]; then \
376
408
                install --mode=u=rw,go=r tmpfiles.d-mandos.conf \
377
409
                        $(TMPFILES)/mandos.conf; \
378
410
        fi
 
411
        if [ "$(SYSUSERS)" != "$(DESTDIR)" \
 
412
                        -a -d "$(SYSUSERS)" ]; then \
 
413
                install --mode=u=rw,go=r sysusers.d-mandos.conf \
 
414
                        $(SYSUSERS)/mandos.conf; \
 
415
        fi
379
416
        install --mode=u=rwx,go=rx mandos $(PREFIX)/sbin/mandos
380
417
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
381
418
                mandos-ctl
386
423
        install --mode=u=rw --target-directory=$(CONFDIR) \
387
424
                clients.conf
388
425
        install --mode=u=rw,go=r dbus-mandos.conf \
389
 
                $(DESTDIR)/etc/dbus-1/system.d/mandos.conf
 
426
                $(DBUSPOLICYDIR)/mandos.conf
390
427
        install --mode=u=rwx,go=rx init.d-mandos \
391
428
                $(DESTDIR)/etc/init.d/mandos
392
429
        if [ "$(SYSTEMD)" != "$(DESTDIR)" -a -d "$(SYSTEMD)" ]; then \
410
447
        gzip --best --to-stdout intro.8mandos \
411
448
                > $(MANDIR)/man8/intro.8mandos.gz
412
449
 
 
450
.PHONY: install-client-nokey
413
451
install-client-nokey: all doc
414
452
        install --directory $(LIBDIR)/mandos $(CONFDIR)
415
453
        install --directory --mode=u=rwx $(KEYDIR) \
416
454
                $(LIBDIR)/mandos/plugins.d \
417
455
                $(LIBDIR)/mandos/plugin-helpers
 
456
        if [ "$(SYSUSERS)" != "$(DESTDIR)" \
 
457
                        -a -d "$(SYSUSERS)" ]; then \
 
458
                install --mode=u=rw,go=r sysusers.d-mandos.conf \
 
459
                        $(SYSUSERS)/mandos-client.conf; \
 
460
        fi
418
461
        if [ "$(CONFDIR)" != "$(LIBDIR)/mandos" ]; then \
419
462
                install --mode=u=rwx \
420
463
                        --directory "$(CONFDIR)/plugins.d" \
425
468
        install --mode=u=rwx,go=rx \
426
469
                --target-directory=$(LIBDIR)/mandos plugin-runner
427
470
        install --mode=u=rwx,go=rx \
428
 
                --target-directory=$(LIBDIR)/mandos mandos-to-cryptroot-unlock
 
471
                --target-directory=$(LIBDIR)/mandos \
 
472
                mandos-to-cryptroot-unlock
429
473
        install --mode=u=rwx,go=rx --target-directory=$(PREFIX)/sbin \
430
474
                mandos-keygen
431
475
        install --mode=u=rwx,go=rx \
488
532
        gzip --best --to-stdout dracut-module/password-agent.8mandos \
489
533
                > $(MANDIR)/man8/password-agent.8mandos.gz
490
534
 
 
535
.PHONY: install-client
491
536
install-client: install-client-nokey
492
537
# Post-installation stuff
493
538
        -$(PREFIX)/sbin/mandos-keygen --dir "$(KEYDIR)"
494
539
        if command -v update-initramfs >/dev/null; then \
495
540
            update-initramfs -k all -u; \
496
541
        elif command -v dracut >/dev/null; then \
497
 
            for initrd in $(DESTDIR)/boot/initr*-$(shell uname --kernel-release); do \
 
542
            for initrd in $(DESTDIR)/boot/initr*-$(LINUXVERSION); do \
498
543
                if [ -w "$$initrd" ]; then \
499
544
                    chmod go-r "$$initrd"; \
500
545
                    dracut --force "$$initrd"; \
503
548
        fi
504
549
        echo "Now run mandos-keygen --password --dir $(KEYDIR)"
505
550
 
 
551
.PHONY: uninstall
506
552
uninstall: uninstall-server uninstall-client
507
553
 
 
554
.PHONY: uninstall-server
508
555
uninstall-server:
509
556
        -rm --force $(PREFIX)/sbin/mandos \
510
557
                $(PREFIX)/sbin/mandos-ctl \
517
564
        update-rc.d -f mandos remove
518
565
        -rmdir $(CONFDIR)
519
566
 
 
567
.PHONY: uninstall-client
520
568
uninstall-client:
521
569
# Refuse to uninstall client if /etc/crypttab is explicitly configured
522
570
# to use it.
553
601
        if command -v update-initramfs >/dev/null; then \
554
602
            update-initramfs -k all -u; \
555
603
        elif command -v dracut >/dev/null; then \
556
 
            for initrd in $(DESTDIR)/boot/initr*-$(shell uname --kernel-release); do \
 
604
            for initrd in $(DESTDIR)/boot/initr*-$(LINUXVERSION); do \
557
605
                test -w "$$initrd" && dracut --force "$$initrd"; \
558
606
            done; \
559
607
        fi
560
608
 
 
609
.PHONY: purge
561
610
purge: purge-server purge-client
562
611
 
 
612
.PHONY: purge-server
563
613
purge-server: uninstall-server
564
614
        -rm --force $(CONFDIR)/mandos.conf $(CONFDIR)/clients.conf \
565
615
                $(DESTDIR)/etc/dbus-1/system.d/mandos.conf
570
620
                $(DESTDIR)/var/run/mandos.pid
571
621
        -rmdir $(CONFDIR)
572
622
 
 
623
.PHONY: purge-client
573
624
purge-client: uninstall-client
574
625
        -shred --remove $(KEYDIR)/seckey.txt $(KEYDIR)/tls-privkey.pem
575
626
        -rm --force $(CONFDIR)/plugin-runner.conf \