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
|
#!/bin/bash
# Copyright © 2024 Mobi - Com Polska Sp. z o.o.
# Author: Małgorzata Olszówka <Malgorzata.Olszowka@stunnel.org>
# Copyright (C) 2013 Nikos Mavrogiannopoulos
# Copyright (C) 2015 Red Hat, Inc.
#
# This is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 3 of the License, or (at
# your option) any later version.
#
# GnuTLS is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GnuTLS; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# Uncomment the following line to enable debugging with Valgrind
# WRAPPER="libtool --mode=execute valgrind -s --track-origins=yes --leak-check=full --show-leak-kinds=all --tool=memcheck --show-reachable=yes --keep-debuginfo=yes"
echo "Current directory: $(pwd)"
echo "Source directory: ${srcdir}"
echo "Output directory: ${outdir}"
mkdir -p ${outdir}
# List of directories to search
SOFTHSM_SEARCH_PATHS=(
"/opt/homebrew"
"/usr/local/lib/softhsm"
"/opt/local/lib/softhsm"
"/usr/lib64/pkcs11"
"/usr/lib64/softhsm"
"/usr/lib/x86_64-linux-gnu/softhsm"
"/usr/lib/softhsm"
"/usr/lib"
)
PKCS11_TOOL_SEARCH_PATHS=(
"/opt/homebrew/Cellar"
"/opt/homebrew/bin"
"/usr/local/bin"
"/usr/bin"
)
# Locate the SoftHSM library
MODULE=$(find "${SOFTHSM_SEARCH_PATHS[@]}" -type f -name "libsofthsm2.so" \
-print -quit 2>/dev/null)
# Output the result
if [[ -n "${MODULE}" ]]; then
echo "SoftHSM library found: ${MODULE}"
else
echo "Skipping test: SoftHSM library not found. Please install SoftHSM to proceed."
exit 77
fi
# Locate the pkcs11-tool
PKCS11_TOOL=$(find "${PKCS11_TOOL_SEARCH_PATHS[@]}" -type f -name "pkcs11-tool" \
-print -quit 2>/dev/null)
# Output the result
if [[ -n "${PKCS11_TOOL}" ]]; then
echo "pkcs11-tool found: ${PKCS11_TOOL}"
else
echo "Skipping test: 'pkcs11-tool' not found. Please install the tool to proceed."
exit 77
fi
# Load openssl settings
TEMP_LD_LIBRARY_PATH=${LD_LIBRARY_PATH}
. ${srcdir}/openssl-settings.sh
OPENSSL_VERSION=$(./openssl_version | cut -d ' ' -f 2)
# Restore settings
export LD_LIBRARY_PATH=${TEMP_LD_LIBRARY_PATH}
# Check for ldd command
if command -v ldd >/dev/null 2>&1; then
LIBCRYPTO_VER=$(ldd "${MODULE}" | grep 'libcrypto' | awk '{print $1}')
elif command -v otool >/dev/null 2>&1; then
LIBCRYPTO_VER=$(otool -L "${MODULE}" | grep 'libcrypto' | awk '{print $1}')
else
echo "Warning: Neither ldd nor otool command found. Skipping library version detection."
LIBCRYPTO_VER="unknown"
fi
# Check OpenSSL version and library compatibility
if [[ "${OPENSSL_VERSION}" =~ ^0.* || "${OPENSSL_VERSION}" =~ ^1\.0.* ]]; then
if [[ "${LIBCRYPTO_VER}" == "libcrypto.so.3" ]]; then
echo -n "Skipping test: Module '${MODULE}' built with '${LIBCRYPTO_VER}'"
echo "is incompatible with OpenSSL version '${OPENSSL_VERSION}'."
exit 77
fi
fi
echo "Detected system: ${OSTYPE}"
if [[ ${OSTYPE} == darwin* ]]; then
SHARED_EXT=.dylib
else
SHARED_EXT=.so
fi
sed -e "s|@MODULE_PATH@|${MODULE}|g" -e \
"s|@ENGINE_PATH@|../src/.libs/pkcs11${SHARED_EXT}|g" \
<"${srcdir}/engines.cnf.in" >"${outdir}/engines.cnf"
# Force the use of the local built engine
export OPENSSL_ENGINES="../src/.libs/"
echo "OPENSSL_ENGINES=${OPENSSL_ENGINES}"
# Set the used PIN and PUK
PIN=1234
PUK=1234
# Set the default object ID for operations
ID=01020304
# Initialize the SoftHSM DB
init_db() {
# Define potential paths for SoftHSM tools
local SOFTHSM_TOOL_SEARCH_PATHS=(
"/usr/bin/softhsm"
"/usr/local/bin/softhsm2-util"
"/opt/local/bin/softhsm2-util"
"/usr/bin/softhsm2-util"
"/opt/homebrew/bin/softhsm2-util"
)
# Detect available SoftHSM tool and configure paths
for tool in "${SOFTHSM_TOOL_SEARCH_PATHS[@]}"; do
if [[ -x "$tool" ]]; then
SOFTHSM_TOOL="$tool"
if [[ "$tool" == *softhsm2-util ]]; then
export SOFTHSM2_CONF="$outdir/softhsm-testpkcs11.config"
SLOT="--free"
else
export SOFTHSM_CONF="$outdir/softhsm-testpkcs11.config"
SLOT="--slot 0"
fi
break
fi
done
# Exit if no tool was found
if [[ -z "${SOFTHSM_TOOL}" ]]; then
echo "Skipping test: No softhsm or softhsm2-util tool found in expected locations."
exit 77
fi
# Initialize SoftHSM configuration and database
local db_dir="$outdir/softhsm-testpkcs11.db"
rm -rf "$db_dir"
mkdir -p "$db_dir"
if [[ -n "${SOFTHSM2_CONF}" ]]; then
cat <<EOF > "${SOFTHSM2_CONF}"
objectstore.backend = file
directories.tokendir = $db_dir
EOF
else
echo "0:$db_dir" > "${SOFTHSM_CONF}"
fi
echo "SoftHSM tool: ${SOFTHSM_TOOL}"
echo "Configuration: ${SOFTHSM2_CONF:-$SOFTHSM_CONF}"
}
# Initialize a token in the first available slot
init_card () {
local token_label="$1"
echo "***************************************"
echo -n "* Initializing token ${token_label} ... "
${SOFTHSM_TOOL} --init-token ${SLOT} --label ${token_label} \
--so-pin ${PUK} --pin ${PIN} >/dev/null
if [[ $? -eq 0 ]]; then
echo ok
else
echo failed
exit 1
fi
}
# Delete the token at a given slot
remove_card () {
local token_label="$1"
echo "* Removing token ${token_label}"
${SOFTHSM_TOOL} --delete-token --token ${token_label}
if [[ $? -ne 0 ]]; then
exit 1
fi
}
# Generate an RSA key pair on the token
generate_rsa_key_pair () {
local obj_label="$1"
local token_label="$2"
echo "* Generating an RSA key pair on the token ${token_label}"
pkcs11-tool --login --pin ${PIN} --module ${MODULE} --id ${ID} \
--keypairgen --key-type "rsa:2048" \
--label ${obj_label} --token-label ${token_label}
if [[ $? -ne 0 ]]; then
exit 1
fi
}
# Do the token initialization
init_token () {
local key_type="$1"
local num_devices="$2"
local common_label="$3"
local obj_id="$4"
local obj_label="$5"
local i=0
# Remove the first 5 parameters from the list of arguments
shift 5
# Initialize SoftHSM DB
init_db
while [[ $i -lt ${num_devices} ]]; do
# Initialize a new device
init_card "${common_label}-$i"
# Import objects with different labels
import_objects ${key_type} "${common_label}-$i" ${obj_id} "${obj_label}-$i" "$@"
# List the objects imported into the token
list_objects "${common_label}-$i"
i=$(($i + 1))
done
}
# Write an object (privkey, pubkey, cert) to the token
import_objects () {
local key_type="$1"
local token_label="$2"
local obj_id="$3"
local obj_label="$4"
# Remove the first 4 parameters from the list of arguments
shift 4
# Import objects with different labels
for param in "$@"; do
if [[ -n "$param" ]]; then
echo -n "* Importing the ${key_type} ${param} object id=${obj_id}"
echo -n " into the token ${token_label} ... "
pkcs11-tool --login --pin ${PIN} --module ${MODULE} \
--token-label "${token_label}" \
--write-object "${srcdir}/${key_type}-${param}.der" \
--type ${param} \
--id ${obj_id} --label "${obj_label}" >/dev/null
if [[ $? -eq 0 ]]; then
echo ok
else
echo failed
exit 1
fi
else
echo "Skipping empty parameter"
fi
done
}
# Show objects on the token
list_objects () {
local token_label="$1"
echo "***************************************"
echo "* Listing objects on the token ${token_label}"
echo "***************************************"
pkcs11-tool --login --pin ${PIN} --module ${MODULE} \
--token-label "${token_label}" --list-objects
if [[ $? -ne 0 ]]; then
exit 1
fi
echo "***************************************"
}
|