[httpc] Wrong Host header in IPv6 HTTP requests.

When a URI with a IPv6 host is parsed, the brackets that encapsulates
the nnn is removed. This value is then supplied as the host header.
This can cause problems with some servers.
A workaround for this is to use headers_as_is and provide the host
header with the requst call
To solve this a new option has been added, ipv6_host_with_brackets.
This option specifies if the host value of the host header shall include
the branckets or not. By default, it does not (as before).
OTP-9628

6 files changed, 104 insertions, 54 deletions

diff --git a/lib/inets/src/http_client/httpc.erl b/lib/inets/src/http_client/httpc.erl
index 6e566589aa..d72c34fa6b 100644
--- a/lib/inets/src/http_client/httpc.erl
+++ b/lib/inets/src/http_client/httpc.erl
@@ -141,7 +141,9 @@ request(Url, Profile) ->
 request(Method, Request, HttpOptions, Options) ->
     request(Method, Request, HttpOptions, Options, default_profile()). 
 
-request(Method, {Url, Headers}, HTTPOptions, Options, Profile) 
+request(Method, 
+	{Url, Headers}, 
+	HTTPOptions, Options, Profile) 
   when (Method =:= options) orelse 
        (Method =:= get) orelse 
        (Method =:= head) orelse 
@@ -154,7 +156,7 @@ request(Method, {Url, Headers}, HTTPOptions, Options, Profile)
 		      {http_options, HTTPOptions}, 
 		      {options,      Options}, 
 		      {profile,      Profile}]),
-    case http_uri:parse(Url) of
+    case http_uri:parse(Url, Options) of
 	{error, Reason} ->
 	    {error, Reason};
 	{ok, ParsedUrl} ->
@@ -162,7 +164,9 @@ request(Method, {Url, Headers}, HTTPOptions, Options, Profile)
 			   HTTPOptions, Options, Profile)
     end;
      
-request(Method, {Url,Headers,ContentType,Body}, HTTPOptions, Options, Profile) 
+request(Method, 
+	{Url, Headers, ContentType, Body}, 
+	HTTPOptions, Options, Profile) 
   when ((Method =:= post) orelse (Method =:= put)) andalso 
        (is_atom(Profile) orelse is_pid(Profile)) ->
     ?hcrt("request", [{method,       Method}, 
@@ -173,7 +177,7 @@ request(Method, {Url,Headers,ContentType,Body}, HTTPOptions, Options, Profile)
 		      {http_options, HTTPOptions}, 
 		      {options,      Options}, 
 		      {profile,      Profile}]),
-    case http_uri:parse(Url) of
+    case http_uri:parse(Url, Options) of
 	{error, Reason} ->
 	    {error, Reason};
 	{ok, ParsedUrl} ->
@@ -267,6 +271,9 @@ store_cookies(SetCookieHeaders, Url, Profile)
 			    {profile,            Profile}]),
     try 
 	begin
+	    %% Since the Address part is not actually used
+	    %% by the manager when storing cookies, we dont
+	    %% care about ipv6-host-with-brackets.
 	    {ok, {_, _, Host, Port, Path, _}} = http_uri:parse(Url),
 	    Address     = {Host, Port}, 
 	    ProfileName = profile_name(Profile),
@@ -464,6 +471,8 @@ handle_request(Method, Url,
 	    HeadersRecord = header_record(NewHeaders, Host2, HTTPOptions),
 	    Receiver      = proplists:get_value(receiver, Options),
 	    SocketOpts    = proplists:get_value(socket_opts, Options),
+	    BracketedHost = proplists:get_value(ipv6_host_with_brackets, 
+						Options),
 	    MaybeEscPath  = maybe_encode_uri(HTTPOptions, Path),
 	    MaybeEscQuery = maybe_encode_uri(HTTPOptions, Query),
 	    AbsUri        = maybe_encode_uri(HTTPOptions, Url),
@@ -482,7 +491,8 @@ handle_request(Method, Url,
 			       stream        = Stream, 
 			       headers_as_is = headers_as_is(Headers0, Options),
 			       socket_opts   = SocketOpts, 
-			       started       = Started},
+			       started       = Started,
+			       ipv6_host_with_brackets = BracketedHost},
 
 	    case httpc_manager:request(Request, profile_name(Profile)) of
 		{ok, RequestId} ->
@@ -739,14 +749,17 @@ request_options_defaults() ->
 		error
 	end,
 
