XEP-0063: Basic Filtering Operations

WARNING: Consideration of this document has been Deferred by the XMPP Standards Foundation. Implementation of the protocol described herein is not recommended.

Table of Contents

1. Introduction

This document defines a module for Packet Filtering [1] that provides some basic conditions and actions to perform common packet filtering tasks.

This module operates in the "http://jabber.org/protocol/filter/basic" namespace.

2. Conditions

This module defines the fullowing conditions:

• <message/> - true if the packet is a <message/> packet.
• <presence/> - true if the packet is a <presence/> packet.
• <iq/> - true if the packet is a <iq/> packet. If this element contains CDATA, then it must match the namespace of the first element inside the packet (typically <query/>) in order to be true.
• <to/> - true when the CDATA of this element matches the "to" attribute of the packet.
• <from/> - true when the CDATA of this element matches the "from" attribute of the packet.
• <type/> - true when the CDATA of this element matches the "type" attribute of the packet.

Example 1. Matches all presence packets

<presence xmlns='http://jabber.org/protocol/filter/basic'/>

Example 2. Matches all jabber:iq:version IQ packets

<iq xmlns='http://jabber.org/protocol/filter/basic'>jabber:iq:version</iq>

Example 3. Matches all packets from user@company.com

<from xmlns='http://jabber.org/protocol/filter/basic'>user@company.com</from>

3. Actions

This module defines the fullowing actions:

• <drop/> - drops the packet
• <bounce/> - bounces the packet with the error specified in the "code" attribute of this element.
• <redirect/> - redirects the packet to the JID specified in the CDATA of this element.
• <copy/> - sends a copy of the packet to the JID specified in the CDATA of this element, while giving the original packet to the user.

Example 4. Pretend that we don't exist

<bounce xmlns='http://jabber.org/protocol/filter/basic' code='404'/>

Example 5. Send a copy to our home account

<copy xmlns='http://jabber.org/protocol/filter/basic'>me@home.com</copy>

4. Security Considerations

There are no security features or concerns related to this proposal.

5. IANA Considerations

This document requires no interaction with the IANA.

6. JANA Considerations

No namespaces or parameters need to be registered with JANA as a result of this document.

Appendices

Appendix A: Document Information

Series: XEP
Number: 0063
Publisher: XMPP Standards Foundation
Status: Deferred
Type: Informational
Version: 0.2
Last Updated: 2003-09-30
Approving Body: XMPP Council
Dependencies: None
Supersedes: None
Superseded By: None
Short Name: Not yet assigned
Source Control: HTML
This document in other formats: XML  PDF

Appendix B: Author Information

Appendix C: Legal Notices

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) 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

Appendix H: Revision History

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

END