SDK-442: Add anchors to new profile class

Author: echarrod

README.md

@@ -81,7 +81,7 @@ pip install yoti
 You can reference the project URL by adding the following import:
 
 ```python
-import "yoti_python_sdk"
+import yoti_python_sdk
 ```
 
 ## Configuration

requirements.in

@@ -1,5 +1,6 @@
+asn1==2.2.0
 click==6.6
-cryptography>=1.5.2
+cryptography>=2.2.1
 Django==1.11
 flask==0.11.1
 itsdangerous==0.24
@@ -8,8 +9,9 @@ MarkupSafe==0.23
 mock==2.0.0
 pbr==1.10.0
 protobuf==3.1.0.post1
+pyopenssl==18.0.0
 pytest==3.3.2
-requests==2.11.1
+requests>=2.11.1
 six==1.10.0
 tox>=1.7.2
 virtualenv==13.1.2

requirements.txt

@@ -1,33 +1,35 @@
-#
-# This file is autogenerated by pip-compile
-# To update, run:
-#
-#    pip-compile --output-file requirements.txt requirements.in
-#
-attrs==18.1.0             # via pytest
-cffi==1.11.5              # via cryptography
-click==6.6
-colorama==0.3.9           # via pytest
-cryptography==1.5.2
-django==1.11
-flask==0.11.1
-future==0.15.2
-idna==2.7                 # via cryptography
-itsdangerous==0.24
-jinja2==2.8
-markupsafe==0.23
-mock==2.0.0
-pbr==1.10.0
-pluggy==0.6.0             # via pytest, tox
-protobuf==3.1.0.post1
-py==1.5.3                 # via pytest, tox
-pyasn1==0.4.3             # via cryptography
-pycparser==2.18           # via cffi
-pytest==3.3.2
-pytz==2018.4              # via django
-requests==2.11.1
-six==1.10.0
-tox==3.0.0
-virtualenv==13.1.2
-werkzeug==0.11.15
-wheel==0.24.0
+#
+# This file is autogenerated by pip-compile
+# To update, run:
+#
+#    pip-compile --output-file requirements.txt requirements.in
+#
+asn1==2.2.0
+asn1crypto==0.24.0        # via cryptography
+attrs==18.1.0             # via pytest
+cffi==1.11.5              # via cryptography
+click==6.6
+colorama==0.3.9           # via pytest
+cryptography==2.2.2
+django==1.11
+flask==0.11.1
+future==0.15.2
+idna==2.7                 # via cryptography
+itsdangerous==0.24
+jinja2==2.8
+markupsafe==0.23
+mock==2.0.0
+pbr==1.10.0
+pluggy==0.6.0             # via pytest, tox
+protobuf==3.1.0.post1
+py==1.5.3                 # via pytest, tox
+pycparser==2.18           # via cffi
+pyopenssl==18.0.0
+pytest==3.3.2
+pytz==2018.4              # via django
+requests==2.11.1
+six==1.10.0
+tox==3.0.0
+virtualenv==13.1.2
+werkzeug==0.11.15
+wheel==0.24.0

setup.py

@@ -17,11 +17,10 @@
     url='https://github.com/getyoti/yoti-python-sdk',
     author='Yoti',
     author_email='[email protected]',
-    install_requires=['cryptography>=1.4', 'protobuf>=3.0.0',
-                      'requests>=2.0.0', 'future>=0.11.0'],
+    install_requires=['cryptography>=2.2.1', 'protobuf>=3.1.0',
+                      'requests>=2.11.1', 'future>=0.11.0', 'asn1==2.2.0', 'pyopenssl>=18.0.0'],
     extras_require={
-        'examples': ['Django>=1.8', 'Flask>=0.10', 'python-dotenv>=0.7.1', 'django-sslserver>=0.2',
-                     'pyopenssl>=18.0.0'],
+        'examples': ['Django>=1.8', 'Flask>=0.10', 'python-dotenv>=0.7.1', 'django-sslserver>=0.2', 'Werkzeug==0.11.15'],
     },
     classifiers=[
         'Development Status :: 5 - Production/Stable',

yoti_python_sdk/activity_details.py

@@ -1,16 +1,17 @@
 # -*- coding: utf-8 -*-
-import json
-
 import collections
+import json
 
-from yoti_python_sdk import config
+from yoti_python_sdk.anchor import Anchor
+from yoti_python_sdk import config, attribute
 from yoti_python_sdk.protobuf.v1.protobuf import Protobuf
 
 
 class ActivityDetails:
     def __init__(self, receipt, decrypted_profile=None):
         self.decrypted_profile = decrypted_profile
-        self.user_profile = {}
+        self.user_profile = {}  # will be deprecated in v3.0.0
+        self.profile = {}
         self.base64_selfie_uri = None
 
         if decrypted_profile and hasattr(decrypted_profile, 'attributes'):
@@ -19,17 +20,21 @@ def __init__(self, receipt, decrypted_profile=None):
                     field.value,
                     field.content_type
                 )
