Merge pull request CatalystCode#6 from ritazh/feat_uac

feat uac: elevate priviledge

Author: Steven Edouard

Gruntfile.js

@@ -5,6 +5,7 @@ var files = ['lib/**/*.js', 'app.js', 'test/**/*.js'];
 grunt.initConfig({
     mochacli: {
         options: {
+            timeout: 4000,
             reporter: 'spec',
             bail: true
         },

README.md

@@ -1,6 +1,6 @@
 # windows-registry-node
 
-Read and Write to the Windows registry in-process from Node.js. Easily set application file associations and other goodies & such.
+Read and Write to the Windows registry in-process from Node.js. Easily set application file associations and other goodies & such. You can also enable your application to run processes as an Administrator.
 
 ## Install
 
@@ -69,6 +69,13 @@ To write a value, you'll again need a [Key](lib/key.js) object and just need to
 ```js
 registry.setValueForKeyObject(key, 'test_value_name', windef.REG_VALUE_TYPE.REG_SZ, 'test_value');
 ``` 
+## Launching a Process as An Admin
+
+To launch a process as an Administrator, you can call the `uac.elevate` api, which will launch a process as an Administrator causing the UAC (User Account Control) elevation prompt to appear if required. This is similar to the Windows Explorer command "Run as administrator".  Pass in `FILEPATH` to the process you want to elevate. Pass in any`PARAMETERS` to run with the process. Since this is an asychronous call, pass in a callback to handle user's selection.
+
+```js
+uac.elevate('C:\\Program Files\\nodejs\\node.exe', 'index.js', function (err, result){console.log('callback');});
+```
 
 ## More Docs?
 

index.js

@@ -4,5 +4,6 @@ module.exports = {
     types: require('./lib/types'),
     windef: require('./lib/windef'),
     Key: require('./lib/key'),
-    fileAssociation: require('./lib/file_association')
+    fileAssociation: require('./lib/file_association'),
+    uac: require('./lib/uac')
 };

lib/types.js

@@ -3,10 +3,17 @@ var ref = require('ref');
 var types = {
     REGSAM: ref.types.uint64,
     DWORD: ref.types.uint32,
+    ULONG: ref.types.uint32,
+    HWND: ref.refType(ref.types.void),
     BYTE: ref.types.uint8,
     HKEY: ref.refType(ref.types.void),
     PVOID: ref.refType(ref.types.void),
-    LPCTSTR: ref.refType(ref.types.CString)
+    HANDLE: ref.refType(ref.types.void),
+    HINSTANCE: ref.refType(ref.types.void),
+    LPCTSTR: ref.refType(ref.types.CString),
+    STRING: ref.types.CString,
+    INT: ref.types.int32,
+    LPVOID: ref.refType(ref.types.void)
 };
 
 types.PHKEY = ref.refType(types.HKEY);

lib/uac.js

@@ -0,0 +1,82 @@
+'use strict';
+var ffi = require('ffi'),
+  ref = require('ref'),
+  struct = require('ref-struct'),
+  uniontype = require('ref-union'),
+  types = require('./types');
+
+// Create the SHELLEXECUTEINFO struct
+
+// yes, this is the name in the official MSDN doc
+var DUMMYUNIONNAME = uniontype({
+    hIcon: types.HANDLE,
+    hMonitor: types.HANDLE
+});
+
+var SHELLEXECUTEINFO  = struct({
+    cbSize: types.DWORD,
+    fMask: types.ULONG,
+    hwnd: types.HWND,
+    lpVerb:  types.STRING,
+    lpFile:  types.STRING,
+    lpParameters: types.STRING,
+    lpDirectory: types.STRING,
+    nShow: types.INT,
+    hInstApp: types.HINSTANCE,
+    lpIDList: types.LPVOID,
+    lpClass: types.STRING,
+    hkeyClass: types.HKEY,
+    dwHotKey: types.DWORD,
+    DUMMYUNIONNAME: DUMMYUNIONNAME,
+    hProcess: types.HANDLE
+});
+
+var SHELLEXECUTEINFOPtr = ref.refType(SHELLEXECUTEINFO);
+
+var shell32 = new ffi.Library('Shell32', {
+    ShellExecuteExA: ['bool',  [SHELLEXECUTEINFOPtr]]
+});
+
+// pass in default values for members
+var lpVerb = 'runas';
+var lpFile = null;
+var lpParameters = null;
+var hInstApp = ref.alloc(types.HINSTANCE);
+var SW_SHOWNORMAL = 0x1;
+
+var uac = {
+    FILEPATH: lpFile,
+    PARAMETERS: lpParameters,
+    elevate: function (filepath, parameters, callback) {
+        this.FILEPATH = filepath;
+        this.PARAMETERS = parameters;
+        if(this.FILEPATH === null || this.FILEPATH === '') {
+            console.log('Missing parameters FILEPATH');
+            return;
+        }
+        var shellexecuteinfoval = new SHELLEXECUTEINFO({
+            cbSize: SHELLEXECUTEINFO.size,
+            fMask: 0x00000000,
+            hwnd: null,
+            lpVerb: lpVerb,
+            lpFile: this.FILEPATH,
+            lpParameters: this.PARAMETERS,
+            lpDirectory: null,
+            nShow: SW_SHOWNORMAL,
+            hInstApp: hInstApp,
+            lpIDList: null,
+            lpCLass: null,
+            hkeyClass: null,
+            dwHotKey: null,
+            DUMMYUNIONNAME: {
+                hIcon: null,
+                hMonitor: null
+            },
+            hProcess: ref.alloc(types.HANDLE)
+        });
+
+        shell32.ShellExecuteExA.async(shellexecuteinfoval.ref(), callback);
+    }
+};
+
+module.exports = uac;

package.json

@@ -11,7 +11,9 @@
     "grunt": "^0.4.5",
     "grunt-mocha-cli": "^2.0.0",
     "load-grunt-tasks": "^3.3.0",
-    "ref": "^1.2.0"
+    "ref": "^1.2.0",
+    "ref-struct": "^1.0.2",
+    "ref-union": "^1.0.0"
   },
   "devDependencies": {
     "grunt": "^0.4.5",
@@ -34,6 +36,7 @@
     "Registry",
     "regedit",
     "file",
+    "uac",
     "association"
   ],
   "author": "sedouard",

test/uac.js

@@ -0,0 +1,51 @@
+/* global describe, it */
+'use strict';
+var uac = require('../lib/uac'),
+	assert = require('assert');
+
+describe('UAC elevate tests', () => {
+    it('Empty file path, should return', () => {
+        uac.elevate('', null, function (err, result) {
+            assert.equal(result, true);
+        });
+        assert.equal(uac.FILEPATH, '');
+    });
+
+    it('Missing file path, should return', () => {
+        uac.elevate(null, null, function (err, result) {
+            assert.equal(result, true);
+        });
+        assert.equal(uac.FILEPATH, null);
+        assert.equal(uac.PARAMETERS, null);
+    });
+
+    it('Should get results for elevate for a given file', (done) => {
+        uac.elevate('C:\\Program Files\\nodejs\\node.exe', null, function (err, result) {
+            try {
+                assert.ok(true);
+                console.log('callback');
+                assert(result !== null);
+                done();
+            } catch (x) {
+                done(x);
+            }
+        });
+        assert.equal(uac.FILEPATH, 'C:\\Program Files\\nodejs\\node.exe');
+        assert.equal(uac.PARAMETERS, null);
+    });
+
+    it('Should get results for elevate for a given file and parameter', (done) => {
+        uac.elevate('C:\\Program Files\\nodejs\\node.exe', '--version', function (err, result) {
+            try {
+                assert.ok(true);
+                console.log('callback');
+                assert(result !== null);
+                done();
+            } catch (x) {
+                done(x);
+            }
+        });
+        assert.equal(uac.FILEPATH, 'C:\\Program Files\\nodejs\\node.exe');
+        assert.equal(uac.PARAMETERS, '--version');
+    });
+});