Network Working Group J. Snell Internet-Draft November 2005 Expires: May 5, 2006 Atom Syndication Format Tombstones draft-snell-atompub-tombstones-00.txt Status of this Memo By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet- Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire on May 5, 2006. Copyright Notice Copyright (C) The Internet Society (2005). Abstract This specification defines mechanisms by which Atom Feed publishers may explicitly indicate that specific Atom Entries have been deleted or archived. Snell Expires May 5, 2006 [Page 1] Internet-Draft Atom Tombstones November 2005 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Notational Conventions . . . . . . . . . . . . . . . . . . . . 3 3. The 'deleted-entry' element . . . . . . . . . . . . . . . . . . 3 4. The 'archived-entry' element . . . . . . . . . . . . . . . . . 4 5. The 'by' Element . . . . . . . . . . . . . . . . . . . . . . . 6 6. The 'comment' Element . . . . . . . . . . . . . . . . . . . . . 6 7. Security Considerations . . . . . . . . . . . . . . . . . . . . 6 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 6 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 6 10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 8 Intellectual Property and Copyright Statements . . . . . . . . . . 9 Snell Expires May 5, 2006 [Page 2] Internet-Draft Atom Tombstones November 2005 1. Introduction This specification defines mechanisms in the form of Atom Format [RFC4287] extensions that Atom Feed publishers can use to explicitly indicate that specific Atom Entries have been removed from a feed due to deletion or archiving. 2. Notational Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14, [RFC2119] This specification uses XML Namespaces [W3C.REC-xml-names-19990114] to uniquely identify XML element names. It uses the following namespace prefix for the indicated namespace URI; {Ed. Note: this namespace MUST be changed to a proper IETF namespace scheme prior to publication} "at": "http://purl.org/atompub/tombstones/1.0" 3. The 'deleted-entry' element The 'deleted-entry' element MAY appear as a child of atom:feed to represent an Atom Entry that has been removed from the feed due to deletion. The element consists of a required 'id' attribute whose value specifies the universally unique atom:id value of the deleted entry and an optional 'when' attribute whose value is an Atom Date Construct specifying the instant the entry was deleted. deletedEntry = element at:deleted-entry { atomCommonAttributes, & attribute id { atomURI }, & attribute when { atomDateConstruct }?, ( by?, & comment*, & undefinedContent ) } Atom Processors MUST ignore 'deleted-entry' elements whose 'id' attributes reference Atom Entries that have not previously appeared within the Atom Feed document. The 'deleted-entry' element MAY contain a 'by' element that identifies the entity that deleted the entry. Snell Expires May 5, 2006 [Page 3] Internet-Draft Atom Tombstones November 2005 The 'deleted-entry' element MAY contain zero or more 'comment' elements whose content provides additional information about the deletion operation. Atom Feed Documents MAY contain any number of 'deleted-entry' elements. ... John Doe jdoe@example.org Removed comment spam John Doe jdoe@example.org Removed comment spam ... 4. The 'archived-entry' element The 'archived-entry' element MAY appear as a child of atom:feed to represent an Atom Entry that has been removed from the feed due to archiving. The element consists of a required 'id' attrubute whose value specifies the universally unique atom:id value of the archived entry, a required 'href' attribute whose value specifies the IRI from which the archived Atom Entry Document MAY be retrieved, and an optional 'when' attribute whose value is an Atom Date Construct specifying the instant the entry was archived. Snell Expires May 5, 2006 [Page 4] Internet-Draft Atom Tombstones November 2005 archivedEntry = element at:archived-entry { atomCommonAttributes, & attribute id { atomURI }, & attribute href { atomURI }, & attribute when { atomDateConstruct }?, ( by?, & comment*, & undefinedContent ) } The 'archived-entry' element MAY contain a 'by' element that identifies the entity that archived the entry. The 'archived-entry' element MAY contain zero or more 'comment' elements whose content provides additional information about the archival operation. Atom Processors MUST ignore 'archived-entry' elements whose 'id' attributes reference Atom Entries that have not previously appeared within the Atom Feed document. Atom Feed Documents MAY contain any number of 'archived-entry' elements. ... Automated Archive Process Automated Archive Process ... Snell Expires May 5, 2006 [Page 5] Internet-Draft Atom Tombstones November 2005 5. The 'by' Element The 'by' element is an Atom Person Construct that is used to identify the entity that performed a deletion or archive operation on an entry. by = element at:by { atomPersonConstruct } 6. The 'comment' Element The 'comment' element in an Atom Text Construct that is used to provide additional human readable information about a deletion or archive operation on an entry. comment = element at:comment { atomTextConstruct } 7. Security Considerations As specified in [RFC4287], Atom processors should be aware of the potential for spoofing attacks where an attacked publishes atom:entry elements with the same atom:id value of entries from other Atom feeds. The same potential exists with the mechanisms defined here in that an attacker may attempt to spoof an application into believing that a given entry has been removed from a feed. To mitigate this issue, Atom processors MUST ignore 'deleted-entry' and 'archived- entry' elements referencing entries that have not previously appeared within the containing Feed document and should take steps to verify the origin of the Atom feed before considering the entries to be removed. 8. IANA Considerations There are no IANA considerations introduced by this specification. 9. Acknowledgements The author gratefully acknowledges the feedback from the members of the Atom Publishing Format and Protocol working group during the development of this specification. 10. References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. Snell Expires May 5, 2006 [Page 6] Internet-Draft Atom Tombstones November 2005 [RFC4287] Nottingham, M. and R. Sayre, "The Atom Syndication Format", RFC 4287, December 2005. [W3C.REC-xml-infoset-20040204] Tobin, R. and J. Cowan, "XML Information Set (Second Edition)", W3C REC REC-xml-infoset-20040204, February 2004. [W3C.REC-xml-names-19990114] Hollander, D., Bray, T., and A. Layman, "Namespaces in XML", W3C REC REC-xml-names-19990114, January 1999. Snell Expires May 5, 2006 [Page 7] Internet-Draft Atom Tombstones November 2005 Author's Address James M Snell Phone: Email: jasnell@gmail.com URI: http://snellspace.com Snell Expires May 5, 2006 [Page 8] Internet-Draft Atom Tombstones November 2005 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Disclaimer of Validity This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Copyright Statement Copyright (C) The Internet Society (2005). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Snell Expires May 5, 2006 [Page 9]