-                self.user_profile[field.name] = value
+
+                anchors = Anchor().parse_anchors(field.anchors)
+
+                self.profile[field.name] = attribute.attribute(field.name, value, anchors)
+                self.user_profile[field.name] = value  # will be deprecated in v3.0.0
 
                 if field.name == 'selfie':
                     self.try_parse_selfie_field(field)
 
                 if field.name.startswith(config.ATTRIBUTE_AGE_OVER) or field.name.startswith(
                         config.ATTRIBUTE_AGE_UNDER):
-                    self.try_parse_age_verified_field(field)
+                    self.try_parse_age_verified_field(field, anchors)
 
                 if field.name == config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS:
-                    self.try_convert_structured_postal_address_to_dict(field)
+                    self.try_convert_structured_postal_address_to_dict(field, anchors)
 
             self.set_address_to_be_formatted_address_if_null()
 
@@ -42,33 +47,45 @@ def try_parse_selfie_field(self, field):
             field.content_type
         )
 
-    def try_parse_age_verified_field(self, field):
+    def try_parse_age_verified_field(self, field, anchors):
         if field is not None:
             is_age_verified = Protobuf().value_based_on_content_type(
                 field.value,
                 field.content_type
             )
             if is_age_verified == 'true':
                 self.user_profile['is_age_verified'] = True
+                self.profile['is_age_verified'] = attribute.attribute(is_age_verified, True, anchors)
                 return
             if is_age_verified == 'false':
                 self.user_profile['is_age_verified'] = False
+                self.profile['is_age_verified'] = attribute.attribute(is_age_verified, False, anchors)
                 return
 
         raise TypeError("age_verified_field unable to be parsed")
 
-    def try_convert_structured_postal_address_to_dict(self, field):
+    def try_convert_structured_postal_address_to_dict(self, field, anchors):
         decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict)
         self.user_profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS] = decoder.decode(field.value)
+        self.profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS] = attribute.attribute(
+            "structured_postal_address",
+            decoder.decode(field.value),
+            anchors)
 
     def set_address_to_be_formatted_address_if_null(self):
         if 'postal_address' not in self.user_profile and 'structured_postal_address' in self.user_profile:
             if 'formatted_address' in self.user_profile['structured_postal_address']:
                 self.user_profile['postal_address'] = self.user_profile['structured_postal_address'][
                     'formatted_address']
 
+        if 'postal_address' not in self.profile and 'structured_postal_address' in self.profile:
+            if 'formatted_address' in self.profile['structured_postal_address'].get_value():
+                self.profile['postal_address'] = self.profile['structured_postal_address'].get_value()[
+                    'formatted_address']
+
     def __iter__(self):
         yield 'user_id', self.user_id
         yield 'outcome', self.outcome
         yield 'user_profile', self.user_profile
+        yield 'profile', self.profile
         yield 'base64_selfie_uri', self.base64_selfie_uri

yoti_python_sdk/anchor.py

@@ -0,0 +1,108 @@
+import asn1
+import datetime
+import OpenSSL
+import yoti_python_sdk.protobuf.v1.common_public_api.signed_timestamp_pb2 as compubapi
+
+from OpenSSL import crypto
+from yoti_python_sdk import config
+
+UNKNOWN_EXTENSION = ""
+SOURCE_EXTENSION = "1.3.6.1.4.1.47127.1.1.1"
+VERIFIER_EXTENSION = "1.3.6.1.4.1.47127.1.1.2"
+
+
+class Anchor:
+    anchor_type = "Unknown"
+    sub_type = ""
+    value = ""
+    signed_timestamp = compubapi.SignedTimestamp()
+
+    def __init__(self, anchor_type=None, sub_type=None, value=None, signed_timestamp=None):
+        self.anchor_type = anchor_type
+        self.sub_type = sub_type
+        self.value = value
+        self.signed_timestamp = signed_timestamp
+
+    def __iter__(self):
+        return self
+
+    def __next__(self):
+        self.idx += 1
+        try:
+            return self.data[self.idx - 1]
+        except IndexError:
+            self.idx = 0
+            raise StopIteration
+
+    next = __next__  # python2.x compatibility.
+
+    @staticmethod
+    def parse_anchors(anchors):
+        for anc in anchors:
+            parsed_anchors = []
+
+            if hasattr(anc, 'origin_server_certs'):
+                origin_server_certs_list = list(anc.origin_server_certs)
+                origin_server_certs_item = origin_server_certs_list[0]
+
+                cert = crypto.load_certificate(OpenSSL.crypto.FILETYPE_ASN1, origin_server_certs_item).to_cryptography()
+
+                for i in range(len(cert.extensions)):
+                    extensions = cert.extensions[i]
+                    if hasattr(extensions, 'oid'):
+                        oid = extensions.oid
+                        if hasattr(oid, 'dotted_string'):
+                            if oid.dotted_string == SOURCE_EXTENSION:
+                                anchor_type = config.ANCHOR_SOURCE
+                            elif oid.dotted_string == VERIFIER_EXTENSION:
+                                anchor_type = config.ANCHOR_VERIFIER
+                            else:
+                                continue
+
+                            if hasattr(extensions, 'value'):
+                                extension_value = extensions.value
+                                if hasattr(extension_value, 'value'):
+                                    parsed_anchors.append(Anchor(
+                                        anchor_type,
+                                        Anchor.get_sub_type(anc),
+                                        Anchor.decode_asn1_value(extension_value.value),
+                                        Anchor.get_signed_timestamp(anc)))
+
+        return parsed_anchors
+
+    @staticmethod
+    def decode_asn1_value(value_to_decode):
+        extension_value_asn1 = value_to_decode
+        decoder = asn1.Decoder()
+
+        decoder.start(extension_value_asn1)
+        tag, once_decoded_value = decoder.read()
+
+        decoder.start(once_decoded_value)
+        tag, twice_decoded_value = decoder.read()
+        
+        utf8_value = twice_decoded_value.decode('utf-8')
+        return utf8_value
+
+    @staticmethod
+    def get_sub_type(anchor):
+        if hasattr(anchor, 'sub_type'):
+            return anchor.sub_type
+        else:
+            return ""
+
+    @staticmethod
+    def get_signed_timestamp(anchor):
+        if hasattr(anchor, 'signed_time_stamp'):
+            signed_timestamp_object = compubapi.SignedTimestamp()
+            signed_timestamp_object.MergeFromString(anchor.signed_time_stamp)
+
+            try:
+                signed_timestamp_parsed = datetime.datetime.fromtimestamp(signed_timestamp_object.timestamp / float(1000000))
+            except OSError:
+                print("Unable to parse timestamp from integer: '{0}'".format(signed_timestamp_object.timestamp))
+                return ""
+
+            return signed_timestamp_parsed
+        else:
+            return ""

yoti_python_sdk/attribute.py

@@ -0,0 +1,18 @@
+class attribute:
+    name = ""
+    value = ""
+    anchors = {}
+
+    def __init__(self, name, value, anchors):
+        self.name = name
+        self.value = value
+        self.anchors = anchors
+
+    def get_name(self):
+        return self.name
+
+    def get_value(self):
+        return self.value
+
+    def get_anchors(self):
+        return self.anchors

yoti_python_sdk/config.py

@@ -1,5 +1,7 @@
-# -*- coding: utf-8 -*-
-SDK_IDENTIFIER = "Python"
-ATTRIBUTE_AGE_OVER = "age_over:"
-ATTRIBUTE_AGE_UNDER = "age_under:"
-ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS = "structured_postal_address"
+# -*- coding: utf-8 -*-
+SDK_IDENTIFIER = "Python"
+ATTRIBUTE_AGE_OVER = "age_over:"
+ATTRIBUTE_AGE_UNDER = "age_under:"
+ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS = "structured_postal_address"
+ANCHOR_SOURCE = "SOURCE"
+ANCHOR_VERIFIER = "VERIFIER"