Guidelines for Web Content Transformation Guidelines 1k Proxies 1w

Group Working Editor's Draft 06 June 2008 29 September 2009

This version:
http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/080606 http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/090929
Latest version:
http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/latest
Previous version: versions:
http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/080410 Draft 1v - 24 Sept 2009 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/090924
Draft 1u - 23 Sept 2009 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/090923
Draft 1t - 21 Sept 2009 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/090921
Draft 1s - 22 June 2009 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/090622
Draft 1r - 7 June 2009 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/090607
Draft 1q - 13 March 2009 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/090313
Draft 1p - 7 Nov 2008 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/081107
Draft 1o - 30 July 2008 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/080730
Draft 1n - 24 July 2008 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/080724
Draft 1m - 22 July 2008 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/080722
Draft 1l - 12 July 2008 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/080712
Draft 1k - 6 June 2008 ( diff ) http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/080606
Editor:
Jo Rabin, mTLD Top Level Domain (dotMobi)

Abstract

This document provides guidance to content transformation Content Transformation proxies and content providers as to whether and how inter-work when delivering to transform Web content.

Content Transformation proxies alter requests sent by user agents to servers and responses returned by servers so that the appearance, structure or control flow of Web applications are modified. Content Transformation proxies are mostly used to convert Web sites designed for desktop computers to a form suitable for mobile devices.

Based on current practice and standards, this document specifies mechanisms with which Content Transformation proxies should make their presence known to other parties, present the outcome of alterations performed on HTTP traffic, and react to indications set by clients or servers to constrain these alterations.

The objective is to reduce undesirable effects on Web applications, especially mobile-ready ones, and to limit the diversity in the modes of operation of Content Transformation proxies, while at the same time allowing proxies to alter content that would otherwise not display successfully on mobile devices.

Important considerations regarding the impact on security are highlighted.

Status of this Document

This document is an editors' copy that has no official standing.

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/. http://www.w3.org/TR/ .

This document reflects group resolutions on comments received on the previous Last Call Working Draft .

Publication as a Group Working Draft of a proposed normative Recommendation does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document has been produced by the Content Transformation Task Force of the Mobile Web Best Practices Working Group as part of the Mobile Web Initiative . Please send comments on this document to the Working Group's public email list public-bpwg-ct@w3.org , a publicly archived mailing list .

This document was produced under the 5 February 2004 W3C Patent Policy . . W3C maintains a public list of patent disclosures made in connection with this document; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) with respect to this specification must disclose the information in accordance with section 6 of the W3C Patent Policy .

Revision Description

Table of Contents

1 Introduction (Non-Normative)
    1.1 Purpose
    1.2 Audience
    1.3 Scope
    1.4 Principles
        1.4.1 IAB Considerations
        1.4.2 Priority of Intention
2 Terminology (Normative)
    2.1 Types of Proxy
    2.2 Types of Transformation
    2.3 Interpretation of RFC 2119 Key Words 3 Requirements Conformance (Normative)
    3.1 Summary Classes of Requirements Product
    3.2 Control of the Behavior of the Proxy         3.2.1 Control by the User         3.2.2 Control by Server Normative and Informative Parts
        3.2.3 Control by Administrative or Other Arrangements.     3.3 Normative Language for Conformance Requirements
        3.2.4 Resolving Conflicting Instructions     3.4 Transformation Deployment Conformance
4 Behavior of Components (Normative)
    4.1 Proxy Treatment Forwarding of Request
        4.1.1 no-transform directive in Request Applicable HTTP Methods
        4.1.2 Proxy Decision to Transform no-transform directive in Request
        4.1.3 Proxy Indication Treatment of its Presence to Server Requesters that are not Web browsers
        4.1.4 Serving Cached Responses
        4.1.5 Altering Alteration of HTTP Header Field Values
    4.2 Server Response to Proxy             4.1.5.1 Content Tasting
    4.3             4.1.5.2 Avoiding "Request Unacceptable" Responses
            4.1.5.3 User Selection of Restructured Experience
            4.1.5.4 Sequence of Requests
            4.1.5.5 Original Header Fields
        4.1.6 Additional HTTP Header Fields
            4.1.6.1 Proxy Receipt and Forwarding Treatment of Response from Server Via Header Field
    4.4     4.2 Proxy Forwarding of Response to User Agent
        4.2.1 Applicable Responses
        4.2.2 User Preferences
        4.2.3 Receipt of Cache-Control: no-transform
        4.2.4 Use of Cache-Control: no-transform
        4.2.5 Server Rejection of HTTP Request
        4.2.6 Receipt of Vary HTTP Header Field
        4.2.7 Link to "handheld" Representation
        4.2.8 WML Content
        4.2.9 Proxy Decision to Transform
            4.2.9.1 Alteration of Response
            4.2.9.2 Link Rewriting
            4.2.9.3 HTTPS Link Rewriting
