feat/remove-pydantic-dependency

.github/workflows/build_and_test.yml

@@ -16,7 +16,6 @@ jobs:
     strategy:
       matrix:
         python-version: ['3.8', '3.9', '3.10', '3.11']
-        pydantic-version: ['>=1.0,<2.0', '>=2.0,<3.0']
 
     steps:
     - uses: actions/checkout@v3
@@ -28,7 +27,6 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-        pip install 'pydantic${{ matrix.pydantic-version }}'
     - name: Test with unittest
       run: |
         python -m unittest

.vscode/settings.json

@@ -1,5 +1,13 @@
 {
+    "black-formatter.args": [
+        "--line-length", "99"
+    ],
+    "mypy-type-checker.path": ["venv/bin/mypy"],
     "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter"
-    }
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnPaste": false,
+        "editor.formatOnSaveMode": "file",
+        "editor.formatOnSave": true,
+    },
+    "python.analysis.typeCheckingMode": "basic"
 }

examples/authentication.py

@@ -5,7 +5,6 @@
     base64url_to_bytes,
 )
 from webauthn.helpers.structs import (
-    PYDANTIC_V2,
     PublicKeyCredentialDescriptor,
     UserVerificationRequirement,
 )
@@ -66,8 +65,5 @@
     require_user_verification=True,
 )
 print("\n[Authentication Verification]")
-if PYDANTIC_V2:
-    print(authentication_verification.model_dump_json(indent=2))
-else:
-    print(authentication_verification.json(indent=2))
+print(authentication_verification)
 assert authentication_verification.new_sign_count == 1

examples/registration.py

@@ -6,7 +6,6 @@
 )
 from webauthn.helpers.cose import COSEAlgorithmIdentifier
 from webauthn.helpers.structs import (
-    PYDANTIC_V2,
     AttestationConveyancePreference,
     AuthenticatorAttachment,
     AuthenticatorSelectionCriteria,
@@ -63,11 +62,11 @@
         "response": {
             "attestationObject": "o2NmbXRkbm9uZWdhdHRTdG10oGhhdXRoRGF0YVkBZ0mWDeWIDoxodDQXD2R2YFuP5K65ooYyx5lc87qDHZdjRQAAAAAAAAAAAAAAAAAAAAAAAAAAACBmggo_UlC8p2tiPVtNQ8nZ5NSxst4WS_5fnElA2viTq6QBAwM5AQAgWQEA31dtHqc70D_h7XHQ6V_nBs3Tscu91kBL7FOw56_VFiaKYRH6Z4KLr4J0S12hFJ_3fBxpKfxyMfK66ZMeAVbOl_wemY4S5Xs4yHSWy21Xm_dgWhLJjZ9R1tjfV49kDPHB_ssdvP7wo3_NmoUPYMgK-edgZ_ehttp_I6hUUCnVaTvn_m76b2j9yEPReSwl-wlGsabYG6INUhTuhSOqG-UpVVQdNJVV7GmIPHCA2cQpJBDZBohT4MBGme_feUgm4sgqVCWzKk6CzIKIz5AIVnspLbu05SulAVnSTB3NxTwCLNJR_9v9oSkvphiNbmQBVQH1tV_psyi9HM1Jtj9VJVKMeyFDAQAB",
             "clientDataJSON": "eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxlbmdlIjoiQ2VUV29nbWcwY2NodWlZdUZydjhEWFhkTVpTSVFSVlpKT2dhX3hheVZWRWNCajBDdzN5NzN5aEQ0RmtHU2UtUnJQNmhQSkpBSW0zTFZpZW40aFhFTGciLCJvcmlnaW4iOiJodHRwOi8vbG9jYWxob3N0OjUwMDAiLCJjcm9zc09yaWdpbiI6ZmFsc2V9",
-            "transports": ["internal"]
+            "transports": ["internal"],
         },
         "type": "public-key",
         "clientExtensionResults": {},
-        "authenticatorAttachment": "platform"
+        "authenticatorAttachment": "platform",
     },
     expected_challenge=base64url_to_bytes(
         "CeTWogmg0cchuiYuFrv8DXXdMZSIQRVZJOga_xayVVEcBj0Cw3y73yhD4FkGSe-RrP6hPJJAIm3LVien4hXELg"
@@ -78,10 +77,7 @@
 )
 
 print("\n[Registration Verification - None]")
-if PYDANTIC_V2:
-    print(registration_verification.model_dump_json(indent=2))
-else:
-    print(registration_verification.json(indent=2))
+print(registration_verification)
 assert registration_verification.credential_id == base64url_to_bytes(
     "ZoIKP1JQvKdrYj1bTUPJ2eTUsbLeFkv-X5xJQNr4k6s"
 )

