[SDK-443] Add Sources & Verifiers

CONTRIBUTING.md

@@ -35,7 +35,7 @@ For developing in VS Code, use the following `launch.json` file (placed inside a
         "host": "127.0.0.1",
         "program": "${workspaceFolder}/examples/profile/main.go",
         "env": {},
-        "args": [],
+        "args": ["certificatehelper.go"],
         "showLog": true
     }
     ]

README.md

@@ -135,6 +135,24 @@ userProfile.GetAttribute("age_over:18").Value.(string)
 
 GetAttribute returns an interface, the value can be acquired through a type assertion.
 
+
+You can retrieve the anchors, sources and verifiers for each attribute as follows:
+```Go
+givenNamesAnchors := userProfile.GivenNames().Anchors
+givenNamesSources := userProfile.GivenNames().Sources
+givenNamesVerifiers := userProfile.GivenNames().Verifiers
+```
+You can also retrieve further properties from these respective anchors in the following way:
+```Go
+givenNamesFirstAnchor := userProfile.GivenNames().Anchors[0]
+
+anchorType := givenNamesFirstAnchor.Type
+originServerCerts := givenNamesFirstAnchor.OriginServerCerts()
+signedTimestamp := givenNamesFirstAnchor.SignedTimestamp().Timestamp
+subType := givenNamesFirstAnchor.SubType()
+value := givenNamesFirstAnchor.Value()
+```
+
 ## Handling Users
 
 When you retrieve the user profile, you receive a user ID generated by Yoti exclusively for your application.
@@ -200,7 +218,7 @@ Performing an AML check on a person *requires* their consent.
 
 Given a YotiClient initialised with your SDK ID and KeyPair (see [Client Initialisation](#client-initialisation)) performing an AML check is a straightforward case of providing basic profile data.
 
-```go
+```Go
 givenNames := "Edward Richard George"
 familyName := "Heath"
 

anchor/anchors.go

@@ -57,8 +57,8 @@ func (a Anchor) OriginServerCerts() []*x509.Certificate {
 // message associated with the timestamp is the marshaled form of
 // AttributeSigning (i.e. the same message that is signed in the
 // Signature field). This method returns the SignedTimestamp
-// object, the actual timestamp as a DateTime can be called with
-// .Timestamp() on this object
+// object, the actual timestamp as a *time.Time can be called with
+// .Timestamp on the result of this function
 func (a Anchor) SignedTimestamp() SignedTimestamp {
 	return a.signedTimestamp
 }
@@ -76,3 +76,22 @@ func (a Anchor) SubType() string {
 func (a Anchor) Value() []string {
 	return a.value
 }
+
+// GetSources returns the anchors which identify how and when an attribute value was acquired.
+func GetSources(anchors []*Anchor) (sources []*Anchor) {
+	return filterAnchors(anchors, AnchorTypeSource)
+}
+
+// GetVerifiers returns the anchors which identify how and when an attribute value was verified by another provider.
+func GetVerifiers(anchors []*Anchor) (sources []*Anchor) {
+	return filterAnchors(anchors, AnchorTypeVerifier)
+}
+
+func filterAnchors(anchors []*Anchor, anchorType Type) (result []*Anchor) {
+	for _, v := range anchors {
+		if v.Type == anchorType {
+			result = append(result, v)
+		}
+	}
+	return result
+}

attribute/genericattribute.go

@@ -11,8 +11,10 @@ import (
 //GenericAttribute is a Yoti attribute which returns a generic value
 type GenericAttribute struct {
 	*yotiprotoattr_v3.Attribute
-	Value   interface{}
-	Anchors []*anchor.Anchor
+	Value     interface{}
+	Anchors   []*anchor.Anchor
+	Sources   []*anchor.Anchor
+	Verifiers []*anchor.Anchor
 }
 
 //NewGeneric creates a new generic attribute
@@ -49,12 +51,16 @@ func NewGeneric(a *yotiprotoattr_v3.Attribute) *GenericAttribute {
 		value = a.Value
 	}
 
+	parsedAnchors := anchor.ParseAnchors(a.Anchors)
+
 	return &GenericAttribute{
 		Attribute: &yotiprotoattr_v3.Attribute{
 			Name:        a.Name,
 			ContentType: a.ContentType,
 		},
-		Value:   value,
-		Anchors: anchor.ParseAnchors(a.Anchors),
+		Value:     value,
+		Anchors:   parsedAnchors,
+		Sources:   anchor.GetSources(parsedAnchors),
+		Verifiers: anchor.GetVerifiers(parsedAnchors),
 	}
 }

attribute/image.go

@@ -2,7 +2,7 @@ package attribute
 
 import (
 	"encoding/base64"
-	"log"
+	"fmt"
 )
 
 //ImageType Image format
@@ -30,19 +30,22 @@ var mimeTypeMap = map[ImageType]string{
 
 // GetMIMEType returns the MIME type of this piece of Yoti user information. For more information see:
 // https://en.wikipedia.org/wiki/Media_type
-func GetMIMEType(imageType ImageType) (result string) {
+func GetMIMEType(imageType ImageType) (string, error) {
 	if val, ok := mimeTypeMap[imageType]; ok {
-		return val
+		return val, nil
 	}
 
-	log.Printf("Unable to find a matching MIME type for value type %q", imageType)
-	return
+	return "", fmt.Errorf("Unable to find a matching MIME type for value type %q", imageType)
 }
 
 // Base64URL is the Image encoded as a base64 URL
 func (image *Image) Base64URL() (string, error) {
 	base64EncodedImage := base64.StdEncoding.EncodeToString(image.Data)
-	contentType := GetMIMEType(image.Type)
+	contentType, err := GetMIMEType(image.Type)
+
+	if err != nil {
+		return "", err
+	}
 
 	return "data:" + contentType + ";base64;," + base64EncodedImage, nil
 }

attribute/imageattribute.go

@@ -8,8 +8,10 @@ import (
 //ImageAttribute is a Yoti attribute which returns an image as its value
 type ImageAttribute struct {
 	*yotiprotoattr_v3.Attribute
-	Value   *Image
-	Anchors []*anchor.Anchor
+	Value     *Image
+	Anchors   []*anchor.Anchor
+	Sources   []*anchor.Anchor
+	Verifiers []*anchor.Anchor
 }
 
 //NewImage creates a new Image attribute
@@ -27,6 +29,8 @@ func NewImage(a *yotiprotoattr_v3.Attribute) *ImageAttribute {
 		imageType = ImageTypeOther
 	}
 
+	parsedAnchors := anchor.ParseAnchors(a.Anchors)
+
 	return &ImageAttribute{
 		Attribute: &yotiprotoattr_v3.Attribute{
 			Name:        a.Name,
@@ -36,6 +40,8 @@ func NewImage(a *yotiprotoattr_v3.Attribute) *ImageAttribute {
 			Data: a.Value,
 			Type: imageType,
 		},
-		Anchors: anchor.ParseAnchors(a.Anchors),
+		Anchors:   parsedAnchors,
+		Sources:   anchor.GetSources(parsedAnchors),
+		Verifiers: anchor.GetVerifiers(parsedAnchors),
 	}
 }

attribute/jsonattribute.go

@@ -13,6 +13,8 @@ type JSONAttribute struct {
 	*yotiprotoattr_v3.Attribute // Value returns the value of a JSON attribute in the form of an interface
 	Value                       interface{}
 	Anchors                     []*anchor.Anchor
+	Sources                     []*anchor.Anchor
+	Verifiers                   []*anchor.Anchor
 }
 
 //NewJSON creates a new JSON attribute
@@ -23,13 +25,17 @@ func NewJSON(a *yotiprotoattr_v3.Attribute) (*JSONAttribute, error) {
 		return nil, err
 	}
 
+	parsedAnchors := anchor.ParseAnchors(a.Anchors)
+
 	return &JSONAttribute{
 		Attribute: &yotiprotoattr_v3.Attribute{
 			Name:        a.Name,
 			ContentType: a.ContentType,
 		},
-		Value:   interfaceValue,
-		Anchors: anchor.ParseAnchors(a.Anchors),
+		Value:     interfaceValue,
+		Anchors:   parsedAnchors,
+		Sources:   anchor.GetSources(parsedAnchors),
+		Verifiers: anchor.GetVerifiers(parsedAnchors),
 	}, nil
 }
 

attribute/stringattribute.go

@@ -8,18 +8,24 @@ import (
 //StringAttribute is a Yoti attribute which returns a string as its value
 type StringAttribute struct {
 	*yotiprotoattr_v3.Attribute
-	Value   string
-	Anchors []*anchor.Anchor
+	Value     string
+	Anchors   []*anchor.Anchor
+	Sources   []*anchor.Anchor
+	Verifiers []*anchor.Anchor
 }
 
 //NewString creates a new String attribute
 func NewString(a *yotiprotoattr_v3.Attribute) *StringAttribute {
+	parsedAnchors := anchor.ParseAnchors(a.Anchors)
+
 	return &StringAttribute{
 		Attribute: &yotiprotoattr_v3.Attribute{
 			Name:        a.Name,
 			ContentType: a.ContentType,
 		},
-		Value:   string(a.Value),
-		Anchors: anchor.ParseAnchors(a.Anchors),
+		Value:     string(a.Value),
+		Anchors:   parsedAnchors,
+		Sources:   anchor.GetSources(parsedAnchors),
+		Verifiers: anchor.GetVerifiers(parsedAnchors),
 	}
 }

attribute/timeattribute.go

@@ -11,8 +11,10 @@ import (
 //TimeAttribute is a Yoti attribute which returns a time as its value
 type TimeAttribute struct {
 	*yotiprotoattr_v3.Attribute
-	Value   *time.Time
-	Anchors []*anchor.Anchor
+	Value     *time.Time
+	Anchors   []*anchor.Anchor
+	Sources   []*anchor.Anchor
+	Verifiers []*anchor.Anchor
 }
 
 //NewTime creates a new Time attribute
@@ -24,12 +26,16 @@ func NewTime(a *yotiprotoattr_v3.Attribute) (*TimeAttribute, error) {
 		return nil, err
 	}
 
+	parsedAnchors := anchor.ParseAnchors(a.Anchors)
+
 	return &TimeAttribute{
 		Attribute: &yotiprotoattr_v3.Attribute{
 			Name:        a.Name,
 			ContentType: a.ContentType,
 		},
-		Value:   &parsedTime,
-		Anchors: anchor.ParseAnchors(a.Anchors),
+		Value:     &parsedTime,
+		Anchors:   parsedAnchors,
+		Sources:   anchor.GetSources(parsedAnchors),
+		Verifiers: anchor.GetVerifiers(parsedAnchors),
 	}, nil
 }

examples/aml/main.go

@@ -18,15 +18,16 @@ var (
 )
 
 func main() {
-	var sdkID = os.Getenv("YOTI_CLIENT_SDK_ID")
-	var key, err = ioutil.ReadFile(os.Getenv("YOTI_KEY_FILE_PATH"))
+	var err error
+	key, err = ioutil.ReadFile(os.Getenv("YOTI_KEY_FILE_PATH"))
+	sdkID = os.Getenv("YOTI_CLIENT_SDK_ID")
 
 	if err != nil {
 		log.Printf("Unable to retrieve `YOTI_KEY_FILE_PATH`. Error: `%s`", err)
 		return
 	}
 
-	var client = yoti.Client{
+	client = &yoti.Client{
 		SdkID: sdkID,
 		Key:   key}
 

examples/profile/login.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8">
     <title>Yoti Example Project</title>
-    <script src="https://sdk.yoti.com/clients/browser.2.1.0.js"></script>
+    <script src="https://sdk.yoti.com/clients/browser.2.2.0.js"></script>
   </head>
 <body style="text-align: center; margin: 200px 0">
     <a class="btn button yoti-connect learn-more btn-primary" data-target='embed' data-yoti-application-id='{{.yotiApplicationID}}'>Use Yoti</a>

examples/profile/main.go

@@ -6,6 +6,7 @@ import (
 	"html/template"
 	"image"
 	"image/jpeg"
+	"io"
 	"io/ioutil"
 	"log"
 	"net/http"
@@ -36,40 +37,58 @@ func home(w http.ResponseWriter, req *http.Request) {
 }
 
 func profile(w http.ResponseWriter, r *http.Request) {
-	var sdkID = os.Getenv("YOTI_CLIENT_SDK_ID")
-	var key, err = ioutil.ReadFile(os.Getenv("YOTI_KEY_FILE_PATH"))
+	var err error
+	key, err = ioutil.ReadFile(os.Getenv("YOTI_KEY_FILE_PATH"))
+	sdkID = os.Getenv("YOTI_CLIENT_SDK_ID")
 
 	if err != nil {
-		log.Printf("Unable to retrieve `YOTI_KEY_FILE_PATH`. Error: `%s`", err)
-		return
+		log.Fatalf("Unable to retrieve `YOTI_KEY_FILE_PATH`. Error: `%s`", err)
 	}
 
-	var client = yoti.Client{
+	client = &yoti.Client{
 		SdkID: sdkID,
 		Key:   key}
 
 	yotiOneTimeUseToken := r.URL.Query().Get("token")
-	profile, err := client.GetUserProfile(yotiOneTimeUseToken)
 
-	if err == nil {
-		templateVars := map[string]interface{}{
-			"profile":         profile,
-			"selfieBase64URL": template.URL(profile.Selfie.URL())}
+	activityDetails, errStrings := client.GetActivityDetails(yotiOneTimeUseToken)
+	if len(errStrings) != 0 {
+		log.Fatalf("Errors: %v", errStrings)
+	}
 
-		decodedImage := decodeImage(profile.Selfie.Data)
-		file := createImage()
-		saveImage(decodedImage, file)
+	userProfile := activityDetails.UserProfile
 
-		t, err := template.ParseFiles("profile.html")
-		if err != nil {
-			fmt.Println(err)
-			return
-		}
+	var base64URL string
+	base64URL, err = userProfile.Selfie().Value.Base64URL()
+
+	if err != nil {
+		log.Fatalf("Unable to retrieve `YOTI_KEY_FILE_PATH`. Error: %q", err)
+	}
+
+	dob, err := userProfile.DateOfBirth()
+	if err != nil {
+		log.Fatalf("Error parsing Date of Birth attribute. Error %q", err)
+	}
+
+	templateVars := map[string]interface{}{
+		"profile":         userProfile,
+		"selfieBase64URL": template.URL(base64URL),
+		"rememberMeID":    activityDetails.RememberMeID,
+		"dateOfBirth":     dob,
+	}
+
+	decodedImage := decodeImage(userProfile.Selfie().Value.Data)
+	file := createImage()
+	saveImage(decodedImage, file)
 
-		t.Execute(w, templateVars)
-	} else {
+	var t *template.Template
+	t, err = template.ParseFiles("profile.html")
+	if err != nil {
 		fmt.Println(err)
+		return
 	}
+
+	t.Execute(w, templateVars)
 }
 
 func main() {
@@ -131,7 +150,7 @@ func createImage() (file *os.File) {
 	return
 }
 
-func saveImage(img image.Image, file *os.File) {
+func saveImage(img image.Image, file io.Writer) {
 	var opt jpeg.Options
 	opt.Quality = 100