5 Testing (Normative)

Appendices

A References
B Conformance Statement
C Internet Content Types associated with Mobile Content
D DOCTYPEs Associated with Mobile Content
E URI Patterns Associated with Mobile Web Sites
F Summary of User Preference Handling
G Example Transformation Interactions (Non-Normative)
    G.1 Basic Content Tasting by Proxy
    G.2 Optimization based on Previous Server Interaction
    G.3 Optimization based on Previous Server Interaction, Server has Changed its Operation
    G.4 Server Response Indicating that this Representation is Intended for the Target Device
    G.5 Server Response Indicating that another Representation is Intended for the Target Device
H Informative Guidance for Origin Servers (Non-Normative)
    H.1 Server Response to Proxy
        H.1.1 Use of HTTP 406 Status
        H.1.2 Use of HTTP 403 Status
        H.1.3 Server Origination of Cache-Control: no-transform
        H.1.4 Varying Representations
            H.1.4.1 Use of Vary HTTP Header Field
            H.1.4.2 Indication of Intended Presentation Media Type of Representation
I Applicability to Transforming Solutions which are Out of Scope (Non-Normative)
J Scope for Future Work (Non-Normative)
    B.1     J.1 POWDER
    B.2     J.2 link HTTP Header Field
    B.3 Amendments to HTTP     J.3 Sources of Device Information
    B.4     J.4 Inter Proxy Communication
C Acknowledgments     J.5 Amendment to and Refinement of HTTP
K Acknowledgments (Non-Normative)


1 Introduction (Non-Normative)

1.1 Purpose

From the point of view of Within this document, document Content Transformation is refers to the manipulation in various ways, by proxies, of requests made to to, and content delivered by responses from, an origin server with a view server. This manipulation is carried out by proxies in order to provide a better user experience of content that would otherwise result in an unsatisfactory experience on the device making it more suitable for mobile presentation. the request.

The W3C MWI BPWG Mobile Web Best Practices Working Group neither approves nor disapproves of Content Transformation, but recognizes that is being deployed widely across mobile data access networks. The deployments are widely divergent to each other, with many non-standard HTTP implications, and no well-understood means either of identifying the presence of such transforming proxies, nor of controlling their actions. This document establishes a framework to allow that to happen.

The overall objective of this document is to provide a means, as far as is practical, for users to be provided with at least a "functional user experience" [Device Independence Glossary] of the Web, when mobile, taking into account the fact that an increasing number of content providers create experiences specially tailored to the mobile context which they do not wish to be altered by third parties. Equally it takes into account the fact that there remain a very large number of Web sites that do not provide a functional user experience when perceived on many mobile devices. The document describes how the origin server may request conforming transforming proxies not to alter HTTP requests and responses, as well as describing control options that a transforming proxy offers users. A more extensive discussion of the requirements for these guidelines can be found in "Content Transformation Landscape" [CT Landscape] .

1.3 Scope

The recommendations in this document refer only to "Web browsing" - i.e. access by user agents that are intended primarily for interaction by users with HTML Web pages (Web browsers). Note: The document is not intended as guidelines for delivery browsers) using HTTP. Clients that interact with proxies using mechanisms other than HTTP (and that typically involve the download of WAP/WML. Some a special client) are out of its recommendations may, scope, and are considered to be a distributed user agent. Proxies which are operated in some circumstances , disrupt the delivery control of WML. or under the direction of the operator of an origin server are similarly considered to be a distributed origin server and hence out of scope.

The BPWG W3C Mobile Web Best Practices Working Group (BPWG) is not chartered to create new technology, technology - its role is to advise on best practice for use of existing technology. In satisfying Content Transformation requirements, existing HTTP headers, header fields, directives and behaviors must be respected, and as far as is practical, no extensions to [RFC 2616 HTTP] are to be used.

The recommendations in this document refer to interactions of a proxy and do not refer to any presumed aspects of the internal operation of the proxy. For this reason, the document does not discuss use of "allow" and "disallow" lists (though it does discuss behavior that is induced by the implementation of such lists). In addition it does not discuss details of how transformation is carried out except if this is reflected in interoperability. For this reason, it does not discuss the insertion or insertion of headers and footers or any other specific behaviors (though it does discuss the need for essential user interaction of some form).

2 Terminology (Normative)

2.2 Types of Transformation

