summaryrefslogtreecommitdiffstats
path: root/utils/pb-plugin
blob: e107f9648ba2e165aa31d6223e69eec5d8f8812f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
#!/bin/sh

__dest=/
__pb_mount_dir=/var/petitboot/mnt/dev/
plugin_abi=1
plugin_ext=pb-plugin
plugin_meta=pb-plugin.conf
plugin_meta_dir=etc/preboot-plugins/
plugin_meta_path=$plugin_meta_dir$plugin_meta
plugin_wrapper_dir=/var/lib/pb-plugins/bin

usage()
{
	cat <<EOF
Usage: $0 <command>

Where <command> is one of:
  install <FILE|URL> - install plugin from FILE/URL
  scan               - look for available plugins on attached devices
  create <DIR>       - create a new plugin archive from DIR
  lint <FILE>        - perform a pre-distribution check on FILE
EOF
}

is_url()
{
	local url tmp
	url=$1
	tmp=${url#*://}
	[ "$url" != "$tmp" ]
}

download()
{
	local url file proto
	url=$1
	file=$2
	proto=${url%://*}

	case "$proto" in
	http)
		wget -O - "$url" > $file
		;;
	ftp)
		ncftpget -c "$url" > $file
		;;
	*)
		echo "error: Unsuported protocol $proto" >&2
		false
	esac
}

plugin_info()
{
	local title
	if [ "$PLUGIN_VENDOR" ]
	then
		title="$PLUGIN_VENDOR: $PLUGIN_NAME"
	else
		title="$PLUGIN_NAME"
	fi

	echo "$title"
	echo "  (version $PLUGIN_VERSION)"
}

parse_meta()
{
	local file name value IFS

	file=$1

	IFS='='
	while read -r name value
	do
		# Ensure we have a sensible variable name
		echo "$name" | grep -q '^PLUGIN_[A-Z_]*$' || continue

		# we know that $name has no quoting/expansion chars, but we
		# may need to do some basic surrounding-quote removal for
		# $value, without evaluating it
		value=$(echo "$value" | sed "s/^\([\"']\)\(.*\)\1\$/\2/g")

		export $name="$value"
	done < $file
}

# How the ABI versioning works:
#
#  - This script has an ABI defined ($plugin_abi)
#
#  - Plugins have a current ABI number ($PLUGIN_ABI), and a minimum supported
#    ABI number ($PLUGIN_ABI_MIN).
#
#  - A plugin is OK to run if:
#    - the plugin's ABI matches the script ABI, or
#    - the plugin's minimum ABI is lower than or equal to the script ABI
plugin_abi_check()
{
	[ -n "$PLUGIN_ABI" ] &&
		( [ $PLUGIN_ABI -eq $plugin_abi ] ||
		  [ $PLUGIN_ABI_MIN -le $plugin_abi ] )
}

do_wrap()
{
	local base binary dir

	base=$1
	binary=$2
	shift 2

	for dir in etc dev sys proc var
	do
		[ -e "$base/$dir" ] || mkdir -p "$base/$dir"
	done

	cp /etc/resolv.conf $base/etc
	mount -o bind /dev $base/dev
	mount -o bind /sys $base/sys
	mount -o bind /proc $base/proc
	mount -o bind /var $base/var

	chroot "$base" "$binary" "$@"

	umount $base/dev
	umount $base/sys
	umount $base/proc
	umount $base/var
}

__create_wrapper()
{
	local base binary wrapper

	base=$1
	binary=$2
	wrapper=$plugin_wrapper_dir/$(basename $binary)

	mkdir -p $plugin_wrapper_dir

	cat <<EOF > $wrapper
#!/bin/sh

exec $(realpath $0) __wrap '$base' '$binary' "\$@"
EOF

	chmod a+x $wrapper
}

