Mercurial > libervia-backend
view libervia/backend/plugins/plugin_xep_0320.py @ 4231:e11b13418ba6
plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation:
Implement XEP-0343: Signaling WebRTC Data Channels in Jingle. The current version of the
XEP (0.3.1) has no implementation and contains some flaws. After discussing this on xsf@,
Daniel (from Conversations) mentioned that they had a sprint with Larma (from Dino) to
work on another version and provided me with this link:
https://gist.github.com/iNPUTmice/6c56f3e948cca517c5fb129016d99e74 . I have used it for my
implementation.
This implementation reuses work done on Jingle A/V call (notably XEP-0176 and XEP-0167
plugins), with adaptations. When used, XEP-0234 will not handle the file itself as it
normally does. This is because WebRTC has several implementations (browser for web
interface, GStreamer for others), and file/data must be handled directly by the frontend.
This is particularly important for web frontends, as the file is not sent from the backend
but from the end-user's browser device.
Among the changes, there are:
- XEP-0343 implementation.
- `file_send` bridge method now use serialised dict as output.
- New `BaseTransportHandler.is_usable` method which get content data and returns a boolean
(default to `True`) to tell if this transport can actually be used in this context (when
we are initiator). Used in webRTC case to see if call data are available.
- Support of `application` media type, and everything necessary to handle data channels.
- Better confirmation message, with file name, size and description when available.
- When file is accepted in preflight, it is specified in following `action_new` signal for
actual file transfer. This way, frontend can avoid the display or 2 confirmation
messages.
- XEP-0166: when not specified, default `content` name is now its index number instead of
a UUID. This follows the behaviour of browsers.
- XEP-0353: better handling of events such as call taken by another device.
- various other updates.
rel 441
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 06 Apr 2024 12:57:23 +0200 |
parents | 4b842c1fb686 |
children |
line wrap: on
line source
#!/usr/bin/env python3 # Libervia plugin # Copyright (C) 2009-2023 Jérôme Poisson (goffi@goffi.org) # This program 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. # 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 Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. from twisted.words.protocols.jabber.xmlstream import XMPPHandler from twisted.words.xish import domish from wokkel import disco, iwokkel from zope.interface import implementer from libervia.backend.core.constants import Const as C from libervia.backend.core.i18n import _ from libervia.backend.core.log import getLogger log = getLogger(__name__) NS_JINGLE_DTLS = "urn:xmpp:jingle:apps:dtls:0" PLUGIN_INFO = { C.PI_NAME: "Use of DTLS-SRTP in Jingle Sessions", C.PI_IMPORT_NAME: "XEP-0320", C.PI_TYPE: "XEP", C.PI_MODES: C.PLUG_MODE_BOTH, C.PI_PROTOCOLS: ["XEP-0320"], C.PI_DEPENDENCIES: ["XEP-0176"], C.PI_RECOMMENDATIONS: [], C.PI_MAIN: "XEP_0320", C.PI_HANDLER: "yes", C.PI_DESCRIPTION: _("""Use of DTLS-SRTP with RTP (for e2ee of A/V calls)"""), } class XEP_0320: def __init__(self, host): log.info(f"plugin {PLUGIN_INFO[C.PI_NAME]!r} initialization") host.trigger.add("XEP-0176_parse_transport", self._parse_transport_trigger) host.trigger.add("XEP-0176_build_transport", self._build_transport_trigger) def get_handler(self, client): return XEP_0320_handler() def _parse_transport_trigger( self, transport_elt: domish.Element, ice_data: dict ) -> bool: """Parse the <fingerprint> element""" fingerprint_elt = next( transport_elt.elements(NS_JINGLE_DTLS, "fingerprint"), None ) if fingerprint_elt is not None: try: ice_data["fingerprint"] = { "hash": fingerprint_elt["hash"], "setup": fingerprint_elt["setup"], "fingerprint": str(fingerprint_elt), } except KeyError as e: log.warning( f"invalid <fingerprint> (attribue {e} is missing): " f"{fingerprint_elt.toXml()})" ) return True def _build_transport_trigger( self, tranport_elt: domish.Element, ice_data: dict ) -> bool: """Build the <fingerprint> element if possible""" try: fingerprint_data = ice_data["fingerprint"] hash_ = fingerprint_data["hash"] setup = fingerprint_data["setup"] fingerprint = fingerprint_data["fingerprint"] except KeyError: pass else: fingerprint_elt = tranport_elt.addElement( (NS_JINGLE_DTLS, "fingerprint"), content=fingerprint ) fingerprint_elt["hash"] = hash_ fingerprint_elt["setup"] = setup return True @implementer(iwokkel.IDisco) class XEP_0320_handler(XMPPHandler): def getDiscoInfo(self, requestor, target, nodeIdentifier=""): return [disco.DiscoFeature(NS_JINGLE_DTLS)] def getDiscoItems(self, requestor, target, nodeIdentifier=""): return []