Transforming proxies can carry out a wide variety of operations. In this document we categorize these operations as follows:

  1. Alteration of Requests

    Transforming proxies process requests in a number of ways, especially replacement of various request headers header fields to avoid HTTP 406 Status responses (the (if a server can not provide content in that is compatible with the format requested) original HTTP request header fields) and at user request.

  2. Alteration of Responses

    There are three classes of operation on responses:

    1. Restructuring content

      [ Definition : Restructuring content is a process whereby the original layout is altered so that content is added or removed or where the spatial or navigational relationship of parts of content is altered, e.g. by linearization (i.e. reordering presentation elements, especially tables, so that they fit on a narrow display and can be traversed without horizontal scrolling) or pagination. pagination (i.e. splitting a document too large to be stored in or transmitted to the terminal in one piece, so that it can be nevertheless accessed by browsing through a succession of smaller interlinked documents). It includes also includes rewriting of URIs so that subsequent requests route are routed via the proxy.] proxy handling the response.

    2. Recoding content

      [ Definition : Recoding content is a process whereby the layout of the content remains the same, but details of its encoding may be altered. Examples include re-encoding HTML as XHTML, correcting invalid markup in HTML, conversion of images between formats (but not, for example, reducing animations to static images). ]

    3. Optimizing content

      [ Definition : Optimizing content includes removing redundant white space, re-compressing images (without loss of fidelity) and compressing for transfer.] transfer.

2.3 Interpretation of RFC 2119 Key Words
This document is not normative Need link to definition and it is inappropriate to claim conformance to it. Implementors of this Recommendation who wish to promote effective inter operability of Web content will, however, interpret the key words must , must not , required , shall , shall not , should , should not , recommended , may , and optional in this Recommendation as described in [RFC 2119] .

3 Requirements Conformance (Normative)

3.1 Summary Classes of Requirements Product

The purpose of this section is to summarize the communication requirements Content Transformation Guidelines specification has one class of actors (transforming proxies, origin servers, and to some extent users) to communicate with each other. The relevant scenario involving a content transformation proxy is as follows: products:

Transformation Deployment
Note:

A Transformation Deployment is the provision of The interactions non-transparent components in the path of several transformation proxies HTTP requests and responses. Provisions that are encompassed by applicable to a Transformation Deployment are identified in this document, but only document by use of the term "transforming proxy" or "proxy" in a rudimentary form. the singular or plural.

that some degree of Content 3.4 Transformation ( restructuring and recoding Deployment Conformance ) can be performed; that Content Transformation will be carried out unless requested not to; that content is being requested on behalf of something else and what that something else is;

that the request headers have been altered (e.g. additional content types inserted). The origin server needs to be able to tell the Content A Transformation proxy: that it varies its presentation according to device type and other factors; that it is permissible (or not) Deployment conforms to perform Content Transformation of various kinds; that these guidelines if it has media-specific representations; that is unable or unwilling to deal with follows the request statements in its present form. The Content 3.4 Transformation proxy needs to be able to tell the user agent: Deployment Conformance , that it has applied transformations 4.1 Proxy Forwarding of various kinds to the content. The Content Transformation proxy needs to be able to interact with the user: Request to allow the user to disable its features; , to alert the user to the fact that it has transformed content and to allow access to an untransformed representation 4.2 Proxy Forwarding of the content. Response to User Agent 3.2 Control of the Behavior of the Proxy and 5 Testing (Normative) .

A transforming proxy as described in this document Transformation Deployment that wishes to claim conformance must offer make available a level of control to users and to origin servers with which it communicates. conformance statement B Conformance Statement 3.2.1 Control by that specifies the User Transforming proxies reasons for non-compliance with any clauses containing the key words " should provide " and " should not ", " recommended " and " not recommended ".

Conformance statements must be sent to their users: public-content-transformation-conformance@w3.org . Public archives of this list may be found at http://lists.w3.org/Archives/Public/public-content-transformation-conformance/ .

an indication that the content being viewed has been transformed for mobile presentation; 4 Behavior of Components (Normative)

an option to view the original, unmodified content.

They may also provide the ability for their users to make a persistent or semi-persistent expression of preferences. Examples of such settings are "Never transform", "Always request desktop presentation", "Transform only if necessary to avoid mis-operation" and "Compress where possible". Editorial Note: The BPWG is studying how to clarify the scope 4.1 Proxy Forwarding of "persistent" and "semi-persistent". Request

3.2.2 Control by Server 4.1.1 Applicable HTTP Methods

Transforming proxies Proxies must should not allow origin servers to control the Content Transformation process. The control mechanisms include use of HTTP conventions as discussed intervene in the following section ( 4 Behavior of Components ). 3.2.3 Control by Administrative or Other Arrangements. methods other than GET, POST, HEAD.

The preferences User agents sometimes issue HTTP HEAD requests in order to determine if a resource is of users and a type and/or size that they are capable of servers handling. A transforming proxy may be ascertained by means outside the scope of this document, for example: the use by transforming proxies of convert a disallow list of Web sites for which Content Transformation is known HEAD request into a GET request (in order to diminish the user experience of content or be ineffective; determine the use by transforming proxies of an allow list of Web sites for which Content Transformation is known to be necessary; terms and conditions characteristics of service, as agreed between a transformed response that it would return if the user and agent subsequently issued a GET request for the Content Transformation service provider. Note: same resource).

