XEP-xxxx: XMPP Traceroute

Abstract
TODO
Author
Florian Schmaus
Copyright
© 1999 – 2020 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <http://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.1 (2019-04-19)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Draft
  4. Final

1. Introduction

Use case: Debug and statistics.

2. XMPP Traceroute

Example 1. A Traceroute IQ Request
<iq from='romeo@mantague.lit/home' to='juliet@capulet.lit/balcony' id='trace-id-1' type='get'>
  <traceroute xmlns='urn:xmpp:traceroute:0'>
    <send by='romeo@montague.lit/home'
       to='montague.lit'
       timestamp='TODO'>
      <connection-security>TLS...</connection-security>
    </send>
  </traceroute>
</iq>

Hops supporting XMPP traceroute SHOULD fill out 'by', 'to' and 'timestamp'. All other information is OPTIONAL.

Example 2. An XMPP Traceroute IQ Result
<iq from='juliet@capulet.lit/chamber'
    to='romeo@montague.lit/home'
    id='trace-id-1'
    type='result'>
  <traceroute-result xmlns='urn:xmpp:traceroute:0'>
    <send by='romeo@montague.lit/home'
         to='montague.lit'
         timestamp='TODO'>
      <connection>
        <security>TLSv1.2 ECDHE-RSA-AES256-GCM-SHA384</connection-security>
        <local>
          <ip>TODO</ip>
          <port></port>
        </local>
        <remote>
          <ip>TODO</ip>
          <port></port>
        </remote>
        <id>2EkSZzyn</id>
      </connection>
    </send>
    <received by='montague.lit'
             from='romeo@mantague.lit/home'
             timestamp='TODO'>
      <connection>
      …
      </connection>
     <!-- More optional metadata here -->
    </received>
    <send by='montague.lit'
         to='capulet.lit'
         timestamp='TODO'>
      <connection>
      …
      </connection>
    </send>
    <received by='capulet.lit'
             from='montague.lit'
             timestamp='TODO'>
      <connection>
      …
      </connection>
    </received>
    <send by='capulet.lit'
         to='juliet@capulet.lit/balcony'
         timestamp='TODO'>
      <connection>
      …
      </connection>
    </send>
    <received by='juliet@capulet.lit/balcony'
             from='capulet.lit'
             timestamp='TODO'>
    </received>
    <!-- Traceroute IQ arrived at destination -->
    <send by='juliet@capulet.lit/balcony'
             to='capulet.lit'
             timestamp='TODO'>
    </send>
    <received by='capulet.lit'
             from='juliet@capulet.lit/balcony'
             timestamp='TODO'>
      <connection>
      …
      </connection>
    </received>
    <send by='capulet.lit'
             to='montague.lit'
             timestamp='TODO'>
      <connection>
      …
      </connection>
    </send>
    <received by='montage.lit'
             from='capulet.lit'
             timestamp='TODO'>
      <connection>
      …
      </connection>
    </received>
    <send by='montage.lit'
             to='romeo@montague.lit/home'
             timestamp='TODO'>
      <connection>
      …
      </connection>
    </send>
  </traceroute>
</iq>
Example 3. A Traceroute IQ Request
<iq from='romeo@mantague.lit/home' to='juliet@capulet.lit/balcony' id='trace-id-2' type='get'>
  <traceroute xmlns='urn:xmpp:traceroute:0' immediate='true'>
    <send by='romeo@montague.lit/home'
       to='montague.lit'
       timestamp='TODO'>
      <connection-security>TLS...</connection-security>
    </send>
  </traceroute>
</iq>
Example 4. A Traceroute immediate message, same hop but forwards
<message from='capulet.lit' to='romeo@mantague.lit/home' id='s2c1' type='get'>
  <traceroute-immediate-result xmlns='urn:xmpp:traceroute:0' id='trace-id-2' >
    <send by='romeo@montague.lit/home'
       to='montague.lit'
       timestamp='TODO'>
      <connection-security>TLS...</connection-security>
    </send>
  </traceroute>
</iq>
Example 5. A Traceroute immediate message, same hop but backwards
<message from='capulet.lit' to='romeo@mantague.lit/home' id='s2c1' type='get'>
  <traceroute-immediate-result xmlns='urn:xmpp:traceroute:0' id='trace-id-2' >
    <send by='romeo@montague.lit/home'
       to='montague.lit'
       timestamp='TODO'>
      <connection-security>TLS...</connection-security>
    </send>
  </traceroute>
</iq>

3. Discovering Support

An entity that follows the buisness rules and supports XMPP traceroute SHOULD announce the 'urn:xmpp:traceroute:0' namespace in its disco features.

Example 6. Client sends service discovery request
<iq from='romeo@montague.tld/garden'
    id='somethingrandom'
    to='example.com'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#info' />
</iq>
Example 7. Compliant servers include the traceroute namespace in its features
<iq from='example.com'
    to='romeo@montague.tld/garden'
    id='somethingrandom'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    …
    <feature var='urn:xmpp:traceroute:0'/>
    …
  </query>
</iq>

4. Security Considerations

TODO

5. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [1].

6. XMPP Registrar Considerations

6.1 Protocol Namespaces

This specification defines the following XML namespaces:

The XMPP Registrar [2] shall include the foregoing namespaces in its registry of protocol namespaces (see <https://xmpp.org/registrar/namespaces.html>) and in its disco features registry (<https://xmpp.org/registrar/disco-features.html>) as defined in Service Discovery (XEP-0030) [3].

Registration
<var>
  <name>urn:xmpp:stanza-timestamps:0</name>
  <desc>Indicates that an entity supports XMPP traceroute and follows the business rules described in the XEP</desc>
  <doc>XEP-TRACEROUTE</doc>
</var>

7. XML Schema

REQUIRED for protocol specifications.

8. Acknowledgements

Thanks to Kim Alvefur.

Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.1
Last Updated
2019-04-19
Approving Body
XMPP Council
Dependencies
XMPP Core
Supersedes
None
Superseded By
None
Short Name
sts

This document in other formats: XML  PDF

Appendix B: Author Information

Florian Schmaus
Email
flo@geekplace.eu
JabberID
flo@geekplace.eu

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2020 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

1. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

2. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.

3. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.

Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

  1. Version 0.0.1 (2019-04-19)

    First draft.

    fs

END