| Network Working Group | M. Douglass |
| Internet-Draft | RPI |
| Intended status: Standards Track | C. Daboo |
| Expires: March 14, 2015 | Apple |
| September 10, 2014 |
Time Zone Data Distribution Service
draft-ietf-tzdist-service-01
This document defines a time zone data distribution service that allows reliable, secure and fast delivery of time zone data to client systems such as calendaring and scheduling applications or operating systems.
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 March 14, 2015.
Copyright (c) 2014 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.
Time zone data typically combines a coordinated universal time (UTC) offset with daylight saving time (DST) rules. Time zones are typically tied to specific geographic and geopolitical regions. Whilst the UTC offset for particular regions changes infrequently, DST rules can change frequently and sometimes with very little notice (maybe hours before a change comes into effect).
Calendaring and scheduling systems, such as those that use iCalendar [RFC5545], as well as operating systems, critically rely on time zone data to determine the correct local time. As such they need to be kept up to date with changes to time zone data. To date there has been no fast and easy way to do that. Time zone data is often supplied in the form of a set of data files that have to be "compiled" into a suitable database format for use by the client application or operating system. In the case of operating systems, often those changes only get propagated to client machines when there is an operating system update, which can be infrequent, resulting in inaccurate time zone data being present for significant amounts of time.
This specification defines a time zone data distribution service protocol that allows for fast, reliable and accurate delivery of time zone data to client systems. This protocol is based on HTTP [RFC7230] using a REST style API, with JSON [RFC7159] responses.
This specification does not define the source of the time zone data. It is assumed that a reliable and accurate source is available. One such source is the IANA hosted time zone database [RFC6557].
Discussion of this document should take place on the tzdist working group mailing list <tzdist@ietf.org>.
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 [RFC2119].
Unless otherwise indicated, if an [RFC3339] UTC date-time value is used, that refers to a date-time value with a "Z" suffix, and not one that includes a numeric offset.
The following terms with the given meanings are used throughout this document.
Note that the term "time zone" does not have the common meaning of a region of the world at a specific UTC offset, possibly modified by daylight saving time. For example, the "Central European Time" zone can correspond to several timezones "Europe/Berlin", "Europe/Paris", etc., because subregions have kept time differently in the past.
==================== ====================
(a) | Contributors | | Contributors |
==================== ====================
| |
==================== ====================
(b) | Publisher A | | Publisher B |
==================== ====================
|
====================
(c) | Provider |
====================
/ | \
/ | \
==================== | ====================
(d) | Provider | | | Provider |
==================== | ====================
| | | |
| | | |
========== ========== ========== ==========
(e) | Client | | Client | | Client | | Client |
========== ========== ========== ==========
Figure 1: Time Zone Data Distribution Service Architecture
The overall process for the delivery of time zone data can be visualized via the diagram shown below.
The overall service is made up of several layers:
Some of those layers may be coalesced by implementors. For example, a vendor may choose to implement the entire service as a single monolithic virtual server with the address embedded in distributed systems. Others may choose to provide a service consisting of multiple layers of providers, many secondary servers and a small number of root servers.
This specification is concerned only with the protocol used to exchange data between providers and from provider to client. This specification does not define how contributors pass their information to publishers, nor how those publishers vet that information to obtain trustworthy data, nor the format of the data produced by the publishers.
Time zone identifiers are unique names associated with each time zone, as defined by publishers. The iCalendar [RFC5545] specification has a "TZID" property and parameter whose value is set to the corresponding time zone identifier, and used to identify time zone data and relate time zones to start and end dates in events, etc. This specification does not define what format of time zone identifiers should be used. It is possible that time zone identifiers from different publishers overlap, and there might be a need for a provider to distinguish those with some form of "namespace" prefix identifying the publisher. However, development of a standard (global) time zone identifier naming scheme is out of scope for this specification.
Time zone aliases map a name onto a time zone identifier. For example "US/Eastern" is usually mapped on to "America/New_York". Time zone aliases are typically used interchangeably with time zone identifiers when presenting information to users.
A time zone data distribution service needs to maintain time zone alias mapping information, and expose that data to clients as well as allow clients to query for time zone data using aliases. When returning time zone data to a client, the server returns the data with an identifier matching the query, but it can include one or more equivalent identifiers in the data to provide a hint to the client that alternative identifiers are available. For example, a query for "US/Eastern" could include equivalent identifiers for "America/New_York" or "America/Montreal".
The set of aliases may vary depending on whether timezone data is truncated (see Section 3.4). For example, a client located in the US state of Michigan may see "US/Eastern" as an alias for "America/Detroit" whereas a client in the US state of New Jersey may see it as an alias for "America/New_York", and all three names may be aliases if timezones are truncated to post-2013 data.
Localized names are names for time zones which can be presented to a user in their own language. Each time zone may have one or more localized names associated with it. Names would typically be unique in their own locale as they might be presented to the user in a list. Localized names are distinct from abbreviations commonly used for UTC offsets within a time zone. For example, the time zone "America/New_York" may have the localized name "Nueva York" in a Spanish locale, as distinct from the abbreviations "EST" and "EDT" which may or may not have their own localizations.
A time zone data distribution service might need to maintain localized name information, for one or more chosen languages, as well as allow clients to query for time zone data using localized names.
Time zones and daylight saving times rules have been in use for over a century. Time zone data can thus contain a large amount of "historical" information that may not be relevant for a particular server's intended clients. For example, calendaring and scheduling clients are likely most concerned with time zone data that covers a period for one or two years in the past on into the future, as users typically create only new events for the present and future. Similarly, time zone data might contain a large amount of "future" information about transitions occurring many decades into the future. Again, clients might be concerned only with a smaller range into the future, and data past that point might be redundant.
To avoid having to send unnecessary data, servers are allowed to truncate time zone data to a range determined by start and end point date and time values, and provide only offsets and rules between those points. The server will need to advertise the ranges it is using so that clients can take appropriate action if they need time zone data for times outside of those ranges.
The truncation points at the start and end of a range are always a UTC date-time value, with both points being "inclusive" to the overall range. A server will advertise a truncation range for the truncated data it can supply, or provide an indicator that it can truncate at any start or end point to produce arbitrary ranges. In addition, the server can advertise that it supplies untruncated data - that is data that covers the full range of times available from the source publisher. In the absence of any indication of truncated data available on the server, the server will supply only untruncated data.
When truncating the start of a "VTIMEZONE" component, the server MUST include either a "STANDARD" or "DAYLIGHT" sub-component with a "DTSTART" property value that matches the start point of the truncation range, and appropriate "TZOFFSETFROM" and "TZOFFSETTO" properties to indicate the correct offset in effect right before and after the truncation range start point. This sub-component, which is the first observance defined by the time zone data, thus represents the earliest valid date-time covered by the time zone data in the truncated "VTIMEZONE" component.
When truncating the end of a "VTIMEZONE" component, the server MUST include a "TZUNTIL" iCalendar property [TZUNTIL] in the "VTIMEZONE" component to indicate the end point of the truncation range.
The time zone data distribution service protocol uses HTTP [RFC7230] for query and delivery of data. Queries are made on a single HTTP resource using the GET method, with specific client request attributes passed in request-URI parameters.
The "action" request-URI parameter defines the overall function being requested, with other request parameters acting as arguments to that function. All request parameters used by this protocol that contain text values MUST be encoded using the UTF-8 [RFC3629] character set.
All responses MUST return data using the UTF-8 [RFC3629] character set.
Most security considerations are already handled adequately by HTTP. However, given the nature of the data being transferred and the requirement it be correct, all interactions between client and server SHOULD use an HTTP connection protected with TLS [RFC5246] as defined in [RFC2818].
Time zone identifiers, aliases or localized names can be used to query for time zone data. This will be more explicitly defined below for each action. In general however, if a "tzid" request parameter is used then the value may be an identifier or an alias. When the "pattern" parameter is used it may be an identifier, an alias or a localized name.
The default format for returning time zone definitions is the iCalendar [RFC5545] data format. In addition, the iCalendar-in-XML [RFC6321], and iCalendar-in-JSON [RFC7265] representations are also available. The "format" request-URI parameter can be used to select which data format is returned.
Time zone data is generally slow moving, with the set of time zones that change from even year-to-year being relatively small. However, any changes that do occur, need to be distributed in a timely manner. Typically it is more efficient to just provide the set of changes to time zone data, so a client can do updates to any locally cached data.
When listing time zones, a timestamp is returned by the server, and that can be used later by clients to determine if any "substantive" change has occurred in the time zone data. Clients can use a conditional "list" action (see Section 6.2), supplying a previous timestamp value, to limit the results to time zones which have changed in a "substantive" manner since that previous timestamp. This allows clients to cache the last timestamp and to periodically poll the server for possible changes.
A "substantive" change is one which affects the calculated onsets for a time zone. Changes to properties such as a description are not treated as a "substantive" change.
Clients SHOULD poll for such changes at least once a day. A server acting as a secondary provider, caching time zone data from another server, SHOULD poll for changes once per hour. See Section 9 on expected client and server behavior regarding high request rates.
Determining time zone offsets at a particular point in time is often a complicated process, as the rules for daylight saving time can be complex. To help with this, the time zone data distribution service provides an action that allows clients to request the server to expand a time zone definition into a set of "observances" over a fixed period of time (see Section 6.4). Each of these observances describes a UTC onset time and UTC offsets for the prior time and the observance time. Together, these provide a quick way for "thin" clients to determine an appropriate UTC offset for an arbitrary date without having to do full time zone expansion themselves.
To enable a simple client implementation, servers SHOULD ensure that they provide or cache data for all commonly used time zones, from various publishers. That allows client implementations to configure a single server to get all time zone data. In turn, any server can refresh any of the data from any other server - though the root servers may provide the most up-to-date copy of the data.
The following are examples of response codes one would expect to be used by the server. Note, however, that unless explicitly prohibited any 2/3/4/5xx series response code may be used in a response.
When an HTTP error response is returned to the client, the server SHOULD return a JSON error object in the response body, as per Section 7.4, with some suitable descriptive text in the "description" member of the JSON object, in addition to the applicable error code (as per Section 6).
This protocol is designed to be extensible through a standards based registration mechanism (see Section 10). It is anticipated that other useful time zone actions will be added in the future (e.g., mapping a geographical location to time zone identifiers, getting change history for time zones), and so, servers MUST return a description of their capabilities. This will allow clients to determine if new features have been installed and, if not, fall back on earlier features or disable some client capabilities.
Client implementations need to either know where the time zone data distribution service is located or discover it through some mechanism. To use a time zone data distribution service, a client needs a fully qualified domain name (FQDN), port and HTTP request-URI path.
[RFC2782] defines a DNS-based service discovery protocol that has been widely adopted as a means of locating particular services within a local area network and beyond, using SRV RR records. This can be used to discover a service's FQDN and port.
This specification adds two service types for use with SRV records:
Clients MUST honor "TTL", "Priority" and "Weight" values in the SRV records, as described by [RFC2782].
Example: service record for server without transport layer security.
_timezone._tcp SRV 0 1 80 tz.example.com.
Example: service record for server with transport layer security.
_timezones._tcp SRV 0 1 443 tz.example.com.
When SRV RRs are used to advertise a time zone data distribution service, it is also convenient to be able to specify a "context path" in the DNS to be retrieved at the same time. To enable that, this specification uses a TXT RR that follows the syntax defined in Section 6 of [RFC6763] and defines a "path" key for use in that record. The value of the key MUST be the actual "context path" to the corresponding service on the server.
A site might provide TXT records in addition to SRV records for each service. When present, clients MUST use the "path" value as the "context path" for the service in HTTP requests. When not present, clients use the ".well-known" URI approach described next.
Example: text record for service with transport layer security.
_timezones._tcp TXT path=/timezones
A "well-known" URI [RFC5785] is registered by this specification for the Time Zone Data Distribution service, "timezone" (see Section 10). This URI points to a resource that the client can use as the initial "context path" for the service they are trying to connect to. The server MUST redirect HTTP requests for that resource to the actual "context path" using one of the available mechanisms provided by HTTP (e.g., using an appropriate 3xx status response). Clients MUST handle HTTP redirects on the ".well-known" URI. Servers MUST NOT locate the actual time zone data distribution service endpoint at the ".well-known" URI as per Section 1.1 of [RFC5785].
Servers SHOULD set an appropriate Cache-Control header value (as per Section 5.2 of [RFC7234]) in the redirect response to ensure caching occurs as needed, or as required by the type of response generated. For example, if it is anticipated that the location of the redirect might change over time, then a "no-cache" value would be used.
To facilitate "context path's" that might differ from user to user, the server MAY require authentication when a client tries to access the ".well-known" URI (i.e., the server would return a 401 status response to the unauthenticated request from the client, then return the redirect response after a successful authentication by the client).
A Time Zone Data Distribution server has a "context path" that is "/servlet/timezone". The client will use "/.well-known/timezone" as the path for the service after it has first found the FQDN and port number via an SRV lookup or via manual entry of information by the user. When the client makes its initial HTTP request against "/.well-known/timezone", the server would issue an HTTP 301 redirect response with a Location response header using the path "/servlet/timezone". The client would then "follow" this redirect to the new resource and continue making HTTP requests there.
When a secondary service or a client wishing to cache all time zone data first starts, or wishes to do a full refresh, it synchronizes with another server by first issuing a "list" action. The client would preserve the returned datestamp for subsequent use. Each time zone in the returned list can then be fetched and stored locally. In addition a mapping of aliases to time zones can be built.
A secondary service or a client caching all time zone data needs to periodically synchronize with a server. To do so it would issue a "list" action with the "changedsince" parameter set to the value of the datestamp returned by the last synchronization. The client would again preserve the returned datestamp for subsequent use. Each time zone in the returned list can then be fetched and stored locally.
Note, this process makes no provision for handling deleted time zones. In general it is bad practice to delete time zones as they might still be in use by consumers of time zone data.
The "action" request-URI parameter MUST be included in all requests to define what action is required of the server.
The following request-URI parameters are used with the various actions.
Example: a server that can return only one set of truncated data - the client can omit the "truncate" query parameter.
"truncated": {
"any": false,
"ranges": [
{
"start": "1970-01-01T00:00:00Z",
"end": "2020-12-31T11:59:59Z"
}
],
"untruncated": false
}
Example: a server that can return truncated data for any range, as well as untruncated data if client omits the "truncate" query parameter.
"truncated": {
"any": true,
"untruncated": true
}
Example: a server that can return only untruncated data - the "truncate" query parameter would always be omitted.
"truncated": {
"any": false,
"untruncated": true
}
Servers MUST support the following actions. The information below shows details about each action: a description, the set of allowed query parameters, the nature of the response, and a set of possible error codes for the response (see Section 7.4).
If an invalid "action" query parameter is sent, the following error code is returned to the client in the response:
>> Request <<
GET /?action=capabilities HTTP/1.1
Host: tz.example.com
>> Response <<
HTTP/1.1 200 OK
Date: Wed, 4 Jun 2008 09:32:12 GMT
Content-Type: application/json; charset="utf-8"
Content-Length: xxxx
{
"version": 1,
"info": {
"primary-source": "Olson:2011m",
"truncate" : {
"any": false,
"ranges": [
{
"start": "1970-01-01T00:00:00Z",
"end": "*"
},
{
"start":"2010-01-01T00:00:00Z",
"end":"2019-12-31T11:11:59Z"
}
],
"untruncated": true
},
"provider-details": "http://tz.example.com/about.html",
"contacts": ["mailto:tzs@example.org"]
},
"actions": [
{
"name": "list",
"parameters": [
{
"name": "lang",
"required": false,
"multi": true
},
{
"name": "changedsince",
"required": false,
"multi": false
}
]
},
{
"name": "get",
"parameters": [
{
"name": "format",
"required": false,
"multi": false,
"values": [
"text/calendar",
"application/calendar+xml",
"application/calendar+json"
]
},
{
"name": "lang",
"required": false,
"multi": true
},
{
"name": "tzid",
"required": true,
"multi": false
},
{
"name": "truncate",
"required": false,
"multi": false
}
]
},
{
"name": "expand",
"parameters": [
{
"name": "tzid",
"required": true,
"multi": false
},
{
"name": "start",
"required": false,
"multi": false
},
{
"name": "end",
"required": false,
"multi": false
}
]
},
{
"name": "find",
"parameters": [
{
"name": "pattern",
"required": true,
"multi": false
},
{
"name": "lang",
"required": false,
"multi": true
}
]
},
{
"name":"capabilities",
"parameters": []
}
]
}
In this example the client requests the time zone identifiers and in addition requests that the US-English local names be returned.
>> Request <<
GET /?action=list&lang=en_US HTTP/1.1
Host: tz.example.com
>> Response <<
HTTP/1.1 200 OK
Date: Wed, 4 Jun 2008 09:32:12 GMT
Content-Type: application/json; charset="utf-8"
Content-Length: xxxx
{
"dtstamp": "2009-10-11T09:32:11Z",
"timezones": [
{
"tzid": "America/New_York",
"last-modified": "2009-09-17T01:39:34Z",
"aliases":["US/Eastern"],
"local-names": [
{
"name": "America/New_York",
"lang": "en_US"
}
]
},
...
]
}
In this example the client requests the time zone with a specific time zone identifier to be returned.
>> Request <<
GET /?action=get&tzid=America/New_York
&format=text/calendar HTTP/1.1
Host: tz.example.com
>> Response <<
HTTP/1.1 200 OK
Date: Wed, 4 Jun 2008 09:32:12 GMT
Content-Type: text/calendar; charset="utf-8"
Content-Length: xxxx
ETag: "123456789-000-111"
BEGIN:VCALENDAR
...
BEGIN:VTIMEZONE
TZID:America/New_York
...
END:VTIMEZONE
END:VCALENDAR
In this example the client requests the time zone with an aliased time zone identifier to be returned, and the server returns the time zone data with that identifier, and two equivalents.
>> Request <<
GET /?action=get&tzid=US/Eastern
&format=text/calendar HTTP/1.1
Host: tz.example.com
>> Response <<
HTTP/1.1 200 OK
Date: Wed, 4 Jun 2008 09:32:12 GMT
Content-Type: text/calendar; charset="utf-8"
Content-Length: xxxx
ETag: "123456789-000-111"
BEGIN:VCALENDAR
...
BEGIN:VTIMEZONE
TZID:US/Eastern
EQUIVALENT-TZID:America/New_York
EQUIVALENT-TZID:America/Montreal
...
END:VTIMEZONE
END:VCALENDAR
Assume the server advertises a "truncated" object in its "capabilities" response that appears as:
"truncated": {
"any": false,
"ranges": [
{"start": "1970-01-01T00:00:00Z", "end": "*"},
{"start":"2010-01-01T00:00:00Z", "end":"2019-12-31T11:11:59Z"}
],
"untruncated": false
}
In this example the client requests the time zone with a specific time zone identifier truncated at one of the ranges specified by the server, to be returned. Note the presence of a "STANDARD" component that matches the start point of the truncation range (converted to the local time for the UTC offset in effect at the matching UTC time). Also, note the presence of the "TZUNTIL" [TZUNTIL] iCalendar property in the "VTIMEZONE" component, indicating the upper bound on the validity of the time zone data.
>> Request <<
GET /?action=get&tzid=America/New_York
&format=text/calendar
&truncate=2010-01-01T00:00:00Z,2019-12-31T11:11:59Z
HTTP/1.1
Host: tz.example.com
>> Response <<
HTTP/1.1 200 OK
Date: Wed, 4 Jun 2008 09:32:12 GMT
Content-Type: text/calendar; charset="utf-8"
Content-Length: xxxx
ETag: "123456789-000-111"
BEGIN:VCALENDAR
...
BEGIN:VTIMEZONE
TZID:America/New_York
TZUNTIL:20191231T111159Z
BEGIN:STANDARD
DTSTART:20101231T190000
TZNAME:EST
TZOFFSETFROM:-0500
TZOFFSETTO:-0500
END:STANDARD
...
END:VTIMEZONE
END:VCALENDAR
In this example the client requests a time zone in the expanded form.
>> Request <<
GET /?action=expand&tzid=America/New_York
&start=2008-01-01T00:00:00Z
&end=2009-01-01T00:00:00Z
HTTP/1.1
Host: tz.example.com
>> Response <<
HTTP/1.1 200 OK
Date: Mon, 11 Oct 2009 09:32:12 GMT
Content-Type: application/json; charset="utf-8"
Content-Length: xxxx
ETag: "123456789-000-111"
{
"dtstamp": "2009-10-11T09:32:11Z",
"tzid": "America/New_York",
"observances": [
{
"name": "Standard",
"onset": "2008-01-01T00:00:00Z",
"utc-offset-from": -18000,
"utc-offset-to": -18000
},
{
"name": "Daylight",
"onset": "2008-03-09T07:00:00Z",
"utc-offset-from": -18000,
"utc-offset-to": -14400
},
{
"name": "Standard",
"onset": "2008-11-02T06:00:00Z",
"utc-offset-from": -14400,
"utc-offset-to": -18000
},
]
}
In addition, when matching, underscore characters (0x5F) SHOULD be mapped to a single space character (0x20) prior to string comparison. This allows time zone identifiers such as "America/New_York" to match a query for "*New York*". ASCII characters in the range 0x41 ("A") through 0x5A ("Z") SHOULD be mapped to their lowercase equivalents.
In this example the client asks for data about the time zone "US/Eastern".
>> Request <<
GET /?action=find&pattern=US/Eastern HTTP/1.1
Host: tz.example.com
>> Response <<
HTTP/1.1 200 OK
Date: Wed, 4 Jun 2008 09:32:12 GMT
Content-Type: application/json; charset="utf-8"
Content-Length: xxxx
{
"dtstamp": "2009-10-11T09:32:11Z",
"timezones": [
{
"tzid": "America/New_York",
"last-modified": "2009-09-17T01:39:34Z",
"aliases":["US/Eastern"],
"local-names": [
{
"name": "America/New_York",
"lang": "en_US"
}
]
},
{
"tzid": "America/Detroit",
"last-modified": "2009-09-17T01:39:34Z",
"aliases":["US/Eastern"],
"local-names": [
{
"name": "America/Detroit",
"lang": "en_US"
}
]
},
...
]
}
JSON members used by this specification are defined here using the syntax in [I-D.newton-json-content-rules]. Clients MUST ignore any JSON members they do not expect.
JSON Content Rules for the JSON document returned for a "capabilities" action request.
; root object
root {
version,
info,
actions
}
; The version number of the protocol supported - MUST be 1
version "version" : integer 1..1
; object containing service information
info "info" {
primary_source / secondary_source,
?truncated,
?provider_details,
?contacts
}
; The source of the time zone data provided by a "primary" server
primary_source "primary-source" : string
; The time zone server from which data is provided by a "secondary"
; server
secondary_source "secondary-source" : uri
; Present if the server is providing truncated time zone data. The
; value is an object providing details of the supported truncation
; modes.
truncated "truncated" : {
any,
?ranges,
?untruncated
}
; Indicates whether the server can truncate time zone data at any
; start or end point. When set to "true" any start or end point is
; a valid value for use with the "truncated" query parameter in an
; action "get" request
any "any" : boolean
; Indicates which ranges of time the server has truncated data for.
; A value from this list may be used with the "truncated" query
; parameter in an action "get" request. Not present if "any" is set
; to "true"
ranges "ranges" : [ * : range ]
; A range of time
range {
range-start,
range-end
}
; [RFC3339] UTC date-time value for inclusive start of the range,
; or the single character "*" to indicate a value corresponding to
; the lower bound supplied by the publisher of the time zone data
range-start "start" : date-time
; [RFC3339] UTC date-time value for inclusive end of the range,
; or the single character "*" to indicate a value corresponding to
; the upper bound supplied by the publisher of the time zone data
range-end "end" : date-time
; Indicates whether the server can can supply untruncated data. When
; set to "true" indicates that, in addition to truncated data being
; available, the server can return untruncated data if an action
; "get" request is executed without a "truncated" query parameter
untruncated "untruncated" : boolean
; A URI where human readable details about the time zone service
; is available
provider_details "provider-details" : uri
; Array of URIs providing contact details for the server
; administrator
contacts "contacts" [ * : uri ]
; Array of actions supported by the server
actions "actions" [ * action ]
; An action supported by the server
action {
action_name,
action_params
}
; Name of the action
action_name "name" : string
; Array of request-URI query parameters supported by the action
action_params "parameters" [ * parameter ]
; Object defining an action parameter
parameter {
param_name,
?param_required,
?param_multi,
?param_values
}
; Name of the parameter
param_name "name" : string
; If true the parameter has to be present in the request-URI
; default is false
param_required "required" : boolean
; If true the parameter can occur more than once in the request-URI
; default is false
param_multi "multi" : boolean,
; An array that defines the allowed set of values for the parameter
; In the absence of this member, any string value is acceptable
param_values "values" [ * : string ]
JSON Content Rules for the JSON document returned for a "list" action request.
; root object
root {
dtstamp,
timezones
}
; Server generated timestamp used for synchronizing changes,
; [RFC3339] UTC value
dtstamp "dtstamp" : date-time
; Array of time zone objects
timezones "timezones" [ * timezone ]
; Information about a time zone available on the server
timezone {
tzid,
last_modified,
?aliases,
?local_names,
}
; Time zone identifier
tzid "tzid" : string
; Date/time when the time zone data was last modified
; [RFC3339] UTC value
last_modified "last-modified" : date-time
; An array that lists the set of time zone aliases available
; for the corresponding time zone
aliases "aliases" [ * : string ]
; An array that lists the set of localized names available
; for the corresponding time zone
local_names "local-names" [ * local_name ]
local_name [lang, lname, ?pref]
; Language tag for the language of the associated name
lang : string
; Localized name
lname : string
; Indicates whether this is the preferred name for the associated
; language default: false
pref : boolean
JSON Content Rules for the JSON document returned for a "expand" action request.
; root object
root {
dtstamp,
tzid,
observances
}
; Server generated timestamp used for synchronizing changes
; [RFC3339] UTC value
dtstamp "dtstamp" : date-time
; Time zone identifier
tzid "tzid" : string
; Array of time zone objects
observances "observances" [ * observance ]
; Information about a time zone available on the server
observance {
oname,
?olocal_names,
onset,
utc_offset_from,
utc_offset_to
}
; Observance name
oname "name" : string
; Array of localized observance names
olocal_names "local-names" [ * : string]
; [RFC3339] UTC date-time value at which the observance takes effect
onset "onset" : date-time
; The UTC offset in seconds before the start of this observance
utc_offset_from "utc-offset-from" : integer
; The UTC offset in seconds at and after the start of this observance
utc_offset_to "utc-offset-to" : integer
JSON Content Rules for the JSON document returned when an error occurs.
; root object
root {
error,
?description
}
; Error code
error "error" : string
; Description of the error
description "description" : string
tzuntil = "TZUNTIL" tzuntilparam ":" date-time CRLF
tzuntilparam = *(";" other-param)
TZUNTIL:20371231T115959Z
equivalent-tzid = "EQUIVALENT-TZID" etzidparam ":"
[tzidprefix] text CRLF
etzidparam = *(";" other-param)
;tzidprefix defined in [RFC5545].
EQUIVALENT-TZID:US/Eastern
Time zone data is critical in determining local or UTC time for devices and in calendaring and scheduling operations. As such, it is vital that a reliable source of time zone data is used. Servers providing a time zone data distribution service MUST support HTTP over Transport Layer Security (TLS) (as defined by [RFC2818]) with a valid certificate. Clients and servers making use of a time zone data distribution service SHOULD use HTTP over TLS and verify the authenticity of the service being used before accepting and using any time zone data from that source.
Clients that support transport layer security as defined by [RFC2818] SHOULD try the "_timezones" service first before trying the "_timezone" service. Clients MUST follow the certificate verification process specified in [RFC6125].
A malicious attacker with access to the DNS server data, or able to get spoofed answers cached in a recursive resolver, can potentially cause clients to connect to any server chosen by the attacker. In the absence of a secure DNS option, clients SHOULD check that the target FQDN returned in the SRV record matches the original service domain that was queried. If the target FQDN is not in the queried domain, clients SHOULD verify with the user that the SRV target FQDN is suitable for use before executing any connections to the host.
Time zone servers SHOULD protect themselves against errant or malicious clients by throttling high request rates or frequent requests for large amounts of data. Clients can avoid being throttled by using the polling capabilities outlined in Section 4.1.3. Servers MAY require some form of authentication or authorization of clients (including secondary servers) to restrict which clients are allowed to access their service, or provide better identification of errant clients. As such, servers MAY require HTTP-based authentication as per [RFC7235].
This specification defines a new registry of "actions" for the time zone data distribution service protocol, defines a "well-known" URI using the registration procedure and template from Section 5.1 of [RFC5785], creates two new SRV service label aliases, and defines one new iCalendar property parameter as per the registration procedure in [RFC5545].
This section defines the process to register new or modified time zone data distribution service actions with IANA.
The IETF will create a mailing list, tzdist-service@ietf.org, which can be used for public discussion of time zone data distribution service actions proposals prior to registration. Use of the mailing list is strongly encouraged. The IESG will appoint a designated expert who will monitor the tzdist-service@ietf.org mailing list and review registrations.
Registration of new time zone data distribution service actions MUST be reviewed by the designated expert and published in an RFC. A Standard Tracks RFC is REQUIRED for the registration of new time zone data distribution service actions. A Standard Tracks RFC is also REQUIRED for changes to actions previously documented in a Standard Tracks RFC.
The registration procedure begins when a completed registration template, defined in the sections below, is sent to tzdist-service@ietf.org and iana@iana.org. The designated expert is expected to tell IANA and the submitter of the registration within two weeks whether the registration is approved, approved with minor changes, or rejected with cause. When a registration is rejected with cause, it can be re-submitted if the concerns listed in the cause are addressed. Decisions made by the designated expert can be appealed to the IESG Applications Area Director, then to the IESG. They follow the normal appeals procedure for IESG decisions.
An action is defined by completing the following template.
An action parameter is defined by completing the following template.
The IANA is requested to create and maintain the following registries for time zone data distribution service actions with pointers to appropriate reference documents.
The following table is to be used to initialize the actions registry.
| Action Name | Status | Reference |
|---|---|---|
| capabilities | Current | RFCXXXX, Section 6.1 |
| list | Current | RFCXXXX, Section 6.2 |
| get | Current | RFCXXXX, Section 6.3 |
| expand | Current | RFCXXXX, Section 6.4 |
| find | Current | RFCXXXX, Section 6.5 |
The following table is to be used to initialize the parameters registry.
| Parameter | Status | Reference |
|---|---|---|
| action | Current | RFCXXXX, Section 5.1 |
| changedsince | Current | RFCXXXX, Section 5.3 |
| end | Current | RFCXXXX, Section 5.5 |
| format | Current | RFCXXXX, Section 5.2 |
| lang | Current | RFCXXXX, Section 5.6 |
| pattern | Current | RFCXXXX, Section 5.8 |
| start | Current | RFCXXXX, Section 5.4 |
| truncate | Current | RFCXXXX, Section 5.9 |
| tzid | Current | RFCXXXX, Section 5.7 |
This document registers two new service names as per [RFC6335]. Both are defined within this document.
This document defines the following new iCalendar properties to be added to the registry defined in Section 8.2.3 of [RFC5545]:
| Property | Status | Reference |
|---|---|---|
| TZUNTIL | Current | RFCXXXX, Section 8.1 |
| EQUIVALENT-TZID | Current | RFCXXXX, Section 8.2 |
The authors would like to thank the members of the Calendaring and Scheduling Consortium's Time Zone Technical Committee, and the participants and chairs of the IETF tzdist working group. In particular, the following individuals have made important contributions to this work: Steve Allen, Lester Caine, Tobias Conradi, Steve Crocker, Paul Eggert, John Haug, Ciny Joy, Bryan Keller, Andrew McMillan, Ken Murchison, Tim Parenti, Arnaud Quillaud, Jose Edvaldo Saraiva, and Dave Thewlis.
This specification originated from work at the Calendaring and Scheduling Consortium, which has supported the development and testing of implementations of the specification.
Changes for -01
Changes for -00