xeps/xep-0127.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Common Alerting Protocol (CAP) Over XMPP</title>
  <abstract>This document specifies a method for sending Common Alerting Protocol (CAP) data over XMPP.</abstract>
  &LEGALNOTICE;
  <number>0127</number>
  <status>Active</status>
  <type>Informational</type>
  <sig>Standards</sig>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>Common Alerting Protocol</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>None</shortname>
  &stpeter;
  <author>
    <firstname>Boyd</firstname>
    <surname>Fletcher</surname>
    <email>Boyd.Fletcher@je.jfcom.mil</email>
    <jid>bfletcher@jabber.com</jid>
  </author>
  <revision>
    <version>1.0</version>
    <date>2004-12-09</date>
    <initials>psa</initials>
    <remark>Per a vote of the Jabber Council, advanced status to Active.</remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2004-11-09</date>
    <initials>psa</initials>
    <remark>Added references to XEP-0033 and XEP-0131.</remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2004-02-23</date>
    <initials>psa</initials>
    <remark>Initial version.</remark>
  </revision>
</header>
<section1 topic='Introduction'>
  <p>The &oasiscap; (CAP) is an open format for alerts and notifications, defined by &OASIS;. CAP was developed to address the call, published in a (U.S.) National Science and Technology Council report, for "a standard method ... to collect and relay instantaneously and automatically all types of hazard warnings and reports". Given that the Extensible Messaging and Presence Protocol (see &xmppcore;) provides a near-real-time transport mechanism for structured information, and that CAP is defined as an XML data format, it makes sense to define a way to transport CAP information over XMPP. Such a method is defined herein.</p>
</section1>
<section1 topic='Terminology'>
  <p>The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in &rfc2119;.</p>
