Skip to content

Add optional label parameter for pkcs11 support #241

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

Open
krishnavema wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −2
Open

Add optional label parameter for pkcs11 support #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions sssd_test_framework/utils/smartcard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ def add_cert(
cert_id: str = "01",
pin: str = "123456",
private: bool | None = False,
label: str | None = None,
) -> None:
"""
Adds a certificate or private key to the smart card.
Expand All @@ -94,6 +95,8 @@ def add_cert(
:type pin: str, optional
:param private: Whether the object is a private key. Defaults to False.
:type private: bool, optional
:param label: Label for the PKCS#11 object, defaults to None.
:type label: str, optional
Comment on lines +98 to +99
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The type hint for the label parameter is str | None, but the docstring specifies :type label: str. To ensure documentation accuracy and prevent potential confusion for developers using this method, the type in the docstring should match the type hint in the function signature.

Suggested change
:param label: Label for the PKCS#11 object, defaults to None.
:type label: str, optional
:param label: Label for the PKCS#11 object, defaults to None.
:type label: str | None, optional

"""
obj_type = "privkey" if private else "cert"
args: CLIBuilderArgs = {
Expand All @@ -104,9 +107,11 @@ def add_cert(
"type": (self.cli.option.VALUE, obj_type),
"id": (self.cli.option.VALUE, cert_id),
}
if label is not None:
args["label"] = (self.cli.option.VALUE, label)
self.host.conn.run(self.cli.command("pkcs11-tool", args), env={"SOFTHSM2_CONF": self.SOFTHSM2_CONF_PATH})

def add_key(self, key_path: str, key_id: str = "01", pin: str = "123456") -> None:
def add_key(self, key_path: str, key_id: str = "01", pin: str = "123456", label: str | None = None) -> None:
"""
Adds a private key to the smart card.

Expand All @@ -116,8 +121,10 @@ def add_key(self, key_path: str, key_id: str = "01", pin: str = "123456") -> Non
:type key_id: str, optional
:param pin: User PIN, defaults to "123456"
:type pin: str, optional
:param label: Label for the PKCS#11 object, defaults to None.
:type label: str, optional
Comment on lines +124 to +125
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The type hint for the label parameter is str | None, but the docstring specifies :type label: str. To ensure documentation accuracy and prevent potential confusion for developers using this method, the type in the docstring should match the type hint in the function signature.

Suggested change
:param label: Label for the PKCS#11 object, defaults to None.
:type label: str, optional
:param label: Label for the PKCS#11 object, defaults to None.
:type label: str | None, optional

"""
self.add_cert(cert_path=key_path, cert_id=key_id, pin=pin, private=True)
self.add_cert(cert_path=key_path, cert_id=key_id, pin=pin, private=True, label=label)

def generate_cert(
self,
Expand Down
Loading