Allow and disallow lists generally cause intractable problems for content providers since there If the HTTP method is no mechanism for them altered from HEAD to establish which lists they GET, proxies should be on, nor any generic mechanism though which they can check or change their status. 3.2.4 Resolving Conflicting Instructions There (providing such action is in accordance with normal HTTP caching rules) cache the possibility for conflict between the desires of the content provider and the desires of users of response so that content. This document sets out to provide a framework within which, second GET request for matters of presentation, the desires of the same content provider are usually accommodated but, where necessary, the user may expressly override those desires with their preferences. 4 Behavior of Components is not required (see also 4.1.4 Serving Cached Responses 4.1 Proxy Treatment of Request ).

Other than to convert between HEAD and GET proxies must not alter request methods.

4.1.1 4.1.2 no-transform directive in Request

If the request contains a Cache-Control: no-transform directive the proxy directive, proxies must not forward alter the request unaltered to the server, other than to comply with transparent HTTP behavior and defined in particular [RFC 2616 HTTP] sections section 14.9.5 and section 13.5.2 and to add a Via header fields as described in 4.1.6 Additional HTTP header. Header Fields below.

Note:

An example of the use of Cache-Control: no-transform is the issuing of asynchronous HTTP requests, perhaps by means of XMLHttpRequest [XHR] , which may include such a directive in order to prevent transformation of both the request and the response.

Irrespective of the presence

4.1.2 Proxy Decision to Transform 4.1.4 Serving Cached Responses

If there is no no-transform directive present Aside from the usual caching procedures defined in [RFC 2616 HTTP] , in some circumstances, proxies may paginate responses and where this is the case a request may be for a subsequent page of a previously requested resource. In this case proxies may for the proxy sake of consistency of representation serve stale data but when doing so should analyze whether it intends to offer transformation services by referring to: any knowledge it has of notify the user preferences; that this is the case and must provide a simple means of retrieving a fresh copy.

any knowledge it has 4.1.5 Alteration of user agent capabilities (including linearization and zoom); HTTP Header Field Values

any prior knowledge it has of server behavior, derived Aside from previous interaction with the server - and usual procedures defined in particular to preserve the consistency of user experience across a sequence of related requests; [RFC 2616 HTTP] proxies should not modify the HTTP method values of header fields other than the request. User-Agent , Accept , Accept-Charset , Accept-Encoding , and Accept-Language header fields and must not delete header fields. It must be possible for the server to reconstruct the original User Agent originated header fields by copying directly from the corresponding X-Device header field values (see 4.1.5.5 Original Header Fields ).

Proxies Other than to comply with transparent HTTP operation, proxies should not alter HTTP requests unless: modify any request header fields unless one of the following applies:

  1. unaltered headers the user would be prohibited from accessing content as a result in of the user's request being rejected by server responding that the origin server; an unaltered request body is not consistent with the origin server's requirements in respect "unacceptable" (see 4.2.5 Server Rejection of Internet content type or character encoding (as may happen, for example, if the proxy has transformed an HTML form that results in this request); HTTP Request );

  2. the user has specifically requested a restructured version desktop experience (see 4.1.5.3 User Selection of Restructured Experience );

  3. the request is part of a desktop presentation. sequence of requests to the same Web site and either it is technically infeasible not to adjust the request because of earlier interaction, or because doing so preserves consistency of user experience.

These circumstances are detailed in the following sections.

Note: Rejection

In this section, the concept of a request by a server "Web site" is taken to mean both a HTTP 406 Status as well used (rather than "origin server") as HTTP 200 Status, with content indicating that some origin servers host many different Web sites. Since the request cannot be handled - e.g. "Your browser concept of "Web site" is not supported" strictly defined, proxies should use heuristics including comparisons of domain name to assess whether resources form part of the same "Web site".

Editorial

Note:

The BPWG is studying heuristics for URI referred to in the request plays no part in determining when a response with a 200 Status should be treated as a response with a 406 Status. whether or not to alter HTTP request header field values. In particular the patterns mentioned in 4.2.9 Proxy Decision to Transform are not material.

4.1.5.2 Avoiding "Request Unacceptable" Responses

