rfc3206.txt
New publish rfc for POP3
Showing
2 changed files
with
340 additions
and
0 deletions
doc/rfc/rfc3206.txt
0 → 100644
1 | |||
2 | |||
3 | |||
4 | |||
5 | |||
6 | |||
7 | Network Working Group R. Gellens | ||
8 | Request for Comments: 3206 QUALCOMM | ||
9 | Category: Standards Track February 2002 | ||
10 | |||
11 | |||
12 | The SYS and AUTH POP Response Codes | ||
13 | |||
14 | Status of this Memo | ||
15 | |||
16 | This document specifies an Internet standards track protocol for the | ||
17 | Internet community, and requests discussion and suggestions for | ||
18 | improvements. Please refer to the current edition of the "Internet | ||
19 | Official Protocol Standards" (STD 1) for the standardization state | ||
20 | and status of this protocol. Distribution of this memo is unlimited. | ||
21 | |||
22 | Copyright Notice | ||
23 | |||
24 | Copyright (C) The Internet Society (2002). All Rights Reserved. | ||
25 | |||
26 | Abstract | ||
27 | |||
28 | This memo proposes two response codes: SYS and AUTH, which enable | ||
29 | clients to unambiguously determine an optimal response to an | ||
30 | authentication failure. In addition, a new capability (AUTH-RESP- | ||
31 | CODE) is defined. | ||
32 | |||
33 | Table of Contents | ||
34 | |||
35 | 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 | ||
36 | 2. Conventions Used in this Document . . . . . . . . . . . . . . 2 | ||
37 | 3. Background . . . . . . . . . . . . . . . . . . . . . . . . 2 | ||
38 | 4. The SYS Response Code . . . . . . . . . . . . . . . . . . . 3 | ||
39 | 5. The AUTH Response Code . . . . . . . . . . . . . . . . . . 3 | ||
40 | 6. The AUTH-RESP-CODE Capability . . . . . . . . . . . . . . . 4 | ||
41 | 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . 4 | ||
42 | 8. Security Considerations . . . . . . . . . . . . . . . . . . 4 | ||
43 | 9. References . . . . . . . . . . . . . . . . . . . . . . . . 5 | ||
44 | 10. Author's Address . . . . . . . . . . . . . . . . . . . . . . 5 | ||
45 | 11. Full Copyright Statement . . . . . . . . . . . . . . . . . 6 | ||
46 | |||
47 | |||
48 | |||
49 | |||
50 | |||
51 | |||
52 | |||
53 | |||
54 | |||
55 | |||
56 | |||
57 | |||
58 | Gellens Standards Track [Page 1] | ||
59 | |||
60 | RFC 3206 The SYS and AUTH POP Response Codes February 2002 | ||
61 | |||
62 | |||
63 | |||
64 | 1. Introduction | ||
65 | |||
66 | RFC 2449 [POP3-EXT] defined extended [POP3] response codes, to give | ||
67 | clients more information about errors so clients can respond more | ||
68 | appropriately. In addition to the mechanism, two initial response | ||
69 | codes were defined (IN-USE and LOGIN-DELAY), in an attempt to | ||
70 | differentiate between authentication failures related to user | ||
71 | credentials, and other errors. | ||
72 | |||
73 | In practice, these two response codes, while helpful, do not go far | ||
74 | enough. This memo proposes two additional response codes: SYS and | ||
75 | AUTH, which enable clients to unambiguously determine an optimal | ||
76 | response to an authentication failure. | ||
77 | |||
78 | In addition, a new capability (AUTH-RESP-CODE) is defined. | ||
79 | |||
80 | 2. Conventions Used in this Document | ||
81 | |||
82 | The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | ||
83 | "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this | ||
84 | document are to be interpreted as described in RFC 2119 [KEYWORDS]. | ||
85 | |||
86 | 3. Background | ||
87 | |||
88 | RFC 2449 [POP3-EXT] introduced the IN-USE and LOGIN-DELAY response | ||
89 | codes. The intent is to allow clients to clearly determine the | ||
90 | underlying cause of a failure in order to respond. For example, | ||
91 | clients need to know if the user should be asked for new credentials, | ||
92 | or if the POP3 session should simply be tried again later. (Some | ||
93 | deployed POP3 clients attempt to parse the text of authentication | ||
94 | failure errors, looking for strings known to be issued by various | ||
95 | servers which indicate the mailbox is locked.) | ||
96 | |||
97 | IN-USE indicates that an exclusive lock could not be obtained for the | ||
98 | user's mailbox, probably because another POP3 session is in progress. | ||
99 | LOGIN-DELAY informs the client that the user has not waited long | ||
100 | enough before authenticating again. | ||
101 | |||
102 | However, there are other error conditions which do not require new | ||
103 | credentials, some of which should be brought to the user's attention. | ||
104 | |||
105 | Despite the IN-USE and LOGIN-DELAY responses, clients cannot be sure | ||
106 | if any other error requires new user credentials. | ||
107 | |||
108 | |||
109 | |||
110 | |||
111 | |||
112 | |||
113 | |||
114 | Gellens Standards Track [Page 2] | ||
115 | |||
116 | RFC 3206 The SYS and AUTH POP Response Codes February 2002 | ||
117 | |||
118 | |||
119 | 4. The SYS Response Code | ||
120 | |||
121 | The SYS response code announces that a failure is due to a system | ||
122 | error, as opposed to the user's credentials or an external condition. | ||
123 | It is hierarchical, with two possible second-level codes: TEMP and | ||
124 | PERM. (Case is not significant at any level of the hierarchy.) | ||
125 | |||
126 | SYS/TEMP indicates a problem which is likely to be temporary in | ||
127 | nature, and therefore there is no need to alarm the user, unless the | ||
128 | failure persists. Examples might include a central resource which is | ||
129 | currently locked or otherwise temporarily unavailable, insufficient | ||
130 | free disk or memory, etc. | ||
131 | |||
132 | SYS/PERM is used for problems which are unlikely to be resolved | ||
133 | without intervention. It is appropriate to alert the user and | ||
134 | suggest that the organization's support or assistance personnel be | ||
135 | contacted. Examples include corrupted mailboxes, system | ||
136 | configuration errors, etc. | ||
137 | |||
138 | The SYS response code is valid with an -ERR response to any command. | ||
139 | |||
140 | 5. The AUTH Response Code | ||
141 | |||
142 | The AUTH response code informs the client that there is a problem | ||
143 | with the user's credentials. This might be an incorrect password, an | ||
144 | unknown user name, an expired account, an attempt to authenticate in | ||
145 | violation of policy (such as from an invalid location or during an | ||
146 | unauthorized time), or some other problem. | ||
147 | |||
148 | The AUTH response code is valid with an -ERR response to any | ||
149 | authentication command including AUTH, USER (see note), PASS, or | ||
150 | APOP. | ||
151 | |||
152 | Servers which include the AUTH response code with any authentication | ||
153 | failure SHOULD support the CAPA command [POP3-EXT] and SHOULD include | ||
154 | the AUTH-RESP-CODE capability in the CAPA response. AUTH-RESP-CODE | ||
155 | assures the client that only errors with the AUTH code are caused by | ||
156 | credential problems. | ||
157 | |||
158 | NOTE: Returning the AUTH response code to the USER command | ||
159 | reveals to the client that the specified user exists. It is | ||
160 | strongly RECOMMENDED that the server not issue this response code | ||
161 | to the USER command. | ||
162 | |||
163 | |||
164 | |||
165 | |||
166 | |||
167 | |||
168 | |||
169 | |||
170 | Gellens Standards Track [Page 3] | ||
171 | |||
172 | RFC 3206 The SYS and AUTH POP Response Codes February 2002 | ||
173 | |||
174 | |||
175 | 6. The AUTH-RESP-CODE Capability | ||
176 | |||
177 | CAPA tag: | ||
178 | AUTH-RESP-CODE | ||
179 | |||
180 | Arguments: | ||
181 | none | ||
182 | |||
183 | Added commands: | ||
184 | none | ||
185 | |||
186 | Standard commands affected: | ||
187 | none | ||
188 | |||
189 | Announced states / possible differences: | ||
190 | both / no | ||
191 | |||
192 | Commands valid in states: | ||
193 | n/a | ||
194 | |||
195 | Specification reference: | ||
196 | this document | ||
197 | |||
198 | Discussion: | ||
199 | The AUTH-RESP-CODE capability indicates that the server includes | ||
200 | the AUTH response code with any authentication error caused by a | ||
201 | problem with the user's credentials. | ||
202 | |||
203 | 7. IANA Considerations | ||
204 | |||
205 | IANA has added the AUTH-RESP-CODE capability to the list of POP3 | ||
206 | capabilities (established by RFC 2449 [POP3-EXT]). | ||
207 | |||
208 | IANA has also added the SYS and AUTH response codes to the list of | ||
209 | POP3 response codes (also established by RFC 2449 [POP3-EXT]). | ||
210 | |||
211 | 8. Security Considerations | ||
212 | |||
213 | Section 5, The AUTH Response Code, discusses the security issues | ||
214 | related to use of the AUTH response code with the USER command. | ||
215 | |||
216 | |||
217 | |||
218 | |||
219 | |||
220 | |||
221 | |||
222 | |||
223 | |||
224 | |||
225 | |||
226 | Gellens Standards Track [Page 4] | ||
227 | |||
228 | RFC 3206 The SYS and AUTH POP Response Codes February 2002 | ||
229 | |||
230 | |||
231 | 9. References | ||
232 | |||
233 | [KEYWORDS] Bradner, S., "Key words for use in RFCs to Indicate | ||
234 | Requirement Levels", BCP 14, RFC 2119, March 1997. | ||
235 | |||
236 | [POP3] Myers, J. and M. Rose, "Post Office Protocol -- Version | ||
237 | 3", STD 53, RFC 1939, May 1996. | ||
238 | |||
239 | [POP3-EXT] Gellens, R., Newman, C. and L. Lundblade, "POP3 Extension | ||
240 | Mechanism", RFC 2449, November 1998. | ||
241 | |||
242 | 10. Author's Address | ||
243 | |||
244 | Randall Gellens | ||
245 | QUALCOMM Incorporated | ||
246 | 5775 Morehouse Drive | ||
247 | San Diego, CA 92121-2779 | ||
248 | U.S.A. | ||
249 | |||
250 | Phone: +1 858 651 5115 | ||
251 | EMail: randy@qualcomm.com | ||
252 | |||
253 | |||
254 | |||
255 | |||
256 | |||
257 | |||
258 | |||
259 | |||
260 | |||
261 | |||
262 | |||
263 | |||
264 | |||
265 | |||
266 | |||
267 | |||
268 | |||
269 | |||
270 | |||
271 | |||
272 | |||
273 | |||
274 | |||
275 | |||
276 | |||
277 | |||
278 | |||
279 | |||
280 | |||
281 | |||
282 | Gellens Standards Track [Page 5] | ||
283 | |||
284 | RFC 3206 The SYS and AUTH POP Response Codes February 2002 | ||
285 | |||
286 | |||
287 | 11. Full Copyright Statement | ||
288 | |||
289 | Copyright (C) The Internet Society (2002). All Rights Reserved. | ||
290 | |||
291 | This document and translations of it may be copied and furnished to | ||
292 | others, and derivative works that comment on or otherwise explain it | ||
293 | or assist in its implementation may be prepared, copied, published | ||
294 | and distributed, in whole or in part, without restriction of any | ||
295 | kind, provided that the above copyright notice and this paragraph are | ||
296 | included on all such copies and derivative works. However, this | ||
297 | document itself may not be modified in any way, such as by removing | ||
298 | the copyright notice or references to the Internet Society or other | ||
299 | Internet organizations, except as needed for the purpose of | ||
300 | developing Internet standards in which case the procedures for | ||
301 | copyrights defined in the Internet Standards process must be | ||
302 | followed, or as required to translate it into languages other than | ||
303 | English. | ||
304 | |||
305 | The limited permissions granted above are perpetual and will not be | ||
306 | revoked by the Internet Society or its successors or assigns. | ||
307 | |||
308 | This document and the information contained herein is provided on an | ||
309 | "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING | ||
310 | TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING | ||
311 | BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION | ||
312 | HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF | ||
313 | MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. | ||
314 | |||
315 | Acknowledgement | ||
316 | |||
317 | Funding for the RFC Editor function is currently provided by the | ||
318 | Internet Society. | ||
319 | |||
320 | |||
321 | |||
322 | |||
323 | |||
324 | |||
325 | |||
326 | |||
327 | |||
328 | |||
329 | |||
330 | |||
331 | |||
332 | |||
333 | |||
334 | |||
335 | |||
336 | |||
337 | |||
338 | Gellens Standards Track [Page 6] | ||
339 |
-
Please register or sign in to post a comment