Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

p11-kit tool: make "no matching object/token" error user friendly #575

Merged
merged 3 commits into from
Sep 26, 2023
Merged

p11-kit tool: make "no matching object/token" error user friendly #575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3404bd8
Don't check for slot == 0 as 0 is a valid slot ID
ZoltanFridrich Sep 22, 2023
e9d783d
p11-kit tool: make "no matching object/token" error user friendly
ZoltanFridrich Sep 22, 2023
014325a
Test for nonexistent tokens in p11-kit commands
ZoltanFridrich Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions common/test-init.sh.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ assert_fail()

assert_contains()
{
if ! grep -qF $2 $1; then
if ! grep -qF "$2" "$1"; then
assert_fail "$1 does not contain $2"
fi
}

assert_not_contains()
{
if grep -qF $2 $1; then
if grep -qF "$2" "$1"; then
assert_fail "$1 contains $2"
fi
}
Expand Down
10 changes: 4 additions & 6 deletions p11-kit/add-profile.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,10 @@ add_profile (const char *token_str,
p11_kit_iter_begin (iter, modules);
rv = p11_kit_iter_next (iter);
if (rv != CKR_OK) {
p11_message (_("failed to find the token: %s"), p11_kit_strerror (rv));
if (rv == CKR_CANCEL)
p11_message (_("no matching token"));
else
p11_message (_("failed to find token: %s"), p11_kit_strerror (rv));
goto cleanup;
}

Expand All @@ -117,12 +120,7 @@ add_profile (const char *token_str,
p11_message (_("failed to obtain module"));
goto cleanup;
}

slot = p11_kit_iter_get_slot (iter);
if (slot == 0) {
p11_message (_("failed to obtain slot"));
goto cleanup;
}

rv = module->C_OpenSession (slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &session);
if (rv != CKR_OK) {
Expand Down
5 changes: 4 additions & 1 deletion p11-kit/delete-object.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ delete_object (const char *token_str)
p11_kit_iter_begin (iter, modules);
rv = p11_kit_iter_next (iter);
if (rv != CKR_OK) {
p11_message (_("failed to find the object: %s"), p11_kit_strerror (rv));
if (rv == CKR_CANCEL)
p11_message (_("no matching object"));
else
p11_message (_("failed to find object: %s"), p11_kit_strerror (rv));
goto cleanup;
}

Expand Down
10 changes: 4 additions & 6 deletions p11-kit/generate-keypair.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,10 @@ generate_keypair (const char *token_str,
p11_kit_iter_begin (iter, modules);
rv = p11_kit_iter_next (iter);
if (rv != CKR_OK) {
p11_message (_("failed to find the token: %s"), p11_kit_strerror (rv));
if (rv == CKR_CANCEL)
p11_message (_("no matching token"));
else
p11_message (_("failed to find token: %s"), p11_kit_strerror (rv));
goto cleanup;
}

Expand All @@ -301,12 +304,7 @@ generate_keypair (const char *token_str,
p11_message (_("failed to obtain module"));
goto cleanup;
}

slot = p11_kit_iter_get_slot (iter);
if (slot == 0) {
p11_message (_("failed to obtain slot"));
goto cleanup;
}

rv = module->C_OpenSession (slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &session);
if (rv != CKR_OK) {
Expand Down
35 changes: 34 additions & 1 deletion p11-kit/test-objects.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,5 +258,38 @@ EOF
fi
}

test_generate_keypair_nonexistent_token() {
cat > list.exp <<EOF
EOF

if "$abs_top_builddir"/p11-kit/p11-kit-testable generate-keypair --type=mock "pkcs11:token=NONEXISTENT" > list.out 2> err.out; then
assert_fail "expected to fail: p11-kit generate-keypair"
fi

: ${DIFF=diff}
if ! ${DIFF} list.exp list.out > list.diff; then
sed 's/^/# /' list.diff
assert_fail "output contains wrong result"
fi
assert_contains err.out "no matching token"
}

test_delete_nonexistent_token() {
cat > list.exp <<EOF
EOF

if "$abs_top_builddir"/p11-kit/p11-kit-testable delete-object "pkcs11:token=NONEXISTENT" > list.out 2> err.out; then
assert_fail "expected to fail: p11-kit delete-object"
fi

: ${DIFF=diff}
if ! ${DIFF} list.exp list.out > list.diff; then
sed 's/^/# /' list.diff
assert_fail "output contains wrong result"
fi
assert_contains err.out "no matching object"
}

run test_list_all test_list_with_type test_list_exact test_list_nonexistent \
test_export_cert test_export_pubkey test_generate_keypair
test_export_cert test_export_pubkey test_generate_keypair test_generate_keypair_nonexistent_token \
test_delete_nonexistent_token
19 changes: 18 additions & 1 deletion p11-kit/test-profiles.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,21 @@ EOF
fi
}

run test_list_profiles
test_add_profile_nonexistent_token() {
cat > list.exp <<EOF
EOF

if "$abs_top_builddir"/p11-kit/p11-kit-testable add-profile --profile=baseline-provider "pkcs11:token=NONEXISTENT" > list.out 2> err.out; then
assert_fail "expected to fail: p11-kit add-profile"
fi

: ${DIFF=diff}
if ! ${DIFF} list.exp list.out > list.diff; then
sed 's/^/# /' list.diff
assert_fail "output contains wrong results"
fi
assert_contains err.out "no matching token"
}

run test_list_profiles \
test_add_profile_nonexistent_token
Loading