Network Working Group | C. Daboo |
Internet-Draft | Apple Inc. |
Updates: 5545 (if approved) | June 29, 2016 |
Intended status: Standards Track | |
Expires: December 31, 2016 |
New Properties for iCalendar
draft-ietf-calext-extensions-04
This document defines a set of new properties for iCalendar data as well as extending the use of some existing properties to the entire iCalendar object.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
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."
This Internet-Draft will expire on December 31, 2016.
Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
The iCalendar [RFC5545] data format is used to represent calendar data and is used with iTIP [RFC5546] to handle scheduling operations between calendar users. iCalendar is in widespread use, and in accordance with provisions in that specification, extension elements have been added by various vendors to the data format in order to support and enhance capabilities. This specification collects a number of these ad-hoc extensions and uses the new IANA registry capability defined in [RFC5545] to register standard variants with clearly defined definitions and semantics. In addition, some new elements are introduced for features that vendors have recently been requesting.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
The notation used in this memo is the ABNF notation of [RFC5234] as used by iCalendar [RFC5545]. Any syntax elements shown below that are not explicitly defined in this specification come from iCalendar [RFC5545].
iCalendar defines properties which can have different value types indicated by a "VALUE" parameter. The definition of a property specifies a "default" value type that is assumed to be used when no "VALUE" parameter is present. However, this poses a problem to iCalendar parser/generator software that does not know about the default values for new properties. For example, if a new property "FOO" were defined with a default value type of URI, and a URI value with a comma was used, an iCalendar generator not aware of this fact would likely treat the property value as "TEXT" and apply backslash escaping to the comma in the value, effectively making it an invalid URI value.
To avoid this problem, this specification recommends that all properties not defined in [RFC5545], always include a "VALUE" parameter, if the type is other than "TEXT". i.e., in the example above, the "FOO" property would have a "VALUE=URI" parameter. This allows iCalendar parser/generator software to track the correct types of unknown properties.
New properties defined in this specification use the term "no default" in the "Value Type" definition to indicate that the "VALUE" parameter has to be included.
calprops =/ *( ; ; The following are OPTIONAL, ; but MUST NOT occur more than once. ; uid / last-mod / url / refresh / source / color ; ; The following are OPTIONAL, ; and MAY occur more than once. ; name / description / categories / image ; ) eventprop =/ *( ; ; The following are OPTIONAL, ; but MUST NOT occur more than once. ; color / ; ; The following are OPTIONAL, ; and MAY occur more than once. ; conference / image ; ) todoprop =/ *( ; ; The following are OPTIONAL, ; but MUST NOT occur more than once. ; color / ; ; The following are OPTIONAL, ; and MAY occur more than once. ; conference / image ; ) jourprop =/ *( ; ; The following are OPTIONAL, ; but MUST NOT occur more than once. ; color / ; ; The following are OPTIONAL, ; and MAY occur more than once. ; conference / image ; )
The following changes to the syntax defined in iCalendar [RFC5545] are made here. New elements are defined in subsequent sections.
name = "NAME" nameparam ":" text CRLF nameparam = *( ; ; The following are OPTIONAL, ; but MUST NOT occur more than once. ; (";" altrepparam) / (";" languageparam) / ; ; The following is OPTIONAL, ; and MAY occur more than once. ; (";" other-param) ; )
NAME:Company Vacation Days
This specification modifies the definition of the "DESCRIPTION" property to allow it to be defined on an iCalendar object. The following additions are made to the definition of this property, originally specified in Section 3.8.1.5 of [RFC5545].
This specification modifies the definition of the "UID" property to allow it to be defined on an iCalendar object. The following additions are made to the definition of this property, originally specified in Section 3.8.4.7 of [RFC5545].
This specification modifies the definition of the "LAST-MODIFIED" property to allow it to be defined on an iCalendar object. The following additions are made to the definition of this property, originally specified in Section 3.8.7.3 of [RFC5545].
This specification modifies the definition of the "URL" property to allow it to be defined on an iCalendar object. The following additions are made to the definition of this property, originally specified in Section 3.8.4.6 of [RFC5545].
This specification modifies the definition of the "CATEGORIES" property to allow it to be defined on an iCalendar object. The following additions are made to the definition of this property, originally specified in Section 3.8.1.2 of [RFC5545].
refresh = "REFRESH-INTERVAL" refreshparam ":" dur-value CRLF ;consisting of a positive duration of time. refreshparam = *( ; ; The following is REQUIRED, ; but MUST NOT occur more than once. ; (";" "VALUE" "=" "DURATION") / ; ; The following is OPTIONAL, ; and MAY occur more than once. ; (";" other-param) ; )
REFRESH-INTERVAL;VALUE=DURATION:P1W
source = "SOURCE" sourceparam ":" uri CRLF sourceparam = *(";" other-param)
SOURCE;VALUE=URI:https://example.com/holidays.ics
color = "COLOR" colorparam ":" text CRLF ; Value is CSS3 color name colorparam = *(";" other-param)
COLOR:turquoise
image = "IMAGE" imageparam ( ( ";" "VALUE" "=" "URI" ":" uri ) / ( ";" "ENCODING" "=" "BASE64" ";" "VALUE" "=" "BINARY" ":" binary ) ) CRLF imageparam = *( ; ; The following is OPTIONAL for a URI value, ; RECOMMENDED for a BINARY value, ; and MUST NOT occur more than once. ; (";" fmttypeparam) / ; ; The following are OPTIONAL, ; and MUST NOT occur more than once. ; (";" altrepparam) / (";" displayparam) / ; ; The following is OPTIONAL, ; and MAY occur more than once. ; (";" other-param) ; )
IMAGE;VALUE=URI;DISPLAY=BADGE;FMTTYPE=image/png:h ttp://example.com/images/party.png
conference = "CONFERENCE" confparam ":" uri CRLF confparam = *( ; ; The following is REQUIRED, ; but MUST NOT occur more than once. ; (";" "VALUE" "=" "URI") / ; ; The following are OPTIONAL, ; and MUST NOT occur more than once. ; (";" featureparam) / (";" labelparam) / ; ; The following is OPTIONAL, ; and MAY occur more than once. ; (";" other-param) ; )
CONFERENCE;VALUE=URI;FEATURE=PHONE,MODERATOR; LABEL=Moderator dial-in:tel:+1-412-555-0123,,,654321 CONFERENCE;VALUE=URI;FEATURE=PHONE; LABEL=Attendee dial-in:tel:+1-412-555-0123,,,555123 CONFERENCE;VALUE=URI;FEATURE=PHONE; LABEL=Attendee dial-in:tel:+1-888-555-0456,,,555123 CONFERENCE;VALUE=URI;FEATURE=CHAT; LABEL=Chat room:xmpp:chat-123@conference.example.com CONFERENCE;VALUE=URI;FEATURE=AUDIO,VIDEO; LABEL=Attendee dial-in:https://chat.example.com/audio?id=123456
displayparam = "DISPLAY" "=" displayval *("," displayval) displayval = ("BADGE" / ; image inline with the title of the ; event "GRAPHIC" / ; a full image replacement for the event ; itself "FULLSIZE" / ; an image that is used to enhance the ; event "THUMBNAIL" / ; a smaller variant of "FULLSIZE" to be ; used when space for the image is ; constrained x-name / ; Experimental type iana-token) ; Other IANA registered type ; ; Default is BADGE
IMAGE;VALUE=URI;DISPLAY=BADGE,THUMBNAIL;FMTTYPE=image/png:https://exa mple.com/images/weather-cloudy.png
emailparam = "EMAIL" "=" param-value
ATTENDEE;CN=Cyrus Daboo;EMAIL=cyrus@example.com:mailto:opaque-toke n-1234@example.com
featureparam = "FEATURE" "=" featuretext *("," featuretext) featuretext = ("AUDIO" / ; Audio capability "CHAT" / ; Chat or instant messaging "FEED" / ; Blog or Atom feed "MODERATOR" / ; Moderator dial-in code "PHONE" / ; Phone conference "SCREEN" / ; Screen sharing "VIDEO" / ; Video capability x-name / ; Experimental type iana-token) ; Other IANA registered type
CONFERENCE;VALUE=URI;FEATURE=AUDIO:rtsp://audio.example.com/ event CONFERENCE;VALUE=URI;FEATURE=AUDIO,VIDEO:https://video-chat.exam ple.com/;group-id=1234
labelparam = "LABEL" "=" param-value
CONFERENCE;VALUE=URI;FEATURE=VIDEO; LABEL="Web video chat, access code=76543"; :https://video-chat.example.com/;group-id=1234
Several of the new properties or parameters defined by this specification allow reference to "external" URIs. Care MUST be taken when accessing data at external URIs as malicious content could be present. Clients SHOULD ensure that suitable permission is granted by calendar users before such URIs are dereferenced.
The "REFRESH-INTERVAL" property could be used by an attacker to make a client carry out rapid requests to the server hosting the calendar, by specifying a very short duration (e.g., one second). This could lead to resource consumption on the client or server, and denial-of-service attacks against the server. Clients MUST ensure that they throttle requests to the server to a reasonable rate. In most cases, updating a public calendar once per day would suffice. If the "REFRESH-INTERVAL" is any less than that, clients SHOULD warn the calendar user and allow them to override it with a longer value.
The "CONFERENCE" property can include a "FEATURE" property parameter with a "MODERATOR" value. In some cases the access code used by the owner/initiator of a conference might be private to an individual and clients and servers MUST ensure that such properties are not sent to attendees of a scheduled component, or sharees of a shared component.
Both the "COLOR" and "IMAGE" properties are likely to be used by calendar users to express their own personal view of the calendar data. In addition, these properties could be used by attackers to produce a confusing display in a calendar user agent. When such properties are encountered in calendar data that has come from other calendar users (e.g., via a scheduling message, "public" calendar subscription, shared calendar etc), it is advisable for the client to give the receiving calendar user the option to remove (or adjust) these properties as the data is imported into their calendar system.
Security considerations in [RFC5545], and [RFC5546] MUST also be adhered to.
Several of the new properties or parameters defined by this specification allow reference to "external" URIs. Access to those URIs could be tracked, leading to loss of privacy. Clients SHOULD ensure that suitable permission is granted by calendar users before such URIs are dereferenced.
Privacy considerations in [RFC5545], and [RFC5546] MUST also be adhered to.
This document defines the following new iCalendar properties to be added to the registry defined in Section 8.3.2 of [RFC5545]:
Property | Status | Reference |
---|---|---|
NAME | Current | RFCXXXX, Section 5.1 |
DESCRIPTION | Current | RFC5545 Section 3.8.1.5, RFCXXXX, Section 5.2 |
UID | Current | RFC5545 Section 3.8.4.7, RFCXXXX, Section 5.3 |
LAST-MODIFIED | Current | RFC5545 Section 3.8.7.3, RFCXXXX, Section 5.4 |
URL | Current | RFC5545 Section 3.8.4.6, RFCXXXX, Section 5.5 |
CATEGORIES | Current | RFC5545 Section 3.8.1.2, RFCXXXX, Section 5.6 |
REFRESH-INTERVAL | Current | RFCXXXX, Section 5.7 |
SOURCE | Current | RFCXXXX, Section 5.8 |
COLOR | Current | RFCXXXX, Section 5.9 |
IMAGE | Current | RFCXXXX, Section 5.10 |
CONFERENCE | Current | RFCXXXX, Section 5.11 |
This document defines the following new iCalendar property parameters to be added to the registry defined in Section 8.3.3 of [RFC5545]:
Property Parameter | Status | Reference |
---|---|---|
DISPLAY | Current | RFCXXXX, Section 6.1 |
Current | RFCXXXX, Section 6.2 | |
FEATURE | Current | RFCXXXX, Section 6.3 |
LABEL | Current | RFCXXXX, Section 6.4 |
This document defines the following new iCalendar value registry as per Section 8.2.6 of [RFC5545]:
Display Type | Status | Reference |
---|---|---|
BADGE | Current | RFCXXXX, Section 6.1 |
GRAPHIC | Current | RFCXXXX, Section 6.1 |
FULLSIZE | Current | RFCXXXX, Section 6.1 |
THUMBNAIL | Current | RFCXXXX, Section 6.1 |
This document defines the following new iCalendar value registry as per Section 8.2.6 of [RFC5545]:
Feature Type | Status | Reference |
---|---|---|
AUDIO | Current | RFCXXXX, Section 6.3 |
CHAT | Current | RFCXXXX, Section 6.3 |
FEED | Current | RFCXXXX, Section 6.3 |
MODERATOR | Current | RFCXXXX, Section 6.3 |
PHONE | Current | RFCXXXX, Section 6.3 |
SCREEN | Current | RFCXXXX, Section 6.3 |
VIDEO | Current | RFCXXXX, Section 6.3 |
Thanks to the following for feedback: Bernard Desruisseaux, Mike Douglass, Lucia Fedorova, Ken Murchison, Arnaud Quillaud, and Dave Thewlis.
This specification came about via discussions at the Calendaring and Scheduling Consortium.
[RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997. |
[RFC5234] | Crocker, D. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, DOI 10.17487/RFC5234, January 2008. |
[RFC5545] | Desruisseaux, B., "Internet Calendaring and Scheduling Core Object Specification (iCalendar)", RFC 5545, DOI 10.17487/RFC5545, September 2009. |
[RFC5546] | Daboo, C., "iCalendar Transport-Independent Interoperability Protocol (iTIP)", RFC 5546, DOI 10.17487/RFC5546, December 2009. |
[W3C.REC-css3-color-20110607] | Ãelik, T., Lilley, C. and D. Baron, "CSS Color Module Level 3", World Wide Web Consortium Recommendation REC-css3-color-20110607, June 2011. |
[RFC2397] | Masinter, L., "The "data" URL scheme", RFC 2397, DOI 10.17487/RFC2397, August 1998. |
[RFC3966] | Schulzrinne, H., "The tel URI for Telephone Numbers", RFC 3966, DOI 10.17487/RFC3966, December 2004. |
[RFC7230] | Fielding, R. and J. Reschke, "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing", RFC 7230, DOI 10.17487/RFC7230, June 2014. |
Changes in draft-ietf-calext-extensions-04:
Changes in draft-ietf-calext-extensions-03:
Changes in draft-ietf-calext-extensions-02:
Changes in draft-ietf-calext-extensions-01:
Changes in draft-ietf-calext-extensions-00:
Changes in draft-daboo-icalendar-extensions-09:
Changes in draft-daboo-icalendar-extensions-08:
Changes in draft-daboo-icalendar-extensions-07:
Changes in draft-daboo-icalendar-extensions-06:
Changes in draft-daboo-icalendar-extensions-05:
Changes in draft-daboo-icalendar-extensions-04:
Changes in draft-daboo-icalendar-extensions-03:
Changes in draft-daboo-icalendar-extensions-02:
Changes in draft-daboo-icalendar-extensions-01: