Merge pull request #191 from dajiaji/migrate-to-poetry

Migrate to poetry.

.github/workflows/python-package.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, windows-latest]
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
 
     steps:
     - uses: actions/checkout@v2
@@ -29,8 +29,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools wheel
-        python -m pip install --upgrade coverage[toml] virtualenv tox tox-gh-actions
+        python -m pip install --upgrade coverage[toml] virtualenv tox tox-gh-actions poetry
 
     - name: Run tox targets for ${{ matrix.python-version }}
       run: python -m tox
@@ -63,11 +62,12 @@ jobs:
       with:
         python-version: "3.8"
 
-    - name: Install pep517 and twine
-      run: python -m pip install pep517 twine
+    - name: Install poetry
+      run: python -m pip install poetry twine
 
     - name: Build package
-      run: python -m pep517.build --source --binary .
+      run: |
+        python -m poetry build
 
     - name: List result
       run: ls -l dist
@@ -90,7 +90,7 @@ jobs:
         python-version: "3.8"
 
     - name: Install in dev mode
-      run: python -m pip install -e .[dev]
+      run: python -m pip install .
 
     - name: Import package
       run: python -c 'import cwt; print(cwt.__version__)'

.github/workflows/python-publish.yml

@@ -13,19 +13,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout sources
+      uses: actions/checkout@v2
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
         python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+        pip install poetry
     - name: Build and publish
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        POETRY_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        POETRY_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+        poetry build
+        poetry publish -u $POETRY_USERNAME -p $POETRY_PASSWORD

.pre-commit-config.yaml

@@ -3,34 +3,30 @@ repos:
     rev: 21.12b0
     hooks:
       - id: black
-        args: ["--target-version=py36"]
+        args: [--line-length, "128"]
 
   - repo: https://github.com/asottile/blacken-docs
     rev: v1.12.0
     hooks:
       - id: blacken-docs
-        args: ["--target-version=py36"]
 
   - repo: https://github.com/PyCQA/flake8
     rev: 4.0.1
     hooks:
       - id: flake8
-        language_version: python3.8
+        args: [--ignore, "E203,E501,B006,W503"]
+        additional_dependencies: [flake8-bugbear]
 
   - repo: https://github.com/PyCQA/isort
     rev: 5.10.1
     hooks:
       - id: isort
+        args: [--profile, "black"]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1
     hooks:
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
       - id: debug-statements
-
-  - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.47"
-    hooks:
-      - id: check-manifest
-        args: [--no-build-isolation]
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: trailing-whitespace

.readthedocs.yml

@@ -1,2 +1,9 @@
+version: 2
+
 python:
-   setup_py_install: true
+  version: "3.8"
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

CHANGES.rst

@@ -4,6 +4,10 @@ Changes
 Unreleased
 ----------
 
+- Migrate to poetry. `#191 <https://github.com/dajiaji/python-cwt/pull/191>`__
+- Change max line length to 128. `#191 <https://github.com/dajiaji/python-cwt/pull/191>`__
+- Fix updated flake8 warning. `#191 <https://github.com/dajiaji/python-cwt/pull/191>`__
+
 Version 1.4.2
 -------------
 

cwt/algs/asymmetric.py

@@ -33,12 +33,8 @@ def validate_certificate(self, ca_certs: List[bytes]) -> bool:
 
         ctx = ValidationContext(trust_roots=ca_certs)
         try:
-            validator = CertificateValidator(
-                self._cert, self._intermediates, validation_context=ctx
-            )
+            validator = CertificateValidator(self._cert, self._intermediates, validation_context=ctx)
             validator.validate_usage(set(["digital_signature"]), extended_optional=True)
         except Exception as err:
-            raise VerifyError(
-                "Failed to validate the certificate bound to the key."
-            ) from err
+            raise VerifyError("Failed to validate the certificate bound to the key.") from err
         return True

cwt/algs/ec2.py

@@ -92,9 +92,7 @@ def __init__(self, params: Dict[int, Any]):
                         if not (set(self._key_ops) & set([1, 2])):
                             raise ValueError("Invalid key_ops for signing key.")
                         if set(self._key_ops) & set([7, 8]):
-                            raise ValueError(
-                                "Signing key should not be used for key derivation."
-                            )
+                            raise ValueError("Signing key should not be used for key derivation.")
                     else:
                         # public key for signing.
                         if 2 not in self._key_ops or len(self._key_ops) != 1:
@@ -114,14 +112,10 @@ def __init__(self, params: Dict[int, Any]):
                         if not (set(self._key_ops) & set([7, 8])):
                             raise ValueError("Invalid key_ops for key derivation.")
                         if set(self._key_ops) & set([1, 2]):
-                            raise ValueError(
-                                "ECDHE key should not be used for signing."
-                            )
+                            raise ValueError("ECDHE key should not be used for signing.")
                     else:
                         # public key for key derivation.
-                        raise ValueError(
-                            "Public key for ECDHE should not have key_ops."
-                        )
+                        raise ValueError("Public key for ECDHE should not have key_ops.")
                 else:
                     if -2 not in params and -3 not in params:
                         # private key for key derivation.
