<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep xmlns="">
<header>
  <title>Software Information</title>
  <abstract>This document specifies an extended data format whereby XMPP service discovery responses can include detailed information about the software application that powers a given XMPP entity for includion in service discovery responses.</abstract>
  
<legal>
<copyright>This XMPP Extension Protocol is copyright © 1999 – 2024 by the <link url="https://xmpp.org/">XMPP Standards Foundation</link> (XSF).</copyright>
<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.</permissions>
<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. ##</warranty>
<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.</liability>
<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 &lt;<link url="https://xmpp.org/about/xsf/ipr-policy">https://xmpp.org/about/xsf/ipr-policy</link>&gt; or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).</conformance>
</legal>
  <number>0232</number>
  <status>Deferred</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0004</spec>
    <spec>XEP-0030</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT_YET_ASSIGNED</shortname>
  
  <author>
    <firstname>Peter</firstname>
    <surname>Saint-Andre</surname>
    <email>stpeter@stpeter.im</email>
    <jid>stpeter@jabber.org</jid>
    <uri>https://stpeter.im/</uri>
  </author>

  <revision>
    <version>0.3</version>
    <date>2009-02-26</date>
    <initials>psa</initials>
    <remark><p>Per Last Call feedback, removed icons for presence states; redefined the icon field to use media element per XEP-0221.</p></remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2008-03-14</date>
    <initials>psa</initials>
    <remark><p>Added icon fields.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2008-01-30</date>
    <initials>psa</initials>
    <remark><p>Initial published version.</p></remark>
  </revision>
  <revision>
    <version>0.0.3</version>
    <date>2008-01-23</date>
    <initials>psa</initials>
    <remark><p>Added software field; generalized to be software information, not client information.</p></remark>
  </revision>
  <revision>
    <version>0.0.2</version>
    <date>2008-01-22</date>
    <initials>psa</initials>
    <remark><p>Clarified relationship to Software Version (XEP-0092).</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2008-01-21</date>
    <initials>psa</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>

<section1 topic="Introduction" anchor="intro">
  <p><span class="ref"><link url="https://xmpp.org/extensions/xep-0128.html">Service Discovery Extensions (XEP-0128)</link></span> <note>XEP-0128: Service Discovery Extensions &lt;<link url="https://xmpp.org/extensions/xep-0128.html">https://xmpp.org/extensions/xep-0128.html</link>&gt;.</note> defines a way for an XMPP entity to include extended information in its responses to <span class="ref"><link url="https://xmpp.org/extensions/xep-0030.html">Service Discovery (XEP-0030)</link></span> <note>XEP-0030: Service Discovery &lt;<link url="https://xmpp.org/extensions/xep-0030.html">https://xmpp.org/extensions/xep-0030.html</link>&gt;.</note> information requests. This document specifies a usage of <span class="ref"><link url="https://xmpp.org/extensions/xep-0128.html">Service Discovery Extensions (XEP-0128)</link></span> <note>XEP-0128: Service Discovery Extensions &lt;<link url="https://xmpp.org/extensions/xep-0128.html">https://xmpp.org/extensions/xep-0128.html</link>&gt;.</note> whereby an XMPP entity can provide detailed data about itself in such responses. This protocol is intended to replace <span class="ref"><link url="https://xmpp.org/extensions/xep-0092.html">Software Version (XEP-0092)</link></span> <note>XEP-0092: Software Version &lt;<link url="https://xmpp.org/extensions/xep-0092.html">https://xmpp.org/extensions/xep-0092.html</link>&gt;.</note> for software information discovery (thus reducing or eliminating the need for distinct software version requests) and also provides a format that can be encapsulated into <span class="ref"><link url="https://xmpp.org/extensions/xep-0115.html">Entity Capabilities (XEP-0115)</link></span> <note>XEP-0115: Entity Capabilities &lt;<link url="https://xmpp.org/extensions/xep-0115.html">https://xmpp.org/extensions/xep-0115.html</link>&gt;.</note> notifications.</p>
</section1>

