All files / symbol-qr-library/src EncryptedPayload.ts

95.24% Statements 20/21
100% Branches 8/8
100% Functions 5/5
95.24% Lines 20/21

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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                                            1x               25x           25x                       1x       12x     11x 1x     10x 1x     9x                 1x 12x 1x         11x 11x         11x             1x 14x     1x   1x  
/**
 * Copyright 2019 NEM
 *
 * 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.
 */
// internal dependencies
/**
 * Class `EncryptedPayload` describes an encrypted payload
 * with salt and ciphertext properties.
 *
 * @since 0.3.0
 */
class EncryptedPayload {
 
    constructor(/**
                 * The payload ciphertext.
                 * The first X bytes represent the IV.
                 *
                 * @var {string}
                 */
                public readonly ciphertext: string,
                /**
                 * The payload salt.
                 *
                 * @var {string}
                 */
                public readonly salt: string) {}
 
    /**
     * Parse a JSON representation of an encrypted
     * payload into a `EncryptedPayload` instance.
     *
     * The provided JSON must contain fields 'ciphertext'
     * and 'salt'.
     *
     * @param   {string}    json
     * @return  {EncryptedPayload}
     */
    public static fromJSON(
        json: string,
    ): EncryptedPayload {
 
        const jsonObject = EncryptedPayload.validateJson(json);
 
        // validate obligatory fields
        if (!jsonObject.hasOwnProperty('ciphertext')) {
            throw new Error("Missing mandatory field 'ciphertext'.");
        }
 
        if (!jsonObject.hasOwnProperty('salt')) {
            throw new Error("Missing mandatory field 'salt'.");
        }
 
        return new EncryptedPayload(jsonObject.ciphertext, jsonObject.salt);
    }
 
    /**
     * Validates given json string and returns json object
     * @param json
     * @return json object
     * @throws {Error} If validation fails
     */
    private static validateJson(json: string) {
        if (! json.length) {
            throw new Error('JSON argument cannot be empty.');
        }
 
        // validate JSON
        let jsonObject: any;
        try {
            jsonObject = JSON.parse(json);
        } catch (e) {
            // Invalid JSON provided, forward error
            throw new Error('Invalid json body in payload! ' + e.message);
        }
        return jsonObject;
    }
 
    /**
     * Checks if the data ojbect is encrypted
     * @param jsonObject
     */
    public static isDataEncrypted(jsonObject: any) : boolean {
        return jsonObject.hasOwnProperty('ciphertext') && jsonObject.hasOwnProperty('salt');
    }
 
}
 
export {EncryptedPayload};