+    VerifyBrackets = VerifyBoolean, 
+
     [
-     {sync,          true,      VerifySync}, 
-     {stream,        none,      VerifyStream},
-     {body_format,   string,    VerifyBodyFormat},
-     {full_result,   true,      VerifyFullResult},
-     {headers_as_is, false,     VerifyHeaderAsIs},
-     {receiver,      self(),    VerifyReceiver},
-     {socket_opts,   undefined, VerifySocketOpts}
+     {sync,                    true,      VerifySync}, 
+     {stream,                  none,      VerifyStream},
+     {body_format,             string,    VerifyBodyFormat},
+     {full_result,             true,      VerifyFullResult},
+     {headers_as_is,           false,     VerifyHeaderAsIs},
+     {receiver,                self(),    VerifyReceiver},
+     {socket_opts,             undefined, VerifySocketOpts},
+     {ipv6_host_with_brackets, false,     VerifyBrackets}
     ]. 
 
 request_options(Options) ->
diff --git a/lib/inets/src/http_client/httpc_internal.hrl b/lib/inets/src/http_client/httpc_internal.hrl
index 1d8a5b6a92..e4127d992d 100644
--- a/lib/inets/src/http_client/httpc_internal.hrl
+++ b/lib/inets/src/http_client/httpc_internal.hrl
@@ -90,25 +90,28 @@
 %%% All data associated to a specific HTTP request
 -record(request,
 	{
-	 id,            % ref() - Request Id
-	 from,          % pid() - Caller
-	 redircount = 0,% Number of redirects made for this request
-	 scheme,        % http | https 
-	 address,       % ({Host,Port}) Destination Host and Port
-	 path,          % string() - Path of parsed URL
-	 pquery,        % string() - Rest of parsed URL
-	 method,        % atom() - HTTP request Method
-	 headers,       % #http_request_h{}
-	 content,       % {ContentType, Body} - Current HTTP request
-	 settings,      % #http_options{} - User defined settings
-	 abs_uri,       % string() ex: "http://www.erlang.org"
-	 userinfo,      % string() - optinal "<userinfo>@<host>:<port>"
-	 stream,	% Boolean() - stream async reply?
-	 headers_as_is, % Boolean() - workaround for servers that does
-			% not honor the http standard, can also be used for testing purposes.
-	 started,       % integer() > 0 - When we started processing the request
-	 timer,         % undefined | ref()
-	 socket_opts    % undefined | [socket_option()]
+	  id,            % ref() - Request Id
+	  from,          % pid() - Caller
+	  redircount = 0,% Number of redirects made for this request
+	  scheme,        % http | https 
+	  address,       % ({Host,Port}) Destination Host and Port
+	  path,          % string() - Path of parsed URL
+	  pquery,        % string() - Rest of parsed URL
+	  method,        % atom() - HTTP request Method
+	  headers,       % #http_request_h{}
+	  content,       % {ContentType, Body} - Current HTTP request
+	  settings,      % #http_options{} - User defined settings
+	  abs_uri,       % string() ex: "http://www.erlang.org"
+	  userinfo,      % string() - optinal "<userinfo>@<host>:<port>"
+	  stream,	 % boolean() - stream async reply?
+	  headers_as_is, % boolean() - workaround for servers that does
+			 % not honor the http standard, can also be used 
+			 % for testing purposes.
+	  started,       % integer() > 0 - When we started processing the 
+			 % request
+	  timer,         % undefined | ref()
+	  socket_opts,   % undefined | [socket_option()]
+	  ipv6_host_with_brackets % boolean()
 	}
        ).               
 
diff --git a/lib/inets/src/http_client/httpc_manager.erl b/lib/inets/src/http_client/httpc_manager.erl
index 470d802740..ab575d867e 100644
--- a/lib/inets/src/http_client/httpc_manager.erl
+++ b/lib/inets/src/http_client/httpc_manager.erl
@@ -256,19 +256,27 @@ reset_cookies(ProfileName) ->
 
 
 %%--------------------------------------------------------------------
-%% Function: which_cookies(Url, ProfileName) -> [cookie()]
+%% Function: which_cookies(ProfileName)               -> [cookie()]
+%%           which_cookies(Url, ProfileName)          -> [cookie()]
+%%           which_cookies(Url, Options, ProfileName) -> [cookie()]
 %%
 %%	Url = string()
+%%	Options = [option()]
 %%      ProfileName = atom()
+%%      option() = {ipv6_host_with_brackets, boolean()}
 %%
 %% Description: Retrieves the cookies that would be sent when 
 %% requesting <Url>.
 %%--------------------------------------------------------------------
 
-which_cookies(ProfileName) ->
+which_cookies(ProfileName) when is_atom(ProfileName) ->
     call(ProfileName, which_cookies).
