amt-wsman.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. /*
  2. Copyright 2020-2021 Intel Corporation
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. @description Intel AMT WSMAN Stack
  13. @author Ylian Saint-Hilaire
  14. @version v0.3.0
  15. */
  16. /*jslint node: true */
  17. /*jshint node: true */
  18. /*jshint strict:false */
  19. /*jshint -W097 */
  20. /*jshint esversion: 6 */
  21. "use strict";
  22. // Construct a WSMAN stack object
  23. function WsmanStackCreateService(comm)
  24. {
  25. var obj = {_ObjectID: 'WSMAN'};
  26. //obj.onDebugMessage = null; // Set to a function if you want to get debug messages.
  27. obj.NextMessageId = 1; // Next message number, used to label WSMAN calls.
  28. obj.Address = '/wsman';
  29. obj.xmlParser = require('./amt-xml.js');
  30. obj.comm = comm;
  31. obj.PerformAjax = function PerformAjax(postdata, callback, tag, pri, namespaces) {
  32. if (namespaces == null) namespaces = '';
  33. obj.comm.PerformAjax('<?xml version=\"1.0\" encoding=\"utf-8\"?><Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd" xmlns=\"http://www.w3.org/2003/05/soap-envelope\" ' + namespaces + '><Header><a:Action>' + postdata, function (data, status, tag) {
  34. var wsresponse = null;
  35. if (data != null) { try { wsresponse = obj.xmlParser.ParseWsman(data); } catch (ex) { } }
  36. if ((data != null) && (!wsresponse || wsresponse == null) && (status == 200)) {
  37. callback(obj, null, { Header: { HttpError: status } }, 601, tag);
  38. } else {
  39. if (status != 200) {
  40. if (wsresponse == null) { wsresponse = { Header: {} }; }
  41. wsresponse.Header.HttpError = status;
  42. try { wsresponse.Header.WsmanError = wsresponse.Body['Reason']['Text']['Value']; } catch (ex) { }
  43. }
  44. callback(obj, wsresponse.Header['ResourceURI'], wsresponse, status, tag);
  45. }
  46. }, tag, pri);
  47. }
  48. // Private method
  49. //obj.Debug = function (msg) { /*console.log(msg);*/ }
  50. // Cancel all pending queries with given status
  51. obj.CancelAllQueries = function CancelAllQueries(s) { obj.comm.CancelAllQueries(s); }
  52. // Get the last element of a URI string
  53. obj.GetNameFromUrl = function (resuri) {
  54. var x = resuri.lastIndexOf("/");
  55. return (x == -1)?resuri:resuri.substring(x + 1);
  56. }
  57. // Perform a WSMAN Subscribe operation
  58. obj.ExecSubscribe = function ExecSubscribe(resuri, delivery, url, callback, tag, pri, selectors, opaque, user, pass) {
  59. var digest = "", digest2 = "", opaque = "";
  60. if (user != null && pass != null) { digest = '<t:IssuedTokens xmlns:t="http://schemas.xmlsoap.org/ws/2005/02/trust" xmlns:se="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><t:RequestSecurityTokenResponse><t:TokenType>http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#UsernameToken</t:TokenType><t:RequestedSecurityToken><se:UsernameToken><se:Username>' + user + '</se:Username><se:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd#PasswordText">' + pass + '</se:Password></se:UsernameToken></t:RequestedSecurityToken></t:RequestSecurityTokenResponse></t:IssuedTokens>'; digest2 = '<w:Auth Profile="http://schemas.dmtf.org/wbem/wsman/1/wsman/secprofile/http/digest"/>'; }
  61. if (opaque != null) { opaque = '<a:ReferenceParameters><m:arg>' + opaque + '</m:arg></a:ReferenceParameters>'; }
  62. if (delivery == 'PushWithAck') { delivery = 'dmtf.org/wbem/wsman/1/wsman/PushWithAck'; } else if (delivery == 'Push') { delivery = 'xmlsoap.org/ws/2004/08/eventing/DeliveryModes/Push'; }
  63. var data = "http://schemas.xmlsoap.org/ws/2004/08/eventing/Subscribe</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>" + _PutObjToSelectorsXml(selectors) + digest + '</Header><Body><e:Subscribe><e:Delivery Mode="http://schemas.' + delivery + '"><e:NotifyTo><a:Address>' + url + '</a:Address>' + opaque + '</e:NotifyTo>' + digest2 + '</e:Delivery></e:Subscribe>';
  64. obj.PerformAjax(data + "</Body></Envelope>", callback, tag, pri, 'xmlns:e="http://schemas.xmlsoap.org/ws/2004/08/eventing" xmlns:m="http://x.com"');
  65. }
  66. // Perform a WSMAN UnSubscribe operation
  67. obj.ExecUnSubscribe = function ExecUnSubscribe(resuri, callback, tag, pri, selectors) {
  68. var data = "http://schemas.xmlsoap.org/ws/2004/08/eventing/Unsubscribe</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>" + _PutObjToSelectorsXml(selectors) + '</Header><Body><e:Unsubscribe/>';
  69. obj.PerformAjax(data + "</Body></Envelope>", callback, tag, pri, 'xmlns:e="http://schemas.xmlsoap.org/ws/2004/08/eventing"');
  70. }
  71. // Perform a WSMAN PUT operation
  72. obj.ExecPut = function ExecPut(resuri, putobj, callback, tag, pri, selectors) {
  73. var data = "http://schemas.xmlsoap.org/ws/2004/09/transfer/Put</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><w:OperationTimeout>PT60.000S</w:OperationTimeout>" + _PutObjToSelectorsXml(selectors) + '</Header><Body>' + _PutObjToBodyXml(resuri, putobj);
  74. obj.PerformAjax(data + "</Body></Envelope>", callback, tag, pri);
  75. }
  76. // Perform a WSMAN CREATE operation
  77. obj.ExecCreate = function ExecCreate(resuri, putobj, callback, tag, pri, selectors) {
  78. var objname = obj.GetNameFromUrl(resuri);
  79. var data = "http://schemas.xmlsoap.org/ws/2004/09/transfer/Create</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><w:OperationTimeout>PT60S</w:OperationTimeout>" + _PutObjToSelectorsXml(selectors) + "</Header><Body><g:" + objname + " xmlns:g=\"" + resuri + "\">";
  80. for (var n in putobj) { data += "<g:" + n + ">" + putobj[n] + "</g:" + n + ">" }
  81. obj.PerformAjax(data + "</g:" + objname + "></Body></Envelope>", callback, tag, pri);
  82. }
  83. // Perform a WSMAN DELETE operation
  84. obj.ExecDelete = function ExecDelete(resuri, putobj, callback, tag, pri) {
  85. var data = "http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><w:OperationTimeout>PT60S</w:OperationTimeout>" + _PutObjToSelectorsXml(putobj) + "</Header><Body /></Envelope>";
  86. obj.PerformAjax(data, callback, tag, pri);
  87. }
  88. // Perform a WSMAN GET operation
  89. obj.ExecGet = function ExecGet(resuri, callback, tag, pri) {
  90. obj.PerformAjax("http://schemas.xmlsoap.org/ws/2004/09/transfer/Get</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><w:OperationTimeout>PT60S</w:OperationTimeout></Header><Body /></Envelope>", callback, tag, pri);
  91. }
  92. // Perform a WSMAN method call operation
  93. obj.ExecMethod = function ExecMethod(resuri, method, args, callback, tag, pri, selectors) {
  94. var argsxml = "";
  95. for (var i in args) { if (args[i] != null) { if (Array.isArray(args[i])) { for (var x in args[i]) { argsxml += "<r:" + i + ">" + args[i][x] + "</r:" + i + ">"; } } else { argsxml += "<r:" + i + ">" + args[i] + "</r:" + i + ">"; } } }
  96. obj.ExecMethodXml(resuri, method, argsxml, callback, tag, pri, selectors);
  97. }
  98. // Perform a WSMAN method call operation. The arguments are already formatted in XML.
  99. obj.ExecMethodXml = function ExecMethodXml(resuri, method, argsxml, callback, tag, pri, selectors) {
  100. obj.PerformAjax(resuri + "/" + method + "</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><w:OperationTimeout>PT60S</w:OperationTimeout>" + _PutObjToSelectorsXml(selectors) + "</Header><Body><r:" + method + '_INPUT' + " xmlns:r=\"" + resuri + "\">" + argsxml + "</r:" + method + "_INPUT></Body></Envelope>", callback, tag, pri);
  101. }
  102. // Perform a WSMAN ENUM operation
  103. obj.ExecEnum = function ExecEnum(resuri, callback, tag, pri) {
  104. obj.PerformAjax("http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerate</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><w:OperationTimeout>PT60S</w:OperationTimeout></Header><Body><Enumerate xmlns=\"http://schemas.xmlsoap.org/ws/2004/09/enumeration\" /></Body></Envelope>", callback, tag, pri);
  105. }
  106. // Perform a WSMAN PULL operation
  107. obj.ExecPull = function ExecPull(resuri, enumctx, callback, tag, pri) {
  108. obj.PerformAjax("http://schemas.xmlsoap.org/ws/2004/09/enumeration/Pull</a:Action><a:To>" + obj.Address + "</a:To><w:ResourceURI>" + resuri + "</w:ResourceURI><a:MessageID>" + (obj.NextMessageId++) + "</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><w:OperationTimeout>PT60S</w:OperationTimeout></Header><Body><Pull xmlns=\"http://schemas.xmlsoap.org/ws/2004/09/enumeration\"><EnumerationContext>" + enumctx + "</EnumerationContext><MaxElements>999</MaxElements><MaxCharacters>99999</MaxCharacters></Pull></Body></Envelope>", callback, tag, pri);
  109. }
  110. function _PutObjToBodyXml(resuri, putObj) {
  111. if (!resuri || putObj == null) return '';
  112. var objname = obj.GetNameFromUrl(resuri);
  113. var result = '<r:' + objname + ' xmlns:r="' + resuri + '">';
  114. for (var prop in putObj) {
  115. if (!putObj.hasOwnProperty(prop) || prop.indexOf('__') === 0 || prop.indexOf('@') === 0) continue;
  116. if (putObj[prop] == null || typeof putObj[prop] === 'function') continue;
  117. if (typeof putObj[prop] === 'object' && putObj[prop]['ReferenceParameters']) {
  118. result += '<r:' + prop + '><a:Address>' + putObj[prop].Address + '</a:Address><a:ReferenceParameters><w:ResourceURI>' + putObj[prop]['ReferenceParameters']["ResourceURI"] + '</w:ResourceURI><w:SelectorSet>';
  119. var selectorArray = putObj[prop]['ReferenceParameters']['SelectorSet']['Selector'];
  120. if (Array.isArray(selectorArray)) {
  121. for (var i=0; i< selectorArray.length; i++) {
  122. result += '<w:Selector' + _ObjectToXmlAttributes(selectorArray[i]) + '>' + selectorArray[i]['Value'] + '</w:Selector>';
  123. }
  124. }
  125. else {
  126. result += '<w:Selector' + _ObjectToXmlAttributes(selectorArray) + '>' + selectorArray['Value'] + '</w:Selector>';
  127. }
  128. result += '</w:SelectorSet></a:ReferenceParameters></r:' + prop + '>';
  129. }
  130. else {
  131. if (Array.isArray(putObj[prop])) {
  132. for (var i = 0; i < putObj[prop].length; i++) {
  133. result += '<r:' + prop + '>' + putObj[prop][i].toString() + '</r:' + prop + '>';
  134. }
  135. } else {
  136. result += '<r:' + prop + '>' + putObj[prop].toString() + '</r:' + prop + '>';
  137. }
  138. }
  139. }
  140. result += '</r:' + objname + '>';
  141. return result;
  142. }
  143. /*
  144. convert
  145. { @Name: 'InstanceID', @AttrName: 'Attribute Value'}
  146. into
  147. ' Name="InstanceID" AttrName="Attribute Value" '
  148. */
  149. function _ObjectToXmlAttributes(objWithAttributes) {
  150. if(!objWithAttributes) return '';
  151. var result = ' ';
  152. for (var propName in objWithAttributes) {
  153. if (!objWithAttributes.hasOwnProperty(propName) || propName.indexOf('@') !== 0) continue;
  154. result += propName.substring(1) + '="' + objWithAttributes[propName] + '" ';
  155. }
  156. return result;
  157. }
  158. function _PutObjToSelectorsXml(selectorSet) {
  159. if (!selectorSet) return '';
  160. if (typeof selectorSet == 'string') return selectorSet;
  161. if (selectorSet['InstanceID']) return "<w:SelectorSet><w:Selector Name=\"InstanceID\">" + selectorSet['InstanceID'] + "</w:Selector></w:SelectorSet>";
  162. var result = '<w:SelectorSet>';
  163. for(var propName in selectorSet) {
  164. if (!selectorSet.hasOwnProperty(propName)) continue;
  165. result += '<w:Selector Name="' + propName + '">';
  166. if (selectorSet[propName]['ReferenceParameters']) {
  167. result += '<a:EndpointReference>';
  168. result += '<a:Address>' + selectorSet[propName]['Address'] + '</a:Address><a:ReferenceParameters><w:ResourceURI>' + selectorSet[propName]['ReferenceParameters']['ResourceURI'] + '</w:ResourceURI><w:SelectorSet>';
  169. var selectorArray = selectorSet[propName]['ReferenceParameters']['SelectorSet']['Selector'];
  170. if (Array.isArray(selectorArray)) {
  171. for (var i = 0; i < selectorArray.length; i++) {
  172. result += '<w:Selector' + _ObjectToXmlAttributes(selectorArray[i]) + '>' + selectorArray[i]['Value'] + '</w:Selector>';
  173. }
  174. } else {
  175. result += '<w:Selector' + _ObjectToXmlAttributes(selectorArray) + '>' + selectorArray['Value'] + '</w:Selector>';
  176. }
  177. result += '</w:SelectorSet></a:ReferenceParameters></a:EndpointReference>';
  178. } else {
  179. result += selectorSet[propName];
  180. }
  181. result += '</w:Selector>';
  182. }
  183. result += '</w:SelectorSet>';
  184. return result;
  185. }
  186. return obj;
  187. }
  188. module.exports = WsmanStackCreateService;