mypy.ini

@@ -1,11 +1,6 @@
 [mypy]
-plugins = pydantic.mypy
-
 python_version = 3.8
 
-[pydantic-mypy]
-init_typed=True
-
 [mypy-asn1crypto.*]
 ignore_missing_imports = True
 

requirements.txt

@@ -1,7 +1,6 @@
-annotated-types==0.5.0
 asn1crypto==1.4.0
 black==21.9b0
-cbor2==5.4.6
+cbor2==5.5.0
 cffi==1.15.0
 click==8.0.3
 cryptography==41.0.4
@@ -12,12 +11,10 @@ pathspec==0.9.0
 platformdirs==2.4.0
 pycodestyle==2.8.0
 pycparser==2.20
-pydantic==2.4.2
-pydantic_core==2.10.1
 pyflakes==2.4.0
 pyOpenSSL==23.2.0
 regex==2021.10.8
 six==1.16.0
 toml==0.10.2
 tomli==1.2.1
-typing_extensions==4.7.1
+typing_extensions==4.9.0

setup.py

@@ -51,7 +51,6 @@ def find_version(*file_paths):
         'asn1crypto>=1.4.0',
         'cbor2>=5.4.6',
         'cryptography>=41.0.4',
-        'pydantic>=1.10.11',
         'pyOpenSSL>=23.2.0',
     ]
 )

tests/test_bytes_subclass_support.py

@@ -99,7 +99,7 @@ def test_supports_strings_for_bytes(self) -> None:
             authenticator_data=bytes(),
             client_data_json=bytes(),
             signature=bytes(),
-            user_handle='some_user_handle_string'  # type: ignore
+            user_handle="some_user_handle_string",
         )
 
-        self.assertEqual(response.user_handle, b'some_user_handle_string')
+        self.assertEqual(response.user_handle, "some_user_handle_string")

tests/test_decode_credential_public_key.py

@@ -23,13 +23,11 @@ def test_decodes_ec2_public_key(self) -> None:
         assert decoded.crv == 1
         assert (
             decoded.x
-            and bytes_to_base64url(decoded.x)
-            == "MMcEPFOpY_jJlmcBrnbgvq4-7CGKt5TBEPmxdjpTaDE"
+            and bytes_to_base64url(decoded.x) == "MMcEPFOpY_jJlmcBrnbgvq4-7CGKt5TBEPmxdjpTaDE"
         )
         assert (
             decoded.y
-            and bytes_to_base64url(decoded.y)
-            == "xuwbECbDdNfTTegnc174oYdusZiMmJgct0yI_ulrJGI"
+            and bytes_to_base64url(decoded.y) == "xuwbECbDdNfTTegnc174oYdusZiMmJgct0yI_ulrJGI"
         )
 
     def test_decode_rsa_public_key(self) -> None:
@@ -62,11 +60,9 @@ def test_decode_uncompressed_ec2_public_key(self) -> None:
         assert decoded.crv == 1
         assert (
             decoded.x
-            and bytes_to_base64url(decoded.x)
-            == "FrEpm55XKvkgIN-izKDHBF-VJ09Rw2F5mFOFcJ5MVM0"
+            and bytes_to_base64url(decoded.x) == "FrEpm55XKvkgIN-izKDHBF-VJ09Rw2F5mFOFcJ5MVM0"
         )
         assert (
             decoded.y
-            and bytes_to_base64url(decoded.y)
-            == "o0EM9dj0V-xJ1JwpE2XZ_8NRIt5KVvr71Zl0rB8BWOs"
+            and bytes_to_base64url(decoded.y) == "o0EM9dj0V-xJ1JwpE2XZ_8NRIt5KVvr71Zl0rB8BWOs"
         )

tests/test_generate_registration_options.py

@@ -66,9 +66,7 @@ def test_generates_options_with_custom_values(self) -> None:
             timeout=120000,
         )
 
-        assert options.rp == PublicKeyCredentialRpEntity(
-            id="example.com", name="Example Co"
-        )
+        assert options.rp == PublicKeyCredentialRpEntity(id="example.com", name="Example Co")
         assert options.challenge == b"1234567890"
         assert options.user == PublicKeyCredentialUserEntity(
             id=b"ABAV6QWPBEY9WOTOA1A4",
@@ -80,9 +78,7 @@ def test_generates_options_with_custom_values(self) -> None:
             alg=COSEAlgorithmIdentifier.ECDSA_SHA_512,
         )
         assert options.timeout == 120000
