Network Working Group | M. Douglass |
Internet-Draft | Spherical Cow Group |
Intended status: Standards Track | C. Daboo |
Expires: December 31, 2015 | Apple |
June 29, 2015 |
Time Zone Data Distribution Service
draft-ietf-tzdist-service-09
This document defines a time zone data distribution service that allows reliable, secure and fast delivery of time zone data and leap second rules 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 December 31, 2015.
Copyright (c) 2015 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. In some cases, old versions of operating systems stop being supported, but are still in use and thus require users to manually "patch" their system to keep up to date with time zone changes.
Along with time zone data, it is also important to track the use of leap seconds to allow a mapping between International Atomic Time (TAI) and UTC. Leap seconds can be added (or possibly removed) at various times of year in an irregular pattern typically determined by precise astronomical observations. The insertion of leap seconds into UTC is currently the responsibility of the International Earth Rotation Service.
This specification defines a time zone data distribution service protocol that allows for fast, reliable and accurate delivery of time zone data and leap second information to client systems. This protocol is based on HTTP [RFC7230] using a simple JSON [RFC7159] based API.
This specification does not define the source of the time zone data or leap second information. 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 has taken 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, [RFC3339] UTC date-time values use a "Z" suffix, and not fixed numeric offsets.
This specification contains examples of HTTP requests and responses. In some cases, additional line breaks have been introduced into the request or response data to match maximum line length limits of this document.
==================== ==================== (a) | Contributors | | Contributors | ==================== ==================== | | ==================== ==================== (b) | Publisher A | | Publisher B | ==================== ==================== \ / ==================== (c) | Root Provider | ==================== / | \ / | \ ====================== | ====================== (d) | Secondary Provider | | | Secondary 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.
This section defines several terms and explains some key concepts used in this specification.
A description of the past and predicted future timekeeping practices of a collection of clocks that are intended to agree.
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 time zones "Europe/Berlin", "Europe/Paris", etc., because subregions have kept time differently in the past.
Data that defines a single time zone, including an identifier, UTC offset values, DST rules, and other information such as time zone abbreviations.
Data that describes additional properties of a time zone that is not itself included in the time zone data. This can include such things as the publisher name, version identifier, aliases, and localized names (see below).
A server implementing the Time Zone Data Distribution Service Protocol defined by this specification.
A time zone with varying rules for the UTC offset will have adjacent periods of time that use different UTC offsets. Each period of time with a constant UTC offset is called an observance.
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 additional 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 additional identifiers for "America/New_York" or "America/Montreal".
The set of aliases may vary depending on whether time zone data is truncated (see Section 3.9). 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 time zones 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 zone data can contain information about past and future UTC offsets 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 new events only 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 unnecessary.
To avoid having to send unnecessary data, servers can choose 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. If such truncation is done, the server MUST include the ranges it is using in the "capabilities" action response (see Section 6.1), 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 the start point being "inclusive" to the overall range, and the end point being "exclusive" to the overall range (i.e., the end value is just past the end of the last valid value in the 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 exactly one "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, 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.
Time zone data changes over time and it is important for consumers of that data to stay up to date with the latest versions. As a result it is useful to identify individual time zones with a specific version number or version identifier as supplied by the time zone data publisher. There are two common models which time zone data publishers might use to publish updates to time zone data:
A time zone data distribution service needs to ensure that the version identifiers used by the time zone data publisher are available to any client, along with the actual publisher name on a per-time zone basis. This allows clients to compare publisher/version details on any server, with existing locally cached client data, and only fetch those time zones which have actually changed (see Section 4.2.2 for more details on how clients synchronize data from the server).
The time zone data distribution service protocol uses HTTP [RFC7230] for query and delivery of time zone data and meta-data, and leap second information. The interactions with the HTTP server can be broken down into a set of "actions" that define the overall function being requested (see Section 5). Each action targets a specific HTTP resource using the GET method, with various request-URI parameters altering the behavior as needed.
The HTTP resources used for requests will be identified via URI templates [RFC6570]. The overall time zone distribution service has a "context path" request-URI defined as "{/service-prefix}". This "root" prefix is discovered by the client as per Section 4.2.1. Request-URIs that target time zone data directly use the prefix "{/service-prefix,data-prefix}". The second component of the prefix template can be used to introduce additional path segments in the request-URI to allow for alternative ways to "partition" the time zone data. For example, time zone data might be partitioned by publisher release dates, or version identifiers. This specification does not define any partitions, which is left for future extensions. When the "data-prefix" variable is empty, the server is expected to return the current version of time zone data it has for all publishers it supports.
All template-URI variable values, and URI request parameters 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. It is important to note that any "/" characters, which are frequently found in time zone identifiers, are percent-encoded when used in the value of a path segment expansion variable in a URI template (as per Section 3.2.6 of [RFC6570]). Thus the time zone identifier "America/New_York" would appear as "America%2FNew_York" when used as the value for the "{/tzid}" URI template variable defined later in this specification.
The server provides time zone meta-data in the form of a JSON [RFC7159] object. Clients can directly request the time zone meta-data, or issues queries for subsets of meta-data that match specific criteria.
Security and privacy considerations for this protocol are discussed in detail in Section 8 and Section 9, respectively.
Time zone identifiers, aliases or localized names can be used to query for time zone data or meta-data. This will be more explicitly defined below for each action. In general however, if a "tzid" URI template variable is used, then the value may be an identifier or an alias. When the "pattern" URI query parameter is used it may be an identifier, an alias or a localized name.
The default media type [RFC2046] format for returning time zone data is the iCalendar [RFC5545] data format. In addition, the iCalendar-in-XML [RFC6321], and iCalendar-in-JSON [RFC7265] representations are also available. Clients use the HTTP Accept header field (see Section 5.3.2 of [RFC7231]) to indicate their preference for the returned data format. Servers indicate the available formats that they support via the "capabilities" action response [action_get_capabilities].
As per Section 3.8, time zone data can support localized names. Clients use the HTTP Accept-Language header field (see Section 5.3.5 of [RFC7231]) to indicate their preference for the language used for localized names in the response data.
When time zone data or meta-data changes, it needs to be distributed in a timely manner because changes to local time offsets might occur within a few days of the publication of the time zone data changes. Typically, the number of time zones that change is small, whilst the overall number of time zones can be large. Thus, when a client is using more than a few time zones, it is more efficient for the client to be able to download only those time zones that have changed (an incremental update).
Clients initially request a full list of time zones from the server using a "list" action request (see Section 5.2). The response to that request includes two items the client caches for use with subsequent "conditional" (incremental update) requests:
For subsequent updates to cached data, clients can use the following procedure:
Note that time zone meta-data will always change when the corresponding time zone data changes. However, the converse is not true: it is possible for some piece of the time zone meta-data to change without the corresponding time zone data changing. e.g., for the case of a "monolithic" publisher (see Section 3.10), the version identifier in every time zone meta-data element will change with each new published revision, however, only a small subset of time zone data will actually change.
If a client needs data for only one, or a small set of time zones (e.g., a clock in a fixed location), then it can use a conditional HTTP request to determine if the time zone data has changed and retrieve the new data. The full details of HTTP conditional requests are described in [RFC7232], what follows is a brief summary of what a client typically does.
Clients SHOULD poll for changes, using an appropriate conditional request, 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 8 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 into a set of "observances" over a fixed period of time (see Section 5.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.
When an HTTP error response is returned to the client, the server SHOULD return a JSON "problem detail" object in the response body, as per [I-D.ietf-appsawg-http-problem]. Every JSON "problem detail" object MUST include a "type" member with a uri value matching the applicable error code (defined for each action in Section 5).
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. The request-URI path found via discovery is the "context path" for the service itself. The "context path" is used as the value of the "service-prefix" URI template variable when executing actions (see Section 5).
The following sub-sections describe two methods of service discovery using DNS SRV records [RFC2782] and an HTTP "well-known" [RFC5785] resource. However, alternative mechanisms could also be used (e.g., a DHCP server option [RFC2131]).
[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 in Section 4.2.1.3.
To facilitate "context path's" that might differ from user to user, the server MAY require authentication when a client tries to access the path URI specified by the TXT RR (i.e., the server would return a 401 status response to the unauthenticated request from the client, then return a redirect response after a successful authentication by the client).
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]. The "well-known" URI MUST be present on the server, even when a TXT RR [txt_rr] is used in the DNS to specify a "context path".
Servers SHOULD set an appropriate Cache-Control header field 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 an appropriate "max-age" 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 field using the path "/servlet/timezone". The client would then "follow" this redirect to the new resource and continue making HTTP requests there. The client would also cache the redirect information, subject to any Cache-Control directive, for use in subsequent requests.
This section discusses possible client synchronization strategies using the various protocol elements provided by the server for that purpose.
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 to retrieve all the time zone meta-data. The client would preserve the returned opaque token for subsequent use (see "synctoken" in Section 5.2.1). The client will store the meta-data for each time zone returned in the response. Time zone data for each corresponding time zone can then be fetched and stored locally. In addition a mapping of aliases to time zones can be built from the meta-data.
A secondary service or a client caching all time zones needs to periodically synchronize with a server. To do so it would issue a "list" action with the "changedsince" URI query parameter set to the value of the opaque token returned by the last synchronization. The client would again preserve the returned opaque token for subsequent use. The client will update its stored time zone meta-data using the new values returned in the response, which contains just the time zone meta-data for those time zones changed since the last synchronization. In addition, it will compare the "etag" value in each time zone meta-data to the ETag header field value for the corresponding time zone data resource it has previously cached, and if different, it will fetch the new time zone data. Note that if the client presents the server with a "changedsince" value that the server does not support, all time zone data will be returned, as it would for the case where the request did not include a "changedsince" value.
Publishers should take into account the fact that the "outright" deletion of time zone names will cause problems to simple clients and so aliasing a deleted time zone identifier to a suitable alternate one is preferable.
A client might be pre-provisioned with time zone data from a source other than the time zone data distribution service it is configured to use. In such cases, the client might want to minimize the amount of time zone data it synchronizes by doing an initial "list" action to retrieve all the time zone meta-data, but then only fetch time zone data for those time zones that do not match the publisher and version details for the pre-provisioned data.
Servers MUST support the following actions. The information below shows details about each action: the request-URI the client targets (in the form of a URI template [RFC6570]) 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 4.1.7).
For any error not covered by the specific error codes defined below, the "urn:ietf:params:tzdist:error:invalid-action" error code is returned to the client in the JSON "problem details" object.
The examples in the following subsections presume that the timezone context path has been discovered to be "/servlet/timezone" (as in the example in Section 4.2.1.3.1).
>> Request << GET /servlet/timezone/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", "formats": [ "text/calendar", "application/calendar+xml", "application/calendar+json" ], "truncated" : { "any": false, "ranges": [ { "start": "1970-01-01T00:00:00Z", "end": "*" }, { "start":"2010-01-01T00:00:00Z", "end":"2020-01-01T00:00:00Z" } ], "untruncated": true }, "provider-details": "http://tz.example.com/about.html", "contacts": ["mailto:tzs@example.org"] }, "actions": [ { "name": "capabilities", "uri-template": "/servlet/timezone/capabilities", "parameters": [] }, { "name": "list", "uri-template": "/servlet/timezone/zones{?changedsince}", "parameters": [ { "name": "changedsince", "required": false, "multi": false } ] }, { "name": "get", "uri-template": "/servlet/timezone/zones{/tzid}{?start,end}", "parameters": [ { "name": "start", "required": false, "multi": false }, { "name": "end", "required": false, "multi": false } ] }, { "name": "expand", "uri-template": "/servlet/timezone/zones{/tzid}/observances{?start,end}", "parameters": [ { "name": "start", "required": true, "multi": false }, { "name": "end", "required": true, "multi": false } ] }, { "name": "find", "uri-template": "/servlet/timezone/zones{?pattern}", "parameters": [ { "name": "pattern", "required": true, "multi": false } ] }, { "name": "leapseconds", "uri-template": "/servlet/timezone/leapseconds", "parameters": [] } ] }
In this example the client requests the full set of time zone identifiers.
>> Request << GET /servlet/timezone/zones 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 { "synctoken": "2009-10-11T09:32:11Z", "timezones": [ { "tzid": "America/New_York", "etag": "123456789-000-111", "last-modified": "2009-09-17T01:39:34Z", "publisher": "Example.com", "version": "2015a", "aliases":["US/Eastern"], "local-names": [ { "name": "America/New_York", "lang": "en_US" } ] }, ...other time zones... ] }
In this example the client requests the time zone with a specific time zone identifier to be returned.
>> Request << GET /servlet/timezone/zones/America%2FNew_York HTTP/1.1 Host: tz.example.com Accept:text/calendar >> 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 a specific time zone identifier to be returned, but uses an If-None-Match header field in the request, set to the value of a previously returned ETag header field, or the value of the "etag" member in a JSON "timezone" object returned from a "list" action response. In this example, the data on the server has not changed, so a 304 response is returned.
>> Request << GET /servlet/timezone/zones/America%2FNew_York HTTP/1.1 Host: tz.example.com Accept:text/calendar If-None-Match: "123456789-000-111" >> Response << HTTP/1.1 304 Not Modified Date: Wed, 4 Jun 2008 09:32:12 GMT
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 aliases.
>> Request << GET /servlet/timezone/zones/US%2FEastern HTTP/1.1 Host: tz.example.com Accept:text/calendar >> 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 TZID-ALIAS-OF:America/New_York TZID-ALIAS-OF: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":"2020-01-01T00:00:00Z"} ], "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 /servlet/timezone/zones/America%2FNew_York ?start=2010-01-01T00:00:00Z&end=2020-01-01T00:00:00Z HTTP/1.1 Host: tz.example.com Accept:text/calendar >> 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:20200101T000000Z BEGIN:STANDARD DTSTART:20101231T190000 TZNAME:EST TZOFFSETFROM:-0500 TZOFFSETTO:-0500 END:STANDARD ... END:VTIMEZONE END:VCALENDAR
In this example the client requests the time zone with a specific time zone identifier to be returned. As it turns out, no time zone exists with that identifier.
>> Request << GET /servlet/timezone/zones/America%2FPittsburgh HTTP/1.1 Host: tz.example.com Accept:application/calendar+json >> Response << HTTP/1.1 404 Not Found Date: Wed, 4 Jun 2008 09:32:12 GMT Content-Type: application/problem+json; charset="utf-8" Content-Language: en Content-Length: xxxx { "type": "urn:ietf:params:tzdist:error:tzid-not-found", "title": "Time zone identifier was not found on this server", "status": 404 }
In this example the client requests a time zone in the expanded form.
>> Request << GET /servlet/timezone/zones/America%2FNew_York/observances ?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" { "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:
In this example the client asks for data about the time zone "US/Eastern".
>> Request << GET /servlet/timezone/zones?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 { "synctoken": "2009-10-11T09:32:11Z", "timezones": [ { "tzid": "America/New_York", "etag": "123456789-000-111", "last-modified": "2009-09-17T01:39:34Z", "publisher": "Example.com", "version": "2015a", "aliases":["US/Eastern"], "local-names": [ { "name": "America/New_York", "lang": "en_US" } ] }, { "tzid": "America/Detroit", "etag": "123456789-999-222", "last-modified": "2009-09-17T01:39:34Z", "publisher": "Example.com", "version": "2015a", "aliases":["US/Eastern"], "local-names": [ { "name": "America/Detroit", "lang": "en_US" } ] }, ... ] }
In this example the client requests the current leap second information from the server.
>> Request << GET /servlet/timezone/leapseconds 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 { "expires": "2015-12-28", "publisher": "Example.com", "version": "2015d", "leapseconds": [ { "utc-offset": 10, "onset": "1972-01-01", }, { "utc-offset": 11, "onset": "1972-07-01", }, ... { "utc-offset": 35, "onset": "2012-07-01", }, { "utc-offset": 36, "onset": "2015-07-01", } ] }
[RFC7159] defines the structure of JSON objects using a set of primitive elements. Those elements will be used to describe the structure of JSON objects used by this specification using a set of "rules". The rules used are:
Note, clients MUST ignore any unexpected JSON members in responses from the server.
Rules for the JSON document returned for a "capabilities" action request.
; root object OBJECT (version, info, actions) ; The version number of the protocol supported - MUST be 1 MEMBER version "version" : NUMBER ; object containing service information ; Only one of primary_source or secondary_source MUST be present MEMBER info "info" : OBJECT ( primary_source | secondary_source, formats, ?truncated, ?provider_details, ?contacts ) ; The source of the time zone data provided by a "primary" server MEMBER primary_source "primary-source" : STRING ; The time zone data server from which data is provided by a ; "secondary" server MEMBER secondary_source "secondary-source" : STRING ; Array of one or more media types for the time zone data formats ; that the server can return MEMBER formats "formats" : ARRAY STRING ; Present if the server is providing truncated time zone data. The ; value is an object providing details of the supported truncation ; modes. MEMBER truncated "truncated" : OBJECT: ( 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 "start" and "end" URI query ; parameters in a "get" action request MEMBER any "any" : BOOLEAN ; Indicates which ranges of time the server has truncated data for. ; A value from this list may be used with the "start" and "end" URI ; query parameters in a "get" action request. Not present if "any" ; is set to "true" MEMBER ranges "ranges" : ARRAY OBJECT (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 MEMBER range-start "start" : STRING ; [RFC3339] UTC date-time value for exclusive 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 MEMBER range-end "end" : STRING ; 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 a "get" ; action request is executed without a "start" or "end" URI query ; parameter MEMBER untruncated "untruncated" : BOOLEAN ; A URI where human readable details about the time zone service ; is available MEMBER provider_details "provider-details" : STRING ; Array of URIs providing contact details for the server ; administrator MEMBER contacts "contacts" : ARRAY STRING ; Array of actions supported by the server MEMBER actions "actions" : ARRAY OBJECT ( action_name, action_params ) ; Name of the action MEMBER action_name: "name" : STRING ; Array of request-URI query parameters supported by the action MEMBER action_params: "parameters" ARRAY OBJECT ( param_name, ?param_required, ?param_multi, ?param_values ) ; Name of the parameter MEMBER param_name "name" : STRING ; If true the parameter has to be present in the request-URI ; default is false MEMBER param_required "required" : BOOLEAN ; If true the parameter can occur more than once in the request-URI ; default is false MEMBER 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 MEMBER param_values "values" ARRAY STRING
Rules for the JSON document returned for a "list" or "find" action request.
; root object OBJECT (synctoken, timezones) ; Server generated opaque token used for synchronizing changes, MEMBER synctoken "synctoken" : STRING ; Array of time zone objects MEMBER timezones "timezones" : ARRAY OBJECT ( tzid, etag, last_modified, publisher, version, ?aliases, ?local_names, ) ; Time zone identifier MEMBER tzid "tzid" : STRING ; Current ETag for the corresponding time zone data resource MEMBER etag "etag" : STRING ; Date/time when the time zone data was last modified ; [RFC3339] UTC date-time value MEMBER last_modified "last-modified" : STRING ; Time zone data publisher MEMBER publisher "publisher" : STRING ; Current version of the time zone data as defined by the ; publisher MEMBER version "version" : STRING ; An array that lists the set of time zone aliases available ; for the corresponding time zone MEMBER aliases "aliases" : ARRAY STRING ; An array that lists the set of localized names available ; for the corresponding time zone MEMBER local_names "local-names" : ARRAY OBJECT ( lname, lang, ?pref ) ; Language tag for the language of the associated name MEMBER: lang "lang" : STRING ; Localized name MEMBER lname "name" : STRING ; Indicates whether this is the preferred name for the associated ; language default: false MEMBER pref "pref" : BOOLEAN
Rules for the JSON document returned for a "expand" action request.
; root object OBJECT ( tzid, ?start, ?end, observances ) ; Time zone identifier MEMBER tzid "tzid" : STRING ; The actual inclusive start point for the returned observances ; if different from the value of the "start" URI query parameter MEMBER start "start" : STRING ; The actual exclusive end point for the returned observances ; if different from the value of the "end" URI query parameter MEMBER end "end" : STRING ; Array of time zone objects MEMBER observances "observances" : ARRAY OBJECT ( oname, ?olocal_names, onset, utc_offset_from, utc_offset_to ) ; Observance name MEMBER oname "name" : STRING ; Array of localized observance names MEMBER olocal_names "local-names" : ARRAY STRING ; [RFC3339] UTC date-time value at which the observance takes effect MEMBER onset "onset" : STRING ; The UTC offset in seconds before the start of this observance MEMBER utc_offset_from "utc-offset-from" : NUMBER ; The UTC offset in seconds at and after the start of this observance MEMBER utc_offset_to "utc-offset-to" : NUMBER
Rules for the JSON document returned for a "leapseconds" action request.
; root object OBJECT ( expires, publisher, version, leapseconds ) ; Last valid date covered by the data in this response ; [RFC3339] full-date value MEMBER expires "expires" : STRING ; Leap second information publisher MEMBER publisher "publisher" : STRING ; Current version of the leap second information as defined by the ; publisher MEMBER version "version" : STRING ; Array of leap second objects MEMBER leapseconds "leapseconds" : ARRAY OBJECT ( utc_offset, onset ) ; The UTC offset from TAI in seconds in effect at and after the ; specified date MEMBER utc_offset "utc-offset" : NUMBER ; [RFC3339] full-date value at which the new UTC offset takes effect, ; at T00:00:00Z MEMBER onset "onset" : STRING
tzuntil = "TZUNTIL" tzuntilparam ":" date-time CRLF tzuntilparam = *(";" other-param)
TZUNTIL:20260101T000000Z
tzid-alias-of = "TZID-ALIAS-OF" tzidaliasofparam ":" [tzidprefix] text CRLF tzidaliasofparam = *(";" other-param) ;tzidprefix defined in [RFC5545].
TZID-ALIAS-OF:America/New_York
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] and [RFC5246], with best practices described in [RFC7525]). Servers MAY support a time zone data distribution service over HTTP without TLS. However, secondary servers MUST use TLS to fetch data from a primary server.
Clients SHOULD use transport layer security as defined by [RFC2818], unless they are specifically configured otherwise. Clients that have been configured to use the TLS-based service, MUST NOT fall back to using the non-TLS service if the TLS-based service is not available. In additional, clients MUST NOT follow HTTP redirect requests from a TLS service to a non-TLS service. When using TLS, clients MUST verify the identity of the server, using a standard, secure mechanism such as the certificate verification process specified in [RFC6125] or DANE [RFC6698].
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 is the same as the original service domain that was queried, or is a sub-domain of the original service domain. In many cases the client configuration is likely to be handled automatically without any user input and as such, any mismatch between the original service domain and the target FQDN is treated as a failure and the client MUST NOT attempt to connect to the target server. In addition, when transport layer security is being used, the transport layer security certificate SHOULD include an SRV-ID field as per [RFC4985] matching the expected DNS SRV queries clients will use for service discovery. If an SRV-ID field is present in a certificate, clients MUST match the SRV-ID value with the service type and domain that matches the DNS SRV request made by the client to discover the service.
Time zone data servers SHOULD protect themselves against poorly implemented 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.4. Servers MAY require some form of authentication or authorization of clients (including secondary servers), as per [RFC7235], to restrict which clients are allowed to access their service, or provide better identification of problematic clients.
The type and pattern of requests that a client makes can be used to "fingerprint" specific clients or devices and thus potentially used to track information about what the users of the clients might be doing. In particular, a client that only downloads time zone data on an as needed basis, will leak the fact that a user's device has moved from one time zone to another or that the user is receiving scheduling messages from another user in a different time zone.
Clients need to be aware of the potential ways in which an untrusted server or a network observer might be able to track them and take precautions such as the following:
Note that some of the above recommendations will result in less efficient use of the protocol due to fetching data that might not be relevant to the client.
An organization can setup a secondary server within their own domain, and configure their clients to use that server, to protect the organization's users from the possibility of being tracked by an untrusted time zone distribution server. Clients can then use more efficient protocol interactions, free from the concerns above, on the basis that their organization's server is trusted. When doing this, the secondary server would follow the recommendations for clients (listed in the previous paragraph) so that the untrusted server is not able to gain information about the organization as a whole. Note, however, that if client requests to the secondary server are subject to tracking by a network observer so clients ought to apply some of the randomization techniques from the list above.
Servers that want to avoid accidentally storing information that could be used to identify clients can take the following precautions:
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]. It also adds a new "tzdist Identifiers Registry" to the IETF parameters URN sub-namespace as per [RFC3553] for use with protocol related error codes.
IANA is asked to create a new top-level category called "Time Zone Distribution Service (TZDIST) Parameters", and to put all the registries created herein into that category.
IANA is asked to create a new registry called "TZDIST Service Actions", as defined below.
This registry uses the "Specification Required" policy defined in [I-D.leiba-cotton-iana-5226bis], which makes use of a designated expert to review potential registrations.
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. The IESG will appoint a designated expert who will monitor the tzdist-service@ietf.org mailing list and review registrations.
A Standards Track RFC is REQUIRED for changes to actions previously documented in a Standards Track RFC, otherwise any public specification that satisfies the requirements of [I-D.leiba-cotton-iana-5226bis] is acceptable.
The registration procedure begins when a completed registration template, as defined 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 whether the registration is approved, approved with minor changes, or rejected with cause, within two weeks. 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 as per Section 10 of [I-D.leiba-cotton-iana-5226bis].
The designated expert MUST take the following requirements into account when reviewing the registration:
The IANA registry will contain the name of the action ("Action Name") and a reference to the section of the specification where the action registration template is defined ("Reference").
An action is defined by completing the following template.
The following table is to be used to initialize the actions registry.
Action Name | Reference |
---|---|
capabilities | RFCXXXX, Section 5.1 |
list | RFCXXXX, Section 5.2 |
get | RFCXXXX, Section 5.3 |
expand | RFCXXXX, Section 5.4 |
find | RFCXXXX, Section 5.5 |
leapseconds | RFCXXXX, Section 5.6 |
IANA is asked to make the following registration in the "Well-Known URIs" [RFC5785] registry:
IANA is asked to add two new service names to the "Service Name and Transport Protocol Port Number Registry" [RFC6335], as defined below.
IANA is requested to register a new URN sub-namespace within the IETF URN Sub-namespace for Registered Protocol Parameter Identifiers defined in [RFC3553].
Each registration in the "tzdist Identifiers" registry requires the following information:
The "tzdist Identifiers" registry has the initial registrations included in the following sections.
This section registers the "urn:ietf:params:tzdist:error:invalid-action" URN in the "tzdist Identifiers" registry.
This section registers the "urn:ietf:params:tzdist:error:invalid-changedsince" URN in the "tzdist Identifiers" registry.
This section registers the "urn:ietf:params:tzdist:error:tzid-not-found" URN in the "tzdist Identifiers" registry.
This section registers the "urn:ietf:params:tzdist:error:invalid-format" URN in the "tzdist Identifiers" registry.
This section registers the "urn:ietf:params:tzdist:error:invalid-start" URN in the "tzdist Identifiers" registry.
This section registers the "urn:ietf:params:tzdist:error:invalid-end" URN in the "tzdist Identifiers" registry.
This section registers the "urn:ietf:params:tzdist:error:invalid-pattern" URN in the "tzdist Identifiers" registry.
This document defines the following new iCalendar properties to be added to the "Properties" registry under "iCalendar Element Registries" [RFC5545]:
Property | Status | Reference |
---|---|---|
TZUNTIL | Current | RFCXXXX, Section 7.1 |
TZID-ALIAS-OF | Current | RFCXXXX, Section 7.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, Stephen Colebourne, Tobias Conradi, Steve Crocker, Paul Eggert, John Haug, Ciny Joy, Bryan Keller, Barry Leiba, 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.
[RFC2131] | Droms, R., "Dynamic Host Configuration Protocol", RFC 2131, March 1997. |
Changes for -09
Changes for -08
Changes for -07
Changes for -06
Changes for -05
Changes for -04
Changes for -03
Changes for -02
Changes for -01
Changes for -00