From jyri@sac.sfbay.sun.com Mon Oct 12 18:23:38 2009 Received: from sunmail2sca.sfbay.sun.com (sunmail2sca.SFBay.Sun.COM [129.145.155.234]) by sac.sfbay.sun.com (8.13.8+Sun/8.13.8) with ESMTP id n9D1NbjW004077 for ; Mon, 12 Oct 2009 18:23:37 -0700 (PDT) Received: from nwk-avmta-2.sfbay.sun.com (nwk-avmta-2.SFBay.Sun.COM [129.145.155.6]) by sunmail2sca.sfbay.sun.com (8.13.8+Sun/8.13.8/ENSMAIL,v2.4) with ESMTP id n9D1NZ4Z004505; Mon, 12 Oct 2009 18:23:36 -0700 (PDT) Received: from pmxchannel-daemon.nwk-avmta-2.sfbay.sun.com by nwk-avmta-2.sfbay.sun.com (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) id <0KRF0000BIJBJG00@nwk-avmta-2.sfbay.sun.com>; Mon, 12 Oct 2009 18:23:35 -0700 (PDT) Received: from dm-sfbay-02.sfbay.sun.com ([129.146.11.31]) by nwk-avmta-2.sfbay.sun.com (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) with ESMTP id <0KRF0074EIJB69E0@nwk-avmta-2.sfbay.sun.com>; Mon, 12 Oct 2009 18:23:35 -0700 (PDT) Received: from sac.sfbay.sun.com (sac.SFBay.Sun.COM [129.146.226.132]) by dm-sfbay-02.sfbay.sun.com (8.13.8+Sun/8.13.8/ENSMAIL,v2.2) with ESMTP id n9D1NYLG008740; Mon, 12 Oct 2009 18:23:34 -0700 (PDT) Received: from sac.sfbay.sun.com (localhost [127.0.0.1]) by sac.sfbay.sun.com (8.13.8+Sun/8.13.8) with ESMTP id n9D1N2kG004068; Mon, 12 Oct 2009 18:23:02 -0700 (PDT) Received: (from jyri@localhost) by sac.sfbay.sun.com (8.13.8+Sun/8.13.8/Submit) id n9D1N0Mc004064; Mon, 12 Oct 2009 18:23:00 -0700 (PDT) Date: Mon, 12 Oct 2009 18:23:00 -0700 (PDT) From: Jyri Virkki Subject: modules mod_proxy_html and mod_xml2enc for Apache HTTPD 2.2 [LSARC/2009/553 FastTrack timeout 10/20/2009] To: LSARC-ext@sun.com Cc: niq@sun.com, webstack-discuss@opensolaris.org Message-id: <200910130123.n9D1N0Mc004064@sac.sfbay.sun.com> Content-transfer-encoding: 7BIT X-PMX-Version: 5.4.1.325704 Status: RO Content-Length: 10248 I am sponsoring this case for Nick Kew. It is a straightfoward addition of two more Apache httpd modules. Timeout set to 10/20/200. Template Version: @(#)sac_nextcase 1.68 02/23/09 SMI This information is Copyright 2009 Sun Microsystems 1. Introduction 1.1. Project/Component Working Name: modules mod_proxy_html and mod_xml2enc for Apache HTTPD 2.2 1.2. Name of Document Author/Supplier: Author: Nick Kew 1.3 Date of This Document: 12 October, 2009 4. Technical Description 1. Introduction 1.1 Title modules mod_proxy_html and mod_xml2enc for Apache HTTPD 2.2 1.2 Author Nick Kew 1.3 Date 2009-10-09 1.4 Customers Users of Apache HTTPD as a reverse proxy/gateway 1.5 Email Aliases 1.5.2 Responsible Engineer niq@sun.com 1.5.4 Interest List webstack-discuss@opensolaris.org 2. Summary 2.1 Description mod_proxy_html is a markup-aware filter capable of rewriting HTML and XHTML on-the-fly. It is commonly required in a reverse proxy situation, such as where Apache HTTPD is used as a gateway providing external access to servers hosted on an internal or private network. mod_xml2enc deals with managing character encodings (charset) support on behalf of mod_proxy_html and other filters, and is required to support internationalisation correctly where a proxied server delivers character sets that are not ASCII- or Unicode (utf-8)-compatible. 2.2 Risks and Assumptions N/A 3. Business Summary 3.1 Problem Area A web gateway, or reverse proxy, is often used to provide external access to servers hosted on a private network. Often such servers include or generate documents containing links that cannot be reached or even resolved from outside the network. mod_proxy_html serves to rewrite such links into the gateway's address space, so that they can be addressed from outside the private network. mod_proxy_html is one of several Apache filter modules based on parsing documents with libxml2. This library uses unicode (utf-8) internally, and is capable of reading documents in a limited range of other character encodings. mod_xml2enc is required to detect automatically the character set of incoming documents so they can be correctly parsed, and is required to support character encodings not directly supported by libxml2. mod_xml2enc provides strong internationalisation support for mod_proxy_html, and other libxml2-based modules such as mod_transform (XInclude/XSLT processing) and mod_xml2 (SAX2 event-based parsing). 3.2 Market/Requester mod_proxy_html has been requested by Web Stack users. 3.3 Business Justification Packaging these modules provides significant added value for Web Stack users. Specifically, it enables use of the Web Stack in a major class of applications that are not possible without these modules. 3.4 Competitive Analysis The reverse proxy/gateway is a common application, and one in which Apache HTTPD has a strong market share. In addition to widely-supported proxy functionality such as loadbalancing and cacheing/acceleration, and web application firewall (a third-party product, mod_security), Apache has a significant advantage in its filter architecture. This enables a wide range of applications in the areas of content transformation and aggregation. One such is mod_proxy_html, which enables Apache to serve as gateway to systems that would fail if accessed through a basic non-content-aware gateway. Earlier versions of mod_proxy_html have been packaged for some years by many competitors, such as Linux distributions, FreeBSD, and even Windows packagers. 3.5 Opportunity Window/Exposure These modules are relevant for the forseeable future. Earlier versions have been in widespread use for several years. 3.6 How will you know when you are done? IPS Packages will be available. They will be verified as rewriting links in a proxy context, and correctly handling "exotic" character sets using test cases such as Pravda (cyrillic script and incorporating complex transcluded content). 4. Technical Description: 4.1 Details This is a straightforward packaging effort. 4.2 Bug/RFE Number(s) CR 6716096 (mod_xml2enc) and CR 6716092 (mod_proxy_html) OSR 9711 (mod_xml2enc) and OSR 9712 (mod_proxy_html) 4.3 In Scope Documentation will be updated. 4.4 Out of Scope The tutorial at www.apachetutor.org should be updated and may additionally be duplicated at Sun for Web Stack users. However, this falls outside this project. 4.5 Interfaces Both modules introduce a number of configuration options for Apache's httpd.conf, and mod_proxy_html packages a sample configuration file proxy_html.conf configuring it to parse documents by default as standard W3C HTML 4.01 or XHTML 1.0. In addition, mod_xml2enc exports an API/ABI for internationalisation support in file mod_xml2enc.h. These are expected to remain compatible for at least the lifetime of Apache 2.2. Exported Interfaces NAME STABILITY DESCRIPTION ----------------------------------------------------------------------- /usr/apache2/2.2/include/mod_xml2enc.h Uncommitted Header file exporting i18n API/ABI /etc/apache2/2.2/samples-conf.d/proxy_html.conf Uncommitted Configuration sample xml2EncDefault Uncommitted Configuration directive xml2EncAlias Uncommitted Configuration directive xml2StartParse Uncommitted Configuration directive ProxyHTMLEvents Uncommitted Configuration directive ProxyHTMLLinks Uncommitted Configuration directive ProxyHTMLURLMap Uncommitted Configuration directive ProxyHTMLDoctype Uncommitted Configuration directive ProxyHTMLFixups Uncommitted Configuration directive ProxyHTMLMeta Uncommitted Configuration directive ProxyHTMLInterp Uncommitted Configuration directive ProxyHTMLExtended Uncommitted Configuration directive ProxyHTMLStripComments Uncommitted Configuration directive ProxyHTMLLogVerbose Uncommitted Configuration directive ProxyHTMLBufSize Uncommitted Configuration directive ProxyHTMLCharsetOut Uncommitted Configuration directive ProxyHTMLEnable Uncommitted Configuration directive SUNWapch22m-xml2enc Committed Package name SUNWapch22m-proxy-html Committed Package name Imported Interfaces NAME Stability Description ARC Case ref ----------------------------------------------------------------------- libxml2 Stable XML library PSARC/2008/032 Apache HTTPD Uncommitted Apache HTTPD PSARC/2007/169 4.6 Doc Impact Documentation is available at the originator's website. The configuration sample will direct users there. 4.7 Admin/Config Impact New Apache configuration options as documented at http://apache.webthing.com/mod_proxy_html/ and http://apache.webthing.com/mod_xml2enc/ 4.8 HA Impact N/A 4.9 I18N/L10N Impact By default, all contents are served as UTF-8, regardless of the character encoding of the original contents. mod_xml2enc supports automatic detection and administrator overrides of different character encodings, and conversion of output to an administrator's choice of encoding. 4.10 Packaging/Delivery This project is part of the Sun Webstack, and will be packaged as SUNWapch22m-xml2enc and SUNWapch22m-proxy-html It has no impact on existing packages. 4.11 Security Impact None known. 4.12 Dependencies This proposal depends on Apache HTTPD 2.2.x and libxml2 2.6 or later. libxml2: http://arc.opensolaris.org/caselog/PSARC/2008/032/ Apache HTTPD: http://arc.opensolaris.org/caselog/PSARC/2007/169/ 5. Reference Documents http://apache.webthing.com/mod_proxy_html/ http://apache.webthing.com/mod_xml2enc/ http://www.apachetutor.org/admin/reverseproxies OSR 9711 (mod_xml2enc) and OSR 9712 (mod_proxy_html) cr6716096 (mod_xml2enc) and cr6716092 (mod_proxy_html) http://arc.opensolaris.org/caselog/PSARC/2008/032/ http://arc.opensolaris.org/caselog/PSARC/2007/169/ 6. Projected Availability 2009/12 7. Prototype Availability The modules are available, and can be compiled "by hand" as prototype. APPENDIX A: Files to be delivered in SUNWapch22m-xml2enc /usr/apache2/2.2/include/mod_xml2enc.h /usr/apache2/2.2/libexec/mod_xml2enc.so /usr/apache2/2.2/libexec/amd64/mod_xml2enc.so /usr/apache2/2.2/libexec/sparc9/mod_xml2enc.so APPENDIX B: Files to be delivered in SUNWapch22m-proxy-html /etc/apache2/2.2/samples-conf.d/proxy_html.conf /usr/apache2/2.2/libexec/mod_proxy_html.so /usr/apache2/2.2/libexec/amd64/mod_proxy_html.so /usr/apache2/2.2/libexec/sparc9/mod_proxy_html.so 6. Resources and Schedule 6.4. Steering Committee requested information 6.4.1. Consolidation C-team Name: sfw 6.5. ARC review type: FastTrack 6.6. ARC Exposure: open From Jyri.Virkki@sun.com Fri Oct 16 14:51:21 2009 Received: from sunmail4.singapore.sun.com (sunmail4.Singapore.Sun.COM [129.158.71.19]) by sac.sfbay.sun.com (8.13.8+Sun/8.13.8) with ESMTP id n9GLpLoF014341 for ; Fri, 16 Oct 2009 14:51:21 -0700 (PDT) Received: from nwk-avmta-1.SFBay.Sun.COM (nwk-avmta-1.SFBay.Sun.COM [129.146.11.74]) by sunmail4.singapore.sun.com (8.13.4+Sun/8.13.3/ENSMAIL,v2.2) with ESMTP id n9GLpIIi025463; Sat, 17 Oct 2009 05:51:18 +0800 (SGT) Received: from pmxchannel-daemon.nwk-avmta-1.sfbay.Sun.COM by nwk-avmta-1.sfbay.Sun.COM (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) id <0KRM00A01NDHKJ00@nwk-avmta-1.sfbay.Sun.COM>; Fri, 16 Oct 2009 14:51:17 -0700 (PDT) Received: from brmea-mail-1.sun.com ([192.18.98.31]) by nwk-avmta-1.sfbay.Sun.COM (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) with ESMTP id <0KRM00MEQNDHIL80@nwk-avmta-1.sfbay.Sun.COM>; Fri, 16 Oct 2009 14:51:17 -0700 (PDT) Received: from dm-usca19-13.red.iplanet.com (host-179-56-18-192.iplanet.com [192.18.56.179] (may be forged)) by brmea-mail-1.sun.com (8.13.6+Sun/8.12.9) with ESMTP id n9GLpGPg015277; Fri, 16 Oct 2009 21:51:16 +0000 (GMT) Received: from buye.red.iplanet.com (buye [192.18.65.224]) by dm-usca19-13.red.iplanet.com (8.11.7p1+Sun/8.11.7/IPLANET,v1.2) with ESMTP id n9GLpGJ24261; Fri, 16 Oct 2009 14:51:16 -0700 (PDT) Received: from buye.red.iplanet.com (localhost [127.0.0.1]) by buye.red.iplanet.com (8.13.7+Sun/8.13.7) with ESMTP id n9GLpGd4028055; Fri, 16 Oct 2009 14:51:16 -0700 (PDT) Received: (from jyri@localhost) by buye.red.iplanet.com (8.13.7+Sun/8.13.7/Submit) id n9GLpGE5028054; Fri, 16 Oct 2009 14:51:16 -0700 (PDT) Date: Fri, 16 Oct 2009 14:51:16 -0700 From: Jyri Virkki Subject: Re: modules mod_proxy_html and mod_xml2enc for Apache HTTPD 2.2 [LSARC/2009/553 FastTrack timeout 10/20/2009] In-reply-to: <200910130123.n9D1N0Mc004064@sac.sfbay.sun.com> To: niq@sun.com Cc: LSARC-ext@sun.com, niq@sun.com Message-id: <20091016215116.GA27849@sun.com> MIME-version: 1.0 Content-type: text/plain; charset=us-ascii Content-transfer-encoding: 7BIT Content-disposition: inline X-PMX-Version: 5.4.1.325704 References: <200910130123.n9D1N0Mc004064@sac.sfbay.sun.com> User-Agent: Mutt/1.5.11 Status: RO Content-Length: 407 Jyri Virkki wrote: > > I am sponsoring this case for Nick Kew. It is a straightfoward addition > of two more Apache httpd modules. Timeout set to 10/20/200. FYI I won't be here for the next two ARC meetings, if other ARC members have a chance to review and +1 this it can get closed. If it doesn't happen, the timeout can be extended to 11/3. -- Jyri J. Virkki - jyri.virkki@sun.com - Sun Microsystems From Jyri.Virkki@sun.com Tue Nov 3 16:35:04 2009 Received: from newsunmail1brm.central.sun.com (newsunmail1brm.Central.Sun.COM [129.147.62.245]) by sac.sfbay.sun.com (8.13.8+Sun/8.13.8) with ESMTP id nA40Z4Af004946 for ; Tue, 3 Nov 2009 16:35:04 -0800 (PST) Received: from nwk-avmta-1.SFBay.Sun.COM (nwk-avmta-1.SFBay.Sun.COM [129.146.11.74]) by newsunmail1brm.central.sun.com (8.13.7+Sun/8.13.7/ENSMAIL,v2.2) with ESMTP id nA40Z1Je029038; Tue, 3 Nov 2009 17:35:03 -0700 (MST) Received: from pmxchannel-daemon.nwk-avmta-1.sfbay.Sun.COM by nwk-avmta-1.sfbay.Sun.COM (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) id <0KSK00N0T6YE4I00@nwk-avmta-1.sfbay.Sun.COM>; Tue, 03 Nov 2009 16:35:02 -0800 (PST) Received: from brmea-mail-4.sun.com ([192.18.98.36]) by nwk-avmta-1.sfbay.Sun.COM (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) with ESMTP id <0KSK005BN6YDMAA0@nwk-avmta-1.sfbay.Sun.COM>; Tue, 03 Nov 2009 16:35:01 -0800 (PST) Received: from dm-usca19-13.red.iplanet.com (host-179-56-18-192.iplanet.com [192.18.56.179] (may be forged)) by brmea-mail-4.sun.com (8.13.6+Sun/8.12.9) with ESMTP id nA40YTvv008502; Wed, 04 Nov 2009 00:34:29 +0000 (GMT) Received: from buye.red.iplanet.com (buye [192.18.65.224]) by dm-usca19-13.red.iplanet.com (8.11.7p1+Sun/8.11.7/IPLANET,v1.2) with ESMTP id nA40YaJ17730; Tue, 03 Nov 2009 16:34:36 -0800 (PST) Received: from buye.red.iplanet.com (localhost [127.0.0.1]) by buye.red.iplanet.com (8.13.7+Sun/8.13.7) with ESMTP id nA40YSpo022740; Tue, 03 Nov 2009 16:34:28 -0800 (PST) Received: (from jyri@localhost) by buye.red.iplanet.com (8.13.7+Sun/8.13.7/Submit) id nA40YSm0022739; Tue, 03 Nov 2009 16:34:28 -0800 (PST) Date: Tue, 03 Nov 2009 16:34:28 -0800 From: Jyri Virkki Subject: Re: modules mod_proxy_html and mod_xml2enc for Apache HTTPD 2.2 [LSARC/2009/553 FastTrack timeout 10/20/2009] In-reply-to: <200910130123.n9D1N0Mc004064@sac.sfbay.sun.com> To: niq@sun.com Cc: LSARC-ext@sun.com, webstack-discuss@opensolaris.org Message-id: <20091104003428.GA22721@sun.com> MIME-version: 1.0 Content-type: text/plain; charset=us-ascii Content-transfer-encoding: 7BIT Content-disposition: inline X-PMX-Version: 5.4.1.325704 References: <200910130123.n9D1N0Mc004064@sac.sfbay.sun.com> User-Agent: Mutt/1.5.11 Status: RO Content-Length: 296 Jyri Virkki wrote: > > I am sponsoring this case for Nick Kew. It is a straightfoward addition > of two more Apache httpd modules. Timeout set to 10/20/200. For the email record, this case was approved at the Oct.20 LSARC meeting. -- Jyri J. Virkki - jyri.virkki@sun.com - Sun Microsystems