do_install()
{
	local url name file __dest

	url=$1

	if [ -z "$url" ]
	then
		echo "error: install requires a file/URL argument." >&2
		exit 1
	fi

	name=${url##*/}

	if is_url "$url"
	then
		file=$(mktemp)
		trap "rm '$file'" EXIT
		download "$url" "$file"
		if [ $? -ne 0 ]
		then
			echo "error: failed to download $url" >&2
			exit 1
		fi
	else
		file=$url
		if [ ! -r "$file" ]
		then
			echo "error: $file doesn't exist or is not readable" >&2
			exit 1
		fi
	fi

        echo "File '$name' has the following sha256 checksum:"
	echo
	sha256sum "$file" | cut -f1 -d' '
	echo

	echo "Do you want to install this plugin? (y/N)"
	read resp

	case $resp in
	[yY]|[yY][eE][sS])
		;;
	*)
		echo "Cancelled"
		exit 0
		;;
	esac

	__dest=$(mktemp -d)
	gunzip -c "$file" | ( cd $__dest && cpio -i -d)

	if [ $? -ne 0 ]
	then
		echo "error: Failed to extract archive $url, exiting"
		rm -rf $__dest
		exit 1
	fi

	parse_meta $__dest/$plugin_meta_path

	if ! plugin_abi_check
	then
		echo "Plugin at $url is incompatible with this firmware," \
			"exiting."
		rm -rf $__dest
		exit 1
	fi

	for binary in ${PLUGIN_EXECUTABLES}
	do
		__create_wrapper "$__dest" "$binary"
	done

	echo "Plugin installed"
	plugin_info
}

