@neykoor/libsignal-node 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -41
- package/package.json +44 -36
- package/lib/base-key-type.d.ts +0 -4
- package/lib/base-key-type.js +0 -5
- package/lib/chain-type.d.ts +0 -4
- package/lib/chain-type.js +0 -5
- package/lib/crypto.d.ts +0 -6
- package/lib/crypto.js +0 -73
- package/lib/curve.d.ts +0 -9
- package/lib/curve.js +0 -112
- package/lib/direction.d.ts +0 -4
- package/lib/direction.js +0 -5
- package/lib/errors.d.ts +0 -16
- package/lib/errors.js +0 -28
- package/lib/index.d.ts +0 -20
- package/lib/index.js +0 -16
- package/lib/keyhelper.d.ts +0 -18
- package/lib/keyhelper.js +0 -52
- package/lib/logger.d.ts +0 -6
- package/lib/logger.js +0 -11
- package/lib/memory-storage.d.ts +0 -25
- package/lib/memory-storage.js +0 -68
- package/lib/numeric-fingerprint.d.ts +0 -5
- package/lib/numeric-fingerprint.js +0 -54
- package/lib/prekey-bundle-validator.d.ts +0 -2
- package/lib/prekey-bundle-validator.js +0 -44
- package/lib/protobufs.d.ts +0 -5
- package/lib/protobufs.js +0 -3
- package/lib/protocol-address.d.ts +0 -8
- package/lib/protocol-address.js +0 -31
- package/lib/queue-job.d.ts +0 -3
- package/lib/queue-job.js +0 -49
- package/lib/session-builder.d.ts +0 -12
- package/lib/session-builder.js +0 -153
- package/lib/session-cipher.d.ts +0 -29
- package/lib/session-cipher.js +0 -326
- package/lib/session-record.d.ts +0 -109
- package/lib/session-record.js +0 -286
- package/lib/types.d.ts +0 -42
- package/lib/types.js +0 -1
- package/lib/util.d.ts +0 -2
- package/lib/util.js +0 -10
- package/lib/whisper-text-protocol.d.ts +0 -3
- package/lib/whisper-text-protocol.js +0 -483
package/lib/session-record.js
DELETED
|
@@ -1,286 +0,0 @@
|
|
|
1
|
-
import { BaseKeyType } from './base-key-type.js';
|
|
2
|
-
import { getLogger } from './logger.js';
|
|
3
|
-
const CLOSED_SESSIONS_MAX = 40;
|
|
4
|
-
const SESSION_RECORD_VERSION = 'v1';
|
|
5
|
-
function assertBuffer(value) {
|
|
6
|
-
if (!Buffer.isBuffer(value)) {
|
|
7
|
-
throw new TypeError('Buffer required');
|
|
8
|
-
}
|
|
9
|
-
}
|
|
10
|
-
export class SessionEntry {
|
|
11
|
-
constructor() {
|
|
12
|
-
this._chains = {};
|
|
13
|
-
}
|
|
14
|
-
toString() {
|
|
15
|
-
const baseKey = this.indexInfo && this.indexInfo.baseKey && this.indexInfo.baseKey.toString('base64');
|
|
16
|
-
return `<SessionEntry [baseKey=${baseKey}]>`;
|
|
17
|
-
}
|
|
18
|
-
inspect() {
|
|
19
|
-
return this.toString();
|
|
20
|
-
}
|
|
21
|
-
addChain(key, value) {
|
|
22
|
-
assertBuffer(key);
|
|
23
|
-
const id = key.toString('base64');
|
|
24
|
-
if (Object.prototype.hasOwnProperty.call(this._chains, id)) {
|
|
25
|
-
throw new Error('Overwrite attempt');
|
|
26
|
-
}
|
|
27
|
-
this._chains[id] = value;
|
|
28
|
-
}
|
|
29
|
-
getChain(key) {
|
|
30
|
-
assertBuffer(key);
|
|
31
|
-
return this._chains[key.toString('base64')];
|
|
32
|
-
}
|
|
33
|
-
deleteChain(key) {
|
|
34
|
-
assertBuffer(key);
|
|
35
|
-
const id = key.toString('base64');
|
|
36
|
-
if (!Object.prototype.hasOwnProperty.call(this._chains, id)) {
|
|
37
|
-
throw new ReferenceError('Not Found');
|
|
38
|
-
}
|
|
39
|
-
delete this._chains[id];
|
|
40
|
-
}
|
|
41
|
-
*chains() {
|
|
42
|
-
for (const [k, v] of Object.entries(this._chains)) {
|
|
43
|
-
yield [Buffer.from(k, 'base64'), v];
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
serialize() {
|
|
47
|
-
const data = {
|
|
48
|
-
registrationId: this.registrationId,
|
|
49
|
-
currentRatchet: {
|
|
50
|
-
ephemeralKeyPair: {
|
|
51
|
-
pubKey: this.currentRatchet.ephemeralKeyPair.pubKey.toString('base64'),
|
|
52
|
-
privKey: this.currentRatchet.ephemeralKeyPair.privKey.toString('base64')
|
|
53
|
-
},
|
|
54
|
-
lastRemoteEphemeralKey: this.currentRatchet.lastRemoteEphemeralKey.toString('base64'),
|
|
55
|
-
previousCounter: this.currentRatchet.previousCounter,
|
|
56
|
-
rootKey: this.currentRatchet.rootKey.toString('base64')
|
|
57
|
-
},
|
|
58
|
-
indexInfo: {
|
|
59
|
-
baseKey: this.indexInfo.baseKey.toString('base64'),
|
|
60
|
-
baseKeyType: this.indexInfo.baseKeyType,
|
|
61
|
-
closed: this.indexInfo.closed,
|
|
62
|
-
used: this.indexInfo.used,
|
|
63
|
-
created: this.indexInfo.created,
|
|
64
|
-
remoteIdentityKey: this.indexInfo.remoteIdentityKey.toString('base64')
|
|
65
|
-
},
|
|
66
|
-
_chains: SessionEntry._serializeChains(this._chains)
|
|
67
|
-
};
|
|
68
|
-
if (this.pendingPreKey) {
|
|
69
|
-
data.pendingPreKey = {
|
|
70
|
-
...this.pendingPreKey,
|
|
71
|
-
baseKey: this.pendingPreKey.baseKey.toString('base64')
|
|
72
|
-
};
|
|
73
|
-
}
|
|
74
|
-
return data;
|
|
75
|
-
}
|
|
76
|
-
static deserialize(data) {
|
|
77
|
-
const obj = new SessionEntry();
|
|
78
|
-
obj.registrationId = data.registrationId;
|
|
79
|
-
obj.currentRatchet = {
|
|
80
|
-
ephemeralKeyPair: {
|
|
81
|
-
pubKey: Buffer.from(data.currentRatchet.ephemeralKeyPair.pubKey, 'base64'),
|
|
82
|
-
privKey: Buffer.from(data.currentRatchet.ephemeralKeyPair.privKey, 'base64')
|
|
83
|
-
},
|
|
84
|
-
lastRemoteEphemeralKey: Buffer.from(data.currentRatchet.lastRemoteEphemeralKey, 'base64'),
|
|
85
|
-
previousCounter: data.currentRatchet.previousCounter,
|
|
86
|
-
rootKey: Buffer.from(data.currentRatchet.rootKey, 'base64')
|
|
87
|
-
};
|
|
88
|
-
obj.indexInfo = {
|
|
89
|
-
baseKey: Buffer.from(data.indexInfo.baseKey, 'base64'),
|
|
90
|
-
baseKeyType: data.indexInfo.baseKeyType,
|
|
91
|
-
closed: data.indexInfo.closed,
|
|
92
|
-
used: data.indexInfo.used,
|
|
93
|
-
created: data.indexInfo.created,
|
|
94
|
-
remoteIdentityKey: Buffer.from(data.indexInfo.remoteIdentityKey, 'base64')
|
|
95
|
-
};
|
|
96
|
-
obj._chains = SessionEntry._deserializeChains(data._chains);
|
|
97
|
-
if (data.pendingPreKey) {
|
|
98
|
-
obj.pendingPreKey = {
|
|
99
|
-
...data.pendingPreKey,
|
|
100
|
-
baseKey: Buffer.from(data.pendingPreKey.baseKey, 'base64')
|
|
101
|
-
};
|
|
102
|
-
}
|
|
103
|
-
return obj;
|
|
104
|
-
}
|
|
105
|
-
static _serializeChains(chains) {
|
|
106
|
-
const r = {};
|
|
107
|
-
for (const key of Object.keys(chains)) {
|
|
108
|
-
const c = chains[key];
|
|
109
|
-
const messageKeys = {};
|
|
110
|
-
for (const [idx, mk] of Object.entries(c.messageKeys)) {
|
|
111
|
-
messageKeys[Number(idx)] = mk.toString('base64');
|
|
112
|
-
}
|
|
113
|
-
r[key] = {
|
|
114
|
-
chainKey: {
|
|
115
|
-
counter: c.chainKey.counter,
|
|
116
|
-
key: c.chainKey.key && c.chainKey.key.toString('base64')
|
|
117
|
-
},
|
|
118
|
-
chainType: c.chainType,
|
|
119
|
-
messageKeys
|
|
120
|
-
};
|
|
121
|
-
}
|
|
122
|
-
return r;
|
|
123
|
-
}
|
|
124
|
-
static _deserializeChains(chainsData) {
|
|
125
|
-
const r = {};
|
|
126
|
-
for (const key of Object.keys(chainsData)) {
|
|
127
|
-
const c = chainsData[key];
|
|
128
|
-
const messageKeys = {};
|
|
129
|
-
for (const [idx, mk] of Object.entries(c.messageKeys)) {
|
|
130
|
-
messageKeys[Number(idx)] = Buffer.from(mk, 'base64');
|
|
131
|
-
}
|
|
132
|
-
r[key] = {
|
|
133
|
-
chainKey: {
|
|
134
|
-
counter: c.chainKey.counter,
|
|
135
|
-
key: c.chainKey.key ? Buffer.from(c.chainKey.key, 'base64') : undefined
|
|
136
|
-
},
|
|
137
|
-
chainType: c.chainType,
|
|
138
|
-
messageKeys
|
|
139
|
-
};
|
|
140
|
-
}
|
|
141
|
-
return r;
|
|
142
|
-
}
|
|
143
|
-
}
|
|
144
|
-
const migrations = [
|
|
145
|
-
{
|
|
146
|
-
version: 'v1',
|
|
147
|
-
migrate(data) {
|
|
148
|
-
const sessions = data._sessions;
|
|
149
|
-
if (data.registrationId) {
|
|
150
|
-
for (const key in sessions) {
|
|
151
|
-
if (!sessions[key].registrationId) {
|
|
152
|
-
sessions[key].registrationId = data.registrationId;
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
}
|
|
156
|
-
else {
|
|
157
|
-
for (const key in sessions) {
|
|
158
|
-
if (sessions[key].indexInfo.closed === -1) {
|
|
159
|
-
getLogger().warn('V1 session storage migration error: missing registrationId for open session', {
|
|
160
|
-
registrationId: data.registrationId,
|
|
161
|
-
version: data.version
|
|
162
|
-
});
|
|
163
|
-
}
|
|
164
|
-
}
|
|
165
|
-
}
|
|
166
|
-
}
|
|
167
|
-
}
|
|
168
|
-
];
|
|
169
|
-
export class SessionRecord {
|
|
170
|
-
constructor() {
|
|
171
|
-
this.sessions = {};
|
|
172
|
-
this.version = SESSION_RECORD_VERSION;
|
|
173
|
-
}
|
|
174
|
-
static createEntry() {
|
|
175
|
-
return new SessionEntry();
|
|
176
|
-
}
|
|
177
|
-
static migrate(data) {
|
|
178
|
-
let run = data.version === undefined;
|
|
179
|
-
for (const migration of migrations) {
|
|
180
|
-
if (run) {
|
|
181
|
-
migration.migrate(data);
|
|
182
|
-
}
|
|
183
|
-
else if (migration.version === data.version) {
|
|
184
|
-
run = true;
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
if (!run) {
|
|
188
|
-
throw new Error('Error migrating SessionRecord');
|
|
189
|
-
}
|
|
190
|
-
}
|
|
191
|
-
static deserialize(data) {
|
|
192
|
-
const parsed = JSON.parse(Buffer.from(data).toString('utf-8'));
|
|
193
|
-
if (parsed.version !== SESSION_RECORD_VERSION) {
|
|
194
|
-
SessionRecord.migrate(parsed);
|
|
195
|
-
}
|
|
196
|
-
const obj = new SessionRecord();
|
|
197
|
-
if (parsed._sessions) {
|
|
198
|
-
for (const [key, entry] of Object.entries(parsed._sessions)) {
|
|
199
|
-
obj.sessions[key] = SessionEntry.deserialize(entry);
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
return obj;
|
|
203
|
-
}
|
|
204
|
-
serialize() {
|
|
205
|
-
const _sessions = {};
|
|
206
|
-
for (const [key, entry] of Object.entries(this.sessions)) {
|
|
207
|
-
_sessions[key] = entry.serialize();
|
|
208
|
-
}
|
|
209
|
-
return Buffer.from(JSON.stringify({ _sessions, version: this.version }), 'utf-8');
|
|
210
|
-
}
|
|
211
|
-
haveOpenSession() {
|
|
212
|
-
const openSession = this.getOpenSession();
|
|
213
|
-
return !!openSession && typeof openSession.registrationId === 'number';
|
|
214
|
-
}
|
|
215
|
-
getSession(key) {
|
|
216
|
-
assertBuffer(key);
|
|
217
|
-
const session = this.sessions[key.toString('base64')];
|
|
218
|
-
if (session && session.indexInfo.baseKeyType === BaseKeyType.OURS) {
|
|
219
|
-
throw new Error('Tried to lookup a session using our basekey');
|
|
220
|
-
}
|
|
221
|
-
return session;
|
|
222
|
-
}
|
|
223
|
-
getOpenSession() {
|
|
224
|
-
for (const session of Object.values(this.sessions)) {
|
|
225
|
-
if (!this.isClosed(session)) {
|
|
226
|
-
return session;
|
|
227
|
-
}
|
|
228
|
-
}
|
|
229
|
-
return undefined;
|
|
230
|
-
}
|
|
231
|
-
setSession(session) {
|
|
232
|
-
this.sessions[session.indexInfo.baseKey.toString('base64')] = session;
|
|
233
|
-
}
|
|
234
|
-
getSessions() {
|
|
235
|
-
return Array.from(Object.values(this.sessions)).sort((a, b) => {
|
|
236
|
-
const aUsed = a.indexInfo.used || 0;
|
|
237
|
-
const bUsed = b.indexInfo.used || 0;
|
|
238
|
-
return aUsed === bUsed ? 0 : aUsed < bUsed ? 1 : -1;
|
|
239
|
-
});
|
|
240
|
-
}
|
|
241
|
-
closeSession(session) {
|
|
242
|
-
if (this.isClosed(session)) {
|
|
243
|
-
return;
|
|
244
|
-
}
|
|
245
|
-
session.indexInfo.closed = Date.now();
|
|
246
|
-
}
|
|
247
|
-
openSession(session) {
|
|
248
|
-
session.indexInfo.closed = -1;
|
|
249
|
-
}
|
|
250
|
-
isClosed(session) {
|
|
251
|
-
return session.indexInfo.closed !== -1;
|
|
252
|
-
}
|
|
253
|
-
removeOldSessions() {
|
|
254
|
-
while (Object.keys(this.sessions).length > CLOSED_SESSIONS_MAX) {
|
|
255
|
-
let oldestKey;
|
|
256
|
-
let oldestSession;
|
|
257
|
-
for (const [key, session] of Object.entries(this.sessions)) {
|
|
258
|
-
if (session.indexInfo.closed !== -1 &&
|
|
259
|
-
(!oldestSession || session.indexInfo.closed < oldestSession.indexInfo.closed)) {
|
|
260
|
-
oldestKey = key;
|
|
261
|
-
oldestSession = session;
|
|
262
|
-
}
|
|
263
|
-
}
|
|
264
|
-
if (oldestKey) {
|
|
265
|
-
delete this.sessions[oldestKey];
|
|
266
|
-
}
|
|
267
|
-
else {
|
|
268
|
-
throw new Error('Corrupt sessions object');
|
|
269
|
-
}
|
|
270
|
-
}
|
|
271
|
-
}
|
|
272
|
-
removeStaleSessions(maxAgeMs) {
|
|
273
|
-
const cutoff = Date.now() - maxAgeMs;
|
|
274
|
-
for (const [key, session] of Object.entries(this.sessions)) {
|
|
275
|
-
const lastUsed = session.indexInfo.used || session.indexInfo.created || 0;
|
|
276
|
-
if (session.indexInfo.closed !== -1 && lastUsed < cutoff) {
|
|
277
|
-
delete this.sessions[key];
|
|
278
|
-
}
|
|
279
|
-
}
|
|
280
|
-
}
|
|
281
|
-
deleteAllSessions() {
|
|
282
|
-
for (const key of Object.keys(this.sessions)) {
|
|
283
|
-
delete this.sessions[key];
|
|
284
|
-
}
|
|
285
|
-
}
|
|
286
|
-
}
|
package/lib/types.d.ts
DELETED
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
import type { KeyPair } from './curve.js';
|
|
2
|
-
import type { Direction } from './direction.js';
|
|
3
|
-
import type { SessionRecord } from './session-record.js';
|
|
4
|
-
export type { KeyPair };
|
|
5
|
-
export interface SignalStorage {
|
|
6
|
-
loadSession(id: string): Promise<SessionRecord | undefined>;
|
|
7
|
-
storeSession(id: string, session: SessionRecord): Promise<void>;
|
|
8
|
-
isTrustedIdentity(identifier: string, identityKey: Buffer, direction: Direction): Promise<boolean> | boolean;
|
|
9
|
-
saveIdentity?(identifier: string, identityKey: Buffer): Promise<boolean> | boolean;
|
|
10
|
-
removeIdentity?(identifier: string): Promise<void> | void;
|
|
11
|
-
loadPreKey(id?: number | string): Promise<KeyPair | undefined>;
|
|
12
|
-
removePreKey(id: number): Promise<void> | void;
|
|
13
|
-
loadSignedPreKey(id?: number | string): Promise<KeyPair | undefined> | KeyPair | undefined;
|
|
14
|
-
getOurRegistrationId(): Promise<number> | number;
|
|
15
|
-
getOurIdentity(): Promise<KeyPair> | KeyPair;
|
|
16
|
-
}
|
|
17
|
-
export interface DeviceKeyBundle {
|
|
18
|
-
registrationId: number;
|
|
19
|
-
identityKey: Buffer;
|
|
20
|
-
signedPreKey: {
|
|
21
|
-
keyId: number;
|
|
22
|
-
publicKey: Buffer;
|
|
23
|
-
signature: Buffer;
|
|
24
|
-
};
|
|
25
|
-
preKey?: {
|
|
26
|
-
keyId: number;
|
|
27
|
-
publicKey: Buffer;
|
|
28
|
-
};
|
|
29
|
-
}
|
|
30
|
-
export interface IncomingPreKeyMessage {
|
|
31
|
-
registrationId?: number;
|
|
32
|
-
identityKey: Buffer;
|
|
33
|
-
baseKey: Buffer;
|
|
34
|
-
preKeyId?: number;
|
|
35
|
-
signedPreKeyId?: number;
|
|
36
|
-
message: Buffer;
|
|
37
|
-
}
|
|
38
|
-
export interface EncryptedMessage {
|
|
39
|
-
type: number;
|
|
40
|
-
body: Buffer;
|
|
41
|
-
registrationId?: number;
|
|
42
|
-
}
|
package/lib/types.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
package/lib/util.d.ts
DELETED
package/lib/util.js
DELETED