-
Notifications
You must be signed in to change notification settings - Fork 766
/
protocol.py
2047 lines (1708 loc) · 90.2 KB
/
protocol.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
###############################################################################
#
# The MIT License (MIT)
#
# Copyright (c) typedef int GmbH
#
# 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.
#
###############################################################################
from typing import Union, Optional, Dict, Any, ClassVar, List, Callable
import txaio
import inspect
from functools import reduce
from autobahn import wamp
from autobahn.util import public, IdGenerator, ObservableMixin
from autobahn.wamp import uri
from autobahn.wamp import message
from autobahn.wamp import types
from autobahn.wamp import role
from autobahn.wamp import exception
from autobahn.wamp.exception import ApplicationError, ProtocolError, SerializationError, TypeCheckError
from autobahn.wamp.interfaces import ISession, IPayloadCodec, IAuthenticator, ITransport, IMessage # noqa
from autobahn.wamp.types import Challenge, SessionDetails, CloseDetails, EncodedPayload, SubscribeOptions, \
CallResult, RegisterOptions
from autobahn.exception import PayloadExceededError
from autobahn.wamp.request import \
Publication, \
Subscription, \
Handler, \
Registration, \
Endpoint, \
PublishRequest, \
SubscribeRequest, \
UnsubscribeRequest, \
CallRequest, \
InvocationRequest, \
RegisterRequest, \
UnregisterRequest
def is_method_or_function(f):
return inspect.ismethod(f) or inspect.isfunction(f)
class BaseSession(ObservableMixin):
"""
WAMP session base class.
This class implements :class:`autobahn.wamp.interfaces.ISession`.
"""
log = None
def __init__(self):
self.log = txaio.make_logger()
self.set_valid_events(
valid_events=[
'join', # right before onJoin runs
'leave', # after onLeave has run
'ready', # after onJoin and all 'join' listeners have completed
'connect', # right before onConnect
'disconnect', # right after onDisconnect
]
)
# this is for marshalling traceback from exceptions thrown in user
# code within WAMP error messages (that is, when invoking remoted
# procedures)
self.traceback_app = False
# mapping of exception classes to list of WAMP error URI patterns
self._ecls_to_uri_pat: Dict[ClassVar, List[uri.Pattern]] = {}
# mapping of WAMP error URIs to exception classes
self._uri_to_ecls: Dict[str, ClassVar] = {
ApplicationError.INVALID_PAYLOAD: SerializationError,
ApplicationError.PAYLOAD_SIZE_EXCEEDED: PayloadExceededError,
}
# WAMP ITransport (_not_ a Twisted protocol, which is self.transport - when using Twisted)
self._transport: Optional[ITransport] = None
# session authentication information
self._realm: Optional[str] = None
self._session_id: Optional[int] = None
self._authid: Optional[str] = None
self._authrole: Optional[str] = None
self._authmethod: Optional[str] = None
self._authprovider: Optional[str] = None
self._authextra: Optional[Dict[str, Any]] = None
# set client role features supported and announced
self._session_roles: Dict[str, role.RoleFeatures] = role.DEFAULT_CLIENT_ROLES
# complete session details
self._session_details: Optional[SessionDetails] = None
# payload transparency codec
self._payload_codec: Optional[IPayloadCodec] = None
# generator for WAMP request IDs
self._request_id_gen = IdGenerator()
@property
def transport(self) -> Optional[ITransport]:
"""
Implements :func:`autobahn.wamp.interfaces.ITransportHandler.transport`
"""
# Note: self._transport (which is a WAMP ITransport) is different from self.transport (which
# is a Twisted protocol when using Twisted)!
return self._transport
@public
def is_connected(self) -> bool:
"""
Implements :func:`autobahn.wamp.interfaces.ISession.is_connected`
"""
return self._transport is not None and self._transport.isOpen()
@public
def is_attached(self) -> bool:
"""
Implements :func:`autobahn.wamp.interfaces.ISession.is_attached`
"""
return self._session_id is not None and self.is_connected()
@property
def session_details(self) -> Optional[SessionDetails]:
"""
Implements :func:`autobahn.wamp.interfaces.ISession.session_details`
"""
return self._session_details
@property
def realm(self) -> Optional[str]:
return self._realm
@property
def session_id(self) -> Optional[int]:
return self._session_id
@property
def authid(self) -> Optional[str]:
return self._authid
@property
def authrole(self) -> Optional[str]:
return self._authrole
@property
def authmethod(self) -> Optional[str]:
return self._authmethod
@property
def authprovider(self) -> Optional[str]:
return self._authprovider
@property
def authextra(self) -> Optional[Dict[str, Any]]:
return self._authextra
def define(self, exception: Exception, error: Optional[str] = None):
"""
Implements :func:`autobahn.wamp.interfaces.ISession.define`
"""
if error is None:
if hasattr(exception, '_wampuris'):
self._ecls_to_uri_pat[exception] = exception._wampuris
self._uri_to_ecls[exception._wampuris[0].uri()] = exception
else:
raise RuntimeError('cannot define WAMP exception from class with no decoration ("_wampuris" unset)')
else:
if not hasattr(exception, '_wampuris'):
self._ecls_to_uri_pat[exception] = [uri.Pattern(error, uri.Pattern.URI_TARGET_HANDLER)]
self._uri_to_ecls[error] = exception
else:
raise RuntimeError('cannot define WAMP exception: error URI is explicit, but class is decorated ("_wampuris" set')
def _message_from_exception(self, request_type, request, exc, tb=None, enc_algo=None):
"""
Create a WAMP error message from an exception.
:param request_type: The request type this WAMP error message is for.
:type request_type: int
:param request: The request ID this WAMP error message is for.
:type request: int
:param exc: The exception.
:type exc: Instance of :class:`Exception` or subclass thereof.
:param tb: Optional traceback. If present, it'll be included with the WAMP error message.
:type tb: list or None
"""
args = None
if hasattr(exc, 'args'):
args = list(exc.args) # make sure tuples are made into lists
kwargs = None
if hasattr(exc, 'kwargs'):
kwargs = exc.kwargs
if tb:
if kwargs:
kwargs['traceback'] = tb
else:
kwargs = {'traceback': tb}
if isinstance(exc, exception.ApplicationError):
error = exc.error if type(exc.error) == str else exc.error
else:
if exc.__class__ in self._ecls_to_uri_pat:
error = self._ecls_to_uri_pat[exc.__class__][0]._uri
else:
error = "wamp.error.runtime_error"
encoded_payload = None
if self._payload_codec:
encoded_payload = self._payload_codec.encode(False, error, args, kwargs)
if encoded_payload:
msg = message.Error(request_type,
request,
error,
payload=encoded_payload.payload,
enc_algo=encoded_payload.enc_algo,
enc_key=encoded_payload.enc_key,
enc_serializer=encoded_payload.enc_serializer)
else:
msg = message.Error(request_type,
request,
error,
args,
kwargs)
return msg
def _exception_from_message(self, msg):
"""
Create a user (or generic) exception from a WAMP error message.
:param msg: A WAMP error message.
:type msg: instance of :class:`autobahn.wamp.message.Error`
"""
# FIXME:
# 1. map to ecls based on error URI wildcard/prefix
# 2. extract additional args/kwargs from error URI
exc = None
enc_err = None
if msg.enc_algo:
if not self._payload_codec:
log_msg = "received encoded payload, but no payload codec active"
self.log.warn(log_msg)
enc_err = ApplicationError(ApplicationError.ENC_NO_PAYLOAD_CODEC, log_msg, enc_algo=msg.enc_algo)
else:
try:
encoded_payload = EncodedPayload(msg.payload, msg.enc_algo, msg.enc_serializer, msg.enc_key)
decrypted_error, msg.args, msg.kwargs = self._payload_codec.decode(True, msg.error, encoded_payload)
except Exception as e:
self.log.warn("failed to decrypt application payload 1: {err}", err=e)
enc_err = ApplicationError(
ApplicationError.ENC_DECRYPT_ERROR,
"failed to decrypt application payload 1: {}".format(e),
enc_algo=msg.enc_algo,
)
else:
if msg.error != decrypted_error:
self.log.warn(
"URI within encrypted payload ('{decrypted_error}') does not match the envelope ('{error}')",
decrypted_error=decrypted_error,
error=msg.error,
)
enc_err = ApplicationError(
ApplicationError.ENC_TRUSTED_URI_MISMATCH,
"URI within encrypted payload ('{}') does not match the envelope ('{}')".format(decrypted_error, msg.error),
enc_algo=msg.enc_algo,
)
if enc_err:
return enc_err
if msg.error in self._uri_to_ecls:
ecls = self._uri_to_ecls[msg.error]
try:
# the following might fail, eg. TypeError when
# signature of exception constructor is incompatible
# with args/kwargs or when the exception constructor raises
if msg.kwargs:
if msg.args:
exc = ecls(*msg.args, **msg.kwargs)
else:
exc = ecls(**msg.kwargs)
else:
if msg.args:
exc = ecls(*msg.args)
else:
exc = ecls()
except Exception:
try:
self.onUserError(
txaio.create_failure(),
"While re-constructing exception",
)
except:
pass
if not exc:
# the following ctor never fails ..
if msg.kwargs:
if msg.args:
exc = exception.ApplicationError(msg.error, *msg.args, **msg.kwargs)
else:
exc = exception.ApplicationError(msg.error, **msg.kwargs)
else:
if msg.args:
exc = exception.ApplicationError(msg.error, *msg.args)
else:
exc = exception.ApplicationError(msg.error)
# FIXME: cleanup and integate into ctors above
if hasattr(exc, 'enc_algo'):
exc.enc_algo = msg.enc_algo
if hasattr(exc, 'callee'):
exc.callee = msg.callee
if hasattr(exc, 'callee_authid'):
exc.callee_authid = msg.callee_authid
if hasattr(exc, 'callee_authrole'):
exc.callee_authrole = msg.callee_authrole
if hasattr(exc, 'forward_for'):
exc.forward_for = msg.forward_for
return exc
@public
class ApplicationSession(BaseSession):
"""
WAMP application session for applications (networking framework agnostic parts).
Implements (partially):
* :class:`autobahn.wamp.interfaces.ITransportHandler`
* :class:`autobahn.wamp.interfaces.ISession`
"""
def __init__(self, config: Optional[types.ComponentConfig] = None):
"""
Implements :func:`autobahn.wamp.interfaces.ISession`
"""
BaseSession.__init__(self)
self._config: types.ComponentConfig = config or types.ComponentConfig(realm="realm1")
# for keeping transport-closing state
self._goodbye_sent: bool = False
self._transport_is_closing: bool = False
# WAMP application payload codec (e.g. for WAMP-cryptobox E2E)
self._payload_codec: Optional[IPayloadCodec] = None
# outstanding requests
self._publish_reqs = {}
self._subscribe_reqs = {}
self._unsubscribe_reqs = {}
self._call_reqs = {}
self._register_reqs = {}
self._unregister_reqs = {}
# subscriptions in place
self._subscriptions = {}
# registrations in place
self._registrations = {}
# incoming invocations
self._invocations = {}
@property
def config(self) -> types.ComponentConfig:
return self._config
@public
def set_payload_codec(self, payload_codec: Optional[IPayloadCodec]):
"""
Implements :func:`autobahn.wamp.interfaces.ISession.set_payload_codec`
"""
self._payload_codec = payload_codec
@public
def get_payload_codec(self) -> Optional[IPayloadCodec]:
"""
Implements :func:`autobahn.wamp.interfaces.ISession.get_payload_codec`
"""
return self._payload_codec
@public
def onOpen(self, transport: ITransport):
"""
Implements :func:`autobahn.wamp.interfaces.ITransportHandler.onOpen`
"""
self.log.debug('{func}(transport={transport})', func=self.onOpen, transport=transport)
# The WAMP transport (e.g. WebSocket connection)
self._transport = transport
# FIXME: the observer API gets "transport" as argument, but _not_ the onConnect callback below?
d = self.fire('connect', self, transport)
txaio.add_callbacks(
d, None,
lambda fail: self._swallow_error(fail, "While notifying 'connect'")
)
txaio.add_callbacks(
d,
lambda _: txaio.as_future(self.onConnect),
lambda fail: self._swallow_error(fail, "While calling 'onConnect'")
)
@public
def onConnect(self):
"""
Implements :func:`autobahn.wamp.interfaces.ISession.onConnect`
"""
self.log.debug('{func}()', func=self.onConnect)
self.join(self.config.realm)
@public
def join(self,
realm: str,
authmethods: Optional[List[str]] = None,
authid: Optional[str] = None,
authrole: Optional[str] = None,
authextra: Optional[Dict[str, Any]] = None,
resumable: Optional[bool] = None,
resume_session: Optional[int] = None,
resume_token: Optional[str] = None):
"""
Implements :func:`autobahn.wamp.interfaces.ISession.join`
"""
if self._session_id:
raise Exception("session already joined")
if not self._transport:
raise Exception("no transport set for session")
# store the realm requested by client, though this might be overwritten later,
# when realm redirection kicks in
self._realm = realm
# closing handshake state
self._goodbye_sent = False
# send HELLO message to router
msg = message.Hello(realm=realm,
roles=self._session_roles,
authmethods=authmethods,
authid=authid,
authrole=authrole,
authextra=authextra,
resumable=resumable,
resume_session=resume_session,
resume_token=resume_token)
self._transport.send(msg)
@public
def disconnect(self):
"""
Implements :func:`autobahn.wamp.interfaces.ISession.disconnect`
"""
if self._transport:
self._transport.close()
@public
def onUserError(self, fail, msg):
"""
Implements :func:`autobahn.wamp.interfaces.ISession.onUserError`
"""
if hasattr(fail, 'value') and isinstance(fail.value, exception.ApplicationError):
self.log.warn('{klass}.onUserError(): "{msg}"',
klass=self.__class__.__name__,
msg=fail.value.error_message())
else:
self.log.error(
'{klass}.onUserError(): "{msg}"\n{traceback}',
klass=self.__class__.__name__,
msg=msg,
traceback=txaio.failure_format_traceback(fail),
)
def _swallow_error(self, fail, msg):
'''
This is an internal generic error-handler for errors encountered
when calling down to on*() handlers that can reasonably be
expected to be overridden in user code.
Note that it *cancels* the error, so use with care!
Specifically, this should *never* be added to the errback
chain for a Deferred/coroutine that will make it out to user
code.
'''
try:
self.onUserError(fail, msg)
except Exception:
self.log.error(
"Internal error: {tb}",
tb=txaio.failure_format_traceback(txaio.create_failure()),
)
return None
def type_check(self, func):
"""
Does parameter type checking and validation against type hints
and appropriately tells the user code and the caller (through router).
"""
async def _type_check(*args, **kwargs):
# Converge both args and kwargs into a dictionary
arguments = inspect.getcallargs(func, *args, **kwargs)
response = []
for name, kind in func.__annotations__.items():
if name in arguments:
# if a "type" has __origin__ attribute it is a
# parameterized generic
if getattr(kind, "__origin__", None) == Union:
expected_types = [arg.__name__ for arg in kind.__args__]
if not isinstance(arguments[name], kind.__args__):
response.append(
"'{}' expected types={} got={}".format(name, expected_types,
type(arguments[name]).__name__))
elif not isinstance(arguments[name], kind):
response.append(
"'{}' expected type={} got={}".format(name, kind.__name__, type(arguments[name]).__name__))
if response:
raise TypeCheckError(', '.join(response))
return await txaio.as_future(func, *args, **kwargs)
return _type_check
def onMessage(self, msg: IMessage):
"""
Implements :func:`autobahn.wamp.interfaces.ITransportHandler.onMessage`
"""
if self._session_id is None:
# the first message must be WELCOME, ABORT or CHALLENGE ..
if isinstance(msg, message.Welcome):
# before we let user code see the session -- that is,
# before we fire "join" -- we give authentication
# instances a chance to abort the session. Usually
# this would be for "mutual authentication"
# scenarios. For example, WAMP-SCRAM uses this to
# confirm the server-signature
d = txaio.as_future(self.onWelcome, msg)
def success(res):
if res is not None:
self.log.debug("Session denied by onWelcome: {res}", res=res)
reply = message.Abort(
"wamp.error.cannot_authenticate", "{0}".format(res)
)
self._transport.send(reply)
return
if msg.realm:
self._realm = msg.realm
self._session_id = msg.session
self._authid = msg.authid
self._authrole = msg.authrole
self._authmethod = msg.authmethod
self._authprovider = msg.authprovider
self._authextra = msg.authextra
self._router_roles = msg.roles
self._session_details = SessionDetails(
realm=self._realm,
session=self._session_id,
authid=self._authid,
authrole=self._authrole,
authmethod=self._authmethod,
authprovider=self._authprovider,
authextra=msg.authextra,
serializer=self._transport._serializer.SERIALIZER_ID,
transport=self._transport.transport_details,
# FIXME
resumed=False, # msg.resumed,
resumable=False, # msg.resumable,
resume_token=None, # msg.resume_token,
)
# firing 'join' *before* running onJoin, so that
# the idiom where you "do stuff" in onJoin --
# possibly including self.leave() -- works
# properly. Besides, there's "ready" that fires
# after 'join' and onJoin have all completed...
d = self.fire('join', self, self._session_details)
# add a logging errback first, which will ignore any
# errors from fire()
txaio.add_callbacks(
d, None,
lambda e: self._swallow_error(e, "While notifying 'join'")
)
# this should run regardless
txaio.add_callbacks(
d,
lambda _: txaio.as_future(self.onJoin, self._session_details),
None
)
# ignore any errors from onJoin (XXX or, should that be fatal?)
txaio.add_callbacks(
d, None,
lambda e: self._swallow_error(e, "While firing onJoin")
)
# this instance is now "ready"...
txaio.add_callbacks(
d,
lambda _: self.fire('ready', self),
None
)
# ignore any errors from 'ready'
txaio.add_callbacks(
d, None,
lambda e: self._swallow_error(e, "While notifying 'ready'")
)
def error(e):
reply = message.Abort(
"wamp.error.cannot_authenticate", "Error calling onWelcome handler"
)
self._transport.send(reply)
return self._swallow_error(e, "While firing onWelcome")
txaio.add_callbacks(d, success, error)
elif isinstance(msg, message.Abort):
# fire callback and close the transport
details = types.CloseDetails(msg.reason, msg.message)
d = txaio.as_future(self.onLeave, details)
def success(arg):
# XXX also: handle async
d = self.fire('leave', self, details)
def return_arg(_):
return arg
def _error(e):
return self._swallow_error(e, "While firing 'leave' event")
txaio.add_callbacks(d, return_arg, _error)
return d
def _error(e):
return self._swallow_error(e, "While firing onLeave")
txaio.add_callbacks(d, success, _error)
elif isinstance(msg, message.Challenge):
challenge = types.Challenge(msg.method, msg.extra)
d = txaio.as_future(self.onChallenge, challenge)
def success(signature):
if signature is None:
raise Exception('onChallenge user callback did not return a signature')
if type(signature) == bytes:
signature = signature.decode('utf8')
if type(signature) != str:
raise Exception('signature must be unicode (was {})'.format(type(signature)))
reply = message.Authenticate(signature)
self._transport.send(reply)
def error(err):
self.onUserError(err, "Authentication failed")
reply = message.Abort("wamp.error.cannot_authenticate", "{0}".format(err.value))
self._transport.send(reply)
# fire callback and close the transport
details = types.CloseDetails(reply.reason, reply.message)
d = txaio.as_future(self.onLeave, details)
def success(arg):
# XXX also: handle async
self.fire('leave', self, details)
return arg
def _error(e):
return self._swallow_error(e, "While firing onLeave")
txaio.add_callbacks(d, success, _error)
# switching to the callback chain, effectively
# cancelling error (which we've now handled)
return d
txaio.add_callbacks(d, success, error)
else:
raise ProtocolError("Received {0} message, and session is not yet established".format(msg.__class__))
else:
# self._session_id != None (aka "session established")
if isinstance(msg, message.Goodbye):
if not self._goodbye_sent:
# the peer wants to close: send GOODBYE reply
reply = message.Goodbye()
self._transport.send(reply)
self._session_id = None
# fire callback and close the transport
details = types.CloseDetails(msg.reason, msg.message)
d = txaio.as_future(self.onLeave, details)
def success(arg):
# XXX also: handle async
self.fire('leave', self, details)
return arg
def _error(e):
errmsg = 'While firing onLeave for reason "{0}" and message "{1}"'.format(msg.reason, msg.message)
return self._swallow_error(e, errmsg)
txaio.add_callbacks(d, success, _error)
elif isinstance(msg, message.Event):
if msg.subscription in self._subscriptions:
# fire all event handlers on subscription ..
for subscription in self._subscriptions[msg.subscription]:
handler = subscription.handler
topic = msg.topic or subscription.topic
if msg.enc_algo:
# FIXME: behavior in error cases (no keyring, decrypt issues, URI mismatch, ..)
if not self._payload_codec:
self.log.warn("received encoded payload with enc_algo={enc_algo}, but no payload codec active - ignoring encoded payload!", enc_algo=msg.enc_algo)
return
else:
try:
encoded_payload = EncodedPayload(msg.payload, msg.enc_algo, msg.enc_serializer, msg.enc_key)
decoded_topic, msg.args, msg.kwargs = self._payload_codec.decode(False, topic, encoded_payload)
except Exception as e:
self.log.warn("failed to decode application payload encoded with enc_algo={enc_algo}: {error}", error=e, enc_algo=msg.enc_algo)
return
else:
if topic != decoded_topic:
self.log.warn("envelope topic URI does not match encoded one")
return
invoke_args = (handler.obj,) if handler.obj else tuple()
if msg.args:
invoke_args = invoke_args + tuple(msg.args)
invoke_kwargs = msg.kwargs if msg.kwargs else dict()
if handler.details_arg:
invoke_kwargs[handler.details_arg] = types.EventDetails(subscription, msg.publication, publisher=msg.publisher, publisher_authid=msg.publisher_authid, publisher_authrole=msg.publisher_authrole, topic=topic, transaction_hash=msg.transaction_hash, retained=msg.retained, enc_algo=msg.enc_algo, forward_for=msg.forward_for)
# FIXME: https://github.com/crossbario/autobahn-python/issues/764
def _success(_):
# Acknowledged Events -- only if we got the details header and
# the broker advertised it
if msg.x_acknowledged_delivery and self._router_roles["broker"].x_acknowledged_event_delivery:
if self._transport:
response = message.EventReceived(msg.publication)
self._transport.send(response)
else:
self.log.warn("successfully processed event with acknowledged delivery, but could not send ACK, since the transport was lost in the meantime")
def _error(e):
errmsg = 'While firing {0} subscribed under {1}.'.format(
handler.fn, msg.subscription)
return self._swallow_error(e, errmsg)
future = txaio.as_future(handler.fn, *invoke_args, **invoke_kwargs)
txaio.add_callbacks(future, _success, _error)
else:
raise ProtocolError("EVENT received for non-subscribed subscription ID {0}".format(msg.subscription))
elif isinstance(msg, message.Published):
if msg.request in self._publish_reqs:
# get and pop outstanding publish request
publish_request = self._publish_reqs.pop(msg.request)
if txaio.is_future(publish_request.on_reply) and txaio.is_called(publish_request.on_reply):
return
# create a new publication object
publication = Publication(msg.publication, was_encrypted=publish_request.was_encrypted)
# resolve deferred/future for publishing successfully
txaio.resolve(publish_request.on_reply, publication)
else:
raise ProtocolError("PUBLISHED received for non-pending request ID {0}".format(msg.request))
elif isinstance(msg, message.Subscribed):
if msg.request in self._subscribe_reqs:
# get and pop outstanding subscribe request
request = self._subscribe_reqs.pop(msg.request)
if txaio.is_future(request.on_reply) and txaio.is_called(request.on_reply):
return
# create new handler subscription list for subscription ID if not yet tracked
if msg.subscription not in self._subscriptions:
self._subscriptions[msg.subscription] = []
subscription = Subscription(msg.subscription, request.topic, self, request.handler)
# add handler to existing subscription
self._subscriptions[msg.subscription].append(subscription)
# resolve deferred/future for subscribing successfully
txaio.resolve(request.on_reply, subscription)
else:
raise ProtocolError("SUBSCRIBED received for non-pending request ID {0}".format(msg.request))
elif isinstance(msg, message.Unsubscribed):
if msg.request in self._unsubscribe_reqs:
# get and pop outstanding subscribe request
request = self._unsubscribe_reqs.pop(msg.request)
if txaio.is_future(request.on_reply) and txaio.is_called(request.on_reply):
return
# if the subscription still exists, mark as inactive and remove ..
if request.subscription_id in self._subscriptions:
for subscription in self._subscriptions[request.subscription_id]:
subscription.active = False
del self._subscriptions[request.subscription_id]
# resolve deferred/future for unsubscribing successfully
txaio.resolve(request.on_reply, 0)
else:
raise ProtocolError("UNSUBSCRIBED received for non-pending request ID {0}".format(msg.request))
elif isinstance(msg, message.Result):
if msg.request in self._call_reqs:
call_request = self._call_reqs[msg.request]
proc = call_request.procedure
enc_err = None
if msg.enc_algo:
if not self._payload_codec:
log_msg = "received encoded payload, but no payload codec active"
self.log.warn(log_msg)
enc_err = ApplicationError(ApplicationError.ENC_NO_PAYLOAD_CODEC, log_msg)
else:
try:
encoded_payload = EncodedPayload(msg.payload, msg.enc_algo, msg.enc_serializer, msg.enc_key)
decrypted_proc, msg.args, msg.kwargs = self._payload_codec.decode(True, proc, encoded_payload)
except Exception as e:
self.log.warn(
"failed to decrypt application payload 1: {err}",
err=e,
)
enc_err = ApplicationError(
ApplicationError.ENC_DECRYPT_ERROR,
"failed to decrypt application payload 1: {}".format(e),
)
else:
if proc != decrypted_proc:
self.log.warn(
"URI within encrypted payload ('{decrypted_proc}') does not match the envelope ('{proc}')",
decrypted_proc=decrypted_proc,
proc=proc,
)
enc_err = ApplicationError(
ApplicationError.ENC_TRUSTED_URI_MISMATCH,
"URI within encrypted payload ('{}') does not match the envelope ('{}')".format(decrypted_proc, proc),
)
if msg.progress:
# process progressive call result
if call_request.options.on_progress:
if enc_err:
self.onUserError(enc_err, "could not deliver progressive call result, because payload decryption failed")
else:
kw = msg.kwargs or dict()
args = msg.args or tuple()
def _error(fail):
self.onUserError(fail, "While firing on_progress")
if call_request.options and call_request.options.details:
prog_d = txaio.as_future(call_request.options.on_progress,
types.CallResult(*msg.args,
callee=msg.callee,
callee_authid=msg.callee_authid,
callee_authrole=msg.callee_authrole,
forward_for=msg.forward_for,
**msg.kwargs))
else:
prog_d = txaio.as_future(call_request.options.on_progress,
*args,
**kw)
txaio.add_callbacks(prog_d, None, _error)
else:
# process final call result
# drop original request
del self._call_reqs[msg.request]
# user callback that gets fired
on_reply = call_request.on_reply
if txaio.is_future(on_reply) and txaio.is_called(on_reply):
return
# above might already have rejected, so we guard ..
if enc_err:
txaio.reject(on_reply, enc_err)
else:
if msg.kwargs or (call_request.options and call_request.options.details):
kwargs = msg.kwargs or {}
if msg.args:
res = types.CallResult(*msg.args,
callee=msg.callee,
callee_authid=msg.callee_authid,
callee_authrole=msg.callee_authrole,
forward_for=msg.forward_for,
**kwargs)
else:
res = types.CallResult(callee=msg.callee,
callee_authid=msg.callee_authid,
callee_authrole=msg.callee_authrole,
forward_for=msg.forward_for,
**kwargs)
txaio.resolve(on_reply, res)
else:
if msg.args:
if len(msg.args) > 1:
res = types.CallResult(*msg.args)
txaio.resolve(on_reply, res)
else:
txaio.resolve(on_reply, msg.args[0])
else:
txaio.resolve(on_reply, None)
else:
raise ProtocolError("RESULT received for non-pending request ID {0}".format(msg.request))
elif isinstance(msg, message.Invocation):
if msg.request in self._invocations:
raise ProtocolError("INVOCATION received for request ID {0} already invoked".format(msg.request))
else:
if msg.registration not in self._registrations:
raise ProtocolError("INVOCATION received for non-registered registration ID {0}".format(msg.registration))
else:
registration = self._registrations[msg.registration]
endpoint = registration.endpoint
proc = msg.procedure or registration.procedure
enc_err = None
if msg.enc_algo:
if not self._payload_codec:
log_msg = "received encrypted INVOCATION payload, but no keyring active"
self.log.warn(log_msg)
enc_err = ApplicationError(ApplicationError.ENC_NO_PAYLOAD_CODEC, log_msg)
else:
try:
encoded_payload = EncodedPayload(msg.payload, msg.enc_algo, msg.enc_serializer, msg.enc_key)
decrypted_proc, msg.args, msg.kwargs = self._payload_codec.decode(False, proc, encoded_payload)
except Exception as e:
self.log.warn(
"failed to decrypt INVOCATION payload: {err}",