do_scan_mount()
{
	local mnt dev plugin_path __meta_tmp
	mnt=$1
	dev=$(basename $mnt)

	for plugin_path in $mnt/*.$plugin_ext
	do
		[ -e "$plugin_path" ] || continue

		# extract plugin metadata to a temporary directory
		__meta_tmp=$(mktemp -d)
		[ -d $__meta_tmp ] || continue
		gunzip -c "$plugin_path" 2>/dev/null |
			(cd $__meta_tmp &&
				cpio -i -d $plugin_meta_path 2>/dev/null)
		if ! [ $? = 0 -a -e "$plugin_path" ]
		then
			rm -rf $__meta_tmp
			continue
		fi

		(
			parse_meta $__meta_tmp/$plugin_meta_path

			plugin_abi_check || exit 1

			printf "Plugin found on %s:\n" $dev
			plugin_info
			printf "\n"
			printf "To run this plugin:\n"
			printf "  $0 install $plugin_path\n"
			printf "\n"
		)
		if [ $? = 0 ]
		then
			found=1
		fi
		rm -rf $__meta_tmp
	done
}

do_scan()
{
	local found mnt
	found=0
	for mnt in $__pb_mount_dir/*
	do
		do_scan_mount $mnt
	done

	if [ "$found" = 0 ]
	then
		echo "No plugins found"
	fi
}

guided_meta()
{
	local vendorname vendorshortname
	local pluginname pluginnhortname
	local version date executable
	local file

	file=$1

cat <<EOF

Enter the vendor company / author name. This can contain spaces.
(eg. 'Example Corporation')
EOF
	read vendorname
cat <<EOF

Enter the vendor shortname. This should be a single-word abbreviation, in all
lower-case. This is only used in internal filenames.

Typically, a stock-ticker name is used for this (eg 'exco')
EOF
	read vendorshortname

cat <<EOF

Enter the descriptive plugin name. This can contain spaces, but should only be
a few words in length (eg 'RAID configuration utility')
EOF
	read pluginname

cat <<EOF

Enter the plugin shortname. This should not contain spaces, but hyphens are
fine (eg 'raid-config'). This is only used in internal filnames.
EOF
	read pluginshortname


cat <<EOF

Enter the plugin version. This should not contain spaces (eg 1.2):
EOF
	read version

cat <<EOF

Enter the full path (within the plugin root) to the plugin executable file(s).
These will be exposed as wrapper scripts, to be run from the standard petitboot
shell environment (eg, /usr/bin/my-raid-config).

If multiple executables are provided, separate with a space.
EOF
	read executables

	date=$(date +%Y-%m-%d)

	mkdir -p $(dirname $file)

	cat <<EOF > $file
PLUGIN_ABI='$plugin_abi'
PLUGIN_ABI_MIN='1'
PLUGIN_VENDOR='$vendorname'
PLUGIN_VENDOR_ID='$vendorshortname'
PLUGIN_NAME='$pluginname'
PLUGIN_ID='$pluginshortname'
PLUGIN_VERSION='$version'
PLUGIN_DATE='$date'
PLUGIN_EXECUTABLES='$executables'
EOF

}

do_create()
{
	local src meta_dir_abs meta_file
	src=$1

	if [ -z "$src" ]
	then
		echo "error: missing source directory" >&2
		usage
		exit 1
	fi

	if [ ! -d "$src" ]
	then
		echo "error: source directory missing" >&2
		exit 1
	fi

	meta_file=$src/$plugin_meta_path

	if [ ! -e $meta_file ]
	then
		echo "No plugin metadata file found. " \
			"Would you like to create one? (Y/n)"
		read resp
		case "$resp" in
		[nN]|[nN][oO])
			echo "Cancelled, exiting"
			exit 1
			;;
		esac
		guided_meta $meta_file || exit
	fi

	# Sanity check metadata file
	parse_meta $meta_file

	errors=0
	warnings=0

	lint_metadata

	if [ $errors -ne 0 ]
	then
		exit 1
	fi

	outfile=${PLUGIN_ID}-${PLUGIN_VERSION}.${plugin_ext}

	(
		cd $src
		find -mindepth 1 | cpio -o -Hnewc -v
	) | gzip -c > $outfile

	echo
	echo "Plugin metadata:"
	sed -e 's/^/  /' $meta_file
	echo

	echo "User-visible metadata:"
	plugin_info | sed -e 's/^/  /'

	echo

cat <<EOF
Plugin created in:
  $outfile

Ship this file in the top-level-directory of a USB device or CD to have it
automatically discoverable by 'pb-plugin scan'. This file can be re-named,
but must retain the .$plugin_ext extension to be discoverable.
EOF
}

lint_fatal()
{
	echo "fatal:" "$@"
	[ -d "$__dest" ] && rm -rf "$__dest"
	exit 1
}

lint_err()
{
	echo "error:" "$@"
	errors=$(($errors+1))
}

lint_warn()
{
	echo "warning:" "$@"
	warnings=$(($warnings+1))
}

lint_metadata()
{
	[ -n "$PLUGIN_ABI" ] ||
		lint_err "no PLUGIN_ABI defined in metadata"

	printf '%s' "$PLUGIN_ABI" | grep -q '[^0-9]' &&
		lint_err "PLUGIN_ABI has non-numeric characters"

	[ -n "$PLUGIN_ABI_MIN" ] ||
		lint_err "no PLUGIN_ABI_MIN defined in metadata"

	printf '%s' "$PLUGIN_ABI_MIN" | grep -q '[^0-9]' &&
		lint_err "PLUGIN_ABI_MIN has non-numeric characters"

	[ "$PLUGIN_ABI" = "$plugin_abi" ] ||
		lint_warn "PLUGIN_ABI (=$PLUGIN_ABI) is not $plugin_abi"

	[ -n "$PLUGIN_VENDOR" ] ||
		lint_err "no PLUGIN_VENDOR defined in metadata"

	[ -n "$PLUGIN_VENDOR_ID" ] ||
		lint_err "no PLUGIN_VENDOR_ID defined in metadata"

	printf '%s' "$PLUGIN_VENDOR_ID" | grep -q '[^a-z0-9-]' &&
		lint_err "PLUGIN_VENDOR_ID should only contain lowercase" \
			"alphanumerics and hyphens"

	[ -n "$PLUGIN_NAME" ] ||
		lint_err "no PLUGIN_NAME defined in metadata"

	[ -n "$PLUGIN_ID" ] ||
		lint_err "no PLUGIN_ID defined in metadata"

	printf '%s' "$PLUGIN_ID" | grep -q '[^a-z0-9-]' &&
		lint_err "PLUGIN_ID should only contain lowercase" \
			"alphanumerics and hyphens"

	[ "$PLUGIN_VERSION" ] ||
		lint_err "no PLUGIN_VERSION defined in metadata"

	[ -n "$PLUGIN_DATE" ] ||
		lint_err "no PLUGIN_DATE defined in metadata"

	[ -n "$PLUGIN_EXECUTABLES" ] ||
		lint_err "no PLUGIN_EXECUTABLES defined in metadata"
}

do_lint()
{
	local plugin_file errors warnings __dest executable dir

	plugin_file=$1
	errors=0
	warnings=0
	__dest=

	[ "${plugin_file##*.}" = $plugin_ext ] ||
		lint_err "Plugin file does not end with $plugin_ext"

	gunzip -c "$plugin_file" > /dev/null 2>&1 ||
		lint_fatal "Plugin can't be gunzipped"

	gunzip -c "$plugin_file" 2>/dev/null | cpio -t >/dev/null 2>&1 ||
		lint_fatal "Plugin can't be cpioed"

	__dest=$(mktemp -d)
	gunzip -c "$plugin_file" | ( cd $__dest && cpio -i -d 2>/dev/null)

	[ -e "$__dest/$plugin_meta_path" ] ||
		lint_fatal "No metadata file present (expecting" \
			"$plugin_meta_path)"

	parse_meta "$__dest/$plugin_meta_path"
	lint_metadata

	for executable in ${PLUGIN_EXECUTABLES}
	do
		exec_path="$__dest/$executable"
		[ -e "$exec_path" ] || {
			lint_err "PLUGIN_EXECUTABLES item $executable" \
				"doesn't exist"
			continue
		}

		[ -x "$exec_path" ] ||
			lint_err "PLUGIN_EXECUTABLES item $executable" \
				"isn't executable"
	done

	for dir in dev sys proc var
	do
		[ -e "$__dest/$dir" ] || continue

		[ -d "$__dest/$dir" ] ||
			lint_err "/$dir exists, but isn't a directory"

		[ "$(find $__dest/$dir -mindepth 1)" ] &&
			lint_warn "/$dir contains files/directories," \
				"these will be lost during chroot setup"
	done

	printf '%s: %d errors, %d warnings\n' $plugin_file $errors $warnings
	rm -rf $__dest
	[ $errors = 0 ]
}

test_http_download()
{
	local tmp ref

	tmp=$(mktemp -p $test_tmpdir)
	ref=$(mktemp -p $test_tmpdir)

	echo $RANDOM > $ref

	wget()
	{
		cat $ref
	}

	download http://example.com/test $tmp
	cmp -s "$ref" "$tmp"
}

test_ftp_download()
{
	local tmp ref

	tmp=$(mktemp -p $test_tmpdir)
	ref=$(mktemp -p $test_tmpdir)

	echo $RANDOM > $ref

	ncftpget()
	{
		cat $ref
	}

	download ftp://example.com/test $tmp
	cmp -s "$ref" "$tmp"
}

test_abi_check()
{
	(
		plugin_abi=$1
		PLUGIN_ABI=$2
		PLUGIN_ABI_MIN=$3
		plugin_abi_check
	)
}

test_scan()
{
	__pb_mount_dir="$test_tmpdir/mnt"
	mnt_dir="$__pb_mount_dir/sda"
	mkdir -p $mnt_dir/$plugin_meta_dir
	(
		echo "PLUGIN_ABI=$plugin_abi"
		echo "PLUGIN_NAME=test"
		echo "PLUGIN_VERSION=1"
		echo "PLUGIN_EXECUTABLES=/bin/sh"
	) > $mnt_dir/$plugin_meta_path
	(
		cd $mnt_dir;
		find -mindepth 1 | cpio -o -Hnewc 2>/dev/null
	) | gzip -c > $mnt_dir/test.$plugin_ext

	do_scan | grep -q 'test'
}

test_scan_nogzip()
{
	__pb_mount_dir="$test_tmpdir/mnt"
	mnt_dir="$__pb_mount_dir/sda"
	stderr_file="$test_tmpdir/stderr"

	mkdir -p $mnt_dir
	echo "invalid" > $mnt_dir/nogzip.$plugin_ext

	do_scan 2>$stderr_file | grep -q 'No plugins'

	[ $? = 0 ] || return 1

	if [ -s "$stderr_file" ]
	then
		echo "Scan with invalid (non-gzip) file produced error output" \
			>&2
		cat "$stderr_file"
		return 1
	fi
	true
}

test_scan_nocpio()
{
	__pb_mount_dir="$test_tmpdir/mnt"
	mnt_dir="$__pb_mount_dir/sda"
	stderr_file="$test_tmpdir/stderr"

	mkdir -p $mnt_dir
	echo "invalid" | gzip -c > $mnt_dir/nogzip.$plugin_ext

	do_scan 2>$stderr_file | grep -q 'No plugins'

	[ $? = 0 ] || return 1

	if [ -s "$stderr_file" ]
	then
		echo "Scan with invalid (non-cpio) file produced error output" \
			>&2
		cat "$stderr_file"
		return 1
	fi
	true
}

test_scan_multiple()
{
	__pb_mount_dir="$test_tmpdir/mnt"
	mnt_dir="$__pb_mount_dir/sda"
	outfile=$test_tmpdir/scan.out

	for i in 1 2
	do
		mkdir -p $mnt_dir/$plugin_meta_dir
		(
			echo "PLUGIN_ABI=$plugin_abi"
			echo "PLUGIN_NAME=test-$i"
			echo "PLUGIN_VERSION=1"
			echo "PLUGIN_EXECUTABLES=/bin/sh"
		) > $mnt_dir/$plugin_meta_path
		(
			cd $mnt_dir;
			find -mindepth 1 | cpio -o -Hnewc 2>/dev/null
		) | gzip -c > $mnt_dir/test-${i}.$plugin_ext
		rm -rf $mnt_dir/$plugin_meta_dir
	done

	do_scan >$outfile

	grep -q 'test-1' $outfile && grep -q 'test-2' $outfile
}

test_scan_wrongabi()
{
	__pb_mount_dir="$test_tmpdir/mnt"
	mnt_dir="$__pb_mount_dir/sda"
	mkdir -p $mnt_dir/$plugin_meta_dir
	(
		echo "PLUGIN_ABI=$(($plugin_abi + 1))"
		echo "PLUGIN_ABI_MIN=$(($plugin_abi + 1))"
		echo "PLUGIN_NAME=test"
		echo "PLUGIN_VERSION=1"
		echo "PLUGIN_EXECUTABLES=/bin/sh"
	) > $mnt_dir/$plugin_meta_path
	(
		cd $mnt_dir;
		find -mindepth 1 | cpio -o -Hnewc 2>/dev/null
	) | gzip -c > $mnt_dir/test.$plugin_ext

	do_scan | grep -q 'No plugins'
}

test_empty_scan()
{
	__pb_mount_dir="$test_tmpdir/mnt"
	mkdir -p $__pb_mount_dir
	do_scan | grep -q "No plugins"
}

test_setup()
{
	n=$(($n+1))

	test_tmpdir="$tests_tmpdir/$n"
	mkdir "$test_tmpdir"
}

test_teardown()
{
	true
}

test_failed=0
do_test()
{
	local tstr op

	tstr="$@"
	op=-eq

	if [ "x$1" = "x!" ]
	then
		op=-ne
		shift
	fi

	test_setup
	( $@ )
	local rc=$?
	test_teardown

	if [ $rc $op 0 ]
	then
		echo PASS: "$tstr"
	else
		echo FAIL: "$tstr"
		test_failed=1
		false
	fi
}

do_tests()
{
	local tests_tmpdir n

	tests_tmpdir=$(mktemp -d)
	n=0

	do_test ! is_url "/test"
	do_test ! is_url "./test"
	do_test ! is_url "../test"
	do_test ! is_url "test"
	do_test is_url "http://example.com/path"
	do_test is_url "git+ssh://example.com/path"
	do_test test_http_download
	do_test test_ftp_download
	do_test ! test_abi_check
	do_test ! test_abi_check 1
	do_test test_abi_check 1 1
	do_test test_abi_check 1 1 1
	do_test test_abi_check 1 2 0
	do_test test_abi_check 1 2 1
	do_test ! test_abi_check 1 2 2
	do_test test_scan
	do_test test_scan_nogzip
	do_test test_scan_nocpio
	do_test test_scan_multiple
	do_test test_scan_wrongabi
	do_test test_empty_scan

	if [ $test_failed = 0 ]
	then
		echo "$n tests passed"
	else
		echo "Tests failed"
	fi
	rm -rf "$tests_tmpdir"

	[ $test_failed = 0 ]
}

case "$1" in
install)
	shift
	do_install $@
	;;
scan)
	shift
	do_scan $@
	;;
create)
	shift
	do_create $@
	;;
lint)
	shift
	do_lint $@
	;;
__wrap)
	shift
	do_wrap $@
	;;
__test)
	shift
	do_tests $@
	;;
"")
	echo "error: Missing command" >&2
	usage
	exit 1
	;;
*)
	echo "Invalid command: $1" >&2
	usage
	exit 1
esac


OpenPOWER on IntegriCloud