spelling: fix misspellings
[gpgme.git] / lang / js / src / Key.js
index f2a16b4..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+
- */
-
-/**
- * The key class allows to query the information defined in gpgme Key Objects
- * (see https://www.gnupg.org/documentation/manuals/gpgme/Key-objects.html)
- *
- * This is a stub, as the gpgme-json side is not yet implemented
  *
+ * Author(s):
+ *     Maximilian Krambach <mkrambach@intevation.de>
  */
 
-import { isFingerprint, isLongId } from './Helpers'
-import { gpgme_error } from './Errors'
+
+import { isFingerprint, isLongId } from './Helpers';
+import { gpgme_error } from './Errors';
 import { createMessage } from './Message';
-import { permittedOperations } from './permittedOperations';
 
 /**
- * Validates the fingerprint.
+ * Validates the given fingerprint and creates a new {@link GPGME_Key}
  * @param {String} fingerprint
+ * @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);
 }
 
 /**
- * Representing the Keys as stored in GPG
+ * 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;
 
-    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 data for this key, with the Object as sent
-     * by gpgme-json.
-     * @returns {GPGME_Key|GPGME_Error} The Key object itself after values have
-     * been set
+     * 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 booleans = ['expired', 'disabled','invalid','can_encrypt',
-            'can_sign','can_certify','can_authenticate','secret',
-            'is_qualified'];
-        for (let b =0; b < booleans.length; b++) {
-            if (
-                !data.hasOwnProperty(booleans[b]) ||
-                typeof(data[booleans[b]]) !== 'boolean'
-            ){
-                return gpgme_error('KEY_INVALID');
+    get (property) {
+        if (this._async === true) {
+            switch (property){
+            case 'armored':
+                return this.getArmor();
+            case 'hasSecret':
+                return this.getGnupgSecretState();
+            default:
+                return getGnupgState(this.fingerprint, property);
             }
-            this._data[booleans[b]] = data[booleans[b]];
-        }
-        if (typeof(data.protocol) !== 'string'){
-            return gpgme_error('KEY_INVALID');
-        }
-        // TODO check valid protocols?
-        this._data.protocol = data.protocol;
-
-        if (typeof(data.owner_trust) !== 'string'){
-            return gpgme_error('KEY_INVALID');
-        }
-        // TODO check valid values?
-        this._data.owner_trust = data.owner_trust;
-
-        // TODO: what about origin ?
-        if (!Number.isInteger(data.last_update)){
-            return gpgme_error('KEY_INVALID');
-        }
-        this._data.last_update = data.last_update;
-
-        this._data.subkeys = [];
-        if (data.hasOwnProperty('subkeys')){
-            if (!Array.isArray(data.subkeys)){
-                return gpgme_error('KEY_INVALID');
+        } else {
+            if (property === 'armored') {
+                throw gpgme_error('KEY_ASYNC_ONLY');
             }
-            for (let i=0; i< data.subkeys.length; i++) {
-                this._data.subkeys.push(
-                    new GPGME_Subkey(data.subkeys[i]));
-            }
-        }
-
-        this._data.userids = [];
-        if (data.hasOwnProperty('userids')){
-            if (!Array.isArray(data.userids)){
-                return gpgme_error('KEY_INVALID');
-            }
-            for (let i=0; i< data.userids.length; i++) {
-                this._data.userids.push(
-                    new GPGME_UserId(data.userids[i]));
-            }
-        }
-        return this;
-    }
-
-    /**
-     * Query any property of the Key list
-     * (TODO: armor not in here, might be unexpected)
-     * @param {String} property Key property to be retreived
-     * @param {*} cached (optional) if false, the data will be directly queried
-     * from gnupg.
-     *  @returns {*|Promise<*>} the value, or if not cached, a Promise
-     * resolving on the value
-     */
-    get(property, cached=true) {
-        if (cached === false) {
-            let me = this;
-            return new Promise(function(resolve, reject) {
-                if (property === 'armor'){
-                    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 (!this._data.hasOwnProperty(property)){
-                return gpgme_error('PARAM_WRONG');
+            // eslint-disable-next-line no-use-before-define
+            if (!validKeyProperties.hasOwnProperty(property)){
+                throw gpgme_error('PARAM_WRONG');
             } else {
                 return (this._data[property]);
             }
@@ -183,273 +128,584 @@ export class GPGME_Key {
     }
 
     /**
-     * Reloads the Key from gnupg
+     * 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]);
-                    resolve(me);
+                    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'));
                 }
             }, function (error) {
                 reject(gpgme_error('GNUPG_ERROR'), error);
-            })
+            });
         });
     }
 
     /**
-     * Get the armored block of the non- secret parts of the Key.
-     * @returns {String} the armored Key block.
-     * Notice that this may be outdated cached info. Use the async getArmor if
-     * you need the most current info
-     */
-
-    // get armor(){ TODO }
-
-    /**
-     * Query the armored block of the non- secret parts of the Key directly
-     * from gpg.
+     * 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.armor = result.data;
+            msg.post().then(function (result){
                 resolve(result.data);
-            }, function(error){
+            }, function (error){
                 reject(error);
             });
         });
     }
 
-    getHasSecret(){
-        let me = this;
-        return new Promise(function(resolve, reject) {
+    /**
+     * 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
+     */
+    getGnupgSecretState (){
+        const me = this;
+        return new Promise(function (resolve, reject) {
             if (!me._data.fingerprint){
                 reject(gpgme_error('KEY_INVALID'));
-            }
-            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 === undefined || result.keys.length < 1) {
-                    me._data.hasSecret = false;
-                    resolve(false);
-                }
-                else if (result.keys.length === 1){
-                    let key = result.keys[0];
-                    if (!key.subkeys){
+            } 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);
-                    } else {
-                        for (let i=0; i < key.subkeys.length; i++) {
-                            if (key.subkeys[i].secret === true) {
-                                me._data.hasSecret = true;
-                                resolve(true);
-                                break;
-                            }
-                            if (i === (key.subkeys.length -1)) {
-                                me._data.hasSecret = false;
-                                resolve(false);
-                            }
-                        }
                     }
-                } else {
-                    reject(gpgme_error('CONN_UNEXPECTED_ANSWER'))
-                }
-            }, function(error){
-            })
+                }, function (error){
+                    reject(error);
+                });
+            }
         });
     }
