Consent Receipt Construction

From MgmtWiki
Revision as of 10:48, 29 July 2018 by Tom (talk | contribs) (Context)

Jump to: navigation, search

Full Title or Meme

Consent Receipt generated by an IDESG Best Practice and Example Identifier Provider.


The current design of a Consent receipt is based on the theory of a transaction between a PII Data Controller and a User (aka a PII data principle).

A Consent Receipt is defined as a "record of a consent interaction (or consent record summary linked to the record of consent)" ... "in accordance with an agreed set of terms."

A Privacy Policy is a "statement/policy and applicable terms of use in effect when the consent was obtained, and the receipt was issued".

In the context of an Best Practice and Example Identifier Provider it was based on a state at the IdP of a user immediately after a user initiated profile update. Note that user here means whatever sort of entity has the identifier shown as "user name". It cannot be inferred that the identified user has any rights, or indeed any legal standing, under any regulation, as that would be an unwarranted privacy exposure of its own.

Current draft of the Spec

Draft on which this implementation was based is listed below. In theory, practice is the same as theory, in practice it is not.

Current draft of Kantara Initiative Technical Specification Recommendation, Consent Receipt Specification Version:1.1.0 DRAFT 8 Date:2018-02-20

Warning: this document is based the 1980 OECD Guidelines on the Protection of Privacy and Transborder Flows of Personal Data [OECD] focusing on consent using the ISO 29100 [ISO 29100:2011] lexicon, which means that the terms are stilted and do not reflect current usages. That is also the reason for some of the odd tags in the JSON object.

The Consent Receipt uses obsolete technical terms like "Personally Identifiable Information (PII)" rather than the more generic term from the GDPR of Personal Information or the more descriptive of what we should control Private Personal Information, although with the Right to be Forgotten there may no distinction between those two terms in the EU.

Problems (both solved and remaining)

  • The GDPR has the follows requirements which are addressed herewith:
    • TK
  • It might be useful for the consent receipt to carry an indication of the context (aka receipt type) at its generation.
  • One thing that becomes a little weird in the near future of this site is that the user will have the option of adding more information in the future in support of authentication at other sites. It seems that neither the GDPR nor the Consent Receipt considers that fact that users can enter data of their own free will for reasons that are not known to the IdP but will be used later at a relying party. In this case the IdP is just a trusted third party, a problem which will recur frequently in the health industry.
  • It is not clear from the spec how to code the jurisdiction for US states. Maybe that is covered elsewhere?

Implementation on Microsoft ASP.NET Core 2 Web Site

Links to the Solution

  • this site shows the rendered consent receipt
  • this is the stylesheet that did the rending
  • The source code is available here.
  • Consent receipts were added to the IDESG best practice web site which is accessible at this site.
    • You will first need to register. Google federated signin works quickest.
    • You will need to manage your profile - click on you name in the upper right of the headers (or the drop down if using a cell phone).
    • Select the check box "Get Receipt and click "Save". You will see the Consent Receipt and be able to print it or save it a stringified JSON.

The user is giving reasons why the data is required and what will be done with before the data is even entered.


This site described is an IdP. Several points were noted for discussion:

  1. The Consent Receipt spec is not specific to IdPs. Some assumptions were necessary about how it might work for an IdP that were not necessarily optimal.
  2. One interesting example is the "third party" as that is not known for a federated identifier at the time the the consent receipt is issued. One use case might require that consent receipts were reissued at every new site logon? The right answer may not be known until the lawyers complete some very expensive lawsuits. One can only hope that answers to question like these do not have different answers in different jurisdictions.
  3. Some mandatory requirements, like service address and phone number might be fine for large organizations, but if applied to small ones there will be some that just avoid the issue and hope no one notices. I specifically noted that this site was not in compliance with those requirements, and never intends to be compliant.
  4. Termination was unclear especially as to what might actually be possible. It was decided to just use a link to where the user can get information about that AND privacy policy - they should be tightly related, if not identical.
  5. Experience leads to the conclusion that fields like purpose vary among the different elements of user private information stored. If fact it seems like the GDPR requires this as the point is made (at least in the CA initiative) that some data may be part of a core function and other data voluntary. Since the consent receipt is designed so that it can be issued prior to (and independent of) any data collection, there was no provision made for user data beyond the very broad piiCategory. The question remains about how to accommodate users' desires for determination of the exact extent of exposure and redress to unwanted data disclosures. Specifically can the Kantara Consent Receipt serve as a base requirement to which other elements are added, or is a completely different standard required to meet user expectations?
  6. The assumption seems to be that piiPrinciple is a sentient carbon-based life form. This is not necessarily true. In the case of a Pseudonym it is PII to even know if the principle (Subject) is a carbon-based life form. In case you wondered about this odd formulation it should be noted that Saudi Arabia, which denies women equal rights, makes a robot a citizen

Warning that this is a description of a work in process and changes continue to be added to the best practice site.

