# This file is part of Beremiz, a Integrated Development Environment for
# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
# See COPYING file for copyrights details.
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# This program 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 General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
from __future__ import absolute_import
from __future__ import print_function
from functools import partial
from threading import Thread, Event
from six import text_type as text
from twisted.internet import reactor, threads
from twisted.internet._sslverify import OpenSSLCertificateAuthorities
from twisted.internet.ssl import optionsForClientTLS, VerificationError
from autobahn.twisted import wamp
from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS
from autobahn.wamp import types, auth
from autobahn.wamp.exception import TransportLost
from autobahn.wamp.serializer import MsgPackSerializer
from OpenSSL import crypto
from connectors.ConnectorBase import ConnectorBase
import PSKManagement as PSK
import CertManagement as Cert
_WampConnectEvent = Event()
class WampSession(wamp.ApplicationSession):
user = self.config.extra["IDE_ID"]
self.join(unicode(self.config.realm), [u"wampcra"], unicode(user))
def onChallenge(self, challenge):
if challenge.method == "wampcra":
secret = self.config.extra["secret"]
if 'salt' in challenge.extra:
key = auth.derive_key(secret,
challenge.extra['iterations'],
challenge.extra['keylen'])
signature = auth.compute_wcs(key, challenge.extra['challenge'])
raise Exception("Invalid authmethod {}".format(challenge.method))
def onJoin(self, details):
global _WampSession, _WampConnectEvent
print('WAMP session joined for: ', self.config.extra["IDE_ID"])
def onLeave(self, details):
global _WampSession, _WampError, _WampConnectEvent
if details.reason == "wamp.close.normal":
_WampError = "Closed normally"
elif details.reason == "wamp.error.not_authorized":
_WampError = "WAMP authentication failed. Check IDE identity in security manager."
_WampError = "WAMP closed with error {}: {}".format(details.reason, details.message)
class ComplainingWampWebSocketClientFactory(WampWebSocketClientFactory):
def clientConnectionLost(self, connector, reason):
global _WampError, _WampConnectEvent, _WampSession
if not reason.check(VerificationError):
_WampError = "WAMP TLS certificate verification failed. "+\
"Provide valid certicate in identity manager."
_WampError = "WAMP connection lost: "+reason.getErrorMessage()
clientConnectionFailed = clientConnectionLost
def _WAMP_connector_factory(cls, uri, confnodesroot):
WAMP://127.0.0.1:12345/path#realm#PLC_ID
WAMPS://127.0.0.1:12345/path#realm#PLC_ID
scheme, location = uri.split("://")
urlpath, realm, PLC_ID = location.split('#')
urlprefix = {"WAMP": "ws",
url = urlprefix+"://"+urlpath
CN = urlpath.split("/")[0].split(":")[0]
IDE_ID, secret = PSK.GetIDEIdentity()
trust_store = Cert.GetCertPath(CN)
confnodesroot.logger.write_error(
_("Connection to {loc} failed with exception {ex}\n").format(
def RegisterWampClient():
# start logging to console
# log.startLogging(sys.stdout)
# create a WAMP application session factory
component_config = types.ComponentConfig(
session_factory = wamp.ApplicationSessionFactory(
session_factory.session = cls
# create a WAMP-over-WebSocket transport client factory
transport_factory = ComplainingWampWebSocketClientFactory(
serializers=[MsgPackSerializer()])
if transport_factory.isSecure:
if os.path.exists(trust_store):
cert = crypto.load_certificate(
open(trust_store, 'rb').read()
trustRoot=OpenSSLCertificateAuthorities([cert])
confnodesroot.logger.write_warning("Wamp trust store not found")
contextFactory = optionsForClientTLS(unicode(transport_factory.host), trustRoot=trustRoot)
# start the client from a Twisted endpoint
conn = connectWS(transport_factory, contextFactory)
confnodesroot.logger.write(_("WAMP connecting to URL : %s\n") % url)
AddToDoBeforeQuit = confnodesroot.AppFrame.AddToDoBeforeQuit
_WampConnection = RegisterWampClient()
AddToDoBeforeQuit(reactor.stop)
reactor.run(installSignalHandlers=False)
global _WampConnection, _WampSession, _WampConnectEvent, _WampError
_WampConnectEvent.clear()
Thread(target=ThreadProc).start()
_WampConnection = threads.blockingCallFromThread(
reactor, RegisterWampClient)
if not _WampConnectEvent.wait(4):
confnodesroot.logger.write_error("WAMP connection timeout\n")
threads.blockingCallFromThread(
reactor, _WampConnection.stopConnecting)
confnodesroot.logger.write_error("WAMP connection failed: {}\n".format(_WampError))
class WampPLCObjectProxy(ConnectorBase):
_WampConnection.disconnect()
def WampSessionProcMapper(self, funcname):
wampfuncname = text('.'.join((PLC_ID, funcname)))
def catcher_func(*args, **kwargs):
if _WampSession is not None:
return threads.blockingCallFromThread(
reactor, _WampSession.call, wampfuncname,
confnodesroot.logger.write_error(_("Connection lost!\n"))
confnodesroot._SetConnector(None)
errmess = traceback.format_exc()
confnodesroot.logger.write_error(errmess+"\n")
# confnodesroot._SetConnector(None)
return self.PLCObjDefaults.get(funcname)
def __getattr__(self, attrName):
member = self.__dict__.get(attrName, None)
member = self.WampSessionProcMapper(attrName)
self.__dict__[attrName] = member
return WampPLCObjectProxy()
WAMP_connector_factory = partial(_WAMP_connector_factory, WampSession)