-which_cookies(Url, ProfileName) ->
-    call(ProfileName, {which_cookies, Url}).
+which_cookies(Url, ProfileName) 
+  when is_list(Url) andalso is_atom(ProfileName) ->
+    call(ProfileName, {which_cookies, Url, []}).
+which_cookies(Url, Options, ProfileName) 
+  when is_list(Url) andalso is_list(Options) andalso is_atom(ProfileName) ->
+    call(ProfileName, {which_cookies, Url, Options}).
 
 
 %%--------------------------------------------------------------------
@@ -395,9 +403,10 @@ handle_call(which_cookies, _, #state{cookie_db = CookieDb} = State) ->
     CookieHeaders = httpc_cookie:which_cookies(CookieDb),
     {reply, CookieHeaders, State};
 
-handle_call({which_cookies, Url}, _, #state{cookie_db = CookieDb} = State) ->
-    ?hcrv("which cookies", [{url, Url}]),
-    case http_uri:parse(Url) of
+handle_call({which_cookies, Url, Options}, _, 
+	    #state{cookie_db = CookieDb} = State) ->
+    ?hcrv("which cookies", [{url, Url}, {options, Options}]),
+    case http_uri:parse(Url, Options) of
 	{ok, {Scheme, _, Host, Port, Path, _}} ->
 	    CookieHeaders = 
 		httpc_cookie:header(CookieDb, Scheme, {Host, Port}, Path),
diff --git a/lib/inets/src/http_client/httpc_response.erl b/lib/inets/src/http_client/httpc_response.erl
index 4a2637a179..2414ed0911 100644
--- a/lib/inets/src/http_client/httpc_response.erl
+++ b/lib/inets/src/http_client/httpc_response.erl
@@ -340,7 +340,9 @@ redirect(Response = {StatusLine, Headers, Body}, Request) ->
 	undefined ->
 	    transparent(Response, Request);
 	RedirUrl ->
-	    case http_uri:parse(RedirUrl) of
+	    UrlParseOpts = [{ipv6_host_with_brackets, 
+			     Request#request.ipv6_host_with_brackets}], 
+	    case http_uri:parse(RedirUrl, UrlParseOpts) of
 		{error, no_scheme} when
 		(Request#request.settings)#http_options.relaxed ->
 		    NewLocation = fix_relative_uri(Request, RedirUrl),
@@ -352,8 +354,7 @@ redirect(Response = {StatusLine, Headers, Body}, Request) ->
 		%% Automatic redirection
 		{ok, {Scheme, _, Host, Port, Path,  Query}} -> 
 		    NewHeaders = 
-			(Request#request.headers)#http_request_h{host = 
-								 Host},
+			(Request#request.headers)#http_request_h{host = Host},
 		    NewRequest = 
 			Request#request{redircount = 
 					Request#request.redircount+1,
diff --git a/lib/inets/src/http_lib/http_uri.erl b/lib/inets/src/http_lib/http_uri.erl
index 5fa23ceb2d..74ffa37ca4 100644
--- a/lib/inets/src/http_lib/http_uri.erl
+++ b/lib/inets/src/http_lib/http_uri.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2006-2010. All Rights Reserved.
+%% Copyright Ericsson AB 2006-2011. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -22,17 +22,22 @@
 
 -module(http_uri).
 
--export([parse/1, encode/1, decode/1]).
+-export([parse/1, parse/2, 
+	 encode/1, decode/1]).
+
 
 %%%=========================================================================
 %%%  API
 %%%=========================================================================
 parse(AbsURI) ->
+    parse(AbsURI, []).
+
+parse(AbsURI, Opts) ->
     case parse_scheme(AbsURI) of
 	{error, Reason} ->
 	    {error, Reason};
 	{Scheme, Rest} ->
-	    case (catch parse_uri_rest(Scheme, Rest)) of
+	    case (catch parse_uri_rest(Scheme, Rest, Opts)) of
 		{UserInfo, Host, Port, Path, Query} ->
 		    {ok, {Scheme, UserInfo, Host, Port, Path, Query}};
 		_  ->
@@ -64,15 +69,14 @@ parse_scheme(AbsURI) ->
 	    {error, no_scheme};
 	{StrScheme, Rest} ->
 	    case list_to_atom(http_util:to_lower(StrScheme)) of
-		Scheme when Scheme == http; Scheme == https ->
+		Scheme when (Scheme =:= http) orelse (Scheme =:= https) ->
 		    {Scheme, Rest};
 		Scheme ->
 		    {error, {not_supported_scheme, Scheme}}
 	    end
     end.
 
-parse_uri_rest(Scheme, "//" ++ URIPart) ->
-
+parse_uri_rest(Scheme, "//" ++ URIPart, Opts) ->
     {Authority, PathQuery} =
 	case split_uri(URIPart, "/", URIPart, 1, 0) of
 	    Split = {_, _} ->
@@ -87,8 +91,8 @@ parse_uri_rest(Scheme, "//" ++ URIPart) ->
 	end,
 
     {UserInfo, HostPort} = split_uri(Authority, "@", {"", Authority}, 1, 1),
-    {Host, Port} = parse_host_port(Scheme, HostPort),
-    {Path, Query} = parse_path_query(PathQuery),
+    {Host, Port}         = parse_host_port(Scheme, HostPort, Opts),
+    {Path, Query}        = parse_path_query(PathQuery),
     {UserInfo, Host, Port, Path, Query}.
 
 
@@ -96,13 +100,14 @@ parse_path_query(PathQuery) ->
     {Path, Query} =  split_uri(PathQuery, "\\?", {PathQuery, ""}, 1, 0),
     {path(Path), Query}.
 
-parse_host_port(Scheme,"[" ++ HostPort) -> %ipv6
+parse_host_port(Scheme,"[" ++ HostPort, Opts) -> %ipv6
     DefaultPort = default_port(Scheme),
     {Host, ColonPort} = split_uri(HostPort, "\\]", {HostPort, ""}, 1, 1),
+    Host2 = maybe_ipv6_host_with_brackets(Host, Opts),
     {_, Port} = split_uri(ColonPort, ":", {"", DefaultPort}, 0, 1),
-    {Host, int_port(Port)};
+    {Host2, int_port(Port)};
 
-parse_host_port(Scheme, HostPort) ->
+parse_host_port(Scheme, HostPort, _Opts) ->
     DefaultPort = default_port(Scheme),
     {Host, Port} = split_uri(HostPort, ":", {HostPort, DefaultPort}, 1, 1),
     {Host, int_port(Port)}.
@@ -116,6 +121,14 @@ split_uri(UriPart, SplitChar, NoMatchResult, SkipLeft, SkipRight) ->
 	    NoMatchResult
     end.
 
+maybe_ipv6_host_with_brackets(Host, Opts) ->
+    case lists:keysearch(ipv6_host_with_brackets, 1, Opts) of
+	{value, {ipv6_host_with_brackets, true}} ->
+	    "[" ++ Host ++ "]";
+	_ ->
+	    Host
+    end.
+
 default_port(http) ->
     80;
 default_port(https) ->
diff --git a/lib/inets/test/httpc_SUITE.erl b/lib/inets/test/httpc_SUITE.erl
index f95fb93669..d9432c5127 100644
--- a/lib/inets/test/httpc_SUITE.erl
+++ b/lib/inets/test/httpc_SUITE.erl
@@ -1878,8 +1878,17 @@ parse_url(suite) ->
     [];
 parse_url(Config) when is_list(Config) ->
     %% ipv6
-    {http,[],"2010:836B:4179::836B:4179",80,"/foobar.html",[]}
-	= http_uri:parse("http://[2010:836B:4179::836B:4179]/foobar.html"),
+    {http,[],"2010:836B:4179::836B:4179",80,"/foobar.html",[]} = 
+	http_uri:parse("http://[2010:836B:4179::836B:4179]/foobar.html"),
+    {http,[],"[2010:836B:4179::836B:4179]",80,"/foobar.html",[]} = 
+	http_uri:parse("http://[2010:836B:4179::836B:4179]/foobar.html", 
+		       [{ipv6_host_with_brackets, true}]),
+    {http,[],"2010:836B:4179::836B:4179",80,"/foobar.html",[]} = 
+	http_uri:parse("http://[2010:836B:4179::836B:4179]/foobar.html", 
+		       [{ipv6_host_with_brackets, false}]),
+    {http,[],"2010:836B:4179::836B:4179",80,"/foobar.html",[]} = 
+	http_uri:parse("http://[2010:836B:4179::836B:4179]/foobar.html", 
+		       [{foo, false}]),
     {error,
      {malformed_url,"http://2010:836B:4179::836B:4179/foobar.html"}} =
 	http_uri:parse("http://2010:836B:4179::836B:4179/foobar.html"), 
@@ -1914,6 +1923,8 @@ parse_url(Config) when is_list(Config) ->
 	http_uri:parse("http://www.somedomain.com/%25abc"),
     {http,[],"www.somedomain.com",80,"/%25abc", "?foo=bar"} =
 	http_uri:parse("http://www.somedomain.com/%25abc?foo=bar"),
+
+    
     ok.