Mercurial > libervia-backend
view doc/jp/roster.rst @ 3104:118d91c932a7
plugin XEP-0384: OMEMO for MUC implementation:
- encryption is now allowed for group chats
- when an encryption is requested for a MUC, real jids or all occupants are used to
encrypt the message
- a cache for plain text message sent to MUC is used, because for security reason we can't
encrypt message for our own device with OMEMO (that would prevent ratchet and break the
prefect forward secrecy). Thus, message sent in MUC are cached for 5 min, and the
decrypted version is used when found. We don't send immediately the plain text message
to frontends and history because we want to keep the same MUC behaviour as for plain
text, and receiving a message means that it was received and sent back by MUC service
- <origin-id> is used to identify messages sent by our device
- a feedback_jid is now use to use correct entity for feedback message in case of problem:
with a room we have to send feedback message to the room and not the the emitter
- encryptMessage now only accepts list in the renamed "entity_bare_jids" argument
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 30 Dec 2019 20:59:46 +0100 |
parents | 72583524cfd3 |
children | 012e89fb2dd1 |
line wrap: on
line source
================================ roster: manager an entity roster ================================ "Roster" is the name used in XMPP for the contact list. In addition to list of contacts, you have also data like subscription information or groups associated to a contact. Groups are simple strings associated to one or more contacts (e.g. "friends" or "family"). Subscription is the mechanism to get presence information of an entity. When you add a contact to your roster, most XMPP clients also do a presence subscription request, than the entity may accept or deny. If a presence subscription is accepted, the subscribed user can see when the other entity is online, and its presence status. get === Show the current roster. By default only a display name and JIDs are displayed, but you can increase verbosity to also display groups, or all other metadata. The short name shown next to jid is either the ``name`` specified in roster, or the node part of the jid. If none of them exist, only the entity JID is shown. The following metadata may be displayed: groups group the entity belong too ask true if a presence subscription request has been sent (but not answered yet) from the contact has a subscription to user presence (i.e. your contact can see when you're online and your presence status) to the user has a subscription to the contact presence (i.e. you can see when you're contact is online and his/her presence status) examples -------- Get roster of default profile and display groups:: $ jp roster get -v Get roster of default profile and display all metadata:: $ jp roster get -vv Get roster or default profile and show the result in JSON:: $ jp roster get -O json stats ===== Show some statistics about the profile roster. The number of contacts per server is shown, with a percentage of contacts on this server compared to the total number of contacts. This can notably be helpful to see if there is a concentration of your contacts in a specific server or gateway. Other more or less useful numbers are shown, they are self explaining. example ------- Get statistic for the default profile:: $ jp roster stats purge ===== This command is used to remove from the roster all contacts which have no subscription or only partial subscription. By default, only contacts without subscription at all are removed. With ``--no_from`` you also remove contacts which have no subscription to you (but you have a subscription to them), and with ``--no_to`` you also remove contacts that you are not subscribed to (but who are subscribed to you). example ------- Remove all contacts from default profile which have no subscription at all or from which the default profile is not subscribed to:: $ jp roster purge --no_to resync ====== SàT uses `roster versioning`_ to optimize the synchronisation of roster with server on client connection. This means that once the roster has been retrieved, on each following connection, only the difference of contacts (i.e. which new or removed contacts) is received. This command does a full resynchronisation of the roster, or in other words it requests the whole roster and save it, replacing the list built with versioning. ``resync`` is mostly useful for developers and end-user should not need this command, as roster versioning is supposed to work fine and the roster should be synchronised correctly on startup. But if for any reason you suspect that your current roster list is corrupted, you may use it to be sure that a full resynchronisation is done. .. _roster versioning: https://tools.ietf.org/html/rfc6121#section-2.6 exemple ------- Do a full resynchronisation of default profile's roster:: $ jp roster resync