chore: code linting

Author: peppelinux

linting.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+autopep8 -r --in-place pymdoccbor
+autoflake -r --in-place  --remove-unused-variables --expand-star-imports --remove-all-unused-imports pymdoccbor
+
+flake8 pymdoccbor --count --select=E9,F63,F7,F82 --show-source --statistics
+flake8 pymdoccbor --max-line-length 120 --count --statistics

pymdoccbor/__init__.py

@@ -1 +1 @@
-__version__="0.2.0"
+__version__ = "0.2.0"

pymdoccbor/deprecated/issuerauth.py

@@ -1,4 +1,3 @@
-from typing import List
 
 from pycose.messages.sign1message import Sign1Message
 
@@ -8,34 +7,29 @@
 class MdocIssuerAuth:
     """
     IssuerAuth is a COSE_Sign1 ; The payload is the MobileSecurityObject, see ISO 18013-5 section 9.2.2.4 
-    
+
     A CBOR decoded issuerAuth is a list of [
         cbor({1: -7}) # Protected Header, find -7 here https://datatracker.ietf.org/doc/html/rfc8152
         cbor({33: bytes}) # Unprotected Header containing X509 certificate
         cbor({24: bytes}) # Payload -> Mobile Security Object
     ]
     """
 
-    def parse(self, mso : Sign1Message) -> None:
+    def parse(self, mso: Sign1Message) -> None:
         pass
 
-
     def read(self, mso_dict: dict) -> None:
         """
         Returns a CBOR Endoded tag 24
         """
-    
+
     def verify_signature(self) -> bool:
         pass
 
-
-    def load(self, mso :bytes):
+    def load(self, mso: bytes):
         """
             loads a dumped COSE_Sign1
         """
-        
-        pass
-    
+
     def dump(self) -> bool:
         pass
-    

pymdoccbor/exceptions.py

@@ -1,7 +1,7 @@
 class InvalidMdoc(Exception):
     """
     """
-    pass
+
 
 class UnsupportedMsoDataFormat(Exception):
     pass

pymdoccbor/issuersigned.py

@@ -8,9 +8,9 @@ class IssuerSigned:
     """
     nameSpaces provides the definition within which the data elements of 
         the document are defined.  A document may have multiple nameSpaces.
-    
+
     IssuerAuth is a COSE_Sign1 ; The payload is the MobileSecurityObject, see ISO 18013-5 section 9.2.2.4 
-    
+
     issuerAuth is a list of [
         cbor({1: -7}) # Protected Header, find -7 here https://datatracker.ietf.org/doc/html/rfc8152
         cbor({33: bytes}) # Unprotected Header containing X509 certificate
@@ -20,23 +20,23 @@ class IssuerSigned:
     """
     #  nameSpaces :dict = {}
     #  issuerAuth :IssuerAuth = None
-    
-    def __init__(self, nameSpaces :dict, issuerAuth :Union[dict, bytes]):
-        self.namespaces :dict = nameSpaces
-        
+
+    def __init__(self, nameSpaces: dict, issuerAuth: Union[dict, bytes]):
+        self.namespaces: dict = nameSpaces
+
         #  if isinstance(ia, dict):
         self.issuer_auth = MsoParser(issuerAuth)
-    
+
     def dump(self):
         return {
             'nameSpaces': self.namespaces,
             'issuerAuth': self.issuer_auth
         }
-    
+
     def dumps(self):
         return cbor2.dumps(
             {
-            'nameSpaces': self.namespaces,
-            'issuerAuth': self.issuer_auth.payload_as_cbor
+                'nameSpaces': self.namespaces,
+                'issuerAuth': self.issuer_auth.payload_as_cbor
             }
         )

pymdoccbor/mdoc.py

@@ -15,58 +15,58 @@ class MobileDocument:
         True: "valid",
         False: "failed",
     }
-    
-    def __init__(self, docType :str, issuerSigned : dict, deviceSigned :dict = {}):
-        self.doctype :str = docType # eg: 'org.iso.18013.5.1.mDL'
-        self.issuersigned :List[IssuerSigned] = IssuerSigned(**issuerSigned)
+
+    def __init__(self, docType: str, issuerSigned: dict, deviceSigned: dict = {}):
+        self.doctype: str = docType  # eg: 'org.iso.18013.5.1.mDL'
+        self.issuersigned: List[IssuerSigned] = IssuerSigned(**issuerSigned)
         self.is_valid = False
-        
+
         # TODO
-        self.devicesigned :dict = deviceSigned
-        
-        
+        self.devicesigned: dict = deviceSigned
+
     def dump(self) -> dict:
         return {
             'docType': self.doctype,
             'issuerSigned': self.issuersigned.dump()
         }