@@ -134,9 +128,7 @@ def __init__(self, params: Dict[int, Any]):
                 if set(self._key_ops) & set([1, 2]):
                     # private key for signing.
                     if set(self._key_ops) & set([7, 8]):
-                        raise ValueError(
-                            "EC2 Private key should not be used for both signing and key derivation."
-                        )
+                        raise ValueError("EC2 Private key should not be used for both signing and key derivation.")
                     if self._crv == 1:
                         self._alg = -7  # ES256
                     elif self._crv == 2:
@@ -198,9 +190,7 @@ def __init__(self, params: Dict[int, Any]):
             raise ValueError("d(-4) should be bytes(bstr).")
         self._d = params[-4]
         if len(self._d) != len(self._x):
-            raise ValueError(
-                f"d(-4) should be {len(self._x)} bytes for curve {self._crv}"
-            )
+            raise ValueError(f"d(-4) should be {len(self._x)} bytes for curve {self._crv}")
         try:
             self._private_key = ec.EllipticCurvePrivateNumbers(
                 int.from_bytes(self._d, byteorder="big"), public_numbers
@@ -211,9 +201,7 @@ def __init__(self, params: Dict[int, Any]):
         return
 
     @staticmethod
-    def to_cose_key(
-        k: Union[EllipticCurvePrivateKey, EllipticCurvePublicKey]
-    ) -> Dict[int, Any]:
+    def to_cose_key(k: Union[EllipticCurvePrivateKey, EllipticCurvePublicKey]) -> Dict[int, Any]:
         key_len: int = 32
         cose_key: Dict[int, Any] = {}
 
@@ -234,15 +222,9 @@ def to_cose_key(
             cose_key[-2] = k.public_numbers().x.to_bytes(key_len, byteorder="big")
             cose_key[-3] = k.public_numbers().y.to_bytes(key_len, byteorder="big")
             return cose_key
-        cose_key[-2] = (
-            k.public_key().public_numbers().x.to_bytes(key_len, byteorder="big")
-        )
-        cose_key[-3] = (
-            k.public_key().public_numbers().y.to_bytes(key_len, byteorder="big")
-        )
-        cose_key[-4] = k.private_numbers().private_value.to_bytes(
-            key_len, byteorder="big"
-        )
+        cose_key[-2] = k.public_key().public_numbers().x.to_bytes(key_len, byteorder="big")
+        cose_key[-3] = k.public_key().public_numbers().y.to_bytes(key_len, byteorder="big")
+        cose_key[-4] = k.private_numbers().private_value.to_bytes(key_len, byteorder="big")
         return cose_key
 
     @property
@@ -275,9 +257,7 @@ def verify(self, msg: bytes, sig: bytes):
         try:
             if self._private_key:
                 der_sig = self._os_to_der(self._private_key.curve.key_size, sig)
-                self._private_key.public_key().verify(
-                    der_sig, msg, ec.ECDSA(self._hash_alg())
-                )
+                self._private_key.public_key().verify(der_sig, msg, ec.ECDSA(self._hash_alg()))
             else:
                 der_sig = self._os_to_der(self._public_key.curve.key_size, sig)
                 self._public_key.verify(der_sig, msg, ec.ECDSA(self._hash_alg()))
@@ -309,11 +289,7 @@ def derive_key(
             self._validate_context(context)
 
         # Derive key.
-        self._key = (
-            self._private_key
-            if self._private_key
-            else ec.generate_private_key(self._crv_obj)
-        )
+        self._key = self._private_key if self._private_key else ec.generate_private_key(self._crv_obj)
         shared_key = self._key.exchange(ec.ECDH(), public_key.key)
         hkdf = HKDF(
             algorithm=self._hash_alg(),

cwt/algs/okp.py

@@ -79,9 +79,7 @@ def __init__(self, params: Dict[int, Any]):
             elif self._alg in [-26, -28]:
                 self._hash_alg = hashes.SHA512
             else:
-                raise ValueError(
-                    f"Unsupported or unknown alg used with X25519/X448: {self._alg}."
-                )
+                raise ValueError(f"Unsupported or unknown alg used with X25519/X448: {self._alg}.")
 
         # Validate alg and key_ops.
         if self._key_ops:
@@ -99,9 +97,7 @@ def __init__(self, params: Dict[int, Any]):
                     if not (set(self._key_ops) & set([1, 2])):
                         raise ValueError("Invalid key_ops for signing key.")
                     if set(self._key_ops) & set([7, 8]):
-                        raise ValueError(
-                            "Signing key should not be used for key derivation."
-                        )
+                        raise ValueError("Signing key should not be used for key derivation.")
                 else:
                     # public key for signing.
                     if 2 not in self._key_ops or len(self._key_ops) != 1:
@@ -112,15 +108,11 @@ def __init__(self, params: Dict[int, Any]):
                     if not (set(self._key_ops) & set([7, 8])):
                         raise ValueError("Invalid key_ops for key derivation.")
                     if set(self._key_ops) & set([1, 2]):
-                        raise ValueError(
-                            "Private key for ECDHE should not be used for signing."
-                        )
+                        raise ValueError("Private key for ECDHE should not be used for signing.")
                 else:
                     # public key for key derivation.
                     if self._key_ops:
-                        raise ValueError(
-                            "Public key for ECDHE should not have key_ops."
-                        )
+                        raise ValueError("Public key for ECDHE should not have key_ops.")
             else:
                 raise ValueError(f"Unsupported or unknown alg(3) for OKP: {self._alg}.")
         else:
@@ -129,9 +121,7 @@ def __init__(self, params: Dict[int, Any]):
                 if set(self._key_ops) & set([1, 2]):
                     # private key for signing.
                     if set(self._key_ops) & set([7, 8]):
-                        raise ValueError(
-                            "OKP private key should not be used for both signing and key derivation."
-                        )
+                        raise ValueError("OKP private key should not be used for both signing and key derivation.")
                     self._alg = -8  # EdDSA
             else:
                 # public key.
@@ -206,45 +196,29 @@ def to_cose_key(
             if isinstance(k, Ed25519PublicKey):
                 cose_key[-2] = k.public_bytes(Encoding.Raw, PublicFormat.Raw)
             else:
-                cose_key[-2] = k.public_key().public_bytes(
-                    Encoding.Raw, PublicFormat.Raw
-                )
-                cose_key[-4] = k.private_bytes(
-                    Encoding.Raw, PrivateFormat.Raw, NoEncryption()
-                )
+                cose_key[-2] = k.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw)
+                cose_key[-4] = k.private_bytes(Encoding.Raw, PrivateFormat.Raw, NoEncryption())
         elif isinstance(k, (Ed448PublicKey, Ed448PrivateKey)):
             cose_key[-1] = 7  # Ed448
             if isinstance(k, Ed448PublicKey):
                 cose_key[-2] = k.public_bytes(Encoding.Raw, PublicFormat.Raw)
             else:
-                cose_key[-2] = k.public_key().public_bytes(
-                    Encoding.Raw, PublicFormat.Raw
-                )
-                cose_key[-4] = k.private_bytes(
-                    Encoding.Raw, PrivateFormat.Raw, NoEncryption()
-                )
+                cose_key[-2] = k.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw)
+                cose_key[-4] = k.private_bytes(Encoding.Raw, PrivateFormat.Raw, NoEncryption())
         elif isinstance(k, (X25519PublicKey, X25519PrivateKey)):
             cose_key[-1] = 4  # X25519
             if isinstance(k, X25519PublicKey):
                 cose_key[-2] = k.public_bytes(Encoding.Raw, PublicFormat.Raw)
             else:
-                cose_key[-2] = k.public_key().public_bytes(
-                    Encoding.Raw, PublicFormat.Raw
-                )
-                cose_key[-4] = k.private_bytes(
-                    Encoding.Raw, PrivateFormat.Raw, NoEncryption()
-                )
+                cose_key[-2] = k.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw)
+                cose_key[-4] = k.private_bytes(Encoding.Raw, PrivateFormat.Raw, NoEncryption())
         elif isinstance(k, (X448PublicKey, X448PrivateKey)):
             cose_key[-1] = 5  # X448
             if isinstance(k, X448PublicKey):
                 cose_key[-2] = k.public_bytes(Encoding.Raw, PublicFormat.Raw)
             else:
-                cose_key[-2] = k.public_key().public_bytes(
-                    Encoding.Raw, PublicFormat.Raw
-                )
-                cose_key[-4] = k.private_bytes(
-                    Encoding.Raw, PrivateFormat.Raw, NoEncryption()
-                )
+                cose_key[-2] = k.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw)
+                cose_key[-4] = k.private_bytes(Encoding.Raw, PrivateFormat.Raw, NoEncryption())
         else:
             raise ValueError("Unsupported or unknown key for OKP.")
         return cose_key
@@ -304,9 +278,7 @@ def derive_key(
             raise ValueError("Public key cannot be used for key derivation.")
         if not public_key:
             raise ValueError("public_key should be set.")
-        if not isinstance(public_key.key, X25519PublicKey) and not isinstance(
-            public_key.key, X448PublicKey
-        ):
+        if not isinstance(public_key.key, X25519PublicKey) and not isinstance(public_key.key, X448PublicKey):
             raise ValueError("public_key should be x25519/x448 public key.")
         # if self._alg not in COSE_ALGORITHMS_CKDM_KEY_AGREEMENT.values():
         #     raise ValueError(f"Invalid alg for key derivation: {self._alg}.")
@@ -321,11 +293,7 @@ def derive_key(
         if self._private_key:
             self._key = self._private_key
         else:
-            self._key = (
-                X25519PrivateKey.generate()
-                if self._crv == 4
-                else X448PrivateKey.generate()
-            )
+            self._key = X25519PrivateKey.generate() if self._crv == 4 else X448PrivateKey.generate()
         shared_key = self._key.exchange(public_key.key)
         hkdf = HKDF(
             algorithm=self._hash_alg(),