fido2.client.windows

Classes

`CancelThread`	A class that represents a thread of control.
`WindowsClient`	Fido2Client-like class using the Windows WebAuthn API.

Module Contents

class fido2.client.windows.CancelThread(event)

Bases: threading.Thread

A class that represents a thread of control.

This class can be safely subclassed in a limited fashion. There are two ways to specify the activity: by passing a callable object to the constructor, or by overriding the run() method in a subclass.

daemon = True

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.

event

guid

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

complete()

class fido2.client.windows.WindowsClient(client_data_collector, handle=None, allow_hmac_secret=False)

Bases: fido2.client.WebAuthnClient

Fido2Client-like class using the Windows WebAuthn API.

Note: This class only works on Windows 10 19H1 or later. This is also when Windows started restricting access to FIDO devices, causing the standard client classes to require admin priveleges to run (unlike this one).

Parameters:

origin (str) – The origin to use.
verify – Function to verify an RP ID for a given origin.
handle (ctypes.wintypes.HWND) – (optional) Window reference to use.
client_data_collector (fido2.client.ClientDataCollector)

handle

static is_available()

Return type:: bool

make_credential(options, event=None)

Create a credential using Windows WebAuthN APIs.

Parameters:

options – PublicKeyCredentialCreationOptions data.
event (threading.Event) – (optional) Signal to abort the operation.

get_assertion(options, event=None)

Get assertion using Windows WebAuthN APIs.

Parameters:

options – PublicKeyCredentialRequestOptions data.
event (threading.Event) – (optional) Signal to abort the operation.