</section1>
<section1 topic='Protocol'>
  <p>Because the alerts and notifications structured via CAP require a "push" medium, they SHOULD be sent via the XML &MESSAGE; stanza defined in <cite>XMPP Core</cite>. The message could be sent using either of the following methods:</p>
  <ol>
    <li>Directly from the sender to a single recipient, a list of recipients (using &xep0033;), or a &xep0045; room</li>
    <li>Published to a list of subscribers via &xep0060;</li>
  </ol>
  <p>Both methods are described below.</p>
  <section2 topic='Direct Messages'>
    <p>In the case of direct messages, the message stanza SHOULD have no 'type' attribute, but MAY have any defined type that is appropriate to the communications context (e.g., "groupchat" in a text conference). The &lt;alert/&gt; element SHOULD be the only child element of the message stanza, but other elements MAY be included as necessary (e.g., a &lt;body/&gt; child in the 'jabber:client' namespace providing a natural-language description of the alert). The 'id' attribute of the &MESSAGE; stanza MAY be set to the value of the CAP &lt;identifier/&gt; element.</p>
    <p>The following example shows Example A.2 from the CAP specification sent as a direct message.</p>
    <example caption='An Alert Sent as a Message'><![CDATA[
<message from='KSTO@NWS.NOAA.GOV'
         to='weatherbot@jabber.org'
         id='KSTO1055887203'>
  <alert xmlns='http://www.incident.com/cap/1.0'>
    <identifier>KSTO1055887203</identifier>
    <sender>KSTO@NWS.NOAA.GOV</sender>
    <sent>2003-06-17T14:57:00-07:00</sent>
    <status>Actual</status>
    <msgType>Alert</msgType>
    <scope>Public</scope>
    <info>
      <category>Met</category>
      <event>SEVERE THUNDERSTORM</event>
      <urgency>Severe</urgency>
      <certainty>Likely</certainty>
      <eventCode>same=SVR</eventCode>
      <senderName>NATIONAL WEATHER SERVICE SACRAMENTO</senderName>
      <headline>SEVERE THUNDERSTORM WARNING</headline>
      <description>
        AT 254 PM PDT... NATIONAL WEATHER SERVICE DOPPLER RADAR
        INDICATED A SEVERE THUNDERSTORM OVER SOUTH CENTRAL ALPINE
        COUNTY... OR ABOUT 18 MILES SOUTHEAST OF KIRKWOOD...
        MOVING SOUTHWEST AT 5 MPH. HAIL... INTENSE RAIN AND STRONG
        DAMAGING WINDS ARE LIKELY WITH THIS STORM
      </description>
      <instruction>
        TAKE COVER IN A SUBSTANTIAL SHELTER UNTIL THE STORM PASSES
      </instruction>
      <contact>BARUFFALDI/JUSKIE</contact>
      <area>
        <areaDesc>
          EXTREME NORTH CENTRAL TUOLUMNE COUNTY IN CALIFORNIA,
          EXTREME NORTHEASTERN CALAVERAS COUNTY IN CALIFORNIA,
          SOUTHWESTERN ALPINE COUNTY IN CALIFORNIA
        </areaDesc>
        <polygon>
          38.47,-120.14 38.34,-119.95 38.52,-119.74
          38.62,-119.89 38.47,-120.14
        </polygon>
        <geocode>fips6=006109</geocode>
        <geocode>fips6=006109</geocode>
        <geocode>fips6=006103</geocode>
      </area>
    </info>
  </alert>
</message>
]]></example>
  </section2>
  <section2 topic='PubSub'>
    <p>The publish-subscribe protocol defined in XEP-0060 provides a way to send information to a number of subscribers, and to control the list of subscribers.</p>
    <p>The following example shows Example A.2 from the CAP specification published to a pubsub node.</p>
    <example caption='An Alert Published to a PubSub Node'><![CDATA[
<iq type='set'
    from='KSTO@NWS.NOAA.GOV'
    to='pubsub.jabber.org'
    id='someID'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='NOAA-ALERTS'>
      <item id='KSTO1055887203'>
        <alert xmlns='http://www.incident.com/cap/1.0'>
          <identifier>KSTO1055887203</identifier>
          <sender>KSTO@NWS.NOAA.GOV</sender>
          <sent>2003-06-17T14:57:00-07:00</sent>
          <status>Actual</status>
          <msgType>Alert</msgType>
          <scope>Public</scope>
          <info>
            <category>Met</category>
            <event>SEVERE THUNDERSTORM</event>
            <urgency>Severe</urgency>
            <certainty>Likely</certainty>
            <eventCode>same=SVR</eventCode>
            <senderName>NATIONAL WEATHER SERVICE SACRAMENTO</senderName>
            <headline>SEVERE THUNDERSTORM WARNING</headline>
            <description>
              AT 254 PM PDT... NATIONAL WEATHER SERVICE DOPPLER RADAR
              INDICATED A SEVERE THUNDERSTORM OVER SOUTH CENTRAL ALPINE
              COUNTY... OR ABOUT 18 MILES SOUTHEAST OF KIRKWOOD...
              MOVING SOUTHWEST AT 5 MPH. HAIL... INTENSE RAIN AND STRONG
              DAMAGING WINDS ARE LIKELY WITH THIS STORM
            </description>
            <instruction>
              TAKE COVER IN A SUBSTANTIAL SHELTER UNTIL THE STORM PASSES
            </instruction>
            <contact>BARUFFALDI/JUSKIE</contact>
            <area>
              <areaDesc>
                EXTREME NORTH CENTRAL TUOLUMNE COUNTY IN CALIFORNIA,
                EXTREME NORTHEASTERN CALAVERAS COUNTY IN CALIFORNIA,
                SOUTHWESTERN ALPINE COUNTY IN CALIFORNIA
              </areaDesc>
              <polygon>
                38.47,-120.14 38.34,-119.95 38.52,-119.74
                38.62,-119.89 38.47,-120.14
              </polygon>
              <geocode>fips6=006109</geocode>
              <geocode>fips6=006109</geocode>
              <geocode>fips6=006103</geocode>
            </area>
          </info>
        </alert>
      </item>
    </publish>
  </pubsub>
</iq>
]]></example>
    <p>If the pubsub node is configured to deliver payloads, the information is then sent to all subscribers.</p>
    <example caption='An Alert Sent as a PubSub Payload'><![CDATA[
<message from='pubsub.jabber.org'
         to='weatherbot@jabber.org'>
  <event xmlns="http://jabber.org/protocol/pubsub#event">
    <items node="NOAA-ALERTS">
      <alert xmlns='http://www.incident.com/cap/1.0'>
        <identifier>KSTO1055887203</identifier>
        <sender>KSTO@NWS.NOAA.GOV</sender>
        <sent>2003-06-17T14:57:00-07:00</sent>
        <status>Actual</status>
        <msgType>Alert</msgType>
        <scope>Public</scope>
        <info>
          <category>Met</category>
          <event>SEVERE THUNDERSTORM</event>
          <urgency>Severe</urgency>
          <certainty>Likely</certainty>
          <eventCode>same=SVR</eventCode>
          <senderName>NATIONAL WEATHER SERVICE SACRAMENTO</senderName>
          <headline>SEVERE THUNDERSTORM WARNING</headline>
          <description>
            AT 254 PM PDT... NATIONAL WEATHER SERVICE DOPPLER RADAR
            INDICATED A SEVERE THUNDERSTORM OVER SOUTH CENTRAL ALPINE
            COUNTY... OR ABOUT 18 MILES SOUTHEAST OF KIRKWOOD...
            MOVING SOUTHWEST AT 5 MPH. HAIL... INTENSE RAIN AND STRONG
            DAMAGING WINDS ARE LIKELY WITH THIS STORM
          </description>
          <instruction>
            TAKE COVER IN A SUBSTANTIAL SHELTER UNTIL THE STORM PASSES
          </instruction>
          <contact>BARUFFALDI/JUSKIE</contact>
          <area>
            <areaDesc>
              EXTREME NORTH CENTRAL TUOLUMNE COUNTY IN CALIFORNIA,
              EXTREME NORTHEASTERN CALAVERAS COUNTY IN CALIFORNIA,
              SOUTHWESTERN ALPINE COUNTY IN CALIFORNIA
            </areaDesc>
            <polygon>
              38.47,-120.14 38.34,-119.95 38.52,-119.74
              38.62,-119.89 38.47,-120.14
            </polygon>
            <geocode>fips6=006109</geocode>
            <geocode>fips6=006109</geocode>
            <geocode>fips6=006103</geocode>
          </area>
        </info>
      </alert>
    </items>
  </event>
</message>
.
.
.
]]></example>
  </section2>
</section1>
<section1 topic='Security Considerations'>
  <p>Security considerations for CAP are defined in <strong>Common Alerting Protocol, v. 1.0</strong>; security considerations for XMPP are defined in <strong>RFC 3920: XMPP Core</strong>; security considerations for the XMPP publish-subscribe extension are defined in <cite>XEP-0060: Publish Subscribe</cite>.</p>
  <p>Furthermore, it may be appropriate to include the "Classification", "Distribute", and/or "Store" headers specified in &xep0131; in order to safeguard CAP data.</p>
</section1>
<section1 topic='IANA Considerations'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>
<section1 topic='XMPP Registrar Considerations'>
  <p>No namespaces or parameters need to be registered with the &REGISTRAR; as a result of this document.</p>
</section1>
<section1 topic='XML Schema'>
  <p>The CAP information format is defined by an XML schema. The reader is referred to the CAP specification for the relevant schema definition.</p>
</section1>
</xep>