# all files / red/runtime/nodes/ credentials.js

37.37% Statements 71/190
26.32% Branches 20/76
47.06% Functions 8/17
37.37% Lines 71/190

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377

    1×
    1×
    1×
    1×
    1×

    1×
    1×
    1×
    1×

    1×
    1×
    1×
    1×

    1×

    1×

    30×
    30×
    30×
    30×
    30×
    30×
    30×

    27×

    27×
    27×

    27×
    27×
    27×

    27×
    5×

    27×
    27×
    27×

    1×

    27×
    27×
    27×

    1×
    1×

    8×

    8×
    7×

    7×

    7×

    1×

    1×

    1×
    1×
    1×
    1×

    1×
    1×
    1×
    1×

    1×

    8×

    8×
    8×
    8×

    8×

    8×

    2×

    3×
    3×

    3×

    7×

    7×

    7×

    7×
    7×

    7×

     /**
     * Copyright JS Foundation and other contributors, http://js.foundation
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     * http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     **/

    var when = require("when");
    var crypto = require('crypto');
    var runtime;
    var settings;
    var log;

    var encryptedCredentials = null;
    var credentialCache = {};
    var credentialsDef = {};
    var dirty = false;

    var removeDefaultKey = false;
    var encryptionEnabled = null;
    var encryptionAlgorithm = "aes-256-ctr";
    var encryptionKey;

    function decryptCredentials(key,credentials) {
        var creds = credentials["$"];
        var initVector = new Buffer(creds.substring(0, 32),'hex');
        creds = creds.substring(32);
        var decipher = crypto.createDecipheriv(encryptionAlgorithm, key, initVector);
        var decrypted = decipher.update(creds, 'base64', 'utf8') + decipher.final('utf8');
        return JSON.parse(decrypted);
    }

    var api = module.exports = {
        init: function(_runtime) {
            runtime = _runtime;
            log = runtime.log;
            settings = runtime.settings;
            dirty = false;
            credentialCache = {};
            credentialsDef = {};
            encryptionEnabled = null;
        },

        /**
         * Sets the credentials from storage.
         */
        load: function (credentials) {
            dirty = false;
            /*
              - if encryptionEnabled === null, check the current configuration
            */
            var credentialsEncrypted = credentials.hasOwnProperty("$") && Object.keys(credentials).length === 1;
            var setupEncryptionPromise = when.resolve();
            // if (encryptionEnabled === null) {
                var defaultKey;
                try {
                    defaultKey = settings.get('_credentialSecret');
                } catch(err) {
                }
                if (defaultKey) {
                    defaultKey = crypto.createHash('sha256').update(defaultKey).digest();
                }
                var userKey;
                try {
                    userKey = settings.get('credentialSecret');
                } catch(err) {
                    userKey = false;
                }

                var projectKey = false;
                var activeProject;
                if (runtime.storage.projects) {
                    // projects enabled
                    activeProject = runtime.storage.projects.getActiveProject();
                    Iif (activeProject) {
                        projectKey = activeProject.credentialSecret;
                    }
                }

                Iif (projectKey) {
                    log.debug("red/runtime/nodes/credentials.load : using active project key - ignoring user provided key");
                    userKey = projectKey;
                }

                //TODO: Need to consider the various migration scenarios from no-project to project
                // - _credentialSecret exists, projectKey exists
                // - _credentialSecret does not exist, projectKey exists
                // - userKey exists, projectKey exists
                if (userKey === false) {
                    log.debug("red/runtime/nodes/credentials.load : user disabled encryption");
                    // User has disabled encryption
                    encryptionEnabled = false;
                    // Check if we have a generated _credSecret to decrypt with and remove
                    Iif (defaultKey) {
                        console.log("****************************************************************");
                        console.log("* Oh oh - default key present. We don't handle this well today *");
                        console.log("****************************************************************");
                        log.debug("red/runtime/nodes/credentials.load : default key present. Will migrate");
                        if (credentialsEncrypted) {
                            try {
                                credentials = decryptCredentials(defaultKey,credentials)
                            } catch(err) {
                                credentials = {};
                                log.warn(log._("nodes.credentials.error",{message:err.toString()}))
                                var error = new Error("Failed to decrypt credentials");
                                error.code = "credentials_load_failed";
                                return when.reject(error);
                            }
                        }
                        dirty = true;
                        removeDefaultKey = true;
                    }
                } else Iif (typeof userKey === 'string') {
                    if (!projectKey) {
                        log.debug("red/runtime/nodes/credentials.load : user provided key");
                    }
                    // User has provided own encryption key, get the 32-byte hash of it
                    encryptionKey = crypto.createHash('sha256').update(userKey).digest();
                    encryptionEnabled = true;

                    if (defaultKey) {
                        log.debug("red/runtime/nodes/credentials.load : default key present. Will migrate");
                        // User has provided their own key, but we already have a default key
                        // Decrypt using default key
                        if (credentialsEncrypted) {
                            try {
                                credentials = decryptCredentials(defaultKey,credentials)
                            } catch(err) {
                                credentials = {};
                                log.warn(log._("nodes.credentials.error",{message:err.toString()}))
                                var error = new Error("Failed to decrypt credentials");
                                error.code = "credentials_load_failed";
                                return when.reject(error);
                            }
                        }
                        dirty = true;
                        removeDefaultKey = true;
                    }
                } else {
                    log.debug("red/runtime/nodes/credentials.load : no user key present");
                    // User has not provide their own key
                    encryptionKey = defaultKey;
                    encryptionEnabled = true;
                    Eif (encryptionKey === undefined) {
                        log.debug("red/runtime/nodes/credentials.load : no default key present - generating one");
                        // No user-provided key, no generated key
                        // Generate a new key
                        defaultKey = crypto.randomBytes(32).toString('hex');
                        try {
                            setupEncryptionPromise = settings.set('_credentialSecret',defaultKey);
                            encryptionKey = crypto.createHash('sha256').update(defaultKey).digest();
                        } catch(err) {
                            log.debug("red/runtime/nodes/credentials.load : settings unavailable - disabling encryption");
                            // Settings unavailable
                            encryptionEnabled = false;
                            encryptionKey = null;
                        }
                        dirty = true;
                    } else {
                        log.debug("red/runtime/nodes/credentials.load : using default key");
                    }
                }
            //}
            Iif (encryptionEnabled && !dirty) {
                encryptedCredentials = credentials;
            }
            return setupEncryptionPromise.then(function() {
                var clearInvalidFlag = false;
                Iif (credentials.hasOwnProperty("$")) {
                    // These are encrypted credentials
                    try {
                        credentialCache = decryptCredentials(encryptionKey,credentials)
                        clearInvalidFlag = true;
                    } catch(err) {
                        credentialCache = {};
                        dirty = true;
                        log.warn(log._("nodes.credentials.error",{message:err.toString()}))
                        var error = new Error("Failed to decrypt credentials");
                        error.code = "credentials_load_failed";
                        if (projectKey) {
                            // This is a project with a bad key. Mark it as invalid
                            // TODO: this delves too deep into Project structure
                            activeProject.credentialSecretInvalid = true;
                            return when.reject(error);
                        }
                        return when.reject(error);
                    }
                } else {
                    credentialCache = credentials;
                }
                Iif (clearInvalidFlag) {
                    // TODO: this delves too deep into Project structure
                    delete activeProject.credentialSecretInvalid;
                }
            });
        },

        /**
         * Adds a set of credentials for the given node id.
         * @param id the node id for the credentials
         * @param creds an object of credential key/value pairs
         * @return a promise for backwards compatibility TODO: can this be removed?
         */
        add: function (id, creds) {
            if (!credentialCache.hasOwnProperty(id) || JSON.stringify(creds) !== JSON.stringify(credentialCache[id])) {
                credentialCache[id] = creds;
                dirty = true;
            }
            return when.resolve();
        },

        /**
         * Gets the credentials for the given node id.
         * @param id the node id for the credentials
         * @return the credentials
         */
        get: function (id) {
            return credentialCache[id];
        },

        /**
         * Deletes the credentials for the given node id.
         * @param id the node id for the credentials
         * @return a promise for the saving of credentials to storage
         */
        delete: function (id) {
            delete credentialCache[id];
            dirty = true;
        },

        clear: function() {
            credentialCache = {};
            dirty = true;
        },
        /**
         * Deletes any credentials for nodes that no longer exist
         * @param config a flow config
         * @return a promise for the saving of credentials to storage
         */
        clean: function (config) {
            var existingIds = {};
            config.forEach(function(n) {
                existingIds[n.id] = true;
                if (n.credentials) {
                    api.extract(n);
                }
            });
            var deletedCredentials = false;
            for (var c in credentialCache) {
                if (credentialCache.hasOwnProperty(c)) {
                    if (!existingIds[c]) {
                        deletedCredentials = true;
                        delete credentialCache[c];
                    }
                }
            }
            if (deletedCredentials) {
                dirty = true;
            }
            return when.resolve();
        },

        /**
         * Registers a node credential definition.
         * @param type the node type
         * @param definition the credential definition
         */
        register: function (type, definition) {
            var dashedType = type.replace(/\s+/g, '-');
            credentialsDef[dashedType] = definition;
        },

        /**
         * Extracts and stores any credential updates in the provided node.
         * The provided node may have a .credentials property that contains
         * new credentials for the node.
         * This function loops through the credentials in the definition for
         * the node-type and applies any of the updates provided in the node.
         *
         * This function does not save the credentials to disk as it is expected
         * to be called multiple times when a new flow is deployed.
         *
         * @param node the node to extract credentials from
         */
        extract: function(node) {
            var nodeID = node.id;
            var nodeType = node.type;
            var newCreds = node.credentials;
            if (newCreds) {
                delete node.credentials;
                var savedCredentials = credentialCache[nodeID] || {};
                var dashedType = nodeType.replace(/\s+/g, '-');
                var definition = credentialsDef[dashedType];
                if (!definition) {
                    log.warn(log._("nodes.credentials.not-registered",{type:nodeType}));
                    return;
                }

                for (var cred in definition) {
                    if (definition.hasOwnProperty(cred)) {
                        if (newCreds[cred] === undefined) {
                            continue;
                        }
                        if (definition[cred].type == "password" && newCreds[cred] == '__PWRD__') {
                            continue;
                        }
                        if (0 === newCreds[cred].length || /^\s*$/.test(newCreds[cred])) {
                            delete savedCredentials[cred];
                            dirty = true;
                            continue;
                        }
                        if (!savedCredentials.hasOwnProperty(cred) || JSON.stringify(savedCredentials[cred]) !== JSON.stringify(newCreds[cred])) {
                            savedCredentials[cred] = newCreds[cred];
                            dirty = true;
                        }
                    }
                }
                credentialCache[nodeID] = savedCredentials;
            }
        },

        /**
         * Gets the credential definition for the given node type
         * @param type the node type
         * @return the credential definition
         */
        getDefinition: function (type) {
            return credentialsDef[type];
        },

        dirty: function() {
            return dirty;
        },
        setKey: function(key) {
            encryptionKey = crypto.createHash('sha256').update(key).digest();
            encryptionEnabled = true;
            dirty = true;
        },
        export: function() {
            var result = credentialCache;

            Iif (encryptionEnabled) {
                if (dirty) {
                    try {
                        log.debug("red/runtime/nodes/credentials.export : encrypting");
                        var initVector = crypto.randomBytes(16);
                        var cipher = crypto.createCipheriv(encryptionAlgorithm, encryptionKey, initVector);
                        result = {"$":initVector.toString('hex') + cipher.update(JSON.stringify(credentialCache), 'utf8', 'base64') + cipher.final('base64')};
                    } catch(err) {
                        log.warn(log._("nodes.credentials.error-saving",{message:err.toString()}))
                    }
                } else {
                    result = encryptedCredentials;
                }
            }
            dirty = false;
            Iif (removeDefaultKey) {
                log.debug("red/runtime/nodes/credentials.export : removing unused default key");
                return settings.delete('_credentialSecret').then(function() {
                    removeDefaultKey = false;
                    return result;
                })
            } else {
                return when.resolve(result);
            }
        }
    }