| 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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400 |
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
376x
83x
2x
152x
49x
49x
49x
2x
1x
1x
2x
2x
784x
784x
784x
2x
2x
784x
784x
11x
11x
7x
4x
4x
11x
784x
2x
609x
609x
609x
609x
609x
8x
601x
2x
601x
601x
2x
587x
587x
587x
587x
587x
587x
7x
580x
580x
580x
580x
580x
108x
108x
472x
472x
472x
472x
472x
472x
580x
472x
2x
163x
163x
163x
163x
163x
163x
163x
163x
163x
163x
163x
163x
30x
133x
133x
163x
3x
160x
163x
160x
2x
12x
12x
12x
12x
12x
11x
2x
22x
22x
22x
22x
1x
21x
21x
21x
21x
21x
21x
21x
78x
78x
78x
78x
21x
57x
57x
57x
57x
57x
57x
57x
57x
57x
57x
113x
57x
57x
57x
57x
57x
21x
21x
2x
26x
26x
26x
26x
143x
143x
143x
143x
143x
143x
26x
26x
2x
28x
28x
28x
28x
28x
261x
261x
261x
28x
28x
2x
16x
2x
21x
| /*
* Windows Registry Settings Handler
*
* Copyright 2012, 2014 Raising the Floor - International
* Copyright 2012 Antranig Basman
* Copyright 2012 Astea Solutions AD
*
* Licensed under the New BSD license. You may not use this file except in
* compliance with this License.
*
* The research leading to these results has received funding from the European Union's
* Seventh Framework Programme (FP7/2007-2013)
* under grant agreement no. 289016.
*
* You may obtain a copy of the License at
* https://github.com/GPII/universal/blob/master/LICENSE.txt
*/
"use strict";
var ffi = require("ffi"),
ref = require("ref"),
fluid = require("universal");
require("../../WindowsUtilities/WindowsUtilities.js");
var gpii = fluid.registerNamespace("gpii");
var windows = fluid.registerNamespace("gpii.windows");
fluid.registerNamespace("gpii.windows.registrySettingsHandler");
var NULL = ref.NULL;
// Guide to node_ffi types and conversions:
// https://github.com/rbranson/node-ffi/wiki/Node-FFI-Tutorial
var advapi32 = new ffi.Library("advapi32", {
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724897(v=vs.85).aspx
// HKEY, LPCWSTR, DWORD, REGSAM, PHKEY
// Note abuse of type of argument 1 - node_ffi doesn't allow us to forge pointers from integers directly,
// as required by base keys
RegOpenKeyExW: [
"int32", ["uint32", "pointer", "uint32", "uint32", "pointer"]
],
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724837(v=vs.85).aspx
// HKEY
RegCloseKey: [
"long", ["uint32"]
],
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724911(v=vs.85).aspx
// HKEY, LPCWSTR, LPDWORD, LPDWORD, LPBYTE, LPDWORD
RegQueryValueExW: [
"int32", ["uint32", "pointer", "pointer", "pointer", "pointer", "pointer"]
],
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724844(v=vs.85).aspx
// HKEY, LPCWSTR, DWORD, LPWSTR, DWORD, REGSAM, LPSECURITY_ATTRIBUTES, PHKEY, LPDWORD
// Similar abuse to RegOpenKeyExW
RegCreateKeyExW: [
"long", ["uint32", "pointer", "uint32", "pointer", "uint32", "uint32", "pointer", "pointer", "pointer"]
],
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724923(v=vs.85).aspx
// HKEY, LPCWSTR, DWORD, DWORD, const BYTE*, DWORD
RegSetValueExW: [
"long", ["uint32", "pointer", "uint32", "uint32", "pointer", "uint32"]
],
// https://msdn.microsoft.com/library/ms724847
// HKEY, LPCWSTR
// Similar abuse to RegOpenKeyExW - for convenience, only accepts base keys
RegDeleteKeyExW: [
"long", ["uint32", "pointer", "uint32", "ulong"]
],
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724851(v=vs.85).aspx
// HKEY, LPCWSTR
RegDeleteValueW: [
"long", ["uint32", "pointer"]
],
// https://msdn.microsoft.com/en-us/library/windows/desktop/ms724865(v=vs.85).aspx
// HKEY, DWORD, LPTSTR, LPDWORD, LPDWORD, LPDWORD, LPBYTE, LPDWORD
// Similar abuse to RegOpenKeyExW - for convenience, only accepts base keys
RegEnumValueW: [
"int32", ["uint32", "uint32", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer"]
]
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724847(v=vs.85).aspx
// This API is disused since it was introduced only on Windows Server 2003 (XP support required)
// HKEY, LPCWSTR, REGSAM, DWORD
//RegDeleteKeyExW: [
// "long", ["uint32", "pointer", "uint32", "uint32"]
//]
});
windows.registryTypes = {};
windows.registryTypes.REG_SZ = {
code: 1,
readConvert: function (pointer) {
return windows.fromWideChar(pointer);
},
writeConvert: function (value) {
return windows.toWideChar(value);
}
};
windows.registryTypes.REG_DWORD = {
code: 4,
readConvert: function (pointer) {
return pointer.readUInt32LE(0);
},
writeConvert: function (value) {
var pointer = new Buffer(4);
pointer.writeUInt32LE(Number(value), 0);
return {
pointer: pointer,
length: 4
};
}
};
windows.registryTypes.REG_BINARY = {
code: 3,
readConvert: function (pointer, count) {
return gpii.pointerToHex(pointer, count);
},
writeConvert: function (value) {
return gpii.hexToPointer(value);
}
};
var c = windows.API_constants;
windows.getBaseKey = function (baseKey) {
var key = c[baseKey];
Iif (key === undefined) {
fluid.fail("Unknown registry base key " + baseKey);
}
return key;
};
var cr = windows.checkReturnCode;
/**
* Parses a registry key path, allowing to specify if the 32 or 64-bit view should be used instead of the one correct
* for the processes. The view is specified by prefixing the real path with "32:" or "64:" (eg, "64:Software\GPII").
* Currently, this is only used when retrieving the MachineGuid.
*
* The return object contains the real path, and a value (KEY_WOW64_64KEY, KEY_WOW64_32KEY, or 0) to bitwise "or" with
* the samDesired parameter of RegCreateKeyEx,
* RegOpenKeyEx, or RegDeleteKeyEx.
*
* @param path {String} The path
* @return {Object} Object containing the real path, and access mask.
*/
windows.parseRegistryPath = function (path) {
var togo = {
desiredAccess: 0,
realPath: path
};
// To explicitly use either the 32 or 64bit view, prepend the path with "32:" or "64:".
if (path[2] === ":") {
var bits = path.substr(0, 2);
if (bits === "64") {
togo.desiredAccess |= c.KEY_WOW64_64KEY;
} else Eif (bits === "32") {
togo.desiredAccess |= c.KEY_WOW64_32KEY;
}
togo.realPath = path.substr(3);
}
return togo;
};
windows.openRegistryKey = function (baseKey, path, keyHolder) {
var regPath = windows.parseRegistryPath(path);
var pathW = windows.ensureAlignment(windows.toWideChar(regPath.realPath).pointer);
var base = windows.getBaseKey(baseKey);
var code = advapi32.RegOpenKeyExW(base, pathW, 0, regPath.desiredAccess | c.KEY_QUERY_VALUE, keyHolder);
if (code === windows.API_constants.returnCodes.FILE_NOT_FOUND) {
return {
statusCode: 404
};
}
cr(code);
};
windows.closeRegistryKey = function (keyHolder) {
var code4 = advapi32.RegCloseKey(keyHolder.readUInt32LE(0));
cr(code4);
};
windows.readRegistryKey = function (baseKey, path, subKey, type) {
var converter = windows.registryTypes[type];
Iif (!converter) {
fluid.fail("Unsupported registry type " + type);
}
var togo = {
statusCode: 200
};
var keyHolder = new Buffer(4);
var openError = windows.openRegistryKey(baseKey, path, keyHolder);
if (openError) {
return openError;
}
try {
var subKeyW = windows.ensureAlignment(windows.toWideChar(subKey).pointer);
var dataLength = new Buffer(4);
var code2 = advapi32.RegQueryValueExW(keyHolder.readUInt32LE(0), subKeyW, NULL, NULL, NULL, dataLength);
if (code2 === windows.API_constants.returnCodes.FILE_NOT_FOUND) {
togo.statusCode = 404;
return togo;
}
cr(code2);
togo.bytes = dataLength.readInt32LE(0);
var valueHolder = new Buffer(togo.bytes);
var code3 = advapi32.RegQueryValueExW(keyHolder.readUInt32LE(0), subKeyW, NULL, NULL, valueHolder, dataLength);
cr(code3);
togo.value = converter.readConvert(valueHolder, togo.bytes);
} finally {
windows.closeRegistryKey(keyHolder);
}
return togo;
};
windows.writeRegistryKey = function (baseKey, path, subKey, value, type) {
var converter = windows.registryTypes[type];
Iif (!converter) {
fluid.fail("Unsupported registry type " + type);
}
var togo = {
statusCode: 200
};
var regPath = windows.parseRegistryPath(path);
var pathW = windows.ensureAlignment(windows.toWideChar(regPath.realPath).pointer);
var keyHolder = new Buffer(4);
var base = windows.getBaseKey(baseKey);
var code = advapi32.RegCreateKeyExW(base, pathW, 0, NULL, 0, regPath.desiredAccess | c.KEY_SET_VALUE, NULL,
keyHolder, NULL);
cr(code);
try {
var subKeyW = windows.ensureAlignment(windows.toWideChar(subKey).pointer);
var code2;
if (value === undefined) {
code2 = advapi32.RegDeleteValueW(keyHolder.readUInt32LE(0), subKeyW);
} else {
var converted = converter.writeConvert(value);
code2 = advapi32.RegSetValueExW(keyHolder.readUInt32LE(0), subKeyW, 0, converter.code, converted.pointer, converted.length);
}
if (value === undefined && code2 === windows.API_constants.returnCodes.FILE_NOT_FOUND) { // Do not fail if delete was requested for nonexistent key
return togo;
}
// TODO: consider plausible errors which might result from this process
cr(code2);
} finally {
advapi32.RegCloseKey(keyHolder.readUInt32LE(0));
}
return togo;
};
// Note that this function cannot delete keys recursively. RegDeleteKeyExW is not available
// as a result of requirement for Windows XP level API support. This functionality can be
// implemented manually on top of this existing API if required.
// NB: This utility is currently used only to clean up state from within test cases
windows.deleteRegistryKey = function (baseKey, path) {
var regPath = windows.parseRegistryPath(path);
var pathW = windows.ensureAlignment(windows.toWideChar(regPath.realPath).pointer);
var base = windows.getBaseKey(baseKey);
var code = advapi32.RegDeleteKeyExW(base, pathW, regPath.desiredAccess, 0);
// Do not fail if delete was requested for nonexistent key
if (code !== windows.API_constants.returnCodes.FILE_NOT_FOUND) {
cr(code);
}
};
/**
* Enumerates the values in a key.
*
* @param {String} baseKey The registry base key.
* @param {String} path The key path.
* @return {*} An object containing the name, data, type, and size of each value.
*/
windows.enumRegistryValues = function (baseKey, path) {
var togo = {};
var keyHolder = new Buffer(4);
var openError = windows.openRegistryKey(baseKey, path, keyHolder);
if (openError) {
return openError;
}
try {
var maxLength = 0xffff;
var nameLength = new Buffer(4);
var typeHolder = new Buffer(4);
var nameHolder = new Buffer(maxLength);
var dataSizeHolder = new Buffer(maxLength);
for (var index = 0; ; index++) {
// Get the name, type, and data length of the next value.
nameLength.writeUInt32LE(Number(maxLength), 0);
var code2 = advapi32.RegEnumValueW(keyHolder.readUInt32LE(0), index, nameHolder, nameLength, NULL, typeHolder, NULL, dataSizeHolder);
Iif (code2 === windows.API_constants.returnCodes.FILE_NOT_FOUND) {
return togo;
} else if (code2 === windows.API_constants.returnCodes.ERROR_NO_MORE_ITEMS) {
break;
} else {
cr(code2);
}
var value = {
name: windows.fromWideChar(nameHolder),
bytes: dataSizeHolder.readInt32LE(0),
type: null,
data: null
};
togo[value.name] = value;
// Get the data for the value.
var dataHolder = new Buffer(value.bytes);
var code3 = advapi32.RegQueryValueExW(keyHolder.readUInt32LE(0), nameHolder, NULL, typeHolder, dataHolder, dataSizeHolder);
cr(code3);
// Get the type converter
var typeCode = typeHolder.readUInt32LE(0);
Iif (typeCode === 2) {
// Cater for REG_EXPAND_SZ (RegGetValue should really have been used if expansion is required)
typeCode = windows.registryTypes.REG_SZ.code;
}
var converter = null;
for (var regType in windows.registryTypes) {
if (windows.registryTypes.hasOwnProperty(regType) && windows.registryTypes[regType].code === typeCode) {
converter = windows.registryTypes[regType];
value.type = regType;
break;
}
}
Eif (converter) {
value.data = converter.readConvert(dataHolder, dataSizeHolder.readUInt32LE(0));
}
}
} finally {
windows.closeRegistryKey(keyHolder);
}
return togo;
};
windows.registrySettingsHandler.setImpl = function (payload) {
var baseKey = payload.options.hKey;
var path = payload.options.path;
var dataTypes = payload.options.dataTypes;
var results = fluid.transform(payload.settings, function (value, key) {
Iif (dataTypes[key] === undefined) {
fluid.fail("No registry dataType defined in options block for the setting " + key);
}
var dataType = dataTypes[key];
var oldValue = windows.readRegistryKey(baseKey, path, key, dataType);
var writeStatus = windows.writeRegistryKey(baseKey, path, key, value, dataType);
var newValue = windows.readRegistryKey(baseKey, path, key, dataType);
return {
oldValue: oldValue.value,
statusCode: writeStatus.statusCode,
newValue: newValue.value
};
});
fluid.log("Registry settings handler SET returning results ", results);
return results;
};
windows.registrySettingsHandler.getImpl = function (payload) {
var baseKey = payload.options.hKey;
var path = payload.options.path;
var dataTypes = payload.options.dataTypes;
Iif (dataTypes === undefined) {
fluid.fail("No registry dataTypes block defined in options. Full payload: " +
JSON.stringify(payload, null, 4));
}
var results = fluid.transform(payload.settings, function (value, key) {
Iif (dataTypes[key] === undefined) {
fluid.fail("No registry dataType defined in options block for the setting " + key);
}
var currentValue = windows.readRegistryKey(baseKey, path, key, dataTypes[key]);
return currentValue.value;
});
fluid.log("Registry settings handler GET returning results ", results);
return results;
};
windows.registrySettingsHandler.get = function (payload) {
return gpii.settingsHandlers.invokeSettingsHandler(windows.registrySettingsHandler.getImpl, payload);
};
windows.registrySettingsHandler.set = function (payload) {
return gpii.settingsHandlers.invokeSettingsHandler(windows.registrySettingsHandler.setImpl, payload);
};
|