spelling: fix misspellings
[gpgme.git] / lang / js / src / Key.js
index 30f507c..a3f5204 100644 (file)
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see <http://www.gnu.org/licenses/>.
+ * License along with this program; if not, see <https://www.gnu.org/licenses/>.
  * SPDX-License-Identifier: LGPL-2.1+
  *
  * Author(s):
  *     Maximilian Krambach <mkrambach@intevation.de>
  */
 
+
 import { isFingerprint, isLongId } from './Helpers';
 import { gpgme_error } from './Errors';
 import { createMessage } from './Message';
@@ -28,145 +29,98 @@ import { createMessage } from './Message';
 /**
  * Validates the given fingerprint and creates a new {@link GPGME_Key}
  * @param {String} fingerprint
- * @returns {GPGME_Key|GPGME_Error}
+ * @param {Boolean} async If True, Key properties (except fingerprint) will be
+ * queried from gnupg on each call, making the operation up-to-date, the
+ * answers will be Promises, and the performance will likely suffer
+ * @param {Object} data additional initial properties this Key will have. Needs
+ * a full object as delivered by gpgme-json
+ * @returns {Object} The verified and updated data
  */
-export function createKey(fingerprint){
-    if (!isFingerprint(fingerprint)){
-        return gpgme_error('PARAM_WRONG');
+export function createKey (fingerprint, async = false, data){
+    if (!isFingerprint(fingerprint) || typeof (async) !== 'boolean'){
+        throw gpgme_error('PARAM_WRONG');
+    }
+    if (data !== undefined){
+        data = validateKeyData(fingerprint, data);
+    }
+    if (data instanceof Error){
+        throw gpgme_error('KEY_INVALID');
+    } else {
+        return new GPGME_Key(fingerprint, async, data);
     }
-    else return new GPGME_Key(fingerprint);
 }
 
 /**
- * Represents the Keys as stored in the gnupg backend
- * It allows to query almost all information defined in gpgme Key Objects
- * Refer to {@link validKeyProperties} for available information, and the gpgme
- * documentation on their meaning
- * (https://www.gnupg.org/documentation/manuals/gpgme/Key-objects.html)
+ * Represents the Keys as stored in the gnupg backend. A key is defined by a
+ * fingerprint.
+ * A key cannot be directly created via the new operator, please use
+ * {@link createKey} instead.
+ * A GPGME_Key object allows to query almost all information defined in gpgme
+ * Keys. It offers two modes, async: true/false. In async mode, Key properties
+ * with the exception of the fingerprint will be queried from gnupg on each
+ * call, making the operation up-to-date, the answers will be Promises, and
+ * the performance will likely suffer. In Sync modes, all information except
+ * for the armored Key export will be cached and can be refreshed by
+ * [refreshKey]{@link GPGME_Key#refreshKey}.
+ *
+ * <pre>
+ * see also:
+ *      {@link GPGME_UserId} user Id objects
+ *      {@link GPGME_Subkey} subKey objects
+ * </pre>
+ * For other Key properteis, refer to {@link validKeyProperties},
+ * and to the [gpgme documentation]{@link https://www.gnupg.org/documentation/manuals/gpgme/Key-objects.html}
+ * for meanings and further details.
  *
  * @class
  */
-export class GPGME_Key {
+class GPGME_Key {
 
-    constructor(fingerprint){
-        this.fingerprint = fingerprint;
-    }
+    constructor (fingerprint, async, data){
 
-    set fingerprint(fpr){
-        if (isFingerprint(fpr) === true) {
-            if (this._data === undefined) {
-                this._data = {fingerprint:  fpr};
-            } else {
-                if (this._data.fingerprint === undefined){
-                    this._data.fingerprint = fpr;
-                }
-            }
-        }
-    }
+        /**
+         * @property {Boolean} _async If true, the Key was initialized without
+         * cached data
+         */
+        this._async = async;
 
-    /**
-     * @returns {String} The fingerprint defining this Key
-     */
-    get fingerprint(){
-        if (!this._data || !this._data.fingerprint){
-            return gpgme_error('KEY_INVALID');
+        this._data = { fingerprint: fingerprint.toUpperCase() };
+        if (data !== undefined
+            && data.fingerprint.toUpperCase() === this._data.fingerprint
+        ) {
+            this._data = data;
         }
-        return this._data.fingerprint;
     }
 
     /**
-     * @param {Object} data Bulk set the data for this key, with an Object sent
-     * by gpgme-json.
-     * @returns {GPGME_Key|GPGME_Error} Itself after values have been set, an
-     * error if something went wrong
-     * @private
+     * Query any property of the Key listed in {@link validKeyProperties}
+     * @param {String} property property to be retrieved
+     * @returns {Boolean| String | Date | Array | Object}
+     * @returns {Promise<Boolean| String | Date | Array | Object>} (if in async
+     * mode)
+     * <pre>
+     * Returns the value of the property requested. If the Key is set to async,
+     * the value will be fetched from gnupg and resolved as a Promise. If Key
+     * is not  async, the armored property is not available (it can still be
+     * retrieved asynchronously by [getArmor]{@link GPGME_Key#getArmor})
      */
-    setKeyData(data){
-        if (this._data === undefined) {
-            this._data = {};
-        }
-        if (
-            typeof(data) !== 'object') {
-            return gpgme_error('KEY_INVALID');
-        }
-        if (!this._data.fingerprint && isFingerprint(data.fingerprint)){
-            if (data.fingerprint !== this.fingerprint){
-                return gpgme_error('KEY_INVALID');
-            }
-            this._data.fingerprint = data.fingerprint;
-        } else if (this._data.fingerprint !== data.fingerprint){
-            return gpgme_error('KEY_INVALID');
-        }
-        let dataKeys = Object.keys(data);
-        for (let i=0; i< dataKeys.length; i++){
-            if (!validKeyProperties.hasOwnProperty(dataKeys[i])){
-                return gpgme_error('KEY_INVALID');
-            }
-            if (validKeyProperties[dataKeys[i]](data[dataKeys[i]]) !== true ){
-                return gpgme_error('KEY_INVALID');
-            }
-            switch (dataKeys[i]){
-            case 'subkeys':
-                this._data.subkeys = [];
-                for (let i=0; i< data.subkeys.length; i++) {
-                    this._data.subkeys.push(
-                        new GPGME_Subkey(data.subkeys[i]));
-                }
-                break;
-            case 'userids':
-                this._data.userids = [];
-                for (let i=0; i< data.userids.length; i++) {
-                    this._data.userids.push(
-                        new GPGME_UserId(data.userids[i]));
-                }
-                break;
-            case 'last_update':
-                this._data[dataKeys[i]] = new Date( data[dataKeys[i]] * 1000 );
-                break;
+    get (property) {
+        if (this._async === true) {
+            switch (property){
+            case 'armored':
+                return this.getArmor();
+            case 'hasSecret':
+                return this.getGnupgSecretState();
             default:
-                this._data[dataKeys[i]] = data[dataKeys[i]];
+                return getGnupgState(this.fingerprint, property);
             }
-        }
-        return this;
-    }
-
-    /**
-     * Query any property of the Key listed in {@link validKeyProperties}
-     * @param {String} property property to be retreived
-     * @param {Boolean} cached (optional) if false, the data will be directly
-     * queried from gnupg, and the operation will be asynchronous. Else, the
-     * data will be fetched from the state of the initialization of the Key.
-     * The cached mode may contain outdated information, but can be used as
-     * synchronous operation, where the backend is not expected to change Keys
-     * during a session. The key still can be reloaded by invoking
-     * {@link refreshKey}.
-     * @returns {*|Promise<*>} the value (Boolean, String, Array, Object).
-     * If 'cached' is true, the value will be resolved as a Promise.
-     */
-    get(property, cached=true) {
-        if (cached === false) {
-            let me = this;
-            return new Promise(function(resolve, reject) {
-                if (!validKeyProperties.hasOwnProperty(property)){
-                    reject('PARAM_WRONG');
-                } else if (property === 'armored'){
-                    resolve(me.getArmor());
-                } else if (property === 'hasSecret'){
-                    resolve(me.getHasSecret());
-                } else {
-                    me.refreshKey().then(function(key){
-                        resolve(key.get(property, true));
-                    }, function(error){
-                        reject(error);
-                    });
-                }
-            });
         } else {
-            if (!validKeyProperties.hasOwnProperty(property)){
-                return gpgme_error('PARAM_WRONG');
+            if (property === 'armored') {
+                throw gpgme_error('KEY_ASYNC_ONLY');
             }
-            if (!this._data.hasOwnProperty(property)){
-                return gpgme_error('KEY_NO_INIT');
+            // eslint-disable-next-line no-use-before-define
+            if (!validKeyProperties.hasOwnProperty(property)){
+                throw gpgme_error('PARAM_WRONG');
             } else {
                 return (this._data[property]);
             }
@@ -174,31 +128,40 @@ export class GPGME_Key {
     }
 
     /**
-     * Reloads the Key information from gnupg. This is only useful if you use
-     * the GPGME_Keys cached. Note that this is a performance hungry operation.
-     * If you desire more than a few refreshs, it may be advisable to run
-     * {@link Keyring.getKeys} instead.
-     * @returns {Promise<GPGME_Key|GPGME_Error>}
+     * Reloads the Key information from gnupg. This is only useful if the Key
+     * use the GPGME_Keys cached. Note that this is a performance hungry
+     * operation. If you desire more than a few refreshs, it may be
+     * advisable to run [Keyring.getKeys]{@link Keyring#getKeys} instead.
+     * @returns {Promise<GPGME_Key>}
      * @async
      */
-    refreshKey() {
+    refreshKey () {
         let me = this;
-        return new Promise(function(resolve, reject) {
+        return new Promise(function (resolve, reject) {
             if (!me._data.fingerprint){
                 reject(gpgme_error('KEY_INVALID'));
             }
             let msg = createMessage('keylist');
             msg.setParameter('sigs', true);
             msg.setParameter('keys', me._data.fingerprint);
-            msg.post().then(function(result){
+            msg.post().then(function (result){
                 if (result.keys.length === 1){
-                    me.setKeyData(result.keys[0]);
-                    me.getHasSecret().then(function(){
-                        //TODO retrieve armored Key
-                        resolve(me);
-                    }, function(error){
-                        reject(error);
-                    });
+                    const newdata = validateKeyData(
+                        me._data.fingerprint, result.keys[0]);
+                    if (newdata instanceof Error){
+                        reject(gpgme_error('KEY_INVALID'));
+                    } else {
+                        me._data = newdata;
+                        me.getGnupgSecretState().then(function (){
+                            me.getArmor().then(function (){
+                                resolve(me);
+                            }, function (error){
+                                reject(error);
+                            });
+                        }, function (error){
+                            reject(error);
+                        });
+                    }
                 } else {
                     reject(gpgme_error('KEY_NOKEY'));
                 }
@@ -209,117 +172,102 @@ export class GPGME_Key {
     }
 
     /**
-     * Query the armored block of the Key directly from gnupg. Please note that
-     * this will not get you any export of the secret/private parts of a Key
-     * @returns {Promise<String|GPGME_Error>}
+     * Query the armored block of the Key directly from gnupg. Please note
+     * that this will not get you any export of the secret/private parts of
+     * a Key
+     * @returns {Promise<String>}
      * @async
      */
-    getArmor(){
-        let me = this;
-        return new Promise(function(resolve, reject) {
+    getArmor () {
+        const me = this;
+        return new Promise(function (resolve, reject) {
             if (!me._data.fingerprint){
                 reject(gpgme_error('KEY_INVALID'));
             }
             let msg = createMessage('export');
             msg.setParameter('armor', true);
             msg.setParameter('keys', me._data.fingerprint);
-            msg.post().then(function(result){
-                me._data.armored = result.data;
+            msg.post().then(function (result){
                 resolve(result.data);
-            }, function(error){
+            }, function (error){
                 reject(error);
             });
         });
     }
 
     /**
-     * Find out if the Key includes a secret part. Note that this is a rather
-     * nonperformant operation, as it needs to query gnupg twice. If you want
-     * this inforrmation about more than a few Keys, it may be advisable to run
-     * {@link Keyring.getKeys} instead.
-     * @returns {Promise<Boolean|GPGME_Error>} True if a secret/private Key is
-     * available in the gnupg Keyring
+     * Find out if the Key is part of a Key pair including public and
+     * private key(s). If you want this information about more than a few
+     * Keys in synchronous mode, it may be advisable to run
+     * [Keyring.getKeys]{@link Keyring#getKeys} instead, as it performs faster
+     * in bulk querying.
+     * @returns {Promise<Boolean>} True if a private Key is available in the
+     * gnupg Keyring.
      * @async
      */
-    getHasSecret(){
-        let me = this;
-        return new Promise(function(resolve, reject) {
+    getGnupgSecretState (){
+        const me = this;
+        return new Promise(function (resolve, reject) {
             if (!me._data.fingerprint){
                 reject(gpgme_error('KEY_INVALID'));
+            } else {
+                let msg = createMessage('keylist');
+                msg.setParameter('keys', me._data.fingerprint);
+                msg.setParameter('secret', true);
+                msg.post().then(function (result){
+                    me._data.hasSecret = null;
+                    if (
+                        result.keys &&
+                        result.keys.length === 1 &&
+                        result.keys[0].secret === true
+                    ) {
+                        me._data.hasSecret = true;
+                        resolve(true);
+                    } else {
+                        me._data.hasSecret = false;
+                        resolve(false);
+                    }
+                }, function (error){
+                    reject(error);
+                });
             }
-            let msg = createMessage('keylist');
-            msg.setParameter('keys', me._data.fingerprint);
-            msg.setParameter('secret', true);
-            msg.post().then(function(result){
-                me._data.hasSecret = null;
-                if (
-                    result.keys &&
-                    result.keys.length === 1 &&
-                    result.keys[0].secret === true
-                ) {
-                    me._data.hasSecret = true;
-                    resolve(true);
-                } else {
-                    me._data.hasSecret = false;
-                    resolve(false);
-                }
-            }, function(error){
-                reject(error);
-            });
         });
     }
 
     /**
-     * Convenience functions to be directly used as properties of the Key
-     * Notice that these rely on cached info and may be outdated. Use the async
-     * get(property, false) if you need the most current info
+     * Deletes the (public) Key from the GPG Keyring. Note that a deletion
+     * of a secret key is not supported by the native backend, and gnupg will
+     * refuse to delete a Key if there is still a secret/private Key present
+     * to that public Key
+     * @returns {Promise<Boolean>} Success if key was deleted.
      */
-
-    /**
-     * Property for the export of armored Key. If the armored Key is not
-     * cached, it returns an {@link GPGME_Error} with code 'KEY_NO_INIT'.
-     * Running {@link refreshKey} may help in this case.
-     * @returns {String|GPGME_Error} The armored public Key block.
-     */
-    get armored(){
-        return this.get('armored', true);
-    }
-
-    /**
-     * Property indicating if the Key possesses a private/secret part. If this
-     * information is not yet cached, it returns an {@link GPGME_Error} with
-     * code 'KEY_NO_INIT'.  Running {@link refreshKey} may help in this case.
-     * @returns {Boolean} If the Key has a secret subkey.
-     */
-    get hasSecret(){
-        return this.get('hasSecret', true);
-    }
-
-    /**
-     * Deletes the (public) Key from the GPG Keyring. Note that a deletion of a
-     * secret key is not supported by the native backend.
-     * @returns {Promise<Boolean|GPGME_Error>} Success if key was deleted,
-     * rejects with a GPG error otherwise.
-     */
-    delete(){
-        let me = this;
-        return new Promise(function(resolve, reject){
+    delete (){
+        const me = this;
+        return new Promise(function (resolve, reject){
             if (!me._data.fingerprint){
                 reject(gpgme_error('KEY_INVALID'));
             }
             let msg = createMessage('delete');
             msg.setParameter('key', me._data.fingerprint);
-            msg.post().then(function(result){
+            msg.post().then(function (result){
                 resolve(result.success);
-            }, function(error){
+            }, function (error){
                 reject(error);
             });
         });
     }
+
+    /**
+     * @returns {String} The fingerprint defining this Key. Convenience getter
+     */
+    get fingerprint (){
+        return this._data.fingerprint;
+    }
 }
 
 /**
- * Representing a subkey of a Key.
+ * Representing a subkey of a Key. See {@link validSubKeyProperties} for
+ * possible properties.
  * @class
  * @protected
  */
@@ -330,32 +278,33 @@ class GPGME_Subkey {
      * @param {Object} data
      * @private
      */
-    constructor(data){
+    constructor (data){
+        this._data = {};
         let keys = Object.keys(data);
-        for (let i=0; i< keys.length; i++) {
-            this.setProperty(keys[i], data[keys[i]]);
-        }
-    }
+        const me = this;
 
-    /**
-     * Validates a subkey property against {@link validSubKeyProperties} and
-     * sets it if validation is successful
-     * @param {String} property
-     * @param {*} value
-     * @param private
-     */
-    setProperty(property, value){
-        if (!this._data){
-            this._data = {};
-        }
-        if (validSubKeyProperties.hasOwnProperty(property)){
-            if (validSubKeyProperties[property](value) === true) {
-                if (property === 'timestamp' || property === 'expires'){
-                    this._data[property] = new Date(value * 1000);
-                } else {
-                    this._data[property] = value;
+        /**
+         * Validates a subkey property against {@link validSubKeyProperties} and
+         * sets it if validation is successful
+         * @param {String} property
+         * @param {*} value
+         * @param private
+         */
+        const setProperty = function (property, value){
+            // eslint-disable-next-line no-use-before-define
+            if (validSubKeyProperties.hasOwnProperty(property)){
+                // eslint-disable-next-line no-use-before-define
+                if (validSubKeyProperties[property](value) === true) {
+                    if (property === 'timestamp' || property === 'expires'){
+                        me._data[property] = new Date(value * 1000);
+                    } else {
+                        me._data[property] = value;
+                    }
                 }
             }
+        };
+        for (let i=0; i< keys.length; i++) {
+            setProperty(keys[i], data[keys[i]]);
         }
     }
 
@@ -364,15 +313,17 @@ class GPGME_Subkey {
      * @param {String} property Information to request
      * @returns {String | Number | Date}
      */
-    get(property) {
+    get (property) {
         if (this._data.hasOwnProperty(property)){
             return (this._data[property]);
         }
     }
+
 }
 
 /**
- * Representing user attributes associated with a Key or subkey
+ * Representing user attributes associated with a Key or subkey. See
+ * {@link validUserIdProperties} for possible properties.
  * @class
  * @protected
  */
@@ -383,33 +334,26 @@ class GPGME_UserId {
      * @param {Object} data
      * @private
      */
-    constructor(data){
+    constructor (data){
+        this._data = {};
+        const me = this;
         let keys = Object.keys(data);
-        for (let i=0; i< keys.length; i++) {
-            this.setProperty(keys[i], data[keys[i]]);
-        }
-    }
-    /**
-     * Validates a subkey property against {@link validUserIdProperties} and
-     * sets it if validation is successful
-     * @param {String} property
-     * @param {*} value
-     * @param private
-     */
-    setProperty(property, value){
-        if (!this._data){
-            this._data = {};
-        }
-        if (validUserIdProperties.hasOwnProperty(property)){
-            if (validUserIdProperties[property](value) === true) {
-                if (property === 'last_update'){
-                    this._data[property] = new Date(value*1000);
-                } else {
-                    this._data[property] = value;
+        const setProperty = function (property, value){
+            // eslint-disable-next-line no-use-before-define
+            if (validUserIdProperties.hasOwnProperty(property)){
+                // eslint-disable-next-line no-use-before-define
+                if (validUserIdProperties[property](value) === true) {
+                    if (property === 'last_update'){
+                        me._data[property] = new Date(value*1000);
+                    } else {
+                        me._data[property] = value;
+                    }
                 }
             }
+        };
+        for (let i=0; i< keys.length; i++) {
+            setProperty(keys[i], data[keys[i]]);
         }
-
     }
 
     /**
@@ -417,11 +361,12 @@ class GPGME_UserId {
      * @param {String} property Information to request
      * @returns {String | Number}
      */
-    get(property) {
+    get (property) {
         if (this._data.hasOwnProperty(property)){
             return (this._data[property]);
         }
     }
+
 }
 
 /**
@@ -432,52 +377,52 @@ class GPGME_UserId {
  * @const
  */
 const validUserIdProperties = {
-    'revoked': function(value){
-        return typeof(value) === 'boolean';
+    'revoked': function (value){
+        return typeof (value) === 'boolean';
     },
-    'invalid':  function(value){
-        return typeof(value) === 'boolean';
+    'invalid':  function (value){
+        return typeof (value) === 'boolean';
     },
-    'uid': function(value){
-        if (typeof(value) === 'string' || value === ''){
+    'uid': function (value){
+        if (typeof (value) === 'string' || value === ''){
             return true;
         }
         return false;
     },
-    'validity': function(value){
-        if (typeof(value) === 'string'){
+    'validity': function (value){
+        if (typeof (value) === 'string'){
             return true;
         }
         return false;
     },
-    'name': function(value){
-        if (typeof(value) === 'string' || value === ''){
+    'name': function (value){
+        if (typeof (value) === 'string' || value === ''){
             return true;
         }
         return false;
     },
-    'email': function(value){
-        if (typeof(value) === 'string' || value === ''){
+    'email': function (value){
+        if (typeof (value) === 'string' || value === ''){
             return true;
         }
         return false;
     },
-    'address': function(value){
-        if (typeof(value) === 'string' || value === ''){
+    'address': function (value){
+        if (typeof (value) === 'string' || value === ''){
             return true;
         }
         return false;
     },
-    'comment': function(value){
-        if (typeof(value) === 'string' || value === ''){
+    'comment': function (value){
+        if (typeof (value) === 'string' || value === ''){
             return true;
         }
         return false;
     },
-    'origin':  function(value){
+    'origin':  function (value){
         return Number.isInteger(value);
     },
-    'last_update':  function(value){
+    'last_update':  function (value){
         return Number.isInteger(value);
     }
 };
@@ -489,135 +434,278 @@ const validUserIdProperties = {
  * @const
  */
 const validSubKeyProperties = {
-    'invalid': function(value){
-        return typeof(value) === 'boolean';
+    'invalid': function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_encrypt': function(value){
-        return typeof(value) === 'boolean';
+    'can_encrypt': function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_sign': function(value){
-        return typeof(value) === 'boolean';
+    'can_sign': function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_certify':  function(value){
-        return typeof(value) === 'boolean';
+    'can_certify':  function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_authenticate':  function(value){
-        return typeof(value) === 'boolean';
+    'can_authenticate':  function (value){
+        return typeof (value) === 'boolean';
     },
-    'secret': function(value){
-        return typeof(value) === 'boolean';
+    'secret': function (value){
+        return typeof (value) === 'boolean';
     },
-    'is_qualified': function(value){
-        return typeof(value) === 'boolean';
+    'is_qualified': function (value){
+        return typeof (value) === 'boolean';
     },
-    'is_cardkey':  function(value){
-        return typeof(value) === 'boolean';
+    'is_cardkey':  function (value){
+        return typeof (value) === 'boolean';
     },
-    'is_de_vs':  function(value){
-        return typeof(value) === 'boolean';
+    'is_de_vs':  function (value){
+        return typeof (value) === 'boolean';
     },
-    'pubkey_algo_name': function(value){
-        return typeof(value) === 'string';
+    'pubkey_algo_name': function (value){
+        return typeof (value) === 'string';
         // TODO: check against list of known?['']
     },
-    'pubkey_algo_string': function(value){
-        return typeof(value) === 'string';
+    'pubkey_algo_string': function (value){
+        return typeof (value) === 'string';
         // TODO: check against list of known?['']
     },
-    'keyid': function(value){
+    'keyid': function (value){
         return isLongId(value);
     },
-    'pubkey_algo': function(value) {
+    'pubkey_algo': function (value) {
         return (Number.isInteger(value) && value >= 0);
     },
-    'length': function(value){
+    'length': function (value){
         return (Number.isInteger(value) && value > 0);
     },
-    'timestamp': function(value){
+    'timestamp': function (value){
         return (Number.isInteger(value) && value > 0);
     },
-    'expires': function(value){
+    'expires': function (value){
         return (Number.isInteger(value) && value > 0);
     }
 };
 
 /**
  * Validation definition for Keys. Each valid Key property is represented
- * as a key-value pair, with their value being a validation function
+ * as a key-value pair, with their value being a validation function. For
+ * details on the meanings, please refer to the gpgme documentation
+ * https://www.gnupg.org/documentation/manuals/gpgme/Key-objects.html#Key-objects
+ * @param {String} fingerprint
+ * @param {Boolean} revoked
+ * @param {Boolean} expired
+ * @param {Boolean} disabled
+ * @param {Boolean} invalid
+ * @param {Boolean} can_encrypt
+ * @param {Boolean} can_sign
+ * @param {Boolean} can_certify
+ * @param {Boolean} can_authenticate
+ * @param {Boolean} secret
+ * @param {Boolean}is_qualified
+ * @param {String} protocol
+ * @param {String} issuer_serial
+ * @param {String} issuer_name
+ * @param {Boolean} chain_id
+ * @param {String} owner_trust
+ * @param {Date} last_update
+ * @param {String} origin
+ * @param {Array<GPGME_Subkey>} subkeys
+ * @param {Array<GPGME_UserId>} userids
+ * @param {Array<String>} tofu
+ * @param {Boolean} hasSecret
  * @protected
  * @const
  */
 const validKeyProperties = {
-    'fingerprint': function(value){
+    'fingerprint': function (value){
         return isFingerprint(value);
     },
-    'armored': function(value){
-        return typeof(value === 'string');
+    'revoked': function (value){
+        return typeof (value) === 'boolean';
     },
-    'revoked': function(value){
-        return typeof(value) === 'boolean';
+    'expired': function (value){
+        return typeof (value) === 'boolean';
     },
-    'expired': function(value){
-        return typeof(value) === 'boolean';
+    'disabled': function (value){
+        return typeof (value) === 'boolean';
     },
-    'disabled': function(value){
-        return typeof(value) === 'boolean';
+    'invalid': function (value){
+        return typeof (value) === 'boolean';
     },
-    'invalid': function(value){
-        return typeof(value) === 'boolean';
+    'can_encrypt': function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_encrypt': function(value){
-        return typeof(value) === 'boolean';
+    'can_sign': function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_sign': function(value){
-        return typeof(value) === 'boolean';
+    'can_certify': function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_certify': function(value){
-        return typeof(value) === 'boolean';
+    'can_authenticate': function (value){
+        return typeof (value) === 'boolean';
     },
-    'can_authenticate': function(value){
-        return typeof(value) === 'boolean';
+    'secret': function (value){
+        return typeof (value) === 'boolean';
     },
-    'secret': function(value){
-        return typeof(value) === 'boolean';
+    'is_qualified': function (value){
+        return typeof (value) === 'boolean';
     },
-    'is_qualified': function(value){
-        return typeof(value) === 'boolean';
+    'protocol': function (value){
+        return typeof (value) === 'string';
+        // TODO check for implemented ones
     },
-    'protocol': function(value){
-        return typeof(value) === 'string';
-        //TODO check for implemented ones
+    'issuer_serial': function (value){
+        return typeof (value) === 'string';
     },
-    'issuer_serial': function(value){
-        return typeof(value) === 'string';
+    'issuer_name': function (value){
+        return typeof (value) === 'string';
     },
-    'issuer_name': function(value){
-        return typeof(value) === 'string';
+    'chain_id': function (value){
+        return typeof (value) === 'string';
     },
-    'chain_id': function(value){
-        return typeof(value) === 'string';
+    'owner_trust': function (value){
+        return typeof (value) === 'string';
     },
-    'owner_trust': function(value){
-        return typeof(value) === 'string';
-    },
-    'last_update': function(value){
+    'last_update': function (value){
         return (Number.isInteger(value));
-        //TODO undefined/null possible?
+        // TODO undefined/null possible?
     },
-    'origin': function(value){
+    'origin': function (value){
         return (Number.isInteger(value));
     },
-    'subkeys': function(value){
+    'subkeys': function (value){
         return (Array.isArray(value));
     },
-    'userids': function(value){
+    'userids': function (value){
         return (Array.isArray(value));
     },
-    'tofu': function(value){
+    'tofu': function (value){
         return (Array.isArray(value));
     },
-    'hasSecret': function(value){
-        return typeof(value) === 'boolean';
+    'hasSecret': function (value){
+        return typeof (value) === 'boolean';
     }
 
 };
+
+/**
+* sets the Key data in bulk. It can only be used from inside a Key, either
+* during construction or on a refresh callback.
+* @param {Object} key the original internal key data.
+* @param {Object} data Bulk set the data for this key, with an Object structure
+* as sent by gpgme-json.
+* @returns {Object|GPGME_Error} the changed data after values have been set,
+* an error if something went wrong.
+* @private
+*/
+function validateKeyData (fingerprint, data){
+    const key = {};
+    if (!fingerprint || typeof (data) !== 'object' || !data.fingerprint
+     || fingerprint !== data.fingerprint.toUpperCase()
+    ){
+        return gpgme_error('KEY_INVALID');
+    }
+    let props = Object.keys(data);
+    for (let i=0; i< props.length; i++){
+        if (!validKeyProperties.hasOwnProperty(props[i])){
+            return gpgme_error('KEY_INVALID');
+        }
+        // running the defined validation function
+        if (validKeyProperties[props[i]](data[props[i]]) !== true ){
+            return gpgme_error('KEY_INVALID');
+        }
+        switch (props[i]){
+        case 'subkeys':
+            key.subkeys = [];
+            for (let i=0; i< data.subkeys.length; i++) {
+                key.subkeys.push(
+                    new GPGME_Subkey(data.subkeys[i]));
+            }
+            break;
+        case 'userids':
+            key.userids = [];
+            for (let i=0; i< data.userids.length; i++) {
+                key.userids.push(
+                    new GPGME_UserId(data.userids[i]));
+            }
+            break;
+        case 'last_update':
+            key[props[i]] = new Date( data[props[i]] * 1000 );
+            break;
+        default:
+            key[props[i]] = data[props[i]];
+        }
+    }
+    return key;
+}
+
+/**
+ * Fetches and sets properties from gnupg
+ * @param {String} fingerprint
+ * @param {String} property to search for.
+ * @private
+ * @async
+ */
+function getGnupgState (fingerprint, property){
+    return new Promise(function (resolve, reject) {
+        if (!isFingerprint(fingerprint)) {
+            reject(gpgme_error('KEY_INVALID'));
+        } else {
+            let msg = createMessage('keylist');
+            msg.setParameter('keys', fingerprint);
+            msg.post().then(function (res){
+                if (!res.keys || res.keys.length !== 1){
+                    reject(gpgme_error('KEY_INVALID'));
+                } else {
+                    const key = res.keys[0];
+                    let result;
+                    switch (property){
+                    case 'subkeys':
+                        result = [];
+                        if (key.subkeys.length){
+                            for (let i=0; i < key.subkeys.length; i++) {
+                                result.push(
+                                    new GPGME_Subkey(key.subkeys[i]));
+                            }
+                        }
+                        resolve(result);
+                        break;
+                    case 'userids':
+                        result = [];
+                        if (key.userids.length){
+                            for (let i=0; i< key.userids.length; i++) {
+                                result.push(
+                                    new GPGME_UserId(key.userids[i]));
+                            }
+                        }
+                        resolve(result);
+                        break;
+                    case 'last_update':
+                        if (key.last_update === undefined){
+                            reject(gpgme_error('CONN_UNEXPECTED_ANSWER'));
+                        } else if (key.last_update !== null){
+                            resolve(new Date( key.last_update * 1000));
+                        } else {
+                            resolve(null);
+                        }
+                        break;
+                    default:
+                        if (!validKeyProperties.hasOwnProperty(property)){
+                            reject(gpgme_error('PARAM_WRONG'));
+                        } else {
+                            if (key.hasOwnProperty(property)){
+                                resolve(key[property]);
+                            } else {
+                                reject(gpgme_error(
+                                    'CONN_UNEXPECTED_ANSWER'));
+                            }
+                        }
+                        break;
+                    }
+                }
+            }, function (error){
+                reject(gpgme_error(error));
+            });
+        }
+    });
+}