A transforming proxy may convert reissue a HEAD request into with altered HTTP header field values if a GET previous request if it requires the response body to determine the characteristics of with unaltered values resulted in the transformed response that it would return were origin server rejecting the user agent subsequently to issue a GET request for that content. In this case, the as "unacceptable" (see 4.2.5 Server Rejection of HTTP Request ). A proxy should (providing such action is may apply heuristics of various kinds to assess, in accordance with normal HTTP caching rules) cache advance of sending unaltered header field values, whether the response so that it is not required to send a second GET request is likely to the server. If, as cause a result of carrying out "request unacceptable" response. If it determines that this analysis the proxy remains unaware of the server's preferences and capabilities is likely then it should : Issue a request with may alter header field values without sending unaltered headers and examine values in advance, providing that it subsequently assesses the response (see as described under 4.4 Proxy Response to User Agent 4.2.6 Receipt of Vary HTTP Header Field ); If it below, and is still in doubt, issue a prepared to reissue the request with altered headers unaltered header fields, and alter its subsequent behavior in respect of the Web site so that unaltered header fields are sent.

The A proxy must not issue reissue a POST/PUT POST request with altered headers header fields when the response to the unaltered POST/PUT POST request has HTTP status code 200 (in other words, it may only send the altered request for a POST/PUT request when the unaltered one was refused with a resulted in an HTTP 406 status). The theoretical idempotency of GET requests is response, and not always respected a "request unacceptable" response).

4.1.5.4 Sequence of Requests

When requesting resources that are included resources (e.g. style sheets, images), proxies should make the request for such resources with the same User-Agent header field as the request for the resource from which they are referenced.

For the purpose of consistency of representation, proxies may request linked resources (e.g. those referenced using the a element) that form part of the same Web site as a previously requested resource with the same header fields as the resource from which they are referenced.

When requesting linked resources that do not form part of the same Web site as the resource from which they are linked, proxies should not issue duplicate requests base their choice of header fields on a consistency of presentation premise.

4.1.5.5 Original Header Fields

When forwarding an HTTP request with altered HTTP header fields, in addition to complying with the rules of normal HTTP operation, proxies must include in the request copies of the unaltered header field values in the form "X-Device-"<original header name> . For example, if the User-Agent header field has been altered, an X-Device-User-Agent header field must be added with the value of the received User-Agent header field.

Specifically the following mapping must be used:

Original Replacement Ref
User-Agent X-Device-User-Agent RFC2616 Section 14.43
Accept X-Device-Accept RFC2616 Section 14.1
Accept-Charset X-Device-Accept-Charset RFC2616 Section 14.2
Accept-Encoding X-Device-Accept-Encoding RFC2616 Section 14.3
Accept-Language X-Device-Accept-Language RFC2616 Section 14.4

Note:

The X-Device- prefix was chosen primarily on the basis that this is an already existing convention. It is noted that the values encoded in such header fields may not ultimately derive from a device, they are merely received fields. The treatment of received X-Device header fields, which may happen where there are multiple transforming proxies, is undefined (see J Scope for comparison purposes. Future Work ).

4.1.4 Altering Header Values

4.2 Proxy Forwarding of Response to User Agent

If it has altered HTTP headers In the proxy following, proxies must include copies of the unaltered headers in the request in check for the form presence of equivalent "X-Device-"<original header name> . For example, <meta http-equiv> elements in HTML content, if it has altered the User-Agent header, an X-Device-User-Agent relevant HTTP header field is not present.

4.2.3 Receipt of Cache-Control: no-transform

If the server varies its presentation according to examination of received HTTP headers then it must include response includes a Vary Cache-Control: no-transform HTTP header indicating this to be the case. If, in addition to, or instead of HTTP headers, the server varies its presentation on other factors (source IP Address ...) directive then it proxies must , in accordance not alter it other than to comply with transparent HTTP behavior as described in [RFC 2616 HTTP] , include a Vary header containing the value '*'. Section 13.5.2 and Section 14.9.5 and other than as follows.

If the server has distinct presentations a proxy determines that vary according a resource as currently represented is likely to presentation media, then the medium for which cause serious misoperation of the presentation is intended user agent then it should may be indicated. Editorial Note: The BPWG is studying the use of advise the link element of HTML which is used for user that this purpose. It is noted that the link element is not available in formats other than HTML, case and it is noted that there is currently active discussion about the use of must provide the Link HTTP header, which would serve this purpose well. If option for the server creates a specific user experience according to device characteristics or presentation media types it continue with unaltered content (and should may inhibit transformation provide other options too).

Note:
4.3 Proxy

4.2.6 Receipt and Forwarding of Response from Server Vary HTTP Header Field

If HTTP header fields were altered in the request then the A proxy must may not be prepared to re-issue the carrying out content tasting as described under 4.1.5.2 Avoiding "Request Unacceptable" Responses if it anticipates receiving a "request unacceptable" response. However, if it makes a request with altered header fields in an unaltered form on receipt of these circumstances, and receives a response containing a Vary header in the response indicating that the server offers variants of its presentation according field referring to any one of the HTTP altered header fields that have been modified. Editorial Note: The BPWG is aware that more precision may be needed in the above statement. If a transforming proxy has followed the guidelines in this document, then it should not receive a response request the resource again with a Vary unaltered header if fields. It should also update whatever heuristics it has not already received such a response to a request with uses so that unaltered headers. header fields are presented first in subsequent requests for this resource.