Json classes

 // ConsentReceipt helper clases (c) 2018 tom jones
   public class ConsentReceipt
       public class ProfileResponse
           public string version { get; set; }
           public string jurisdiction { get; set; }
           public string consentTimestamp { get; set; }
           public string collectionMethod { get; set; }
           public string consentReceiptID { get; set; }
           public string publicKey { get; set; }
           [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
           public string language { get; set; }
           public string piiPrincipalId { get; set; }
           public Array piiControllers { get; set; }
           public string policyUrl { get; set; }
           public Array services { get; set; }
           public string sensitive { get; set; }
           [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
           public string spiCat { get; set; }
       public class jsonController
           public static jsonController Create(string json)
               return new jsonController(json);
           public static string Write(jsonController options)
               return JsonConvert.SerializeObject(options);
           public jsonController()
           { }
           public jsonController(string json)
                   JsonConvert.PopulateObject(json, this);
               catch (Exception ex)
                   throw new Exception(string.Format("Error deserializing json:'{0}', into '{1}.", json, GetType()), ex);
           public string piiController { get; set; }
           [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
           public string onBehalf { get; set; }
           public string contact { get; set; }
           public string address { get; set; }
           public string email { get; set; }
           public string phone { get; set; }
           [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
           public string fax { get; set; }
           [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
           public string piiControllerURL { get; set; }
       public class jsonService
           public string service { get; set; }
           public Array purposes { get; set; }
       public class jsonPurpose
           public string purpose { get; set; }
           public string[] purposeCategory { get; set; }
           public string consentType { get; set; }
           public string[] piiCategory { get; set; }
           public bool primaryPurpose { get; set; }
           public string termination { get; set; }
           public bool thirdPartyDisclosure { get; set; }
           [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
           public string thirdPartyName { get; set; }

Json Constructer

           ProfileResponse profileResp = new ProfileResponse
               version = "KI-CR-v1.1.0",
               jurisdiction = "WA",
               consentTimestamp = DateTime.UtcNow.ToString("o"),
               collectionMethod = "user input",
               consentReceiptID = Guid.NewGuid().ToString(),
               language = "en",
               piiPrincipalId = user.UserName,
               piiControllers = new jsonController[]
                   new jsonController { piiController = "IDESGidp",
                   contact = "jerry",
                       address="too restrictive for small sites",
                       phone="too restrictive for small sites"}
               policyUrl = "",
               services = new jsonService[]
                   new jsonService {
                       service = "IdP",
                       purposes = new jsonPurpose[]
                           new jsonPurpose {
                           purpose = "Authenticate User",
                           purposeCategory= new string[] {"1 - Core Function" },
                           piiCategory = new string[] {"2 - Contact" },
                           primaryPurpose= true,
                           thirdPartyDisclosure = false
                           new jsonPurpose
                               purpose="Federated Logon",
                               purposeCategory= new string[] {"2 - not clear to me" },
                               piiCategory=new string[] {"2 - Contact", "3 - More stuff"},
                               termination="same as primary purpose",
                               thirdPartyDisclosure = true,
                               thirdPartyName="this will be the site you visit"
               sensitive = "false"
           string jsonResp = JsonConvert.SerializeObject(profileResp);

Json output

Generated on a partial implementation on 2018-06-06. One thing that might seem a little odd to others is that the Consent receipt for this site never really varies. It is always that same three fields entered at this time.

The next challenge is, given a Consent Receipt on the web site, what should be done with it?

 "version": "KI-CR-v1.1.0",
 "jurisdiction": "WA",
 "consentTimestamp": "2018-06-08T17:43:20.7681968Z",
 "collectionMethod": "user input",
 "consentReceiptID": "ce56a128-abd2-4edc-94f3-3d1b2efcb57d",
 "language": "en",
 "piiPrincipalId": "tomcjones",
 "piiControllers": [
     "piiController": "IDESGidp",
     "contact": "jerry",
     "address": "too restrictive for small sites",
     "email": "",
     "phone": "too restrictive for small sites"
 "policyUrl": "",
 "services": [
     "service": "IdP",
     "purposes": [
         "purpose": "Authenticate User",
         "purposeCategory": [ "1 - Core Function" ],
         "consentType": "EXPLICIT",
         "piiCategory": [ "2 - Contact" ],
         "primaryPurpose": true,
         "termination": "",
         "thirdPartyDisclosure": false
         "purpose": "Federated Logon",
         "purposeCategory": [ "2 - not clear to me" ],
         "consentType": "IMPLICIT",
         "piiCategory": [ "2 - Contact", "3 - More stuff" ],
         "primaryPurpose": false,
         "termination": "same as primary purpose",
         "thirdPartyDisclosure": true,
         "thirdPartyName": "this will be the site you visit"
 "sensitive": "false"

XML output

This is a conversion of the same [JSONOBJECT] that was converted to JSON above.

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="ConsentReceipt-min.xsl" ?>
 <collectionMethod>user input</collectionMethod>
 <piiControllers json:Array="true" xmlns:json="">
   <address>too restrictive for small sites</address>
   <phone>too restrictive for small sites</phone>
 <services json:Array="true" xmlns:json="">
     <purpose>Authenticate User</purpose>
     <purposeCategory json:Array="true">1 - Core Function</purposeCategory>
     <piiCategory json:Array="true">2 - Contact</piiCategory>
     <purpose>Federated Logon</purpose>
     <purposeCategory json:Array="true">2 - not clear to me</purposeCategory>
     <piiCategory>2 - Contact</piiCategory>
     <piiCategory>3 - More stuff</piiCategory>
     <termination>same as primary purpose</termination>
     <thirdPartyName>this will be the site you visit</thirdPartyName>