-        assert options.exclude_credentials == [
-            PublicKeyCredentialDescriptor(id=b"1234567890")
-        ]
+        assert options.exclude_credentials == [PublicKeyCredentialDescriptor(id=b"1234567890")]
         assert options.authenticator_selection == AuthenticatorSelectionCriteria(
             authenticator_attachment=AuthenticatorAttachment.PLATFORM,
             resident_key=ResidentKeyRequirement.REQUIRED,

tests/test_options_to_json.py

@@ -10,12 +10,15 @@
     AuthenticatorTransport,
     PublicKeyCredentialDescriptor,
     ResidentKeyRequirement,
+    UserVerificationRequirement,
 )
-from webauthn import generate_registration_options
+from webauthn import generate_registration_options, generate_authentication_options
 
 
 class TestWebAuthnOptionsToJSON(TestCase):
-    def test_converts_options_to_JSON(self) -> None:
+    maxDiff = None
+
+    def test_converts_registration_options_to_JSON(self) -> None:
         options = generate_registration_options(
             rp_id="example.com",
             rp_name="Example Co",
@@ -37,25 +40,28 @@ def test_converts_options_to_JSON(self) -> None:
 
         output = options_to_json(options)
 
-        assert json.loads(output) == {
-            "rp": {"name": "Example Co", "id": "example.com"},
-            "user": {
-                "id": "QUJBVjZRV1BCRVk5V09UT0ExQTQ",
-                "name": "lee",
-                "displayName": "Lee",
-            },
-            "challenge": "MTIzNDU2Nzg5MA",
-            "pubKeyCredParams": [{"type": "public-key", "alg": -36}],
-            "timeout": 120000,
-            "excludeCredentials": [{"type": "public-key", "id": "MTIzNDU2Nzg5MA"}],
-            "authenticatorSelection": {
-                "authenticatorAttachment": "platform",
-                "residentKey": "required",
-                "requireResidentKey": True,
-                "userVerification": "preferred",
+        self.assertEqual(
+            json.loads(output),
+            {
+                "rp": {"name": "Example Co", "id": "example.com"},
+                "user": {
+                    "id": "QUJBVjZRV1BCRVk5V09UT0ExQTQ",
+                    "name": "lee",
+                    "displayName": "Lee",
+                },
+                "challenge": "MTIzNDU2Nzg5MA",
+                "pubKeyCredParams": [{"type": "public-key", "alg": -36}],
+                "timeout": 120000,
+                "excludeCredentials": [{"type": "public-key", "id": "MTIzNDU2Nzg5MA"}],
+                "authenticatorSelection": {
+                    "authenticatorAttachment": "platform",
+                    "residentKey": "required",
+                    "requireResidentKey": True,
+                    "userVerification": "preferred",
+                },
+                "attestation": "direct",
             },
-            "attestation": "direct",
-        }
+        )
 
     def test_includes_optional_value_when_set(self) -> None:
         options = generate_registration_options(
@@ -73,10 +79,44 @@ def test_includes_optional_value_when_set(self) -> None:
 
         output = options_to_json(options)
 
-        assert json.loads(output)["excludeCredentials"] == [
+        self.assertEqual(
+            json.loads(output)["excludeCredentials"],
+            [
+                {
+                    "id": "MTIzNDU2Nzg5MA",
+                    "transports": ["usb"],
+                    "type": "public-key",
+                }
+            ],
+        )
+
+    def test_converts_authentication_options_to_JSON(self) -> None:
+        options = generate_authentication_options(
+            rp_id="example.com",
+            challenge=b"1234567890",
+            allow_credentials=[
+                PublicKeyCredentialDescriptor(id=b"1234567890"),
+            ],
+            timeout=120000,
+            user_verification=UserVerificationRequirement.DISCOURAGED,
+        )
+
+        output = options_to_json(options)
+
+        self.assertEqual(
+            json.loads(output),
             {
-                "id": "MTIzNDU2Nzg5MA",
-                "transports": ["usb"],
-                "type": "public-key",
-            }
-        ]
+                "rpId": "example.com",
+                "challenge": "MTIzNDU2Nzg5MA",
+                "allowCredentials": [{"type": "public-key", "id": "MTIzNDU2Nzg5MA"}],
+                "timeout": 120000,
+                "userVerification": "discouraged",
+            },
+        )
+
+    def test_raises_on_bad_input(self) -> None:
+        class FooClass:
+            pass
+
+        with self.assertRaisesRegex(TypeError, "not instance"):
+            options_to_json(FooClass())  # type: ignore