4.4 Proxy Response 4.2.7 Link to User Agent "handheld" Representation If the response includes a Warning: 214 Transformation Applied the proxy must not apply further transformation.

If the response is an HTML response and it contains a <link rel="alternate" media="handheld" /> element, the CT-proxy SHOULD a proxy should request and return process the referenced resource, unless the resource referenced is the current resource (1k) representation .

Note:

In this document the term current representation means a "same document reference" as determined by [unresolved discussion] ... . defined in [RFC 3986] Section 4.4 , with the addition that if a Vary HTTP header field was present on the response then it is the same representation if the values of the HTTP header fields of the request have not been altered.

4.2.8 WML Content

If the content is WML proxies should act in a transparent manner.

Note:

This does not affect the operation of proxies that are also WAP Gateways.

4.2.9 Proxy Decision to Transform

In the absence of a Vary or no-transform directive (or a meta HTTP-Equiv element containing Cache-Control: no-transform ) the proxy proxies should not apply heuristics to transform content matching any of the following rules unless the user has specifically requested transformation:

Examples of heuristics: Other factors that a proxy may take into account:

  • The server Web site (see note ) has previously shown that it is contextually aware, even if the present response does not indicate this;

  • the Content-Type or other aspects of the response are known to be specific to the device or class of device (e.g. for HTML documents the DOCTYPE is "-//OMA//DTD XHTML Mobile 1.2//EN", "-//WAPFORUM//DTD XHTML Mobile 1.1//EN" "-//WAPFORUM//DTD XHTML Mobile 1.0//EN" "-//W3C//DTD XHTML Basic 1.1//EN" and "-//W3C//DTD XHTML Basic 1.0//EN"); the user agent has features (such as linearization or zoom capabilities or other features which zoom) that allow it to present the content unaltered;

  • the URI of the response (following redirection or as indicated by the Content-Location HTTP header) indicates that the resource is intended for mobile use (e.g. the domain is *.mobi, wap.*, m.*, mobile.* or the leading portion of the path is /m/ or /mobile/); the response contains client-side client side scripts that may mis-operate misoperate if the resource is restructured;

  • the response is an HTML response and it includes <link> elements specifying alternatives according to presentation media type.

4.2.9.1 Alteration of Response

If the a proxy alters the content then it response then:

  1. It must add a Warning 214 Transformation Applied HTTP Header. header field;

  2. If the proxy alters the content then the The altered content should validate according to an appropriate published formal grammar. grammar and if XML must be well-formed ;

  3. If It should indicate to the response contains links whose user that the content has been transformed for mobile presentation and provide an option to view the original, unmodified content.

4.2.9.2 Link Rewriting

Some proxy deployments have to "rewrite" links in content in order for the User Agent to request the referenced resources through the proxy. In so doing, proxies make unrelated resources appear as though they have the same-origin and hence there is a danger of introducing security vulnerabilities.

Note:

This section (on link rewriting) refers also to insertion of links, frame flattening and any other techniques that introduces the "same-origin" issue.

Note:

Link rewriting is always used by CT Proxies that are accessed as an origin server initially, e.g. which provide mobile adapted web search and navigation to the web pages returned in the search results, or to which the browser is redirected through the CT Proxy for adaptation of a web page. Link rewriting may be used by CT Proxies acting as normal HTTP proxies (e.g. configured or transparent) for the browser, but may not be required since all browser requests flow through the CT Proxy.

Proxies must not only rewrite them so links when content transformation is prohibited.

Proxies must preserve security between requests for domains that are not same-origin in respect of cookies and scripts.

4.2.9.3 HTTPS Link Rewriting

The practice of intercepting HTTPS links is strongly NOT RECOMMENDED .

If the a proxy does rewrite such rewrites HTTPS links, it must advise the user of the security implications of doing so and must provide the option to avoid decryption bypass it and transformation of the resources to communicate with the links refer to. server directly.

If Notwithstanding anything else in this document, proxies must not rewrite HTTPS links in the response includes presence of a Cache-Control: no-transform directive then the response must remain unaltered other than to comply with transparent directive. HTTP behavior and other than as noted below.

If the a proxy determines that rewrites HTTPS links, replacement links must have the resource scheme https .

When forwarding requests originating from HTTPS links proxies must include a Via header field as currently represented is likely to cause serious mis-operation discussed under 4.1.6.1 Proxy Treatment of the user agent then it Via Header Field .

When forwarding responses from servers proxies may , with the users explicit prior consent, warn must notify the user and provide links to both transformed and unaltered versions of the resource. invalid server certificates.

