SDK-340: Update README with anchor info, added origin_server_certs as anchor property

Author: echarrod

README.md

@@ -118,21 +118,40 @@ Here is an example of how this works:
 ```python
 client = Client(YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH)
 activity_details = client.get_activity_details(token)
-user_profile = activity_details.user_profile
-
-user_id = user_profile.get('user_id')
-selfie = user_profile.get('selfie')
-given_names = user_profile.get('given_names')
-family_name = user_profile.get('family_name')
-full_name = user_profile.get('full_name')
-phone_number = user_profile.get('phone_number')
-date_of_birth = user_profile.get('date_of_birth')
-is_age_verified = user_profile.get('is_age_verified')
-postal_address = user_profile.get('postal_address')
-gender = user_profile.get('gender')
-nationality = user_profile.get('nationality')
-
-base64_selfie_uri = activity_details.get('base64_selfie_uri')
+
+profile = activity_details.profile
+		
+selfie = profile.get('selfie').value
+given_names = profile.get('given_names').value
+family_name = profile.get('family_name').value
+full_name = profile.get('full_name').value
+phone_number = profile.get('phone_number').value
+date_of_birth = profile.get('date_of_birth').value
+is_age_verified = profile.get('is_age_verified').value
+postal_address = profile.get('postal_address').value
+gender = profile.get('gender').value
+nationality = profile.get('nationality').value
+
+remember_me_id = activity_details.user_id
+base64_selfie_uri = activity_details.base64_selfie_uri
+```
+
+You can retrieve the anchors, sources and verifiers for each attribute as follows:
+```python
+given_names_attribute = profile.get('given_names')
+
+given_names_anchors = given_names_attribute.anchors
+given_names_sources = given_names_attribute.sources
+given_names_verifiers = given_names_attribute.verifiers
+```
+
+You can also retrieve further properties from these respective anchors in the following way:
+```python
+source_anchor = given_names_sources[0]
+value = source_anchor.value
+sub_type = source_anchor.sub_type
+timestamp = source_anchor.signed_timestamp
+origin_server_certs = source_anchor.origin_server_certs
 ```
 
 ## AML Integration
@@ -252,7 +271,7 @@ For information on testing with multiple Python versions, see [VERSION-SUPPORT.m
 
 * Activity Details
     * [X] User ID `user_id`
-    * [X] Profile `user_profile`
+    * [X] Profile `profile`
         * [X] Photo `selfie`
         * [X] Given Names `given_names`
         * [X] Family Name `family_name`

yoti_python_sdk/activity_details.py

@@ -26,7 +26,7 @@ def __init__(self, receipt, decrypted_profile=None):
                 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':
+                if field.name == config.ATTRIBUTE_SELFIE:
                     self.try_parse_selfie_field(field)
 
                 if field.name.startswith(config.ATTRIBUTE_AGE_OVER) or field.name.startswith(
@@ -54,12 +54,12 @@ def try_parse_age_verified_field(self, field, anchors):
                 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)
+                self.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = True
+                self.profile[config.ATTRIBUTE_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)
+                self.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = False
+                self.profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = attribute.attribute(is_age_verified, False, anchors)
                 return
 
         raise TypeError("age_verified_field unable to be parsed")

yoti_python_sdk/anchor.py

@@ -13,11 +13,12 @@
 
 
 class Anchor:
-    def __init__(self, anchor_type="Unknown", sub_type="", value="", signed_timestamp=None):
+    def __init__(self, anchor_type="Unknown", sub_type="", value="", signed_timestamp=None, origin_server_certs=None):
         self.__anchor_type = anchor_type
         self.__sub_type = sub_type
         self.__value = value
         self.__signed_timestamp = signed_timestamp
+        self.__origin_server_certs = origin_server_certs
 
     def __iter__(self):
         return self
@@ -40,10 +41,11 @@ def parse_anchors(anchors):
                 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()
+                crypto_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]
+                for i in range(len(crypto_cert.extensions)):
+                    extensions = crypto_cert.extensions[i]
                     if hasattr(extensions, 'oid'):
                         oid = extensions.oid
                         if hasattr(oid, 'dotted_string'):
@@ -61,7 +63,8 @@ def parse_anchors(anchors):
                                         anchor_type,
                                         anc.sub_type,
                                         Anchor.decode_asn1_value(extension_value.value),
-                                        anc.signed_time_stamp))
+                                        anc.signed_time_stamp,
+                                        crypto_cert))
 
         return parsed_anchors
 
@@ -107,3 +110,7 @@ def signed_timestamp(self):
             return ""
 
         return signed_timestamp_parsed
+
+    @property
+    def origin_server_certs(self):
+        return self.__origin_server_certs

yoti_python_sdk/config.py

@@ -3,7 +3,9 @@
 ATTRIBUTE_AGE_OVER = "age_over:"
 ATTRIBUTE_AGE_UNDER = "age_under:"
 ATTRIBUTE_POSTAL_ADDRESS = "postal_address"
+ATTRIBUTE_SELFIE = "selfie"
 ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS = "structured_postal_address"
