prosody-modules
8e1f1eb00b58
mod_export_skeletons/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

File

mod_export_skeletons/README.md @ 5285:8e1f1eb00b58

mod_sasl2_fast: Fix harmless off-by-one error (invalidates existing tokens!) Problem: This was causing the key to become "<token>--cur" instead of the expected "<token>-cur". As the same key was used by the code to both set and get, it still worked. Rationale for change: Although it worked, it's unintended, inconsistent and messy. It increases the chances of future bugs due to the unexpected format. Side-effects of change: Existing '--cur' entries will not be checked after this change, and therefore existing FAST clients will fail to authenticate until they attempt password auth and obtain a new FAST token. Existing '--cur' entries in storage will not be cleaned up by this commit, but this is considered a minor issue, and okay for the relatively few FAST deployments.
author Matthew Wild <mwild1@gmail.com>
date Wed, 29 Mar 2023 16:12:15 +0100
parent 4821:17fbe82d4bfe
line wrap: on
line source

---
summary: Export message archives in sanitized minimal form for analysis
---

Exports message archives in a format stripped from private information
and message content.

# Usage

    prosodyctl mod_export_skeletons [options] user@host*

Multiple user JIDs can be given.

## Options

`--store=archive`
:   For overriding the store name, e.g. for compat with `archive2` or
    querying MUC archives with `muc_log`

`--start=timestamp`
:	Start of time span to export in [XEP-0082] format

`--end=timestamp`
:	End of time span to export in [XEP-0082] format

# Output

All content is stripped, leaving only the basic XML structure, with
child tags sorted.

Top level attributes are given special treatment since they carry
protocol semantics. Notably the `@to` and `@from` JIDs are replaced by
symbolic labels to convey what form (bare, full or host) they had. The
`@id` attribute is replaced with a string with the length based on log2
of the original length.

## Example

``` xml
<message from='full' id='xxxxx' type='chat' to='bare'><body/><x xmlns='jabber:x:oob'><url/></x></message>
<message from='bare' id='xxxxx' type='error' to='full'><error><remote-server-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/><text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/></error></message>
<message from='full' id='xxxxx' type='chat' to='bare'><body/><x xmlns='jabber:x:oob'><url/></x></message>
<message from='full' id='xxxxxx' type='normal' to='bare'><x xmlns='jabber:x:conference'/></message>
```