-    
+
     def dumps(self) -> dict:
         return cbor2.dumps(
-            cbor2.CBORTag(24, value = {
-                    'docType': self.doctype,
-                    'issuerSigned': self.issuersigned.dumps()
-                }
+            cbor2.CBORTag(24, value={
+                'docType': self.doctype,
+                'issuerSigned': self.issuersigned.dumps()
+            }
             )
         )
-    
+
     def verify(self) -> bool:
         self.is_valid = self.issuersigned.issuer_auth.verify_signature()
         return self.is_valid
-    
+
     def __repr__(self):
         return f"{self.__module__}.{self.__class__.__name__} [{self._states[self.is_valid]}]"
 
+
 class MdocCbor:
-    
-    version :str = '1.0'
-    documents :List[MobileDocument] = [] 
-    status :int = 0
-        
+
+    version: str = '1.0'
+    documents: List[MobileDocument] = []
+    status: int = 0
+
     def __init__(self):
-        self.data_as_bytes :bytes = b""
-        self.data_as_cbor_dict :dict = {}
-        
-        self.documents :List[MobileDocument] = []
-        self.documents_invalid : list = []
+        self.data_as_bytes: bytes = b""
+        self.data_as_cbor_dict: dict = {}
+
+        self.documents: List[MobileDocument] = []
+        self.documents_invalid: list = []
 
-    def loads(self, data :str):
+    def loads(self, data: str):
         """
         data is a AF BINARY 
         """
         if isinstance(data, bytes):
             data = binascii.hexlify(data)
-        
+
         self.data_as_bytes = binascii.unhexlify(data)
         self.data_as_cbor_dict = cbor2.loads(self.data_as_bytes)
 
@@ -84,19 +84,19 @@ def data_as_string(self):
         return self.dumps().decode()
 
     def verify(self):
-        
+
         cdict = self.data_as_cbor_dict
-        
+
         for i in ('version', 'documents'):
             if i not in cdict:
                 raise InvalidMdoc(
                     f"Mdoc is invalid since it doesn't contain the '{i}' element"
                 )
-        
+
         doc_cnt = 1
         for doc in cdict['documents']:
             mso = MobileDocument(**doc)
-            
+
             try:
                 mso.verify()
             except Exception as e:
@@ -107,11 +107,6 @@ def verify(self):
                 self.documents_invalid.append(doc)
                 doc_cnt += 1
                 continue
-                
+
             self.documents.append(mso)
-            doc_cnt +=1
-            
-        
-    
-    
-    
+            doc_cnt += 1

pymdoccbor/mso.py

@@ -1,12 +1,11 @@
-import binascii
 import cbor2
 import cryptography
 import logging
 
 from pycose.keys import CoseKey, EC2Key
 from pycose.messages import Sign1Message
 
-from typing import Optional, Union
+from typing import Optional
 
 from . exceptions import UnsupportedMsoDataFormat
 from . settings import COSEKEY_HAZMAT_CRV_MAP, CRV_LEN_MAP
@@ -24,62 +23,60 @@ class MobileSecurityObject:
         only if the authentication signature or MAC is correct.
     """
 
-    pass
-
 
 class MsoParser(MobileSecurityObject):
     """
     Parameters
         data: CBOR TAG 24
-        
+
     Example:
         MsoParser(mdoc['documents'][0]['issuerSigned']['issuerAuth'])
 
     Note
         The signature is contained in an untagged COSE_Sign1 
         structure as defined in RFC 8152.
     """
-    
+
     def __init__(self, data: cbor2.CBORTag):
         self._data = data
-        
+
         if isinstance(data, bytes):
-            self.object :Sign1Message = bytes2CoseSign1(cbor2.dumps(cbor2.CBORTag(18, value=data)))
+            self.object: Sign1Message = bytes2CoseSign1(
+                cbor2.dumps(cbor2.CBORTag(18, value=data)))
         elif isinstance(data, list):
-            self.object :Sign1Message = cborlist2CoseSign1(self._data)
+            self.object: Sign1Message = cborlist2CoseSign1(self._data)
         else:
             raise UnsupportedMsoDataFormat(
                 f"MsoParser only supports raw bytes and list, a {type(data)} was provided"
             )
-        
-        
-        self.object.key :Optional[CoseKey, None]  = None
-        self.public_key :cryptography.hazmat.backends.openssl.ec._EllipticCurvePublicKey = None
-        self.x509_certificates :list  = []
-        
+
+        self.object.key: Optional[CoseKey, None] = None
+        self.public_key: cryptography.hazmat.backends.openssl.ec._EllipticCurvePublicKey = None
+        self.x509_certificates: list = []
+
     @property
     def payload_as_cbor(self):
         """
         return the decoded payload
         """
         return cbor2.loads(self.object.payload)
-    
+
     @property
     def payload_as_raw(self):
         return self.object.payload
-    
+
     @property
     def payload_as_dict(self):
         return cbor2.loads(
             cbor2.loads(self.object.payload).value
         )
-    
+
     @property
     def raw_public_keys(self) -> bytes:
         return list(self.object.uhdr.values())
-    
+
     def load_public_key(self):
-        
+
         logger.warning(
             "TODO: in next releases. "
             "The certificate is to be considered as untrusted, this release "
@@ -90,11 +87,11 @@ def load_public_key(self):
             self.x509_certificates.append(
                 cryptography.x509.load_der_x509_certificate(i)
             )
-        
+
         self.public_key = self.x509_certificates[0].public_key()
-        
+
         key = EC2Key(
-            crv=COSEKEY_HAZMAT_CRV_MAP[self.public_key.curve.name], 
+            crv=COSEKEY_HAZMAT_CRV_MAP[self.public_key.curve.name],
             x=self.public_key.public_numbers().x.to_bytes(
                 CRV_LEN_MAP[self.public_key.curve.name], 'big'
             )
@@ -105,12 +102,11 @@ def verify_signature(self) -> bool:
 
         if not self.object.key:
             self.load_public_key()
-        
+
         return self.object.verify_signature()
 
 
 class MsoWriter(MobileSecurityObject):
     """
-        
+
     """
-    pass