+ATTRIBUTE_IS_AGE_VERIFIED = "is_age_verified"
 ANCHOR_SOURCE = "SOURCE"
 ANCHOR_VERIFIER = "VERIFIER"
 KEY_FORMATTED_ADDRESS = "formatted_address"

yoti_python_sdk/tests/anchor_parser.py

@@ -1,6 +1,5 @@
 import binascii
 import io
-
 from os.path import abspath, dirname, join
 
 from yoti_python_sdk import anchor

yoti_python_sdk/tests/test_activity_details.py

@@ -68,7 +68,7 @@
 
 def create_selfie_field(activity_details):
     activity_details.field = lambda: None
-    activity_details.field.name = "selfie"
+    activity_details.field.name = config.ATTRIBUTE_SELFIE
     activity_details.field.value = "base64(ง •̀_•́)ง"
     activity_details.field.content_type = Protobuf.CT_STRING
 
@@ -108,17 +108,17 @@ def test_try_parse_age_verified_field_age_over():
     create_age_verified_field(activity_details, True, "true".encode(), 18)
 
     ActivityDetails.try_parse_age_verified_field(activity_details, activity_details.field, None)
-    assert activity_details.user_profile['is_age_verified'] is True
-    assert activity_details.profile['is_age_verified'].value is True
+    assert activity_details.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] is True
+    assert activity_details.profile[config.ATTRIBUTE_IS_AGE_VERIFIED].value is True
 
 
 def test_try_parse_age_verified_field_age_under():
     activity_details = ActivityDetails(successful_receipt())
     create_age_verified_field(activity_details, False, "false".encode(), 55)
 
     ActivityDetails.try_parse_age_verified_field(activity_details, activity_details.field, None)
-    assert activity_details.user_profile['is_age_verified'] is False
-    assert activity_details.profile['is_age_verified'].value is False
+    assert activity_details.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] is False
+    assert activity_details.profile[config.ATTRIBUTE_IS_AGE_VERIFIED].value is False
 
 
 def test_try_parse_age_verified_field_non_bool_value_throws_error():

yoti_python_sdk/tests/test_anchor.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 import datetime
-import yoti_python_sdk
 
+import yoti_python_sdk
 from yoti_python_sdk import config
 from yoti_python_sdk.tests import anchor_parser
 
@@ -13,6 +13,7 @@ def test_parse_anchors_driving_license():
     assert parsed_anchor.signed_timestamp == datetime.datetime(2018, 4, 11, 13, 13, 3, 923537)
     assert parsed_anchor.sub_type == ""
     assert parsed_anchor.value == "DRIVING_LICENCE"
+    assert parsed_anchor.origin_server_certs.serial == int("46131813624213904216516051554755262812")
 
 
 def test_parse_anchors_passport():
@@ -22,6 +23,7 @@ def test_parse_anchors_passport():
     assert parsed_anchor.signed_timestamp == datetime.datetime(2018, 4, 12, 14, 14, 32, 835537)
     assert parsed_anchor.sub_type == "OCR"
     assert parsed_anchor.value == "PASSPORT"
+    assert parsed_anchor.origin_server_certs.serial == int("277870515583559162487099305254898397834")
 
 
 def test_parse_yoti_admin():
@@ -31,6 +33,7 @@ def test_parse_yoti_admin():
     assert parsed_anchor.signed_timestamp == datetime.datetime(2018, 4, 11, 13, 13, 4, 95238)
     assert parsed_anchor.sub_type == ""
     assert parsed_anchor.value == "YOTI_ADMIN"
+    assert parsed_anchor.origin_server_certs.serial == int("256616937783084706710155170893983549581")
 
 
 def test_anchor_returns_correct_default_values():
@@ -40,3 +43,4 @@ def test_anchor_returns_correct_default_values():
     assert anchor.signed_timestamp is None
     assert anchor.sub_type == ""
     assert anchor.value == ""
+    assert anchor.origin_server_certs is None

yoti_python_sdk/tests/test_client.py

@@ -8,6 +8,8 @@
 from cryptography.fernet import base64
 from past.builtins import basestring
 
+from yoti_python_sdk import config
+
 try:
     from unittest import mock
 except ImportError:
@@ -141,10 +143,10 @@ def test_requesting_activity_details_with_correct_data(
     mock_get.assert_called_once_with(url=expected_activity_details_url, headers=expected_get_headers)
     assert isinstance(activity_details, ActivityDetails)
     assert activity_details.user_id == "ijH4kkqMKTG0FSNUgQIvd2Z3Nx1j8f5RjVQMyoKOvO/hkv43Ik+t6d6mGfP2tdrN"
-    selfie_user_profile = activity_details.user_profile.get('selfie')
+    selfie_user_profile = activity_details.user_profile.get(config.ATTRIBUTE_SELFIE)
     assert isinstance(selfie_user_profile, basestring)
 
-    selfie_profile = activity_details.profile.get('selfie').value
+    selfie_profile = activity_details.profile.get(config.ATTRIBUTE_SELFIE).value
     assert isinstance(selfie_profile, basestring)
 
     base64_selfie_uri = getattr(activity_details, 'base64_selfie_uri')