DocStrap

Source: lib/Decoded.js

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

"use strict";

const Encoded = require("./Encoded");

/**
 * @constructor
 * @desc Stores hashed pass-phrase as decoded Strings.
 * @param {String} key - The decoded key
 * @param {String} salt - The decoded salt
 * @param {Number} iter - The number of PBKDF2 iterations
 */
function Decoded (key, salt, iter) {
    this.key = key;
    this.salt = salt;
    this.iter = iter;
}

/**
 * @method
 * @memberof Decoded
 * @desc Encodes the Decoded object into an Encoded object.
 * @param {String} enc - Encoding scheme to be used
 * @returns {Encoded} The Encoded object
 * @see Encoded
 */
Decoded.prototype.encode = function (enc) {
    const encodedKey = new Buffer(this.key, enc);
    const encodedSalt = new Buffer(this.salt, enc);
    const iter = this.iter;
    return new Encoded(encodedKey, encodedSalt, iter);
}

/**
 * @method
 * @memberof Decoded
 * @desc Concatenates the stored hash data into a hash string.
 * @desc The hash string has the format `iter:salt:key`.
 * @returns {String} The hash string
 */
Decoded.prototype.toString = function () {
    return `${this.iter}:${this.salt}:${this.key}`;
}

/**
 * @method
 * @memberof Decoded
 * @returns {String}
 */
Decoded.prototype.getKey = function () {
    return this.key;
}

/**
 * @method
 * @memberof Decoded
 * @param {Buffer} key
 */
Decoded.prototype.setKey = function (key) {
    this.key = key;
}

/**
 * @method
 * @memberof Decoded
 * @returns {Buffer}
 */
Decoded.prototype.getSalt = function () {
    return this.salt;
}

/**
 * @method
 * @memberof Decoded
 * @param {Buffer} salt
 */
Decoded.prototype.setSalt = function (salt) {
    this.salt = salt;
}

/**
 * @method
 * @memberof Decoded
 * @returns {Number}
 */
Decoded.prototype.getIteration = function () {
    return this.iter;
}

/**
 * @method
 * @memberof Decoded
 * @param {Number} iter
 */
Decoded.prototype.setIteration = function (iter) {
    this.iter = iter;
}


module.exports = Decoded;