Skip to contentSkip to conversation

test: Hide endianness

PATCH In review David Howells 2 participants 2 messages Apr 22, 2025 – Apr 30, 2025 Keys/keyrings

lore
Share & tools
lore

David Howells

author maintainer
#0 lore raw

PATCH 1/1 test: Hide endianness

Hi Jarkko,

Having tried a bunch of ways to determine the cpu endianness so that I can generate model content to compare against the raw contents of a keying, I think it might be better to sidestep the problem and rely on 'od' to byteswap the raw contents and then compare. What do you think?

David
---
test: Hide endianness

Hide the endianness of the raw binary contents of a keyring by passing it through /usr/bin/od which will automatically byteswap it in 4-byte chunks rather than trying to detect the endianness by examining what may be a binary file to obtain a string the format of which changes over time.

---
 tests/keyctl/reading/valid/runtest.sh |    9 ++-------
 tests/toolbox.inc.sh                  |   36 +++++++++++++++++++++++-------------
 2 files changed, 25 insertions(+), 20 deletions(-)
tests/keyctl/reading/valid/runtest.sh +2 -7
index 2fb88b9..2527f13 100644
@@ -40,13 +40,8 @@ expect_payload payload "67697a7a 617264"
 
 # read the contents of the keyring as hex and match it to the key ID
 marker "READ KEYRING"
-read_key $keyringid
-tmp=`printf %08x $keyid`
-if [ "$endian" = "LE" ]
-then
-    tmp=`echo $tmp | sed 's/\(..\)\(..\)\(..\)\(..\)/\4\3\2\1/'`
-fi
-expect_payload payload $tmp
+pipe_key_int32 $keyringid
+expect_payload payload $keyid
 
 # remove read permission from the key and try reading it again
 # - we should still have read permission because it's searchable in our
tests/toolbox.inc.sh +23 -13
index 609a6c7..6f4fb18 100644
@@ -12,19 +12,6 @@
 
 echo === $OUTPUTFILE ===
 
-endian=`file -L /proc/$$/exe`
-if expr "$endian" : '.* MSB \+\(pie executable\|executable\|shared object\).*' >&/dev/null
-then
-    endian=BE
-elif expr "$endian" : '.* LSB \+\(pie executable\|executable\|shared object\).*' >&/dev/null
-then
-    endian=LE
-else
-    echo -e "+++ \e[31;1mCan't Determine Endianness\e[0m"
-    echo "+++ Can't Determine Endianness" >>$OUTPUTFILE
-    exit 2
-fi
-
 maxtypelen=31
 maxtype=`for ((i=0; i<$((maxtypelen)); i++)); do echo -n a; done`
 
@@ -1055,6 +1042,29 @@ function pipe_key ()
     fi
 }
 
+###############################################################################
+#
+# pipe a key's raw payload to od to stdout, displaying it as a sequence of
+# 32-bit numbers, appropriately byteswapped.
+#
+###############################################################################
+function pipe_key_int32 ()
+{
+    my_exitval=0
+    if [ "x$1" = "x--fail" ]
+    then
+	my_exitval=1
+	shift
+    fi
+
+    echo keyctl pipe $1 \| od -t u4 -A none >>$OUTPUTFILE
+    echo `keyctl pipe $1 | od -t u4 -A none` >>$OUTPUTFILE 2>&1
+    if [ $? != $my_exitval ]
+    then
+	failed
+    fi
+}
+
 ###############################################################################
 #
 # pipe a key's raw payload through md5sum
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · David Howells

Hi Jarkko,

Having tried a bunch of ways to determine the cpu endianness so that I can generate model content to compare against the raw contents of a keying, I think it might be better to sidestep the problem and rely on 'od' to byteswap the raw contents and then compare. What do you think?

It's a heck a lot less convoluted at least.

Quoted 81 lines

David
---
test: Hide endianness

Hide the endianness of the raw binary contents of a keyring by passing it through /usr/bin/od which will automatically byteswap it in 4-byte chunks rather than trying to detect the endianness by examining what may be a binary file to obtain a string the format of which changes over time.

---
 tests/keyctl/reading/valid/runtest.sh |    9 ++-------
 tests/toolbox.inc.sh                  |   36 +++++++++++++++++++++++-------------
 2 files changed, 25 insertions(+), 20 deletions(-)
tests/keyctl/reading/valid/runtest.sh +2 -7
index 2fb88b9..2527f13 100644
@@ -40,13 +40,8 @@ expect_payload payload "67697a7a 617264"
 
 # read the contents of the keyring as hex and match it to the key ID
 marker "READ KEYRING"
-read_key $keyringid
-tmp=`printf %08x $keyid`
-if [ "$endian" = "LE" ]
-then
-    tmp=`echo $tmp | sed 's/\(..\)\(..\)\(..\)\(..\)/\4\3\2\1/'`
-fi
-expect_payload payload $tmp
+pipe_key_int32 $keyringid
+expect_payload payload $keyid
 
 # remove read permission from the key and try reading it again
 # - we should still have read permission because it's searchable in our
tests/toolbox.inc.sh +16 -13
index 609a6c7..6f4fb18 100644
@@ -12,19 +12,6 @@
 
 echo === $OUTPUTFILE ===
 
-endian=`file -L /proc/$$/exe`
-if expr "$endian" : '.* MSB \+\(pie executable\|executable\|shared object\).*' >&/dev/null
-then
-    endian=BE
-elif expr "$endian" : '.* LSB \+\(pie executable\|executable\|shared object\).*' >&/dev/null
-then
-    endian=LE
-else
-    echo -e "+++ \e[31;1mCan't Determine Endianness\e[0m"
-    echo "+++ Can't Determine Endianness" >>$OUTPUTFILE
-    exit 2
-fi
-
 maxtypelen=31
 maxtype=`for ((i=0; i<$((maxtypelen)); i++)); do echo -n a; done`
 
@@ -1055,6 +1042,29 @@ function pipe_key ()
     fi
 }
 
+###############################################################################
+#
+# pipe a key's raw payload to od to stdout, displaying it as a sequence of
+# 32-bit numbers, appropriately byteswapped.
+#
+###############################################################################
+function pipe_key_int32 ()
+{
+    my_exitval=0
+    if [ "x$1" = "x--fail" ]
+    then
+	my_exitval=1
+	shift
+    fi
+
+    echo keyctl pipe $1 \| od -t u4 -A none >>$OUTPUTFILE

tests/toolbox.inc.sh function pipe_key () · line 1070

Quoted 10 lines
tests/toolbox.inc.sh +7 -0
+    echo `keyctl pipe $1 | od -t u4 -A none` >>$OUTPUTFILE 2>&1
+    if [ $? != $my_exitval ]
+    then
+	failed
+    fi
+}
+
 ###############################################################################
 #
 # pipe a key's raw payload through md5sum

Yeah, I mean it's also a change from text processing tool to a binary tool (from complex to simple), so IMHO this quite obvious:

BR, Jarkko