+
+    /**
+     * 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.
+     */
+    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){
+                resolve(result.success);
+            }, function (error){
+                reject(error);
+            });
+        });
+    }
+
+    /**
+     * @returns {String} The fingerprint defining this Key. Convenience getter
+     */
+    get fingerprint (){
+        return this._data.fingerprint;
+    }
 }
 
 /**
- * The subkeys of a Key. Currently, they cannot be refreshed separately
+ * Representing a subkey of a Key. See {@link validSubKeyProperties} for
+ * possible properties.
+ * @class
+ * @protected
  */
 class GPGME_Subkey {
 
-    constructor(data){
+    /**
+     * Initializes with the json data sent by gpgme-json
+     * @param {Object} data
+     * @private
+     */
+    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;
 
-    setProperty(property, value){
-        if (!this._data){
-            this._data = {};
-        }
-        if (validSubKeyProperties.hasOwnProperty(property)){
-            if (validSubKeyProperties[property](value) === true) {
-                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]]);
         }
     }
 
     /**
-     *
+     * Fetches any information about this subkey
      * @param {String} property Information to request
-     * @returns {String | Number}
-     * TODO: date properties are numbers with Date in seconds
+     * @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. See
+ * {@link validUserIdProperties} for possible properties.
+ * @class
+ * @protected
+ */
 class GPGME_UserId {
 
-    constructor(data){
+    /**
+     * Initializes with the json data sent by gpgme-json
+     * @param {Object} data
+     * @private
+     */
+    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]]);
-        }
-    }
-
-    setProperty(property, value){
-        if (!this._data){
-            this._data = {};
-        }
-        if (validUserIdProperties.hasOwnProperty(property)){
-            if (validUserIdProperties[property](value) === true) {
-                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]]);
         }
     }
 
     /**
-     *
+     * Fetches information about the user
      * @param {String} property Information to request
      * @returns {String | Number}
-     * TODO: date properties are numbers with Date in seconds
      */
-    get(property) {
+    get (property) {
         if (this._data.hasOwnProperty(property)){
             return (this._data[property]);
         }
     }
+
 }
 
+/**
+ * Validation definition for userIds. Each valid userId property is represented
+ * as a key- Value pair, with their value being a validation function to check
+ * against
+ * @protected
+ * @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 === ''){
-            return true;;
+    'uid': function (value){
+        if (typeof (value) === 'string' || value === ''){
+            return true;
         }
         return false;
     },
-    'validity': function(value){
-        if (typeof(value) === 'string'){
-            return true;;
+    'validity': function (value){
+        if (typeof (value) === 'string'){
+            return true;
         }
         return false;
     },
-    'name': function(value){
-        if (typeof(value) === 'string' || value === ''){
-        return true;;
+    'name': function (value){
+        if (typeof (value) === 'string' || value === ''){
+            return true;
         }
         return false;
     },
-    'email': function(value){
-        if (typeof(value) === 'string' || value === ''){
-            return true;;
+    'email': function (value){
+        if (typeof (value) === 'string' || value === ''){
+            return true;
         }
         return false;
     },
-    'address': function(value){
-        if (typeof(value) === 'string' || value === ''){
-            return true;;
+    'address': function (value){
+        if (typeof (value) === 'string' || value === ''){
+            return true;
         }
         return false;
     },
-    'comment': function(value){
-        if (typeof(value) === 'string' || value === ''){
-            return true;;
+    '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);
     }
 };
 
+/**
+ * Validation definition for subKeys. Each valid userId property is represented
+ * as a key-value pair, with the value being a validation function
+ * @protected
+ * @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';
-            // TODO: check against list of known?['']
+    '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. 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){
+        return isFingerprint(value);
+    },
+    'revoked': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'expired': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'disabled': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'invalid': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'can_encrypt': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'can_sign': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'can_certify': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'can_authenticate': function (value){
+        return typeof (value) === 'boolean';
+    },
+    'secret': 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
+    },
+    'issuer_serial': function (value){
+        return typeof (value) === 'string';
+    },
+    'issuer_name': function (value){
+        return typeof (value) === 'string';
+    },
+    'chain_id': function (value){
+        return typeof (value) === 'string';
+    },
+    'owner_trust': function (value){
+        return typeof (value) === 'string';
+    },
+    'last_update': function (value){
+        return (Number.isInteger(value));
+        // TODO undefined/null possible?
+    },
+    'origin': function (value){
+        return (Number.isInteger(value));
+    },
+    'subkeys': function (value){
+        return (Array.isArray(value));
+    },
+    'userids': function (value){
+        return (Array.isArray(value));
+    },
+    'tofu': function (value){
+        return (Array.isArray(value));
+    },
+    '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));
+            });
+        }
+    });
 }