5 Testing (Normative)

Operators of transforming content transformation proxies should make available interfaces that facilitate testing an interface through which the functions of Web sites accessed the proxy can be exercised. The operations possible through them and this interface should must make cover those necessary to settle the outcome of all conformance statements listed in section B.

The interface must be reachable from terminals with browsing capabilities connected to the Web via a conventional Internet access environment at the tester's premises; accessing the interface may necessitate adjusting standard Web browsing configuration parameters -- such interfaces as specifying a proxy IP address and port on a desktop browser, or activating a WAP setting on a mobile browser.

Such access must be granted under fair, reasonable and non-discriminatory conditions. In particular:

A References

CT Landscape
Content Transformation Landscape 1.0, Jo Rabin, Andrew Swainston (eds), W3C Working Draft 25 October 2007 (See http://www.w3.org/TR/ct-landscape/ http://www.w3.org/TR/2007/WD-ct-landscape-20071025/ )
RFC 2119
Key words for use in RFCs to Indicate Requirement Levels, , Request for Comments: 2119, S. Bradner, March 1997 (See http://www.ietf.org/rfc/rfc2119.txt )
RFC 2616 HTTP
Hypertext Transfer Protocol -- HTTP/1.1 Request for Comments: 2616, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. Leach, T. Berners-Lee, June 1999 (See http://tools.ietf.org/html/rfc2616 )
RFC 3986
Uniform Resource Identifier (URI): Generic Syntax, Request for Comments: 3986, T. Berners-Lee, R. Fielding, L. Masinter, January 2005 (See http://tools.ietf.org/html/rfc3986 )
RFC 3238 OPES
IAB Architectural and Policy Considerations for Open Pluggable Edge Services, Request for Comments: 3238, S. Floyd, L. Daigle, January 2002 (See http://tools.ietf.org/html/rfc3238 )
Device Independence Glossary
W3C Glossary of Terms for Device Independence, Rhys Lewis (ed), W3C Working Draft 18 January 2005
Best Practices
Mobile Web Best Practices 1.0 Basic Guidelines, Jo Rabin, Charles McCathieNevile (eds), W3C Proposed Recommendation, 2 November 2006 29 July 2008 (See http://www.w3.org/TR/mobile-bp/ http://www.w3.org/TR/2008/REC-mobile-bp-20080729/ )
POWDER mobileOK Basic Tests
W3C mobileOK Basic Tests 1.0, Sean Owen, Jo Rabin (eds), W3C Recommendation, 08 December 2008 (See http://www.w3.org/TR/2008/REC-mobileOK-basic10-tests-20081208/ )
mobileOK Scheme
W3C mobileOK Scheme 1.0, Jo Rabin, Phil Archer (eds), W3C Note, 25 August 2009 (See http://www.w3.org/TR/2009/NOTE-mobileOK-20090825/ )
POWDER Resource Grouping
Protocol for Web Description Resources (POWDER) Working Group Home Page (POWDER): Grouping of Resources, Phil Archer, Andrea Perego, Kevin Smith (eds), W3C Recommendation, 1 September 2009 (See http://www.w3.org/2007/powder/ http://www.w3.org/TR/2009/REC-powder-grouping-20090901/ )
XHR
The XMLHttpRequest Object, Anne van Kesteren (ed), W3C Working Draft, 15 April 2008 (See http://www.w3.org/TR/XMLHttpRequest/ )
XML
Extensible Markup Language (XML) 1.0 (Fifth Edition), T. Bray, J. Paoli, C. Sperberg-McQueen, E. Maler, F. Yergeau (eds), W3C Recommendation, 26 November 2008. (See http://www.w3.org/TR/xml/ )

B Conformance Statement

Editorial Note: Update to final location

See http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/ics-090923

C Internet Content Types associated with Mobile Content

D DOCTYPEs Associated with Mobile Content

E URI Patterns Associated with Mobile Web Sites

Using the notation defined in [POWDER Resource Grouping]:

<iriset>
<includehosts>mobi</includehosts>
</iriset>

F Summary of User Preference Handling

User expression of preferences is referred to in several sections in this document. Those sections are:

  1. 1.4.2 Priority of Intention

  2. 4.1.4 Serving Cached Responses

  3. 4.1.5.3 User Selection of Restructured Experience

  4. 4.2.2 User Preferences

  5. 4.2.3 Receipt of Cache-Control: no-transform

  6. 4.2.9 Proxy Decision to Transform

  7. 4.2.9.1 Alteration of Response

  8. 4.2.9.3 HTTPS Link Rewriting

User preferences are also referred to non-normatively under H.1.4 Varying Representations .

G Example Transformation Interactions (Non-Normative)

G.3 Optimization based on Previous Server Interaction, Server has Changed its Operation

Proxy receives a request for resource P, that it has previously encountered as in G.2 Optimization based on Previous Server Interaction

Proxy forwards request with altered header fields

Response is 200 OK containing a Vary: User-Agent header field

Proxy notices that behavior has changed and reissues the request with original header fields

Response is 200 OK and proxy forwards it

H Informative Guidance for Origin Servers (Non-Normative)

Content providers may wish to follow these procedures in order to improve interoperability.

H.1 Server Response to Proxy

H.1.4 Varying Representations

It is good practice to take account of user agent capabilities and formulate an appropriate experience according to those capabilities. It is good practice to provide a means for users to select among available representations, to default to the last selected representation and to provide a means of changing the selection.

H.1.4.1 Use of Vary HTTP Header Field

If a server varies its representation according to examination of received HTTP header fields then [RFC 2616 HTTP] describes how to use the Vary header field to indicate this.

Servers that are aware of the presence of a transforming proxy, as identified by a Via HTTP Header field might alter their responses according to their knowledge of specific proxy behavior. When doing so it is good practice to make sure that the Internet content type for a response is correct for the actual content (e.g. a server should not choose Content-Type: application/vnd.wap.xhtml+xml because it suspects that proxies will not transform content of this type, if its content is not valid XHTML-MP).

H.1.4.2 Indication of Intended Presentation Media Type of Representation

If a server has distinct representations that vary according to the target presentation media type, it can inhibit transformation of the response by including a Cache-Control: no-transform directive (see H.1.3 Server Origination of Cache-Control: no-transform ).

In addition, in HTML content it can indicate the medium for which the representation is intended by including a link element identifying in its media attribute the target presentation media types of this representation and setting the href attribute to "Same-Document Reference" (see [RFC 3986] section 4.4 ) and in particular an empty href attribute is a "Same Document Reference".

In addition it is good practice to include link elements identifying the target presentation media types of other available representations in a similar manner.

If content for more than one presentation media type is served from the same URI, it is better not to use a link element identifying the presentation media types as the URI will appear to be a "same document reference", indicating to a client that this representation is suitable for all the named presentation media types. Instead, use a Vary HTTP header field indicating that the response varies according to the received User-Agent HTTP header field.

Note:

Some examples of the use of the link element are included above in G Example Transformation Interactions .

I Applicability to Transforming Solutions which are Out of Scope (Non-Normative)

There are a number of well-known examples of solutions that seem to their users as though they are using a browser, but because the client software communicates using proprietary protocols and techniques, it is the combination of the client and the network component that is regarded as the HTTP User Agent. The communication between the client and the network component is therefore out of scope of this document.

Additionally, where some kind of administrative arrangement exists between a transforming proxy and an origin server for the purposes of transforming content on the origin server's behalf, this is also out of scope of this document.

In both of the above cases, it is good practice to adhere to the provisions of this document in respect of providing information about the device and the original IP address.

J Scope for Future Work (Non-Normative)

B.1 J.1 POWDER

The BPWG believes that POWDER [POWDER] POWDER will represent a powerful mechanism by which a server may express transformation preferences. Future work in this area may recommend the use of POWDER. POWDER to provide a mechanism for origin servers to indicate more precisely which alternatives they have and what transformation they are willing to allow on them, and in addition to provide for Content Transformation proxies to indicate which services they are able to perform.

J.5 Amendment to and Refinement of HTTP

The BPWG believes that amendments to HTTP are needed to improve the interoperability of transforming proxies. For example, HTTP does not provide a way to distinguish between prohibition of any kind of transformation and the prohibition only of restructuring (and not recoding or compression). C

At present HTTP does not provide a mechanism for communicating original header field values. The scheme based on X-Device prefixed fields described under 4.1.5 Alteration of HTTP Header Field Values records and clarifies an approach used to achieve this effect by some content transformation proxies. This scheme relies upon non-standard HTTP fields, which are identified by their prefix as experimental according to IETF standards (notably RFC 822 and RFC 2076), and are not included in the IANA registry of HTTP header fields. While the mechanism defined in that section, based on current practice, applies to conforming transformation proxy deployments, it is possible that in future, in collaboration with the IETF, this approach will be reconsidered. This implies that the specified X-Device prefixed fields may, at some time, become deprecated in favor of new equivalent fields, or that an entirely different approach will be taken to representing such values.

A number of mechanisms exist in HTTP which might be exploited given more precise definition of their operation - for example the OPTIONS method and the HTTP 300 (Multiple Choices) Status.

K Acknowledgments (Non-Normative)

The editors acknowledge editor acknowledges contributions of various kinds from members of the MWI BPWG Mobile Web Best Practices Working Group and earlier from the Content Transformation Task Force . of that group.

The editor acknowledges significant written contributions from: