What's New in WinHTTP 5.1
This topic describes the most important differences between WinHTTP version 5.1 and version 5.0. Many of these differences require code changes in applications migrating from version 5.0 to version 5.1. Some of the features in version 5.1 are only available starting with Windows Server 2003 and Windows XP with Service Pack 2 (SP2), particularly features related to improving the security of the client against malicious Web servers.
Important With the release of WinHTTP Version 5.1, the WinHTTP 5.0 download is no longer available. As of October 1, 2004, Microsoft has removed the WinHTTP 5.0 SDK download from MSDN and has terminated product support for version 5.0.
The name of the new WinHTTP 5.1 DLL is Winhttp.dll, whereas the name of the WinHTTP 5.0 DLL is Winhttp5.dll.
WinHTTP 5.0 and 5.1 can coexist on the same system; WinHTTP 5.1 does not replace, or install over, WinHTTP 5.0.
WinHTTP 5.1 is available only with Windows Server 2003, Windows 2000 Professional with Service Pack 3 (SP3), Windows XP with Service Pack 1 (SP1), and later operating systems. A redistributable merge module (.msm) file is not available for WinHTTP 5.1.
The ProgID of the WinHttpRequest component has changed from "WinHttp.WinHttpRequest.5" to "WinHttp.WinHttpRequest.5.1". The CLSID of the WinHttpRequest class has also changed.
When calling the WinHttpWriteData, WinHttpQueryDataAvailable and WinHttpReadData functions in asynchronous mode, do not rely on the respective lpdwNumberOfBytesWritten, lpdwNumberOfBytesAvailable, and lpdwNumberOfBytesRead OUT parameters to be set. If the function call completes asynchronously, WinHTTP does not write to these pointers supplied by the application code. Instead, the application should retrieve these values using lpvStatusInformation and dwStatusInformationLength parameters to the callback function.
Changes to default settings include:
- SSL server certificate verification is enabled by default in WinHTTP 5.1. WinHTTP 5.0 does not handle failures encountered when validating the server certificate as fatal errors; they are reported to the application using a SECURE_FAILURE callback notification, but does not cause the request to be aborted. WinHTTP 5.1, alternatively, handles server certificate validation failures as fatal errors that abort the request. The application can instruct WinHTTP to ignore a small subset of certificate errors such as unknown CA, invalid/expired certificate date, or invalid certificate subject name, using the WINHTTP_OPTION_SECURITY_FLAGS option.
- Passport authentication support is disabled by default in WinHTTP 5.1. Passport support can be enabled with the WINHTTP_OPTION_CONFIGURE_PASSPORT_AUTH option. Automatic Passport credential look-up in the Keyring is also disabled by default.
- Redirect behavior change: HTTP redirects from a secure https: URL to a regular http: URL are no longer followed automatically by default for security reasons. There is a new option, WINHTTP_OPTION_REDIRECT_POLICY, to override the default redirect behavior in WinHTTP 5.1. With the WinHttpRequest COM component, use the new WinHttpRequestOption_EnableHttpsToHttpRedirects option to enable redirects from https: to http: URLs.
- When a WinHTTP trace file is created, access is restricted with an ACL such that only administrators can read or write the file. The user account under which the tracefile was created can also modify the ACL to grant others access. This protection is available only on file systems which support security; that is, NTFS, not FAT32).
- Starting with Windows Server 2003 and Windows XP with SP2, sending requests to the following well-known, non-HTTP, ports is restricted for security reasons: 21 (FTP), 25 (SMTP), 70 (GOPHER), 110 (POP3), 119 (NNTP), 143 (IMAP).
- Starting with Windows Server 2003, and Windows XP with SP2, the maximum amount of header data WinHTTP accepts in an HTTP response is 64K, by default. If the server HTTP response contains more that 64K of total header data, WinHTTP fails the request with an ERROR_WINHTTP_INVALID_SERVER_RESPONSE error. This 64K limit can be overridden using the new WINHTTP_OPTION_MAX_RESPONSE_HEADER_SIZE option.
WinHTTP 5.1 adds support for Internet Protocol Version 6 (IPv6). WinHTTP can send HTTP requests to a server whose DNS name resolves into an IPv6 address, and starting with Windows Server 2003 and Windows XP with SP2, WinHTTP also supports IPv6 literal addresses.
WinHTTP 5.1 implements the following new options:
- "#define WINHTTP_OPTION_PASSPORT_SIGN_OUT 86"
- "#define WINHTTP_OPTION_PASSPORT_RETURN_URL 87"
- "#define WINHTTP_OPTION_REDIRECT_POLICY 88"
Starting with Windows Server 2003 and Windows XP with SP2, WinHTTP 5.1 implements the following new options. On Windows 2000 Professional with SP3 or Windows XP with SP1, however, calls to WinHttpSetOption or WinHttpQueryOption with these option IDs fail:
- "#define WINHTTP_OPTION_RECEIVE_RESPONSE_TIMEOUT 7"
- "#define WINHTTP_OPTION_MAX_HTTP_AUTOMATIC_REDIRECTS 89"
- "#define WINHTTP_OPTION_MAX_HTTP_STATUS_CONTINUE 90"
- "#define WINHTTP_OPTION_MAX_RESPONSE_HEADER_SIZE 91"
- "#define WINHTTP_OPTION_MAX_RESPONSE_DRAIN_SIZE 92"
The WinHttpRequest 5.1 component implements the following new options:
The following new WinHttpRequest 5.1 options are available starting with Windows Server 2003 and Windows XP with SP2:
In WinHTTP 5.0, proxy servers are always trusted for auto-logon. This is no longer valid for WinHTTP 5.1 running on Windows Server 2003 and Windows XP with SP2 when the WINHTTP_AUTOLOGON_SECURITY_LEVEL_HIGH policy option is set.
To ease the configuration of proxy settings for WinHTTP-based applications, WinHTTP now implements the Web Proxy Auto-Discovery (WPAD) protocol, also referred to as autoproxy. This is the same protocol that web browsers, such as Internet Explorer, implement to discover the proxy configuration automatically without requiring an end-user to specify a proxy server manually. To support autoproxy, WinHTTP 5.1 implements a new C/C++ function, WinHttpGetProxyForUrl, plus two supporting functions, WinHttpDetectAutoProxyConfigUrl and WinHttpGetIEProxyConfigForCurrentUser.
The following issues are known to exist in WinHTTP 5.1 on Windows 2000 Professional with SP3 and Windows XP with SP1. These issues are resolved for WinHTTP starting with Windows Server 2003 and Windows XP with SP2:
- If the application uses the WinHttpSetTimeouts function or the SetTimeouts method on the WinHttpRequest component to set a non-infinite DNS resolve timeout such as the dwResolveTimeout parameter, a thread handle leak occurs each time WinHTTP resolves a DNS name. Over a large number of HTTP requests, this causes a significant memory leak. The workaround is to leave the default infinite resolve timeout setting unchanged (a value of 0 specifies an infinite timeout). This is strongly recommended in any case as supporting timeouts on DNS name resolutions in WinHTTP is expensive in terms of performance. For Windows 2000 and later, setting a DNS resolve timeout in WinHTTP is unnecessary as the underlying DNS client service implements its own resolve timeout.
- When processing asynchronous requests, WinHTTP does not handle thread impersonation properly. This causes requests that require NTLM/Negotiate authentication to fail, unless credentials are explicitly given using the WinHttpSetCredentials or WinHttpSetOption functions.