comparison sat/bridge/bridge_constructor/bridge_template.ini @ 2733:e347e32aa07f

core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: - encryptionNamespaceGet retrieves algorithm namespace from its short name - encryptionTrustUIGet retrieves trust mangement XMLUI from encryption plugin - new markAsUntrusted internal helper method, to add untrusted flag to message data
author Goffi <goffi@goffi.org>
date Wed, 02 Jan 2019 18:22:30 +0100
parents 5060cbeec01e
children da59ff099b32
comparison
equal deleted inserted replaced
2732:e55f871fa9db 2733:e347e32aa07f
58 type=signal 58 type=signal
59 category=core 59 category=core
60 sig_in=sss 60 sig_in=sss
61 doc=A message encryption session has been started 61 doc=A message encryption session has been started
62 doc_param_0=to_jid: JID of the recipient (bare jid if it's encrypted for all devices) 62 doc_param_0=to_jid: JID of the recipient (bare jid if it's encrypted for all devices)
63 doc_param_1=encryption_data: [JSON_OBJ] data of the encryption algorithm used, encoded as a json object. 63 doc_param_1=encryption_data: (JSON_OBJ) data of the encryption algorithm used, encoded as a json object.
64 it always has the following keys: 64 it always has the following keys:
65 - name: human readable name of the algorithm 65 - name: human readable name of the algorithm
66 - namespace: namespace of the encryption plugin 66 - namespace: namespace of the encryption plugin
67 following keys are present if suitable: 67 following keys are present if suitable:
68 - directed_devices: list or resource where session is encrypted 68 - directed_devices: list or resource where session is encrypted
443 param_1_default='' 443 param_1_default=''
444 param_2_default=False 444 param_2_default=False
445 param_3_default="@NONE@" 445 param_3_default="@NONE@"
446 doc=Start an encryption session 446 doc=Start an encryption session
447 doc_param_0=to_jid: JID of the recipient (bare jid if it must be encrypted for all devices) 447 doc_param_0=to_jid: JID of the recipient (bare jid if it must be encrypted for all devices)
448 doc_param_1=encryption_ns: Namespace of the encryption algorithm to use 448 doc_param_1=namespace: namespace of the encryption algorithm to use
449 doc_param_2=replace: If True and an encryption session already exists, it will be replaced by this one 449 doc_param_2=replace: if True and an encryption session already exists, it will be replaced by this one
450 else a ConflictError will be raised 450 else a ConflictError will be raised
451 doc_param_3=%(doc_profile_key)s 451 doc_param_3=%(doc_profile_key)s
452 452
453 [messageEncryptionStop] 453 [messageEncryptionStop]
454 type=method 454 type=method
455 category=core 455 category=core
456 sig_in=ss 456 sig_in=ss
457 sig_out= 457 sig_out=
458 doc=Start an encryption session 458 doc=Stop an encryption session
459 doc_param_0=to_jid: JID of the recipient (full jid if encryption must be stopped for one device only) 459 doc_param_0=to_jid: JID of the recipient (full jid if encryption must be stopped for one device only)
460 doc_param_1=%(doc_profile_key)s 460 doc_param_1=%(doc_profile_key)s
461 461
462 [messageEncryptionGet] 462 [messageEncryptionGet]
463 type=method 463 type=method
465 sig_in=ss 465 sig_in=ss
466 sig_out=s 466 sig_out=s
467 doc=Retrieve encryption data for a given entity 467 doc=Retrieve encryption data for a given entity
468 doc_param_0=to_jid: bare JID of the recipient 468 doc_param_0=to_jid: bare JID of the recipient
469 doc_param_1=%(doc_profile_key)s 469 doc_param_1=%(doc_profile_key)s
470 doc_return=[JSON_OBJ] empty string if session is unencrypted, else a json encoded objects. 470 doc_return=(JSON_OBJ) empty string if session is unencrypted, else a json encoded objects.
471 In case of dict, following keys are always present: 471 In case of dict, following keys are always present:
472 - name: human readable name of the encryption algorithm 472 - name: human readable name of the encryption algorithm
473 - namespace: namespace of the plugin 473 - namespace: namespace of the plugin
474 following key can be present if suitable: 474 following key can be present if suitable:
475 - directed_devices: list or resource where session is encrypted 475 - directed_devices: list or resource where session is encrypted
476 476
477 [encryptionNamespaceGet]
478 type=method
479 category=core
480 sig_in=s
481 sig_out=s
482 doc=Get algorithm namespace from its name
483
477 [encryptionPluginsGet] 484 [encryptionPluginsGet]
478 type=method 485 type=method
479 category=core 486 category=core
480 sig_in= 487 sig_in=
481 sig_out=aa{ss} 488 sig_out=aa{ss}
482 doc=Retrieve registered plugins for encryption 489 doc=Retrieve registered plugins for encryption
490
491 [encryptionTrustUIGet]
492 async=
493 type=method
494 category=core
495 sig_in=sss
496 sig_out=s
497 doc=Get XMLUI to manage trust for given encryption algorithm
498 doc_param_0=to_jid: bare JID of entity to manage
499 doc_param_0=namespace: namespace of the algorithm to manage
500 doc_param_2=%(doc_profile_key)s
501 doc_return=(XMLUI) UI of the trust management
483 502
484 [setPresence] 503 [setPresence]
485 type=method 504 type=method
486 category=core 505 category=core
487 sig_in=ssa{ss}s 506 sig_in=ssa{ss}s