idnits 2.17.1 draft-sparks-genarea-imaparch-08.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (July 15, 2013) is 3932 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- -- Obsolete informational reference (is this intentional?): RFC 3501 (Obsoleted by RFC 9051) -- Obsolete informational reference (is this intentional?): RFC 6237 (Obsoleted by RFC 7377) Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group R. Sparks 3 Internet-Draft Tekelec 4 Intended status: Informational July 15, 2013 5 Expires: January 16, 2014 7 IMAP Access to IETF Email List Archives 8 draft-sparks-genarea-imaparch-08 10 Abstract 12 The IETF makes heavy use of email lists to conduct its work. This 13 often involves accessing the archived history of those email lists. 14 Participants would like to have the ability to browse and search 15 those archives using standard IMAP clients. This memo captures the 16 requirements for providing a service that would allow such browsing 17 and searching, and it is intended as input to a later activity for 18 the design and development of such a service. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at http://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on January 16, 2014. 37 Copyright Notice 39 Copyright (c) 2013 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (http://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 55 2. Requirements for IMAP access to archived IETF lists . . . . . 2 56 3. Internationalized Address Considerations . . . . . . . . . . 3 57 4. Security Considerations . . . . . . . . . . . . . . . . . . . 3 58 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 59 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 4 60 7. Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . 4 61 7.1. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 4 62 7.2. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 4 63 7.3. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 5 64 7.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 5 65 7.5. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 5 66 7.6. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 5 67 7.7. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 5 68 7.8. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 69 8. Informative References . . . . . . . . . . . . . . . . . . . 5 70 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 6 72 1. Introduction 74 The IETF makes heavy use of email lists to conduct its work. This 75 often involves accessing the archived history of those email lists. 76 Requirements for improved web-based browsing and searching of these 77 archives are captured in [RFC6778]. Participants would like to have 78 the ability to browse and search those archives using standard IMAP 79 clients. This memo captures the requirements for providing a service 80 that would allow such browsing and searching, and it is intended as 81 input to a later activity for the design and development of such a 82 service. 84 2. Requirements for IMAP access to archived IETF lists 86 Many participants would prefer to access the list archives using IMAP 87 [RFC3501]. Providing this access while meeting the following 88 requirements will likely require an IMAP server with specialized 89 capabilities. 91 o The system should expose the archive using an IMAP interface, with 92 each list represented as a mailbox. 94 o This interface must work with standard IMAP clients. 96 o The interface should allow users that have provided credentials to 97 each have their own read/unread marks for messages. Allowing 98 other annotation is desirable. The implementation should consider 99 taking advantage of the IMAP extensions for ANNOTATE [RFC5257] and 100 METADATA [RFC5464]. 102 o It must be possible for administrators to set per-user storage 103 quotas, limiting the space a user can consume with annotations. 105 o The interface must not allow users to modify the underlying 106 message or metadata other than the read/unread marks and 107 annotations described above. Specifically, users must not be able 108 to delete or insert messages, or move them between mailboxes in 109 the archive. (Clients will, of course, be able to make local 110 copies of messages from the archive.) 112 o The interface must have server-side searching enabled, and should 113 scale to support multiple simultaneous extensive searches. The 114 server should provide the enhanced search capabilities described 115 in [RFC6778]. The implementation should consider taking advantage 116 of the extensions defined for IMAP SORT and THREAD [RFC5256], 117 multimailbox search [RFC6237], and fuzzy search [RFC6203]. 119 o When the system requires credentials, it must use the 120 datatracker's authentication system 122 - While the vast majority of archived lists have an open 123 access policy, some archived lists have restricted archives. 124 The system must make it possible to limit access to a 125 restricted archive based on login credentials. 127 - The system must allow access to open archives with or 128 without providing credentials. Specifically, the system 129 will allow anonymous access using the SASL ANONYMOUS 130 authentication mechanism [RFC4505] or a LOGIN command with a 131 special username (such as "anonymous") determined by the 132 administrator. 134 3. Internationalized Address Considerations 136 The implementation should anticipate internationalized email 137 addresses as discussed in the following three documents [RFC6532] 138 [RFC6531] [RFC6855]. There is no firm requirement at this time. 140 4. Security Considerations 141 Allowing IMAP as an interface for browsing and searching the archives 142 of IETF email lists does not affect the security of the Internet in 143 any significant fashion. 145 Searching can be I/O and CPU intensive. Clients that make local 146 copies of all messages in a mailbox can also present an I/O burden, 147 particularly when syncronizing for the first time. The implementors 148 of this interface should consider the potential for maliciously 149 crafted searches attempting to consume a damaging amount of 150 resources. The implementors should consider the potential for denial 151 of service attacks through making many connections to the interface. 152 The implementors should consider ways to rate limit I/O due to making 153 local copies of messages. 155 Storing read/unread marks and other annotations requires potentially 156 unbounded storage space. The implementors of this interface should 157 consider the potential for maliciously crafted annontations 158 attempting to consume a damaging amount of storage space. The 159 implementers should consider making it easy to alert the 160 administrator when a user begins consuming exceptional amounts of 161 space. 163 5. IANA Considerations 165 This document has no actions for IANA. 167 6. Acknowledgements 169 This text was derived directly from an early version of the Internet 170 Draft that became [RFC6778] which incorporated text suggestions from 171 Alexey Melnikov, Pete Resnick, and S. Moonesamy. Barry Leiba 172 suggested several references to IMAP extensions for an implementation 173 to consider. Reviews were provided by Martin Duerst, Carl Wallace, 174 Wassim Haddad, and Juergen Schoenwaelder. 176 7. Changelog 178 7.1. 06 to 07 180 o Editorial tweaks and clarifications based on IETF LC reviews. 182 7.2. 05 to 06 184 o Added a requirement making it explicit that this interface won't 185 allow users to delete, insert, or move messages between archives. 187 o Clarified how the would allow access without credentials (at 188 Alexey's suggestion). 190 o Pointed to potential resource abuse issues in the security 191 considerations section. 193 7.3. 04 to 05 195 o Adapted text from RFC6778 to make it more clear that both 196 authenticated and unauthenticated access should be supported. 198 7.4. 03 to 04 200 o Incorporated suggestions from Pete Resnick and Barry Leiba. 202 7.5. 02 to 03 204 o None - expiry refresh 206 7.6. 01 to 02 208 o Minor editorial changes 210 7.7. 00 to 01 212 o Added requirements to enable controlled access to restricted 213 archives based on credentials 215 o Generalized the requirement to use the datatracker's credentials. 217 7.8. 00 219 o Split this set of requirements out from the mailarch doc so that 220 this project could be pursued separately 222 8. Informative References 224 [RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 225 4rev1", RFC 3501, March 2003. 227 [RFC4505] Zeilenga, K., "Anonymous Simple Authentication and 228 Security Layer (SASL) Mechanism", RFC 4505, June 2006. 230 [RFC5256] Crispin, M. and K. Murchison, "Internet Message Access 231 Protocol - SORT and THREAD Extensions", RFC 5256, June 232 2008. 234 [RFC5257] Daboo, C. and R. Gellens, "Internet Message Access 235 Protocol - ANNOTATE Extension", RFC 5257, June 2008. 237 [RFC5464] Daboo, C., "The IMAP METADATA Extension", RFC 5464, 238 February 2009. 240 [RFC6203] Sirainen, T., "IMAP4 Extension for Fuzzy Search", RFC 241 6203, March 2011. 243 [RFC6237] Leiba, B. and A. Melnikov, "IMAP4 Multimailbox SEARCH 244 Extension", RFC 6237, May 2011. 246 [RFC6531] Yao, J. and W. Mao, "SMTP Extension for Internationalized 247 Email", RFC 6531, February 2012. 249 [RFC6532] Yang, A., Steele, S., and N. Freed, "Internationalized 250 Email Headers", RFC 6532, February 2012. 252 [RFC6778] Sparks, R., "Requirements for Archiving IETF Email Lists 253 and for Providing Web-Based Browsing and Searching", RFC 254 6778, October 2012. 256 [RFC6855] Resnick, P., Newman, C., and S. Shen, "IMAP Support for 257 UTF-8", RFC 6855, March 2013. 259 Author's Address 261 Robert Sparks 262 Tekelec 263 17210 Campbell Road 264 Suite 250 265 Dallas, Texas 75254-4203 266 USA 268 Email: rjsparks@nostrum.com