shoneslab / nodejs-winrm Goto Github PK

Make WinRM service calls from NodeJS

License: MIT License

JavaScript 100.00%

nodejs-winrm's Introduction

nodejs-winrm

nodejs-winrm is a NodeJS client to access WinRM (Windows Remote Management) SOAP web service. It allows to execute commands on target windows machines. Please visit Microsoft's WinRM site for WINRM details.

Supported NodeJS Versions

Tested on NodeJS Version > 8.11

Supported WinRM Versions

As of now Winrm Version 3 is tested.

> winrm id

IdentifyResponse
    ProtocolVersion = http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd
    ProductVendor = Microsoft Corporation
    ProductVersion = OS: 10.0.xxxx SP: 0.0 Stack: 3.0

Install

On the remote host, a PowerShell prompt, using the Run as Administrator option and paste in the following lines:

> winrm quickconfig
y
> winrm set winrm/config/service/Auth '@{Basic="true"}'
> winrm set winrm/config/service '@{AllowUnencrypted="true"}'
> winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="1024"}'

On the client side where NodeJS is installed

npm install nodejs-winrm

Examples

Run a Single Command

var winrm = require('nodejs-winrm');
winrm.runCommand('mkdir D:\\winrmtest001', '10.xxx.xxx.xxx', 'username', 'password', 5985);
winrm.runCommand('ipconfig /all', '10.xxx.xxx.xxx', 'username', 'password', 5985);

Run multiple Commands (Advanced)

var winrm = require('nodejs-winrm');

var userName = 'userName';
var password = 'password';
var _host = '10.xxx.xxx.xxx';
var _port = 5985;

var auth = 'Basic ' + Buffer.from(userName + ":" + password, 'utf8').toString('base64');
var params = {
    host: _host,
    port: _port,
    path: '/wsman'
};
params['auth'] = auth;

//Get the Shell ID
params['shellId']= await winrm.shell.doCreateShell(params);

// Execute Command1
params['command'] = 'ipconfig /all';
params['commandId'] = await winrm.command.doExecuteCommand(params);
var result1= await winrm.command.doReceiveOutput(params);

// Execute Command2
params['command'] = 'mkdir D:\\winrmtest001';
params['commandId'] = await winrm.command.doExecuteCommand(params);
var result2= await winrm.command.doReceiveOutput(params);

// Close the Shell
await winrm.shell.doDeleteShell(params);

Testing

npm test

Maintainers

Shone Jacob (https://github.com/shoneslab)

Credits

https://github.com/jacobludriks/winrmjs

nodejs-winrm's People

Contributors

Stargazers

Watchers

Forkers

elvy1991 tw00 domotz netcuras stormbard octravis droobah usman-invozone asscat1337 ua1wcz

nodejs-winrm's Issues

New Version Should Be Uploaded to NPM

Hi,

I see you have fixed the new Buffer issue 8 months ago. Unfortunately we could not use it because NPM package is still old. Can you create a new version with that change?

Minor error in advanced example

var auth = 'Basic' + Buffer.from(userName + ":" + password, 'utf8').toString('base64');

should be

var auth = 'Basic ' + Buffer.from(userName + ":" + password, 'utf8').toString('base64');

(note the space after "Basic")

Also it should probably be ipconfig instead of ipaddress ;-)

resolve, reject in http.js missing return


> http.js line 33

       if (err) {
           reject(new Error('Data Parsing error', err));
       }
       resolve(result);

This leads to resolve and reject promise at once.

error Failed to process the request, status Code: 500 with an non admin WinRM Account

Hi there,

I'm encountering an issue where I'm unable to execute certain queries using a non-administrator remote account with these modules. While it works flawlessly with an account that has administrator privileges on the remote server, it doesn't work with a standard account. Interestingly, the non-administrator account functions properly; I can do WinRM from my Windows laptop using the non administrator account without any problems.
Someone know something about this problem ?

Thank !

Sincerely, Jérémy

Error: Failed to process the request, status Code

Error: Failed to process the request, status Code:
at ClientRequest.http.request (/home/jnm/node_modules/nodejs-winrm/src/http.js:22:24)

I have verified winrm setup with python code. winrm id returns:

C:\Windows\system32>winrm id
IdentifyResponse
ProtocolVersion = http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd
ProductVendor = Microsoft Corporation
ProductVersion = OS: 10.0.14393 SP: 0.0 Stack: 3.0
SecurityProfiles
SecurityProfileName = http://schemas.dmtf.org/wbem/wsman/1/wsman/secprofile/http/basic, http://schemas.dmtf.org/wbem/wsman/1/wsman/secprofile/http/spnego-kerberos

I think it is related to ntlm. Please help.

When trying to reach the above system, it takes so much time, giving ECONRESET error. The above system requires VPN to get connected.
Do let us know.