/usr/lib/python3/dist-packages/autobahn/wamp/interfaces.py is in python3-autobahn 17.10.1+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | ###############################################################################
#
# The MIT License (MIT)
#
# Copyright (c) Crossbar.io Technologies 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.
#
###############################################################################
import abc
import six
from autobahn.util import public
__all__ = (
'IObjectSerializer',
'ISerializer',
'IMessage',
'ITransport',
'ITransportHandler',
'ISession',
'IPayloadCodec'
)
@public
@six.add_metaclass(abc.ABCMeta)
class IObjectSerializer(object):
"""
Raw Python object serialization and deserialization. Object serializers are
used by classes implementing WAMP serializers, that is instances of
:class:`autobahn.wamp.interfaces.ISerializer`.
"""
@public
@abc.abstractproperty
def BINARY(self):
"""
Flag (read-only) to indicate if serializer requires a binary clean
transport or if UTF8 transparency is sufficient.
"""
@public
@abc.abstractmethod
def serialize(self, obj):
"""
Serialize an object to a byte string.
:param obj: Object to serialize.
:type obj: any (serializable type)
:returns: Serialized bytes.
:rtype: bytes
"""
@public
@abc.abstractmethod
def unserialize(self, payload):
"""
Unserialize objects from a byte string.
:param payload: Objects to unserialize.
:type payload: bytes
:returns: List of (raw) objects unserialized.
:rtype: list
"""
@public
@six.add_metaclass(abc.ABCMeta)
class ISerializer(object):
"""
WAMP message serialization and deserialization.
"""
@public
@abc.abstractproperty
def MESSAGE_TYPE_MAP(self):
"""
Mapping of WAMP message type codes to WAMP message classes.
"""
@public
@abc.abstractproperty
def SERIALIZER_ID(self):
"""
The WAMP serialization format ID.
"""
@public
@abc.abstractmethod
def serialize(self, message):
"""
Serializes a WAMP message to bytes for sending over a transport.
:param message: The WAMP message to be serialized.
:type message: object implementing :class:`autobahn.wamp.interfaces.IMessage`
:returns: A pair ``(payload, isBinary)``.
:rtype: tuple
"""
@public
@abc.abstractmethod
def unserialize(self, payload, isBinary):
"""
Deserialize bytes from a transport and parse into WAMP messages.
:param payload: Byte string from wire.
:type payload: bytes
:param is_binary: Type of payload. True if payload is a binary string, else
the payload is UTF-8 encoded Unicode text.
:type is_binary: bool
:returns: List of ``a.w.m.Message`` objects.
:rtype: list
"""
@public
@six.add_metaclass(abc.ABCMeta)
class IMessage(object):
"""
"""
@public
@abc.abstractproperty
def MESSAGE_TYPE(self):
"""
WAMP message type code.
"""
# the following requires Python 3.3+ and exactly this order of decorators
# http://stackoverflow.com/questions/4474395/staticmethod-and-abc-abstractmethod-will-it-blend
@public
@staticmethod
@abc.abstractmethod
def parse(wmsg):
"""
Factory method that parses a unserialized raw message (as returned byte
:func:`autobahn.interfaces.ISerializer.unserialize`) into an instance
of this class.
:returns: The parsed WAMP message.
:rtype: object implementing :class:`autobahn.wamp.interfaces.IMessage`
"""
@public
@abc.abstractmethod
def serialize(self, serializer):
"""
Serialize this object into a wire level bytes representation and cache
the resulting bytes. If the cache already contains an entry for the given
serializer, return the cached representation directly.
:param serializer: The wire level serializer to use.
:type serializer: object implementing :class:`autobahn.wamp.interfaces.ISerializer`
:returns: The serialized bytes.
:rtype: bytes
"""
@public
@abc.abstractmethod
def uncache(self):
"""
Resets the serialization cache for this message.
"""
@public
@six.add_metaclass(abc.ABCMeta)
class ITransport(object):
"""
A WAMP transport is a bidirectional, full-duplex, reliable, ordered,
message-based channel.
"""
@public
@abc.abstractmethod
def send(self, message):
"""
Send a WAMP message over the transport to the peer. If the transport is
not open, this raises :class:`autobahn.wamp.exception.TransportLost`.
Returns a deferred/future when the message has been processed and more
messages may be sent. When send() is called while a previous deferred/future
has not yet fired, the send will fail immediately.
:param message: The WAMP message to send over the transport.
:type message: object implementing :class:`autobahn.wamp.interfaces.IMessage`
:returns: obj -- A Deferred/Future
"""
@public
@abc.abstractmethod
def isOpen(self):
"""
Check if the transport is open for messaging.
:returns: ``True``, if the transport is open.
:rtype: bool
"""
@public
@abc.abstractmethod
def close(self):
"""
Close the transport regularly. The transport will perform any
closing handshake if applicable. This should be used for any
application initiated closing.
"""
@public
@abc.abstractmethod
def abort(self):
"""
Abort the transport abruptly. The transport will be destroyed as
fast as possible, and without playing nice to the peer. This should
only be used in case of fatal errors, protocol violations or possible
detected attacks.
"""
@public
@abc.abstractmethod
def get_channel_id(self):
"""
Return the unique channel ID of the underlying transport. This is used to
mitigate credential forwarding man-in-the-middle attacks when running
application level authentication (eg WAMP-cryptosign) which are decoupled
from the underlying transport.
The channel ID is only available when running over TLS (either WAMP-WebSocket
or WAMP-RawSocket). It is not available for non-TLS transports (plain TCP or
Unix domain sockets). It is also not available for WAMP-over-HTTP/Longpoll.
Further, it is currently unimplemented for asyncio (only works on Twisted).
The channel ID is computed as follows:
- for a client, the SHA256 over the "TLS Finished" message sent by the client
to the server is returned.
- for a server, the SHA256 over the "TLS Finished" message the server expected
the client to send
Note: this is similar to `tls-unique` as described in RFC5929, but instead
of returning the raw "TLS Finished" message, it returns a SHA256 over such a
message. The reason is that we use the channel ID mainly with WAMP-cryptosign,
which is based on Ed25519, where keys are always 32 bytes. And having a channel ID
which is always 32 bytes (independent of the TLS ciphers/hashfuns in use) allows
use to easily XOR channel IDs with Ed25519 keys and WAMP-cryptosign challenges.
WARNING: For safe use of this (that is, for safely binding app level authentication
to the underlying transport), you MUST use TLS, and you SHOULD deactivate both
TLS session renegotiation and TLS session resumption.
References:
- https://tools.ietf.org/html/rfc5056
- https://tools.ietf.org/html/rfc5929
- http://www.pyopenssl.org/en/stable/api/ssl.html#OpenSSL.SSL.Connection.get_finished
- http://www.pyopenssl.org/en/stable/api/ssl.html#OpenSSL.SSL.Connection.get_peer_finished
:returns: The channel ID (if available) of the underlying WAMP transport. The
channel ID is a 32 bytes value.
:rtype: binary or None
"""
@public
@six.add_metaclass(abc.ABCMeta)
class ITransportHandler(object):
@public
@abc.abstractproperty
def transport(self):
"""
When the transport this handler is attached to is currently open, this property
can be read from. The property should be considered read-only. When the transport
is gone, this property is set to None.
"""
@public
@abc.abstractmethod
def onOpen(self, transport):
"""
Callback fired when transport is open. May run asynchronously. The transport
is considered running and is_open() would return true, as soon as this callback
has completed successfully.
:param transport: The WAMP transport.
:type transport: object implementing :class:`autobahn.wamp.interfaces.ITransport`
"""
@public
@abc.abstractmethod
def onMessage(self, message):
"""
Callback fired when a WAMP message was received. May run asynchronously. The callback
should return or fire the returned deferred/future when it's done processing the message.
In particular, an implementation of this callback must not access the message afterwards.
:param message: The WAMP message received.
:type message: object implementing :class:`autobahn.wamp.interfaces.IMessage`
"""
@public
@abc.abstractmethod
def onClose(self, wasClean):
"""
Callback fired when the transport has been closed.
:param wasClean: Indicates if the transport has been closed regularly.
:type wasClean: bool
"""
@public
@six.add_metaclass(abc.ABCMeta)
class ISession(object):
"""
Interface for WAMP sessions.
"""
@abc.abstractmethod
def __init__(self, config=None):
"""
:param config: Configuration for session.
:type config: instance of :class:`autobahn.wamp.types.ComponentConfig`.
"""
@public
@abc.abstractmethod
def onUserError(self, fail, msg):
"""
This is called when we try to fire a callback, but get an
exception from user code -- for example, a registered publish
callback or a registered method. By default, this prints the
current stack-trace and then error-message to stdout.
ApplicationSession-derived objects may override this to
provide logging if they prefer. The Twisted implemention does
this. (See :class:`autobahn.twisted.wamp.ApplicationSession`)
:param fail: The failure that occurred.
:type fail: instance implementing txaio.IFailedFuture
:param msg: an informative message from the library. It is
suggested you log this immediately after the exception.
:type msg: str
"""
@public
@abc.abstractmethod
def onConnect(self):
"""
Callback fired when the transport this session will run over has been established.
"""
@public
@abc.abstractmethod
def join(self,
realm,
authmethods=None,
authid=None,
authrole=None,
authextra=None,
resumable=None,
resume_session=None,
resume_token=None):
"""
Attach the session to the given realm. A session is open as soon as it is attached to a realm.
"""
@public
@abc.abstractmethod
def onChallenge(self, challenge):
"""
Callback fired when the peer demands authentication.
May return a Deferred/Future.
:param challenge: The authentication challenge.
:type challenge: Instance of :class:`autobahn.wamp.types.Challenge`.
"""
@public
@abc.abstractmethod
def onJoin(self, details):
"""
Callback fired when WAMP session has been established.
May return a Deferred/Future.
:param details: Session information.
:type details: Instance of :class:`autobahn.wamp.types.SessionDetails`.
"""
@public
@abc.abstractmethod
def leave(self, reason=None, message=None):
"""
Actively close this WAMP session.
:param reason: An optional URI for the closing reason. If you
want to permanently log out, this should be `wamp.close.logout`
:type reason: str
:param message: An optional (human readable) closing message, intended for
logging purposes.
:type message: str
:return: may return a Future/Deferred that fires when we've disconnected
"""
@public
@abc.abstractmethod
def onLeave(self, details):
"""
Callback fired when WAMP session has is closed
:param details: Close information.
:type details: Instance of :class:`autobahn.wamp.types.CloseDetails`.
"""
@public
@abc.abstractmethod
def disconnect(self):
"""
Close the underlying transport.
"""
@public
@abc.abstractmethod
def onDisconnect(self):
"""
Callback fired when underlying transport has been closed.
"""
@public
@abc.abstractmethod
def is_connected(self):
"""
Check if the underlying transport is connected.
"""
@public
@abc.abstractmethod
def is_attached(self):
"""
Check if the session has currently joined a realm.
"""
@public
@abc.abstractmethod
def set_payload_codec(self, payload_codec):
"""
Set a payload codec on the session. To remove a previously set payload codec,
set the codec to ``None``.
Payload codecs are used with WAMP payload transparency mode.
:param payload_codec: The payload codec that should process application
payload of the given encoding.
:type payload_codec: object
implementing :class:`autobahn.wamp.interfaces.IPayloadCodec` or ``None``
"""
@public
@abc.abstractmethod
def get_payload_codec(self):
"""
Get the current payload codec (if any) for the session.
Payload codecs are used with WAMP payload transparency mode.
:returns: The current payload codec or ``None`` if no codec is active.
:rtype: object implementing
:class:`autobahn.wamp.interfaces.IPayloadCodec` or ``None``
"""
@public
@abc.abstractmethod
def define(self, exception, error=None):
"""
Defines an exception for a WAMP error in the context of this WAMP session.
:param exception: The exception class to define an error mapping for.
:type exception: A class that derives of ``Exception``.
:param error: The URI (or URI pattern) the exception class should be mapped for.
Iff the ``exception`` class is decorated, this must be ``None``.
:type error: str
"""
@public
@abc.abstractmethod
def call(self, procedure, *args, **kwargs):
"""
Call a remote procedure.
This will return a Deferred/Future, that when resolved, provides the actual result
returned by the called remote procedure.
- If the result is a single positional return value, it'll be returned "as-is".
- If the result contains multiple positional return values or keyword return values,
the result is wrapped in an instance of :class:`autobahn.wamp.types.CallResult`.
- If the call fails, the returned Deferred/Future will be rejected with an instance
of :class:`autobahn.wamp.exception.ApplicationError`.
If ``kwargs`` contains an ``options`` keyword argument that is an instance of
:class:`autobahn.wamp.types.CallOptions`, this will provide specific options for
the call to perform.
When the *Caller* and *Dealer* implementations support canceling of calls, the call may
be canceled by canceling the returned Deferred/Future.
:param procedure: The URI of the remote procedure to be called, e.g. ``u"com.myapp.hello"``.
:type procedure: unicode
:param args: Any positional arguments for the call.
:type args: list
:param kwargs: Any keyword arguments for the call.
:type kwargs: dict
:returns: A Deferred/Future for the call result -
:rtype: instance of :tx:`twisted.internet.defer.Deferred` / :py:class:`asyncio.Future`
"""
@public
@abc.abstractmethod
def register(self, endpoint, procedure=None, options=None, prefix=None):
"""
Register a procedure for remote calling.
When ``endpoint`` is a callable (function, method or object that implements ``__call__``),
then ``procedure`` must be provided and an instance of
:tx:`twisted.internet.defer.Deferred` (when running on **Twisted**) or an instance
of :py:class:`asyncio.Future` (when running on **asyncio**) is returned.
- If the registration *succeeds* the returned Deferred/Future will *resolve* to
an object that implements :class:`autobahn.wamp.interfaces.IRegistration`.
- If the registration *fails* the returned Deferred/Future will *reject* with an
instance of :class:`autobahn.wamp.exception.ApplicationError`.
When ``endpoint`` is an object, then each of the object's methods that is decorated
with :func:`autobahn.wamp.register` is automatically registered and a (single)
DeferredList or Future is returned that gathers all individual underlying Deferreds/Futures.
:param endpoint: The endpoint called under the procedure.
:type endpoint: callable or object
:param procedure: When ``endpoint`` is a callable, the URI (or URI pattern)
of the procedure to register for. When ``endpoint`` is an object,
the argument is ignored (and should be ``None``).
:type procedure: unicode
:param options: Options for registering.
:type options: instance of :class:`autobahn.wamp.types.RegisterOptions`.
:param prefix: if not None, this specifies a prefix to prepend
to all URIs registered for this class. So if there was an
@wamp.register('method_foo') on a method and
prefix='com.something.' then a method
'com.something.method_foo' would ultimately be registered.
:type prefix: str
:returns: A registration or a list of registrations (or errors)
:rtype: instance(s) of :tx:`twisted.internet.defer.Deferred` / :py:class:`asyncio.Future`
"""
@public
@abc.abstractmethod
def publish(self, topic, *args, **kwargs):
"""
Publish an event to a topic.
If ``kwargs`` contains an ``options`` keyword argument that is an instance of
:class:`autobahn.wamp.types.PublishOptions`, this will provide
specific options for the publish to perform.
.. note::
By default, publications are non-acknowledged and the publication can
fail silently, e.g. because the session is not authorized to publish
to the topic.
When publication acknowledgement is requested via ``options.acknowledge == True``,
this function returns a Deferred/Future:
- If the publication succeeds the Deferred/Future will resolve to an object
that implements :class:`autobahn.wamp.interfaces.IPublication`.
- If the publication fails the Deferred/Future will reject with an instance
of :class:`autobahn.wamp.exception.ApplicationError`.
:param topic: The URI of the topic to publish to, e.g. ``u"com.myapp.mytopic1"``.
:type topic: unicode
:param args: Arbitrary application payload for the event (positional arguments).
:type args: list
:param kwargs: Arbitrary application payload for the event (keyword arguments).
:type kwargs: dict
:returns: Acknowledgement for acknowledge publications - otherwise nothing.
:rtype: ``None`` or instance of :tx:`twisted.internet.defer.Deferred` / :py:class:`asyncio.Future`
"""
@public
@abc.abstractmethod
def subscribe(self, handler, topic=None, options=None):
"""
Subscribe to a topic for receiving events.
When ``handler`` is a callable (function, method or object that implements ``__call__``),
then `topic` must be provided and an instance of
:tx:`twisted.internet.defer.Deferred` (when running on **Twisted**) or an instance
of :class:`asyncio.Future` (when running on **asyncio**) is returned.
- If the subscription succeeds the Deferred/Future will resolve to an object
that implements :class:`autobahn.wamp.interfaces.ISubscription`.
- If the subscription fails the Deferred/Future will reject with an instance
of :class:`autobahn.wamp.exception.ApplicationError`.
When ``handler`` is an object, then each of the object's methods that is decorated
with :func:`autobahn.wamp.subscribe` is automatically subscribed as event handlers,
and a list of Deferreds/Futures is returned that each resolves or rejects as above.
:param handler: The event handler to receive events.
:type handler: callable or object
:param topic: When ``handler`` is a callable, the URI (or URI pattern)
of the topic to subscribe to. When ``handler`` is an object, this
value is ignored (and should be ``None``).
:type topic: unicode
:param options: Options for subscribing.
:type options: An instance of :class:`autobahn.wamp.types.SubscribeOptions`.
:returns: A single Deferred/Future or a list of such objects
:rtype: instance(s) of :tx:`twisted.internet.defer.Deferred` / :py:class:`asyncio.Future`
"""
# experimental authentication API
@six.add_metaclass(abc.ABCMeta)
class IAuthenticator(object):
@abc.abstractmethod
def on_challenge(self, session, challenge):
"""
"""
@public
@six.add_metaclass(abc.ABCMeta)
class IPayloadCodec(object):
"""
WAMP payload codecs are used with WAMP payload transparency mode.
In payload transparency mode, application payloads are transmitted "raw",
as binary strings, without any processing at the WAMP router.
Payload transparency can be used eg for these use cases:
* end-to-end encryption of application payloads (WAMP-cryptobox)
* using serializers with custom user types, where the serializer and
the serializer implementation has native support for serializing
custom types (such as CBOR)
* transmitting MQTT payloads within WAMP, when the WAMP router is
providing a MQTT-WAMP bridge
"""
@public
@abc.abstractmethod
def encode(self, is_originating, uri, args=None, kwargs=None):
"""
Encodes application payload.
:param is_originating: Flag indicating whether the encoding
is to be done from an originator (a caller or publisher).
:type is_originating: bool
:param uri: The WAMP URI associated with the WAMP message for which
the payload is to be encoded (eg topic or procedure).
:type uri: str
:param args: Positional application payload.
:type args: list or None
:param kwargs: Keyword-based application payload.
:type kwargs: dict or None
:returns: The encoded application payload or None to
signal no encoding should be used.
:rtype: instance of :class:`autobahn.wamp.types.EncodedPayload`
"""
@public
@abc.abstractmethod
def decode(self, is_originating, uri, encoded_payload):
"""
Decode application payload.
:param is_originating: Flag indicating whether the encoding
is to be done from an originator (a caller or publisher).
:type is_originating: bool
:param uri: The WAMP URI associated with the WAMP message for which
the payload is to be encoded (eg topic or procedure).
:type uri: str
:param payload: The encoded application payload to be decoded.
:type payload: instance of :class:`autobahn.wamp.types.EncodedPayload`
:returns: A tuple with the decoded positional and keyword-based
application payload: ``(uri, args, kwargs)``
:rtype: tuple
"""
|