View source for Enhanced Data Model for NOVA

This page documents the enhanced data model for the final NOVA deployment. The content is for discussion and reviews.

== Data Model ==
The enhanced data model adds 3 fields in 2 document types. These new fields are marked with light-red background.

[[File:GPII data model NOVA.png|center|800px]]

== Example of a New Client Credentials document ==
<pre>
{
    "_id": "clientCredential-1",
    "type": "clientCredential",
    "schemaVersion": "0.1",
    "clientId": "gpiiAppInstallationClient-1",
    "oauth2ClientId": "oauth2ClientId-for-NOVA",
    "oauth2ClientSecret": "oauth2ClientSecret-for-NOVA",
    "allowedIPBlocks": [
        "125.19.23.0/24",          // IPv4 block
        "2001:cdba::3257:9652",    // IPv6 block
        "62.230.58.1"              // IP string
    ],
    "allowedSettingsToWrite": [
        "http://registry.gpii.net/common/language",
        "http://registry.gpii.net/common/DPIScale",
        "http://registry.gpii.net/common/highContrast/enabled",
        "http://registry.gpii.net/common/selfVoicing/enabled"
    ],
    "revoked": false,
    "revokedReason": null,
    "timestampCreated": "2017-11-21T18:11:22.101Z",
    "timestampRevoked": null
}
</pre>

Note: An npm module for ip range check: https://www.npmjs.com/package/ip-range-check

== Questions ==
* The new field "gpiiAppInstallationAuthorization.assignedIP" is to record the IP assigned to an access token request using the new grant type for NOVA. The idea is to verify this IP against IPs where /settings GET/PUT requests using this access token are sent from to ensure it's the same computer that requests and uses an access token. Is this verification necessary?
* The point i) in [https://issues.gpii.net/browse/GPII-3719 the GPII-3719 JIRA] says: "That the new OAuth grant type should be in effect for sessions secured by access tokens granted to clients presenting a matching machine secret/client credentials". Seems to me no data model change is required for this point. It would be helpful to discuss about this at reviewing this document.