X-Git-Url: https://git.ozlabs.org/?a=blobdiff_plain;f=utils%2Fpb-plugin;h=f87e5fb0e6f15f2ec9c151704c15529722a3c4d8;hb=94fe62686228cf49dc055c50ce8f7ced3bf3cb96;hp=1f8a5915960f87fda02fac85ed47fa6616516c34;hpb=0b71e584078dbe370ed37bcc26f2815d138d28fc;p=petitboot diff --git a/utils/pb-plugin b/utils/pb-plugin index 1f8a591..f87e5fb 100755 --- a/utils/pb-plugin +++ b/utils/pb-plugin @@ -2,8 +2,8 @@ __dest=/ __pb_mount_dir=/var/petitboot/mnt/dev/ -__plugin_basedir=/tmp/ -plugin_file=pb-plugin.cpio.gz +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 @@ -63,6 +63,23 @@ plugin_info() echo " (version $PLUGIN_VERSION)" } +# 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 @@ -146,6 +163,7 @@ do_install() echo sha256sum "$file" | cut -f1 -d' ' echo + echo "Do you want to install this plugin? (y/N)" read resp @@ -170,6 +188,14 @@ do_install() . $__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" @@ -179,21 +205,20 @@ do_install() plugin_info } -do_scan() +do_scan_mount() { - local found dev plugin_path __meta_tmp - found=0 - for mnt in $__pb_mount_dir/* - do - dev=$(basename $mnt) - plugin_path="$mnt/$plugin_file" + 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" | + 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" ] @@ -205,6 +230,8 @@ do_scan() ( . $__meta_tmp/$plugin_meta_path + plugin_abi_check || exit 1 + printf "Plugin found on %s:\n" $dev plugin_info printf "\n" @@ -212,8 +239,21 @@ do_scan() printf " $0 run $plugin_path\n" printf "\n" ) + if [ $? = 0 ] + then + found=1 + fi rm -rf $__meta_tmp - found=1 + done +} + +do_scan() +{ + local found mnt + found=0 + for mnt in $__pb_mount_dir/* + do + do_scan_mount $mnt done if [ "$found" = 0 ] @@ -282,8 +322,12 @@ EOF mkdir -p $(dirname $file) cat < $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' @@ -326,37 +370,53 @@ do_create() fi # Sanity check metadata file - ( - . $meta_file - if [ ! -n "$PLUGIN_VENDOR" ] - then - echo "error: no PLUGIN_VENDOR defined in metadata" &>2 - exit 1 - fi - if [ ! -n "$PLUGIN_NAME" ] - then - echo "error: no PLUGIN_NAME defined in metadata" &>2 - exit 1 - fi - if [ ! -n "$PLUGIN_VERSION" ] - then - echo "error: no PLUGIN_VERSION defined in metadata" &>2 - exit 1 - fi - if [ ! -n "$PLUGIN_DATE" ] - then - echo "error: no PLUGIN_DATE defined in metadata" &>2 - exit 1 - fi - if [ ! -n "$PLUGIN_EXECUTABLES" ] - then - echo "error: no PLUGIN_EXECUTABLES defined in metadata"\ &>2 - exit 1 - fi - - ) || exit 1 + . $meta_file + if [ ! -n "$PLUGIN_ABI" ] + then + echo "error: no PLUGIN_ABI defined in metadata" &>2 + exit 1 + fi + if [ "$PLUGIN_ABI" != "$plugin_abi" ] + then + echo "warning: PLUGIN_ABI (=$PLUGIN_ABI) is not $plugin_abi" &>2 + fi + if [ ! -n "$PLUGIN_VENDOR" ] + then + echo "error: no PLUGIN_VENDOR defined in metadata" &>2 + exit 1 + fi + if [ ! -n "$PLUGIN_VENDOR_ID" ] + then + echo "error: no PLUGIN_VENDOR_ID defined in metadata" &>2 + exit 1 + fi + if [ ! -n "$PLUGIN_NAME" ] + then + echo "error: no PLUGIN_NAME defined in metadata" &>2 + exit 1 + fi + if [ ! -n "$PLUGIN_ID" ] + then + echo "error: no PLUGIN_ID defined in metadata" &>2 + exit 1 + fi + if [ ! -n "$PLUGIN_VERSION" ] + then + echo "error: no PLUGIN_VERSION defined in metadata" &>2 + exit 1 + fi + if [ ! -n "$PLUGIN_DATE" ] + then + echo "error: no PLUGIN_DATE defined in metadata" &>2 + exit 1 + fi + if [ ! -n "$PLUGIN_EXECUTABLES" ] + then + echo "error: no PLUGIN_EXECUTABLES defined in metadata" &>2 + exit 1 + fi - outfile=$plugin_file + outfile=${PLUGIN_ID}-${PLUGIN_VERSION}.${plugin_ext} ( cd $src @@ -369,21 +429,17 @@ do_create() echo echo "User-visible metadata:" - - ( - . $meta_file - plugin_info | sed -e 's/^/ /' - ) + plugin_info | sed -e 's/^/ /' echo - cat </dev/null - ) | gzip -c > $mnt_dir/$plugin_file + ) | gzip -c > $mnt_dir/test.$plugin_ext - do_scan | grep -q 'test 1' - rc=$? + 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() @@ -506,7 +665,18 @@ do_tests() 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 ] @@ -514,9 +684,10 @@ do_tests() echo "$n tests passed" else echo "Tests failed" - false fi rm -rf "$tests_tmpdir" + + [ $test_failed = 0 ] } case "$1" in