456 lines
16 KiB
CoffeeScript
456 lines
16 KiB
CoffeeScript
###
|
|
# Copyright 2013, 2014 Zaid Abdulla
|
|
#
|
|
# GenieACS is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# GenieACS is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with GenieACS. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# This file incorporates work covered by the following copyright and
|
|
# permission notice:
|
|
#
|
|
# Copyright 2013 Fanoos Telecom
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
###
|
|
|
|
config = require './config'
|
|
libxmljs = require 'libxmljs'
|
|
|
|
SERVER_NAME = "GenieACS/#{require('../package.json').version}"
|
|
|
|
NAMESPACES = {
|
|
'1.0' : {
|
|
'soap-enc' : 'http://schemas.xmlsoap.org/soap/encoding/',
|
|
'soap-env' : 'http://schemas.xmlsoap.org/soap/envelope/',
|
|
'xsd' : 'http://www.w3.org/2001/XMLSchema',
|
|
'xsi' : 'http://www.w3.org/2001/XMLSchema-instance',
|
|
'cwmp' : 'urn:dslforum-org:cwmp-1-0'
|
|
},
|
|
'1.1' : {
|
|
'soap-enc' : 'http://schemas.xmlsoap.org/soap/encoding/',
|
|
'soap-env' : 'http://schemas.xmlsoap.org/soap/envelope/',
|
|
'xsd' : 'http://www.w3.org/2001/XMLSchema',
|
|
'xsi' : 'http://www.w3.org/2001/XMLSchema-instance',
|
|
'cwmp' : 'urn:dslforum-org:cwmp-1-1'
|
|
},
|
|
'1.2' : {
|
|
'soap-enc' : 'http://schemas.xmlsoap.org/soap/encoding/',
|
|
'soap-env' : 'http://schemas.xmlsoap.org/soap/envelope/',
|
|
'xsd' : 'http://www.w3.org/2001/XMLSchema',
|
|
'xsi' : 'http://www.w3.org/2001/XMLSchema-instance',
|
|
'cwmp' : 'urn:dslforum-org:cwmp-1-2'
|
|
},
|
|
'1.3' : {
|
|
'soap-enc' : 'http://schemas.xmlsoap.org/soap/encoding/',
|
|
'soap-env' : 'http://schemas.xmlsoap.org/soap/envelope/',
|
|
'xsd' : 'http://www.w3.org/2001/XMLSchema',
|
|
'xsi' : 'http://www.w3.org/2001/XMLSchema-instance',
|
|
'cwmp' : 'urn:dslforum-org:cwmp-1-2'
|
|
},
|
|
'1.4' : {
|
|
'soap-enc' : 'http://schemas.xmlsoap.org/soap/encoding/',
|
|
'soap-env' : 'http://schemas.xmlsoap.org/soap/envelope/',
|
|
'xsd' : 'http://www.w3.org/2001/XMLSchema',
|
|
'xsi' : 'http://www.w3.org/2001/XMLSchema-instance',
|
|
'cwmp' : 'urn:dslforum-org:cwmp-1-3'
|
|
}
|
|
}
|
|
|
|
# Generate Libxmljs options
|
|
LIBXMLJS_OPTIONS = {}
|
|
for k, v of config.allConfig
|
|
if k.lastIndexOf('XML_PARSE_', 0) == 0
|
|
LIBXMLJS_OPTIONS[k] = v
|
|
|
|
|
|
# Workaround for devices that don't use correct namespace declarations or prefixes
|
|
if config.get('IGNORE_XML_NAMESPACES')
|
|
libxmljs.Element.prototype.__find = libxmljs.Element.prototype.find
|
|
libxmljs.Element.prototype.find = (xpath, namespaces) ->
|
|
# Modify xpath queries to work regardless of element's namespace
|
|
p = xpath.replace(/([^\/:]+:)?([^\/]+)(\/|$)/g, '$2$3') \
|
|
.replace(/([a-zA-Z0-9_-]+)([^\/]*)(\/|$)/g, "*[local-name()='$1']$2$3")
|
|
libxmljs.Element.prototype.__find.call(this, p, namespaces)
|
|
|
|
|
|
event = (xml) ->
|
|
e.text().trim() for e in xml.find('EventStruct/EventCode')
|
|
|
|
|
|
parameterInfoList = (xml) ->
|
|
infoList = []
|
|
for e in xml.find('ParameterInfoStruct')
|
|
name = e.get('Name').text().trim()
|
|
writable = Boolean(JSON.parse(e.get('Writable').text()))
|
|
infoList.push([name, writable])
|
|
return infoList
|
|
|
|
|
|
parameterValueList = (xml) ->
|
|
valueList = []
|
|
for e in xml.find('ParameterValueStruct')
|
|
valueType = e.get('Value').attr('type').value().trim()
|
|
name = e.get('Name').text().trim()
|
|
value = e.get('Value').text().trim()
|
|
try
|
|
switch valueType
|
|
when 'xsd:boolean'
|
|
value = Boolean(JSON.parse(value))
|
|
when 'xsd:unsignedInt'
|
|
value = JSON.parse(value)
|
|
when 'xsd:int'
|
|
value = JSON.parse(value)
|
|
catch err
|
|
value = null
|
|
valueList.push([name, value, valueType])
|
|
return valueList
|
|
|
|
|
|
cpeGetParameterNames = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:GetParameterNames')
|
|
el.node('ParameterPath').text(methodRequest.parameterPath)
|
|
el.node('NextLevel').text(+methodRequest.nextLevel)
|
|
|
|
|
|
cpeGetParameterNamesResponse = (xml) ->
|
|
{parameterList : parameterInfoList(xml.get('ParameterList'))}
|
|
|
|
|
|
cpeGetParameterValues = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:GetParameterValues').node('ParameterNames')
|
|
el.attr({'soap-enc:arrayType' : "xsd:string[#{methodRequest.parameterNames.length}]"})
|
|
for p in methodRequest.parameterNames
|
|
el.node('string').text(p)
|
|
|
|
|
|
cpeGetParameterValuesResponse = (xml) ->
|
|
{parameterList : parameterValueList(xml.get('ParameterList'))}
|
|
|
|
|
|
cpeSetParameterValues = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:SetParameterValues')
|
|
paramList = el.node('ParameterList')
|
|
paramList.attr({'soap-enc:arrayType' : "cwmp:ParameterValueStruct[#{methodRequest.parameterList.length}]"})
|
|
for i in methodRequest.parameterList
|
|
pvs = paramList.node('ParameterValueStruct')
|
|
pvs.node('Name').text(i[0])
|
|
v = pvs.node('Value')
|
|
v.text(i[1])
|
|
v.attr({'xsi:type' : i[2]}) if i[2]?
|
|
el.node('ParameterKey').text(methodRequest.parameterKey ? '')
|
|
|
|
|
|
cpeSetParameterValuesResponse = (xml) ->
|
|
{status : JSON.parse(xml.get('Status').text())}
|
|
|
|
|
|
cpeAddObject = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:AddObject')
|
|
el.node('ObjectName').text(methodRequest.objectName)
|
|
el.node('ParameterKey').text(methodRequest.parameterKey ? '')
|
|
|
|
|
|
cpeAddObjectResponse = (xml) ->
|
|
{
|
|
instanceNumber : parseInt(xml.get('InstanceNumber').text()),
|
|
status : parseInt(xml.get('Status').text())
|
|
}
|
|
|
|
|
|
cpeDeleteObject = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:DeleteObject')
|
|
el.node('ObjectName').text(methodRequest.objectName)
|
|
el.node('ParameterKey').text(methodRequest.parameterKey ? '')
|
|
|
|
|
|
cpeDeleteObjectResponse = (xml) ->
|
|
{status : parseInt(xml.get('Status').text())}
|
|
|
|
|
|
cpeReboot = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:Reboot')
|
|
el.node('CommandKey').text(methodRequest.commandKey ? '')
|
|
|
|
|
|
cpeRebootResponse = (xml) ->
|
|
{}
|
|
|
|
|
|
cpeFactoryReset = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:FactoryReset')
|
|
|
|
|
|
cpeFactoryResetResponse = (xml, methodRequest) ->
|
|
{}
|
|
|
|
|
|
cpeDownload = (xml, methodRequest) ->
|
|
el = xml.node('cwmp:Download')
|
|
el.node('CommandKey').text(methodRequest.commandKey ? '')
|
|
el.node('FileType').text(methodRequest.fileType)
|
|
el.node('URL').text(methodRequest.url)
|
|
el.node('Username').text(methodRequest.username ? '')
|
|
el.node('Password').text(methodRequest.password ? '')
|
|
el.node('FileSize').text(methodRequest.fileSize ? '0')
|
|
el.node('TargetFileName').text(methodRequest.targetFileName ? '')
|
|
el.node('DelaySeconds').text(methodRequest.delaySeconds ? '0')
|
|
el.node('SuccessURL').text(methodRequest.successUrl ? '')
|
|
el.node('FailureURL').text(methodRequest.failureUrl ? '')
|
|
|
|
|
|
cpeDownloadResponse = (xml) ->
|
|
res = {
|
|
status : parseInt(xml.get('Status').text()),
|
|
}
|
|
|
|
if res.status == 0
|
|
res.startTime = Date.parse(xml.get('StartTime').text())
|
|
res.completeTime = Date.parse(xml.get('CompleteTime').text())
|
|
|
|
return res
|
|
|
|
|
|
acsInform = (xml) ->
|
|
{
|
|
parameterList : parameterValueList(xml.get('ParameterList')),
|
|
deviceId : {
|
|
'Manufacturer' : xml.get('DeviceId/Manufacturer').text(),
|
|
'OUI' : xml.get('DeviceId/OUI').text(),
|
|
'ProductClass' : xml.get('DeviceId/ProductClass').text(),
|
|
'SerialNumber' : xml.get('DeviceId/SerialNumber').text()
|
|
}
|
|
event : event(xml.get('Event')),
|
|
retryCount : parseInt(xml.get('RetryCount').text())
|
|
}
|
|
|
|
|
|
acsInformResponse = (xml, methodResponse) ->
|
|
xml.node('cwmp:InformResponse').node('MaxEnvelopes').text(1)
|
|
|
|
|
|
acsGetRPCMethods = (xml) ->
|
|
{}
|
|
|
|
|
|
acsGetRPCMethodsResponse = (xml, methodResponse) ->
|
|
el = xml.node('cwmp:GetRPCMethodsResponse').node('MethodList')
|
|
el.attr({'soap-enc:arrayType' : "xsd:string[#{methodResponse.methodList.length}]"})
|
|
for m in methodResponse.methodList
|
|
el.node('string').text(m)
|
|
|
|
|
|
acsTransferComplete = (xml) ->
|
|
{
|
|
commandKey : xml.get('CommandKey').text(),
|
|
faultStruct : faultStruct(xml.get('FaultStruct')),
|
|
startTime : Date.parse(xml.get('StartTime').text()),
|
|
completeTime : Date.parse(xml.get('CompleteTime').text())
|
|
}
|
|
|
|
|
|
acsTransferCompleteResponse = (xml, methodResponse) ->
|
|
xml.node('cwmp:TransferCompleteResponse').text('')
|
|
|
|
|
|
acsRequestDownload = (xml) ->
|
|
# TODO FileTypeArg
|
|
{
|
|
fileType : xml.get('FileType').text()
|
|
}
|
|
|
|
|
|
acsRequestDownloadResponse = (xml, methodResponse) ->
|
|
xml.node('cwmp:RequestDownloadResponse').text('')
|
|
|
|
|
|
faultStruct = (xml) ->
|
|
f = {
|
|
faultCode: xml.get('FaultCode').text(),
|
|
faultString: xml.get('FaultString').text()
|
|
}
|
|
|
|
for e in xml.find('SetParameterValuesFault')
|
|
f.setParameterValuesFault ?= []
|
|
f.setParameterValuesFault.push({
|
|
parameterName: e.get('ParameterName').text(),
|
|
faultCode: e.get('FaultCode').text(),
|
|
faultString: e.get('FaultString').text()
|
|
})
|
|
|
|
return f
|
|
|
|
|
|
fault = (xml, cwmpVersion) ->
|
|
{
|
|
faultCode: xml.get('faultcode').text(),
|
|
faultString: xml.get('faultstring').text(),
|
|
detail: faultStruct(xml.get('detail/cwmp:Fault', NAMESPACES[cwmpVersion]))
|
|
}
|
|
|
|
|
|
exports.request = (httpRequest, cwmpVersion) ->
|
|
cwmpRequest = {cwmpVersion : cwmpVersion}
|
|
|
|
data = httpRequest.getBody()
|
|
|
|
if data.length > 0
|
|
xml = libxmljs.parseXml(data, LIBXMLJS_OPTIONS)
|
|
|
|
if not cwmpRequest.cwmpVersion?
|
|
# cwmpVersion not passed, thus it's an inform request
|
|
methodElement = xml.get('/soap-env:Envelope/soap-env:Body/*', NAMESPACES['1.0'])
|
|
switch methodElement.namespace().href()
|
|
when 'urn:dslforum-org:cwmp-1-0'
|
|
cwmpRequest.cwmpVersion = '1.0'
|
|
when 'urn:dslforum-org:cwmp-1-1'
|
|
cwmpRequest.cwmpVersion = '1.1'
|
|
when 'urn:dslforum-org:cwmp-1-2'
|
|
cwmpRequest.sessionTimeout = try xml.get('/soap-env:Envelope/soap-env:Header/cwmp:sessionTimeout', NAMESPACES['1.2']).text() catch then null
|
|
if cwmpRequest.sessionTimeout?
|
|
cwmpRequest.cwmpVersion = '1.3'
|
|
else
|
|
cwmpRequest.cwmpVersion = '1.2'
|
|
when 'urn:dslforum-org:cwmp-1-3'
|
|
cwmpRequest.cwmpVersion = '1.4'
|
|
else
|
|
throw new Error('Unrecognized CWMP version')
|
|
|
|
cwmpRequest.sessionTimeout ?= try xml.get('/soap-env:Envelope/soap-env:Header/cwmp:sessionTimeout', NAMESPACES[cwmpRequest.cwmpVersion]).text() catch then null
|
|
else
|
|
methodElement = xml.get('/soap-env:Envelope/soap-env:Body/cwmp:*', NAMESPACES[cwmpRequest.cwmpVersion])
|
|
|
|
cwmpRequest.id = try xml.get('/soap-env:Envelope/soap-env:Header/cwmp:ID', NAMESPACES[cwmpRequest.cwmpVersion]).text() catch then null
|
|
|
|
if methodElement? and not (config.get('IGNORE_XML_NAMESPACES') and methodElement.name() is 'Fault')
|
|
switch methodElement.name()
|
|
when 'Inform'
|
|
cwmpRequest.methodRequest = acsInform(methodElement)
|
|
cwmpRequest.methodRequest.type = 'Inform'
|
|
when 'GetRPCMethods'
|
|
cwmpRequest.methodRequest = acsGetRPCMethods(methodElement)
|
|
cwmpRequest.methodRequest.type = 'GetRPCMethods'
|
|
when 'TransferComplete'
|
|
cwmpRequest.methodRequest = acsTransferComplete(methodElement)
|
|
cwmpRequest.methodRequest.type = 'TransferComplete'
|
|
when 'RequestDownload'
|
|
cwmpRequest.methodRequest = acsRequestDownload(methodElement)
|
|
cwmpRequest.methodRequest.type = 'RequestDownload'
|
|
when 'GetParameterNamesResponse'
|
|
cwmpRequest.methodResponse = cpeGetParameterNamesResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'GetParameterNamesResponse'
|
|
when 'GetParameterValuesResponse'
|
|
cwmpRequest.methodResponse = cpeGetParameterValuesResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'GetParameterValuesResponse'
|
|
when 'SetParameterValuesResponse'
|
|
cwmpRequest.methodResponse = cpeSetParameterValuesResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'SetParameterValuesResponse'
|
|
when 'AddObjectResponse'
|
|
cwmpRequest.methodResponse = cpeAddObjectResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'AddObjectResponse'
|
|
when 'DeleteObjectResponse'
|
|
cwmpRequest.methodResponse = cpeDeleteObjectResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'DeleteObjectResponse'
|
|
when 'RebootResponse'
|
|
cwmpRequest.methodResponse = cpeRebootResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'RebootResponse'
|
|
when 'FactoryResetResponse'
|
|
cwmpRequest.methodResponse = cpeFactoryResetResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'FactoryResetResponse'
|
|
when 'DownloadResponse'
|
|
cwmpRequest.methodResponse = cpeDownloadResponse(methodElement)
|
|
cwmpRequest.methodResponse.type = 'DownloadResponse'
|
|
else
|
|
throw Error('8000 Method not supported ' + methodElement.name())
|
|
else
|
|
faultElement = xml.get('/soap-env:Envelope/soap-env:Body/soap-env:Fault', NAMESPACES[cwmpRequest.cwmpVersion])
|
|
cwmpRequest.fault = fault(faultElement, cwmpRequest.cwmpVersion)
|
|
|
|
return cwmpRequest
|
|
|
|
|
|
createSoapEnv = (cwmpVersion) ->
|
|
xml = libxmljs.Document()
|
|
env = xml.node('soap-env:Envelope')
|
|
for prefix, url of NAMESPACES[cwmpVersion]
|
|
env.defineNamespace prefix, url
|
|
return env
|
|
|
|
|
|
exports.response = (cwmpResponse) ->
|
|
headers = {
|
|
'Server' : SERVER_NAME,
|
|
'SOAPServer' : SERVER_NAME,
|
|
}
|
|
|
|
if cwmpResponse?.methodResponse?
|
|
env = createSoapEnv(cwmpResponse.cwmpVersion)
|
|
header = env.node('soap-env:Header')
|
|
header.node('cwmp:ID').attr({'soap-env:mustUnderstand' : 1}).text(cwmpResponse.id)
|
|
body = env.node('soap-env:Body')
|
|
switch cwmpResponse.methodResponse.type
|
|
when 'InformResponse'
|
|
acsInformResponse(body, cwmpResponse.methodResponse)
|
|
when 'GetRPCMethodsResponse'
|
|
acsGetRPCMethodsResponse(body, cwmpResponse.methodResponse)
|
|
when 'TransferCompleteResponse'
|
|
acsTransferCompleteResponse(body, cwmpResponse.methodResponse)
|
|
when 'RequestDownloadResponse'
|
|
acsRequestDownloadResponse(body, cwmpResponse.methodResponse)
|
|
else
|
|
throw Error("Unknown method response type #{cwmpResponse.methodResponse.type}")
|
|
else if cwmpResponse?.methodRequest?
|
|
env = createSoapEnv(cwmpResponse.cwmpVersion)
|
|
header = env.node('soap-env:Header')
|
|
header.node('cwmp:ID').attr({'soap-env:mustUnderstand' : 1}).text(cwmpResponse.id)
|
|
body = env.node('soap-env:Body')
|
|
switch cwmpResponse.methodRequest.type
|
|
when 'GetParameterNames'
|
|
cpeGetParameterNames(body, cwmpResponse.methodRequest)
|
|
when 'GetParameterValues'
|
|
cpeGetParameterValues(body, cwmpResponse.methodRequest)
|
|
when 'SetParameterValues'
|
|
cpeSetParameterValues(body, cwmpResponse.methodRequest)
|
|
when 'AddObject'
|
|
cpeAddObject(body, cwmpResponse.methodRequest)
|
|
when 'DeleteObject'
|
|
cpeDeleteObject(body, cwmpResponse.methodRequest)
|
|
when 'Reboot'
|
|
cpeReboot(body, cwmpResponse.methodRequest)
|
|
when 'FactoryReset'
|
|
cpeFactoryReset(body, cwmpResponse.methodRequest)
|
|
when 'Download'
|
|
cpeDownload(body, cwmpResponse.methodRequest)
|
|
else
|
|
throw Error("Unknown method request #{cwmpResponse.methodRequest.type}")
|
|
|
|
if env?
|
|
headers['Content-Type'] = 'text/xml; charset="utf-8"'
|
|
return {code: 200, headers: headers, data: new Buffer(env.doc().toString(false))}
|
|
else
|
|
return {code: 204, headers: headers, data: new Buffer(0)}
|