<section1 topic="Use Case" anchor="usecase">
  <p>To illustrate this usage, consider the following example of a disco#info request-response interaction that includes detailed client information:</p>
  <example caption="Entity queries client for information"><![CDATA[
<iq from='romeo@montaguue.lit/orchard'
    to='juliet@capulet.lit/chamber'
    id='disco1'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
  <p>Upon receiving the disco#info request, the software replies and includes extended information in a data form (<span class="ref"><link url="https://xmpp.org/extensions/xep-0004.html">Data Forms (XEP-0004)</link></span> <note>XEP-0004: Data Forms &lt;<link url="https://xmpp.org/extensions/xep-0004.html">https://xmpp.org/extensions/xep-0004.html</link>&gt;.</note>), where the icon is communicated using the format defined in <span class="ref"><link url="https://xmpp.org/extensions/xep-0221.html">Data Forms Media Element (XEP-0221)</link></span> <note>XEP-0221: Data Forms Media Element &lt;<link url="https://xmpp.org/extensions/xep-0221.html">https://xmpp.org/extensions/xep-0221.html</link>&gt;.</note>.</p>
  <example caption="Client communicates information"><![CDATA[
<iq from='juliet@capulet.lit/chamber'
    to='romeo@montague.lit/orchard'
    id='disco1'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <identity category='client' name='Exodus' type='pc'/>
    <feature var='http://jabber.org/protocol/disco'/>
    <x xmlns='jabber:x:data' type='result'>
      <field var='FORM_TYPE' type='hidden'>
        <value>urn:xmpp:dataforms:softwareinfo</value>
      </field>
      <field var='icon'>
        <media xmlns='urn:xmpp:media-element'
               height='80'
               width='290'>
          <uri type='image/jpeg'>
            http://www.shakespeare.lit/clients/exodus.jpg
          </uri>
          <uri type='image/jpeg'>
            cid:sha1+f24030b8d91d233bac14777be5ab531ca3b9f102@bob.xmpp.org
          </uri>
        </media>
      </field>
      <field var='os'>
        <value>Windows</value>
      </field>
      <field var='os_version'>
        <value>XP</value>
      </field>
      <field var='software'>
        <value>Exodus</value>
      </field>
      <field var='software_version'>
        <value>0.9.1</value>
      </field>
    </x>
  </query>
</iq>
]]></example>
  <p>The fields have the following meaning:</p>
  <ul>
    <li>icon -- A default icon to show for a device running the software</li>
    <li>os -- The operating system on which the XMPP software is running</li>
    <li>os_version -- The operating system version</li>
    <li>software -- The XMPP software running at the entity (if this field is provided, its value SHOULD override any software name provided as the value of the 'name' attribute in the service discovery &lt;identity/&gt; element)</li>
    <li>software_version -- The XMPP software version</li>
  </ul>
</section1>

<section1 topic="Security Considerations" anchor="security">
  <p>Service discovery information is typically world-readable. Therefore, care should be taken in exposing information that may make it easier for a potential attacker to target the publishing entity's system (e.g., the operating system on which the software is running).</p>
</section1>

<section1 topic="IANA Considerations" anchor="iana">
  <p>This document requires no interaction with the <span class="ref"><link url="http://www.iana.org/">Internet Assigned Numbers Authority (IANA)</link></span> <note>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 &lt;<link url="http://www.iana.org/">http://www.iana.org/</link>&gt;.</note>.</p>
</section1>

<section1 topic="XMPP Registrar Considerations" anchor="registrar">
  <p>The <span class="ref"><link url="https://xmpp.org/registrar/">XMPP Registrar</link></span> <note>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 &lt;<link url="https://xmpp.org/registrar/">https://xmpp.org/registrar/</link>&gt;.</note> shall include the following information in its registries.</p>
  <section2 topic="Field Standardization" anchor="registrar-formtype">
    <p><span class="ref"><link url="https://xmpp.org/extensions/xep-0068.html">Field Standardization for Data Forms (XEP-0068)</link></span> <note>XEP-0068: Field Data Standardization for Data Forms &lt;<link url="https://xmpp.org/extensions/xep-0068.html">https://xmpp.org/extensions/xep-0068.html</link>&gt;.</note> defines a process for standardizing the fields used within Data Forms qualified by a particular namespace, and <span class="ref"><link url="https://xmpp.org/extensions/xep-0128.html">Service Discovery Extensions (XEP-0128)</link></span> <note>XEP-0128: Service Discovery Extensions &lt;<link url="https://xmpp.org/extensions/xep-0128.html">https://xmpp.org/extensions/xep-0128.html</link>&gt;.</note> describes how to use field standardization in the context of service discovery. This section registers fields for software information scoped by the "urn:xmpp:dataforms:softwareinfo" FORM_TYPE.</p>
    <code caption="Registry Submission"><![CDATA[
<form_type>
  <name>urn:xmpp:dataforms:softwareinfo</name>
  <doc>XEP-0232</doc>
  <desc>
    Forms enabling the communication of detailed information
    about an XMPP client.
  </desc>
  <field
      var='icon'
      type='text-single'
      label='A URL for an icon representing the software, no matter the
             presence or availability status of the XMPP entity'/>
  <field
      var='os'
      type='text-single'
      label='The operating system on which the XMPP software is running'/>
  <field
      var='os_version'
      type='text-single'
      label='The operating system version'/>
  <field
      var='software'
      type='text-single'
      label='The XMPP software running at the entity'/>
  <field
      var='software_version'
      type='text-single'
      label='The XMPP software version'/>
</form_type>
]]></code>
  </section2>
</section1>

<section1 topic="Acknowledgements" anchor="ack">
  <p>Thanks to Dave Cridland, Olivier Goffart, Joe Hildebrand, Etan Reisner, Remko Tronçon, and Jiří Zárevúcký for their comments.</p>
</section1>

</xep>
