libervia-backend: sat/plugins/plugin_sec

comparison sat/plugins/plugin_sec_aesgcm.py @ 3922:0ff265725489

plugin XEP-0447: handle attachment and download: - plugin XEP-0447 can now be used in message attachments and to retrieve an attachment - plugin attach: `attachment` being processed is added to `extra` so the handler can inspect it - plugin attach: `size` is added to attachment - plugin download: a whole attachment dict is now used in `download` and `file_download`/`file_download_complete`. `download_uri` can be used as a shortcut when just a URI is used. In addition to URI scheme handler, whole attachment handlers can now be registered with `register_download_handler` - plugin XEP-0363: `file_http_upload` `XEP-0363_upload_size` triggers have been renamed to `XEP-0363_upload_pre_slot` and is now using a dict with arguments, allowing for the size but also the filename to be modified, which is necessary for encryption (filename may be hidden from URL this way). - plugin XEP-0446: fix wrong element name - plugin XEP-0447: source handler can now be registered (`url-data` is registered by default) - plugin XEP-0447: source parsing has been put in a separated `parse_sources_elt` method, as it may be useful to do it independently (notably with XEP-0448) - plugin XEP-0447: parse received message and complete attachments when suitable - plugin XEP-0447: can now be used with message attachments - plugin XEP-0447: can now be used with attachments download - renamed `options` arguments to `extra` for consistency - some style change (progressive move from legacy camelCase to PEP8 snake_case) - some typing rel 379

author	Goffi <goffi@goffi.org>
date	Thu, 06 Oct 2022 16:02:05 +0200
parents	3ef988734869
children	78b5f356900c

comparison

equal deleted inserted replaced

-:cc2705225778
+:0ff265725489
 def __init__(self, host):
 self.host = host
 log.info(_("AESGCM plugin initialization"))
 self._http_upload = host.plugins['XEP-0363']
 self._attach = host.plugins["ATTACH"]
-host.plugins["DOWNLOAD"].registerScheme(
+host.plugins["DOWNLOAD"].register_scheme(
 "aesgcm", self.download
 )
 self._attach.register(
 self.canHandleAttachment, self.attach, encrypted=True)
-host.trigger.add("XEP-0363_upload_size", self._uploadSizeTrigger)
+host.trigger.add("XEP-0363_upload_pre_slot", self._upload_pre_slot)
-host.trigger.add("XEP-0363_upload", self._uploadTrigger)
+host.trigger.add("XEP-0363_upload", self._upload_trigger)
 host.trigger.add("messageReceived", self._messageReceivedTrigger)
 async def download(self, client, uri_parsed, dest_path, options):
 fragment = bytes.fromhex(uri_parsed.fragment)
 client=client,
 file_obj=file_obj,
 decryptor=decryptor))
 else:
 d = defer.Deferred()
-self.host.plugins["DOWNLOAD"].errbackDownload(file_obj, d, resp)
+self.host.plugins["DOWNLOAD"].errback_download(file_obj, d, resp)
 return progress_id, d
 async def canHandleAttachment(self, client, data):
 try:
 await self._http_upload.getHTTPUploadEntity(client)
 except exceptions.NotFound:
 return False
 else:
 return True
-async def _uploadCb(self, client, filepath, filename, options):
+async def _upload_cb(self, client, filepath, filename, extra):
-options['encryption'] = C.ENC_AES_GCM
+extra['encryption'] = C.ENC_AES_GCM
-return await self._http_upload.fileHTTPUpload(
+return await self._http_upload.file_http_upload(
 client=client,
 filepath=filepath,
 filename=filename,
-options=options
+extra=extra
 )
 async def attach(self, client, data):
 # XXX: the attachment removal/resend code below is due to the one file per
 #   message limitation of OMEMO media sharing unofficial XEP. We have to remove
 #   elements than body).
 attachments = data["extra"][C.MESS_KEY_ATTACHMENTS]
 if not data['message'] or data['message'] == {'': ''}:
 extra_attachments = attachments[1:]
 del attachments[1:]
-await self._attach.uploadFiles(client, data, upload_cb=self._uploadCb)
+await self._attach.upload_files(client, data, upload_cb=self._upload_cb)
 else:
 # we have a message, we must send first attachment separately
 extra_attachments = attachments[:]
 attachments.clear()
 del data["extra"][C.MESS_KEY_ATTACHMENTS]
-body_elt = next(data["xml"].elements(C.NS_CLIENT, "body"))
+body_elt = data["xml"].body
+if body_elt is None:
+body_elt = data["xml"].addElement("body")
 for attachment in attachments:
 body_elt.addContent(attachment["url"])
 for attachment in extra_attachments:
 file_obj.close()
 else:
 decrypted = decryptor.update(data)
 file_obj.write(decrypted)
-def _uploadSizeTrigger(self, client, options, file_path, size, size_adjust):
+def _upload_pre_slot(self, client, extra, file_metadata):
-if options.get('encryption') != C.ENC_AES_GCM:
+if extra.get('encryption') != C.ENC_AES_GCM:
 return True
 # the tag is appended to the file
-size_adjust.append(16)
+file_metadata["size"] += 16
 return True
 def _encrypt(self, data, encryptor):
 if data:
 return encryptor.update(data)
 return ret + tag
 except AlreadyFinalized:
 # as we have already finalized, we can now send EOF
 return b''
-def _uploadTrigger(self, client, options, sat_file, file_producer, slot):
+def _upload_trigger(self, client, extra, sat_file, file_producer, slot):
-if options.get('encryption') != C.ENC_AES_GCM:
+if extra.get('encryption') != C.ENC_AES_GCM:
 return True
 log.debug("encrypting file with AES-GCM")
 iv = secrets.token_bytes(12)
 key = secrets.token_bytes(32)
 fragment = f'{iv.hex()}{key.hex()}'
 # encrypted data size will be bigger than original file size
 # so we need to check with final data length to avoid a warning on close()
 sat_file.check_size_with_read = True
-# file_producer get length directly from file, and this cause trouble has
+# file_producer get length directly from file, and this cause trouble as
 # we have to change the size because of encryption. So we adapt it here,
 # else the producer would stop reading prematurely
 file_producer.length = sat_file.size
 encryptor = ciphers.Cipher(

Mercurial > libervia-backend

comparison sat/plugins/plugin_sec_aesgcm.py @ 3922:0ff265725489