5593
PROPOSED STANDARD
Internet Message Access Protocol (IMAP) - URL Access Identifier Extension
Authors: N. Cook
Date: June 2009
Working Group: NON WORKING GROUP
Stream: IETF
Updates:
RFC 5092
Abstract
The existing IMAP URL specification (RFC 5092) lists several <access> identifiers and <access> identifier prefixes that can be used to restrict access to URLAUTH-generated URLs. However, these identifiers do not provide facilities for new services such as streaming. This document proposes a set of new <access> identifiers as well as an IANA mechanism to register new <access> identifiers for future applications.
This document updates RFC 5092. [STANDARDS-TRACK]
RFC 5593
PROPOSED STANDARD
Network Working Group N. Cook
Request for Comments: 5593 Cloudmark
Updates: <a href="./rfc5092">5092</a> June 2009
Category: Standards Track
<span class="h1">Internet Message Access Protocol (IMAP) -</span>
<span class="h1">URL Access Identifier Extension</span>
Status of This Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (c) 2009 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents in effect on the date of
publication of this document (<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>).
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document.
Abstract
The existing IMAP URL specification (<a href="./rfc5092">RFC 5092</a>) lists several <access>
identifiers and <access> identifier prefixes that can be used to
restrict access to URLAUTH-generated URLs. However, these
identifiers do not provide facilities for new services such as
streaming. This document proposes a set of new <access> identifiers
as well as an IANA mechanism to register new <access> identifiers for
future applications.
This document updates <a href="./rfc5092">RFC 5092</a>.
<span class="grey">Cook Standards Track [Page 1]</span><span id="page-2" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-2">2</a>
<a href="#section-2">2</a>. Conventions Used in This Document ...............................<a href="#page-2">2</a>
<a href="#section-3">3</a>. Additional Authorized Access Identifiers ........................<a href="#page-3">3</a>
<a href="#section-3.1">3.1</a>. Existing Access Identifiers ................................<a href="#page-3">3</a>
<a href="#section-3.2">3.2</a>. Requirement for Additional Access Identifiers ..............<a href="#page-3">3</a>
<a href="#section-3.3">3.3</a>. Additional Access Identifier Specification .................<a href="#page-4">4</a>
<a href="#section-3.4">3.4</a>. Defining an Access Identifier for Streaming ................<a href="#page-5">5</a>
<a href="#section-4">4</a>. Formal Syntax ...................................................<a href="#page-5">5</a>
<a href="#section-5">5</a>. Acknowledgements ................................................<a href="#page-6">6</a>
<a href="#section-6">6</a>. IANA Considerations .............................................<a href="#page-6">6</a>
<a href="#section-6.1">6.1</a>. Access Identifier Registration Template ....................<a href="#page-7">7</a>
<a href="#section-6.2">6.2</a>. Stream Application Registration ............................<a href="#page-7">7</a>
<a href="#section-6.3">6.3</a>. Submit Application Registration ............................<a href="#page-8">8</a>
<a href="#section-6.4">6.4</a>. User Application Registration ..............................<a href="#page-8">8</a>
<a href="#section-6.5">6.5</a>. Authuser Application Registration ..........................<a href="#page-9">9</a>
<a href="#section-6.6">6.6</a>. Anonymous Application Registration .........................<a href="#page-9">9</a>
<a href="#section-7">7</a>. Security Considerations .........................................<a href="#page-9">9</a>
<a href="#section-8">8</a>. References .....................................................<a href="#page-10">10</a>
<a href="#section-8.1">8.1</a>. Normative References ......................................<a href="#page-10">10</a>
<a href="#section-8.2">8.2</a>. Informative References ....................................<a href="#page-10">10</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
The IMAP URL specification [<a href="./rfc5092" title=""IMAP URL Scheme"">RFC5092</a>] provides a way to carry
authorization information in IMAP URLs. Several authorization
<access> identifiers are specified in the document that allow
URLAUTH-authorized URLs to be used only by anonymous users,
authenticated users, or message submission entities. However, there
is no mechanism defined to create new <access> identifiers, and
overloading the existing mechanisms has security as well as
administrative implications.
This document describes a new <access> identifier, "stream", to be
used by message streaming entities (as described in [<a href="#ref-STREAMING" title=""Streaming Internet Messaging Attachments"">STREAMING</a>]), and
defines an IANA registration template, which can be used to register
new <access> identifiers for future applications. IANA definitions
for the existing access identifiers and prefixes from <a href="./rfc5092">RFC 5092</a> are
also defined in this document -- this document updates <a href="./rfc5092">RFC 5092</a> and
should be taken as the master in the event of any differences or
discrepancies.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Conventions Used in This Document</span>
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 <a href="./rfc2119">RFC 2119</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
<span class="grey">Cook Standards Track [Page 2]</span><span id="page-3" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
In examples, "C:" and "S:" indicate lines sent by the client and
server, respectively. If a single "C:" or "S:" label applies to
multiple lines, then some of the line breaks between those lines are
for editorial clarity only and may not be part of the actual protocol
exchange.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Additional Authorized Access Identifiers</span>
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Existing Access Identifiers</span>
The IMAP URL specification [<a href="./rfc5092" title=""IMAP URL Scheme"">RFC5092</a>] specifies the following
authorized <access> identifiers:
o "authuser" - Indicates that use of this URL is limited to
authenticated IMAP sessions that are logged in as any non-
anonymous user.
o "anonymous" - Indicates that use of this URL is not restricted by
session authorization identity.
Additionally, the following <access> identifier prefixes are defined
in [<a href="./rfc5092" title=""IMAP URL Scheme"">RFC5092</a>]:
o "submit+" - Followed by a userid, indicates that only a userid
authorized as a message submission entity on behalf of the
specified userid is permitted to use this URL.
o "user+" - Followed by a userid, indicates that use of this URL is
limited to IMAP sessions that are logged in as the specified
userid.
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Requirement for Additional Access Identifiers</span>
The existing <access> identifiers are suitable for user-based
authorization, but only the "submit+" <access> identifier prefix is
suitable for entities acting on behalf of a user. Generic support
for external entities acting on behalf of users is required for new
services such as streaming [<a href="#ref-STREAMING" title=""Streaming Internet Messaging Attachments"">STREAMING</a>].
The "submit+" <access> identifier prefix is not suitable for use as a
general mechanism to grant access to entities acting on behalf of
users, for reasons that include:
o Security - The IMAP server maintains a list of submission server
entities that are entitled to retrieve IMAP URLs specifying the
"submit+" <access> identifier prefix. If this list is extended to
include the set of all external entities that could act on behalf
of users, then the attack surface would be increased.
<span class="grey">Cook Standards Track [Page 3]</span><span id="page-4" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
o Administration - When URLAUTH-style IMAP URLs are presented to an
IMAP server by entities acting on behalf of users, the server
administrator has no way of determining the intended use of that
URL from the server logs.
o Resourcing - Without a mechanism to distinguish between the
application for which an IMAP URL is to be used, the IMAP server
has no way to prioritize resources for particular applications.
For example, the server could prioritize "submit+" URL fetch
requests over other access identifiers.
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Additional Access Identifier Specification</span>
The previous section establishes that additional access identifiers
are required to support applications, such as streaming [<a href="#ref-STREAMING" title=""Streaming Internet Messaging Attachments"">STREAMING</a>],
that require entities to retrieve URLAUTH URLs on behalf of users.
This section describes the scope and meaning of any additional
<access> identifiers that are created.
Additional <access> identifiers MUST take one of two forms (<a href="#section-4">Section 4</a>
gives the formal ABNF syntax):
o <access> identifier - The name of the application, e.g.,
"exampleapp".
o <access> identifier prefix - The name of the application, e.g.,
"exampleapp3", followed by a "+" and then a userid. For example,
consider "exampleapp3+testuser".
Note that an <access> identifier name can also be registered as an
<access> identifier prefix. However, this would require 2 separate
IANA registrations.
In both cases, the semantics are the same as those for "submit+",
i.e., the <access> identifier or <access> identifier prefix (which
MUST be followed by a userid) indicates that only a userid authorized
as an application entity for the specified application is permitted
to use this URL. In the case of <access> identifier prefixes, the
IMAP server SHALL NOT validate the specified userid but MUST validate
that the IMAP session has an authorization identity that is
authorized as an application entity for the specified application.
<span class="grey">Cook Standards Track [Page 4]</span><span id="page-5" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
The application entity itself MAY choose to perform validation on any
specified userid before attempting to retrieve the URL.
The authorization granted by any <access> identifiers used as
described above is self-describing, and so requires that the IMAP
server provide an extensible mechanism for associating userids with
new applications. For example, imagine a new application, "foo", is
created that requires application entities to retrieve URLs on behalf
of users. In this case, the IMAP server would need to provide a way
to register the new application "foo" and to associate the set of
userids to be used by those entities with the application "foo". Any
attempt to retrieve URLs containing the <access> identifier "foo"
would be checked for authorization against the list of userids
associated with the application "foo".
<a href="#section-6">Section 6</a> provides the template required to register new <access>
identifiers or prefixes with IANA.
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Defining an Access Identifier for Streaming</span>
One application that makes use of URLAUTH-authorized URLs is that of
streaming multimedia files that are received as internet-messaging
attachments. This application is described in [<a href="#ref-STREAMING" title=""Streaming Internet Messaging Attachments"">STREAMING</a>].
See <a href="#section-6.2">Section 6.2</a> for the IANA registration template for the "stream"
<access> identifier.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Formal Syntax</span>
The following syntax specification uses the Augmented Backus-Naur
Form (ABNF) notation as specified in [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>].
Except as noted otherwise, all alphabetic characters are case-
insensitive. The use of upper- or lower-case characters to define
token strings is for editorial clarity only. Implementations MUST
accept these strings in a case-insensitive fashion.
The ABNF specified below updates the formal syntax of <access>
identifiers as defined in IMAP URL [<a href="./rfc5092" title=""IMAP URL Scheme"">RFC5092</a>].
Copyright (c) 2009 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
<span class="grey">Cook Standards Track [Page 5]</span><span id="page-6" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
- Neither the name of Internet Society, IETF or IETF Trust, nor the
names of specific contributors, may be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
application = 1*(ALPHA/DIGIT)
access =/ application / (application "+" enc-user)
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Acknowledgements</span>
This document was inspired by discussions in the Lemonade Working
Group.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations</span>
IANA created a new registry for IMAP URLAUTH access identifiers and
prefixes.
Access identifiers and prefixes MUST be registered using the "IETF
Review" policy [<a href="./rfc5226" title="">RFC5226</a>]. This section gives the IANA registration
entries for the existing access identifiers and prefixes from <a href="./rfc5092">RFC</a>
<a href="./rfc5092">5092</a> as well as the entry for the "stream" application.
<span class="grey">Cook Standards Track [Page 6]</span><span id="page-7" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Access Identifier Registration Template</span>
To: [email protected]
Subject: IMAP URL Access Identifier Registration
Type: [Either "<access> identifier" or
"<access> identifier prefix"]
Application: [Name of the application, e.g., "stream"]
Description: [A description of the application and its use
of IMAP URLs]
RFC Number: [Number of the RFC in which the application is
defined]
Contact: [Email and/or physical address to contact for
additional information]
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Stream Application Registration</span>
To: [email protected]
Subject: IMAP URL Access Identifier Registration
Type: <access> identifier
Application: stream
Description: Used by SIP Media Servers to retrieve
attachments for streaming to email
clients
RFC Number: <a href="./rfc5593">RFC 5593</a>
Contact: Neil Cook <neil.cook@noware.co.uk>
<span class="grey">Cook Standards Track [Page 7]</span><span id="page-8" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Submit Application Registration</span>
To: [email protected]
Subject: IMAP URL Access Identifier Registration
Type: <access> identifier prefix
Application: submit
Description: Used by message submission entities to
retrieve attachments to be included in
submitted messages
RFC Number: <a href="./rfc5593">RFC 5593</a> and <a href="./rfc5092">RFC 5092</a>
Contact: Lemonade WG <lemonade@ietf.org>
<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. User Application Registration</span>
To: [email protected]
Subject: IMAP URL Access Identifier Registration
Type: <access> identifier prefix
Application: user
Description: Used to restrict access to IMAP sessions
that are logged in as the specified userid
RFC Number: <a href="./rfc5593">RFC 5593</a> and <a href="./rfc5092">RFC 5092</a>
Contact: Lemonade WG <lemonade@ietf.org>
<span class="grey">Cook Standards Track [Page 8]</span><span id="page-9" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>. Authuser Application Registration</span>
To: [email protected]
Subject: IMAP URL Access Identifier Registration
Type: <access> identifier
Application: authuser
Description: Used to restrict access to IMAP sessions
that are logged in as any non-anonymous
user of that IMAP server
RFC Number: <a href="./rfc5593">RFC 5593</a> and <a href="./rfc5092">RFC 5092</a>
Contact: Lemonade WG <lemonade@ietf.org>
<span class="h3"><a class="selflink" id="section-6.6" href="#section-6.6">6.6</a>. Anonymous Application Registration</span>
To: [email protected]
Subject: IMAP URL Access Identifier Registration
Type: <access> identifier
Application: anonymous
Description: Indicates that use of this URL is
not restricted by session authorization
identity
RFC Number: <a href="./rfc5593">RFC 5593</a> and <a href="./rfc5092">RFC 5092</a>
Contact: Lemonade WG <lemonade@ietf.org>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Security Considerations</span>
The extension to <access> identifiers specified in this document
provides a mechanism for extending the semantics of the "submit+"
<access> prefix to arbitrary applications. The use of such
additional <access> identifiers and prefixes is primarily for
security purposes, i.e., to prevent the overloading of "submit+" as a
generic mechanism to allow entities to retrieve IMAP URLs on behalf
of userids. Other than this, the security implications are identical
to those discussed in <a href="#section-10.1">Section 10.1</a> of IMAPURL [<a href="./rfc5092" title=""IMAP URL Scheme"">RFC5092</a>].
<span class="grey">Cook Standards Track [Page 9]</span><span id="page-10" ></span>
<span class="grey"><a href="./rfc5593">RFC 5593</a> IMAP URL Access Identifier June 2009</span>
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. References</span>
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
[<a id="ref-RFC5092">RFC5092</a>] Melnikov, A., Ed., and C. Newman, "IMAP URL Scheme", <a href="./rfc5092">RFC</a>
<a href="./rfc5092">5092</a>, November 2007.
[<a id="ref-RFC5234">RFC5234</a>] Crocker, D., Ed., and P. Overell, "Augmented BNF for
Syntax Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>, January
2008.
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Informative References</span>
[<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>,
May 2008.
[<a id="ref-STREAMING">STREAMING</a>] Cook, N., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22Streaming+Internet+Messaging+Attachments%22'>"Streaming Internet Messaging Attachments"</a>,
Work in Progress, May 2009.
Author's Address
Neil L Cook
Cloudmark
EMail: [email protected]
Cook Standards Track [Page 10]
Annotations
Select text to annotate