OkHttp 2.x Change Log¶
- Fix: Change the certificate pinner to always build full chains. This prevents a potential crash when using certificate pinning with the Google Play Services security provider.
- Fix: Don’t crash when finding the trust manager if the Play Services (GMS) security provider is installed.
- Fix: The previous release introduced a performance regression on Android, caused by looking up CA certificates. This is now fixed.
- Fix: Permit the trusted CA root to be pinned by
- Fix: Don’t eagerly release stream allocations on cache hits. We might still need them to handle redirects.
- Fix: Don’t do a health check on newly-created connections. This is unnecessary work that could put the client in an inconsistent state if the health check fails.
- Rewritten connection management. Previously OkHttp’s connection pool
managed both idle and active connections for HTTP/2, but only idle
connections for HTTP/1.x. With this update the connection pool manages both
idle and active connections for everything. OkHttp now detects and warns on
connections that were allocated but never released, and will enforce HTTP/2
stream limits. This update also fixes
Call.cancel()to not do I/O on the calling thread.
- Fix: Don’t log gzipped data in the logging interceptor.
- Fix: Don’t resolve DNS addresses when connecting through a SOCKS proxy.
- Fix: Drop the synthetic
- Fix: Support 204 and 205 ‘No Content’ replies in the logging interceptor.
- New: Add
New Logging Interceptor. The
logging-interceptorsubproject offers simple request and response logging. It may be configured to log headers and bodies for debugging. It requires this Maven dependency:
<dependency> <groupId>com.squareup.okhttp</groupId> <artifactId>logging-interceptor</artifactId> <version>2.6.0</version> </dependency>
Configure basic logging like this:
HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(); loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BASIC); client.networkInterceptors().add(loggingInterceptor);
Level.BODYin production because they could leak passwords and other authentication credentials to insecure logs.
WebSocket API now uses
ResponseBodyfor messages. This is a backwards-incompatible API change.
The DNS service is now pluggable. In some situations this may be useful to manually prioritize specific IP addresses.
Fix: Don’t throw when converting an
java.net.URI. Previously URLs with special characters like
[would break when subjected to URI’s overly-strict validation.
- Fix: Don’t re-encode
%20in encoded URL query strings. OkHttp prefers
%20when doing its own encoding, but will retain
+when that is provided.
- Fix: Enforce that callers call
WebSocket.close()on IO errors. Error handling in WebSockets is significantly improved.
- Fix: Don’t use SPDY/3 style header concatenation for HTTP/2 request headers. This could have corrupted requests where multiple headers had the same name, as in cookies.
- Fix: Reject bad characters in the URL hostname. Previously characters like
\0would cause a late crash when building the request.
- Fix: Allow interceptors to change the request method.
- Fix: Don’t use the request’s
Proxy-Authorizationwhen connecting to an HTTPS server via an HTTP tunnel. The
Proxy-Authorizationheader was being leaked to the origin server.
- Fix: Digits may be used in a URL scheme.
- Fix: Improve connection timeout recovery.
- Fix: Recover from
getsocknamecrashes impacting Android releases prior to 4.2.2.
- Fix: Drop partial support for HTTP/1.0. Previously OkHttp would send
HTTP/1.0on connections after seeing a response with
HTTP/1.0. The fixed behavior is consistent with Firefox and Chrome.
- Fix: Allow a body in
- Fix: Don’t percent-encode non-ASCII characters in URL fragments.
- Fix: Handle null fragments.
- Fix: Don’t crash on interceptors that throw
IOExceptionbefore a connection is attempted.
- New: Support WebDAV HTTP methods.
- New: Buffer WebSocket frames for better performance.
- New: Drop support for
TLS_DHE_DSS_WITH_AES_128_CBC_SHA, our only remaining DSS cipher suite. This is consistent with Firefox and Chrome which have also dropped these cipher suite.
Timeouts now default to 10 seconds. Previously we defaulted to never timing out, and that was a lousy policy. If establishing a connection, reading the next byte from a connection, or writing the next byte to a connection takes more than 10 seconds to complete, you’ll need to adjust the timeouts manually.
OkHttp now rejects request headers that contain invalid characters. This includes potential security problems (newline characters) as well as simple non-ASCII characters (including international characters and emoji).
Call canceling is more reliable. We had a bug where a socket being connected wasn’t being closed when the application used
Changing a HttpUrl’s scheme now tracks the default port. We had a bug where changing a URL from
httpswould leave it on port 80.
Okio has been updated to 1.6.0.
<dependency> <groupId>com.squareup.okio</groupId> <artifactId>okio</artifactId> <version>1.6.0</version> </dependency>
Cache.initialize(). Call this on a background thread to eagerly initialize the response cache.
- New: Fold
MockWebServer. This makes it easier to write JUnit tests with
MockWebServerlibrary now depends on JUnit, though it continues to work with all testing frameworks.
FormEncodingBuilderis now consistent with browsers in which characters it escapes. Previously we weren’t percent-encoding commas, parens, and other characters.
- Fix: Relax
FormEncodingBuilderto support building empty forms.
- Fix: Timeouts throw
- Fix: Change
MockWebServerto use the same logic as OkHttp when determining whether an HTTP request permits a body.
HttpUrlnow uses the canonical form for IPv6 addresses.
- Fix: Use
- Fix: Recover from Android 4.2.2 EBADF crashes.
- Fix: Don’t crash with an
IllegalStateExceptionif an HTTP/2 or SPDY write fails, leaving the connection in an inconsistent state.
- Fix: Make sure the default user agent is ASCII.
Forbid response bodies on HTTP 204 and 205 responses. Webservers that return such malformed responses will now trigger a
ProtocolExceptionin the client.
WebSocketListener has incompatible changes. The
onOpen()method is now called on the reader thread, so implementations must return before further websocket messages will be delivered. The
onFailure()method now includes an HTTP response if one was returned.
New HttpUrl API. It’s like
java.net.URLbut good. Note that
IllegalArgumentExceptionon malformed URLs. (Previous releases would throw a
MalformedURLExceptionwhen calling a malformed URL.)
We’ve improved connect failure recovery. We now differentiate between setup, connecting, and connected and implement appropriate recovery rules for each. This changes
Addressto no longer use
ConnectionSpec. (This is an incompatible API change).
+for encoded spaces. Both are permitted-by-spec, but
%20requires fewer special cases.
Okio has been updated to 1.4.0.
<dependency> <groupId>com.squareup.okio</groupId> <artifactId>okio</artifactId> <version>1.4.0</version> </dependency>
Request.Builderno longer accepts null if a request body is required. Passing null will now fail for request methods that require a body. Instead use an empty body such as this one:
RequestBody.create(null, new byte);
CertificatePinnernow supports wildcard hostnames. As always with certificate pinning, you must be very careful to avoid bricking your app. You’ll need to pin both the top-level domain and the
*.domain for full coverage.
client.setCertificatePinner(new CertificatePinner.Builder() .add("publicobject.com", "sha1/DmxUShsZuNiqPQsX2Oi9uv2sCnw=") .add("*.publicobject.com", "sha1/DmxUShsZuNiqPQsX2Oi9uv2sCnw=") .add("publicobject.com", "sha1/SXxoaOSEzPC6BgGmxAt/EAcsajw=") .add("*.publicobject.com", "sha1/SXxoaOSEzPC6BgGmxAt/EAcsajw=") .add("publicobject.com", "sha1/blhOM3W9V/bVQhsWAcLYwPU6n24=") .add("*.publicobject.com", "sha1/blhOM3W9V/bVQhsWAcLYwPU6n24=") .add("publicobject.com", "sha1/T5x9IXmcrQ7YuQxXnxoCmeeQ84c=") .add("*.publicobject.com", "sha1/T5x9IXmcrQ7YuQxXnxoCmeeQ84c=") .build());
Interceptors lists are now deep-copied by
OkHttpClient.clone(). Previously clones shared interceptors, which made it difficult to customize the interceptors on a request-by-request basis.
Dispatcher.getRunningCallCount(). These can be useful in diagnostics.
- Fix: OkHttp no longer shares timeouts between pooled connections. This was causing some applications to crash when connections were reused.
OkApacheClientnow allows an empty
- Fix: Websockets no longer rebuffer socket streams.
- Fix: Websockets are now better at handling close frames.
- Fix: Content type matching is now case insensitive.
Varyheaders are not lost with
- Fix: HTTP/2 wasn’t enforcing stream timeouts when writing the underlying connection. Now it is.
- Fix: Never return null on
call.proceed(). This was a bug in call cancelation.
- Fix: When a network interceptor mutates a request, that change is now
- Fix: Badly-behaving caches now throw a checked exception instead of a
- Fix: Better handling of uncaught exceptions in MockWebServer with HTTP/2.
HTTP/2 support. We’ve done interop testing and haven’t seen any problems. HTTP/2 support has been a big effort and we’re particularly thankful to Adrian Cole who has helped us to reach this milestone.
RC4 cipher suites are no longer supported by default. To connect to old, obsolete servers relying on these cipher suites, you must create a custom
Beta WebSockets support.. The
okhttp-wssubproject offers a new websockets client. Please try it out! When it’s ready we intend to include it with the core OkHttp library.
Okio updated to 1.3.0.
<dependency> <groupId>com.squareup.okio</groupId> <artifactId>okio</artifactId> <version>1.3.0</version> </dependency>
Fix: improve parallelism of async requests. OkHttp’s Dispatcher had a misconfigured
ExecutorServicethat limited the number of worker threads. If you’re using
Call.enqueue()this update should significantly improve request concurrency.
Fix: Lazily initialize the response cache. This avoids strict mode warnings when initializing OkHttp on Android‘s main thread.
Fix: Disable ALPN on Android 4.4. That release of the feature was unstable and prone to native crashes in the underlying OpenSSL code.
- Fix: Don’t send both
If-Modified-Sincecache headers when both are applicable.
- Fix: Fail early when a port is out of range.
- Fix: Offer
Content-Lengthheaders for multipart request bodies.
- Fix: Throw
UnknownServiceExceptionif a cleartext connection is attempted when explicitly forbidden.
- Fix: Throw a
SSLPeerUnverifiedExceptionwhen host verification fails.
- Fix: MockWebServer explicitly closes sockets. (On some Android releases, closing the input stream and output stream of a socket is not sufficient.
- Fix: Buffer outgoing HTTP/2 frames to limit how many outgoing frames are created.
- Fix: Avoid crashing when cache writing fails due to a full disk.
- Fix: Improve caching of private responses.
- Fix: Update cache-by-default response codes.
- Fix: Reused
Request.Builderinstances no longer hold stale URL fields.
- New: ConnectionSpec can now be configured to use the SSL socket’s default
cipher suites. To use, set the cipher suites to
- New: Support
DELETEwith a request body.
Headers.of(Map)creates headers from a Map.
IOException. This is a source-incompatible change. If you have code that calls
RequestBody.contentLength(), your compile will break with this update. The change is binary-compatible, however: code compiled for OkHttp 2.0 and 2.1 will continue to work with this update.
COMPATIBLE_TLSno longer supports SSLv3. In response to the POODLE vulnerability, OkHttp no longer offers SSLv3 when negotiation an HTTPS connection. If you continue to need to connect to webservers running SSLv3, you must manually configure your own
OkHttp now offers interceptors. Interceptors are a powerful mechanism that can monitor, rewrite, and retry calls. The interceptors doc is a full introduction to this new API.
New: APIs to iterate and selectively clear the response cache.
- New: Support for SOCKS proxies.
- New: Support for
- New: Update HTTP/2 support to
- New: APIs to prevent retrying non-idempotent requests.
- Fix: Drop NPN support. Going forward we support ALPN only.
- Fix: The hostname verifier is now strict. This is consistent with the hostname verifier in modern browsers.
- Fix: Improve
CONNECThandling for misbehaving HTTP proxies.
- Fix: Don’t retry requests that failed due to timeouts.
- Fix: Cache 302s and 308s that include appropriate response headers.
- Fix: Improve pooling of connections that use proxy selectors.
- Fix: Don’t leak connections when using ALPN on the desktop.
- Fix: Update Jetty ALPN to
7.1.2.v20141202(Java 7) and
8.1.2.v20141202(Java 8). This fixes a bug in resumed TLS sessions where the wrong protocol could be selected.
- Fix: Don’t crash in SPDY and HTTP/2 when disconnecting before connecting.
- Fix: Avoid a reverse DNS-lookup for a numeric proxy address
- Fix: Resurrect http/2 frame logging.
- Fix: Limit to 20 authorization attempts.
- New: Typesafe APIs for interacting with cipher suites and TLS versions.
- Fix: Don’t crash when mixing authorization challenges with upload retries.
OkHttp now caches private responses. We’ve changed from a shared cache to a private cache, and will now store responses that use an
Authorizationheader. This means OkHttp’s cache shouldn’t be used on middleboxes that sit between user agents and the origin server.
TLS configuration updated. OkHttp now explicitly enables TLSv1.2, TLSv1.1 and TLSv1.0 where they are supported. It will continue to perform only one fallback, to SSLv3. Applications can now configure this with the
To disable TLS fallback:
client.setConnectionSpecs(Arrays.asList( ConnectionSpec.MODERN_TLS, ConnectionSpec.CLEARTEXT));
To disable cleartext connections, permitting
client.setConnectionSpecs(Arrays.asList( ConnectionSpec.MODERN_TLS, ConnectionSpec.COMPATIBLE_TLS));
New cipher suites. Please confirm that your webservers are reachable with this limited set of cipher suites.
Android Name Version TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 5.0 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 5.0 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 5.0 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 4.0 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 4.0 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 4.0 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 4.0 TLS_ECDHE_ECDSA_WITH_RC4_128_SHA 4.0 TLS_ECDHE_RSA_WITH_RC4_128_SHA 4.0 TLS_DHE_RSA_WITH_AES_128_CBC_SHA 2.3 TLS_DHE_DSS_WITH_AES_128_CBC_SHA 2.3 TLS_DHE_RSA_WITH_AES_256_CBC_SHA 2.3 TLS_RSA_WITH_AES_128_GCM_SHA256 5.0 TLS_RSA_WITH_AES_128_CBC_SHA 2.3 TLS_RSA_WITH_AES_256_CBC_SHA 2.3 SSL_RSA_WITH_3DES_EDE_CBC_SHA 2.3 (Deprecated in 5.0) SSL_RSA_WITH_RC4_128_SHA 2.3 SSL_RSA_WITH_RC4_128_MD5 2.3 (Deprecated in 5.0)
Okio updated to 1.0.1.
<dependency> <groupId>com.squareup.okio</groupId> <artifactId>okio</artifactId> <version>1.0.1</version> </dependency>
New APIs to permit easy certificate pinning. Be warned, certificate pinning is dangerous and could prevent your application from trusting your server!
Cache improvements. This release fixes some severe cache problems including a bug where the cache could be corrupted upon certain access patterns. We also fixed a bug where the cache was being cleared due to a corrupted journal. We’ve added APIs to configure a request’s
Cache-Controlheaders, and to manually clear the cache.
Request cancellation fixes. This update fixes a bug where synchronous requests couldn’t be canceled by tag. This update avoids crashing when
IOException. That failure will now be logged instead of notifying the thread’s uncaught exception handler. We’ve added a new API,
Call.isCanceled()to check if a call has been canceled.
MultipartBuilderto support content length.
- New: Make it possible to mock
- New: Update to h2-14 and hpack-9.
- New: OkHttp includes a user-agent by default, like
- Fix: Handle response code
308 Permanent Redirect.
- Fix: Don’t skip the callback if a call is canceled.
- Fix: Permit hostnames with underscores.
- Fix: Permit overriding the content-type in
- Fix: Use the socket factory for direct connections.
- Fix: Honor
OkUrlFactoryAPIs that disable redirects.
- Fix: Don’t crash on concurrent modification of
This release commits to a stable 2.0 API. Read the 2.0.0-RC1 changes for advice on upgrading from 1.x to 2.x.
- API Change: Use
Callback.onFailure(). This is a source-incompatible change, and is different from OkHttp 2.0.0-RC2 which used
- Fix: Fixed a caching bug where we weren’t storing rewritten request headers
- Fix: Fixed bugs in handling the SPDY window size. This was stalling certain large downloads
- Update the language level to Java 7. (OkHttp requires Android 2.3+ or Java 7+.)
This update fixes problems in 2.0.0-RC1. Read the 2.0.0-RC1 changes for advice on upgrading from 1.x to 2.x.
- Fix: Don’t leak connections! There was a regression in 2.0.0-RC1 where connections were neither closed nor pooled.
- Fix: Revert builder-style return types from OkHttpClient’s timeout methods for binary compatibility with OkHttp 1.x.
- Fix: Don’t skip client stream 1 on SPDY/3.1. This fixes SPDY connectivity to
https://google.com, which doesn’t follow the SPDY/3.1 spec!
- Fix: Always configure NPN headers. This fixes connectivity to
https://facebook.comwhen SPDY and HTTP/2 are both disabled. Otherwise an unexpected NPN response is received and OkHttp crashes.
- Fix: Write continuation frames when HPACK data is larger than 16383 bytes.
- Fix: Don’t drop uncaught exceptions thrown in async calls.
- Fix: Throw an exception eagerly when a request body is not legal. Previously
we ignored the problem at request-building time, only to crash later with a
- Fix: Include a backwards-compatible
- Fix: Don’t include a default User-Agent header in requests made with the Call API. Requests made with OkUrlFactory will continue to have a default user agent.
New: Guava-like API to create headers:
Headers headers = Headers.of(name1, value1, name2, value2, ...).
New: Make the content-type header optional for request bodies.
Response.isSuccessful()is a convenient API to check response codes.
- New: The response body can now be read outside of the callback. Response bodies must always be closed, otherwise they will leak connections!
- New: APIs to create multipart request bodies (
MultipartBuilder) and form encoding bodies (
OkHttp 2 is designed around a new API that is true to HTTP, with classes for requests, responses, headers, and calls. It uses modern Java patterns like immutability and chained builders. The API now offers asynchronous callbacks in addition to synchronous blocking calls.
New Request and Response types, each with their own builder. There’s also a
RequestBodyclass to write the request body to the network and a
ResponseBodyto read the response body from the network. The standalone
Headersclass offers full access to the HTTP headers.
Okio dependency added. OkHttp now depends on Okio, an I/O library that makes it easier to access, store and process data. Using this library internally makes OkHttp faster while consuming less memory. You can write a
RequestBodyas an Okio
ResponseBodyas an Okio
OutputStreamaccess is also available.
New Call and Callback types execute requests and receive their responses. Both types of calls can be canceled via the
URLConnection support has moved to the okhttp-urlconnection module. If you’re upgrading from 1.x, this change will impact you. You will need to add the
okhttp-urlconnectionmodule to your project and use the
OkUrlFactoryto create new instances of
// OkHttp 1.x: HttpURLConnection connection = client.open(url); // OkHttp 2.x: HttpURLConnection connection = new OkUrlFactory(client).open(url);
Custom caches are no longer supported. In OkHttp 1.x it was possible to define your own response cache with the
OkResponseCacheinterfaces. Both of these APIs have been dropped. In OkHttp 2 the built-in disk cache is the only supported response cache.
HttpResponseCache has been renamed to Cache. Install it with
OkAuthenticator has been replaced with Authenticator. This new authenticator has access to the full incoming response and can respond with whichever followup request is appropriate. The
Challengeclass is now a top-level class and
Credentialis replaced with a utility class called
OkHttpClient.getFollowProtocolRedirects() renamed to getFollowSslRedirects(). We reserve the word protocol for the HTTP version being used (HTTP/1.1, HTTP/2). The old name of this method was misleading; it was always used to configure redirects between
RouteDatabase is no longer public API. OkHttp continues to track which routes have failed but this is no exposed in the API.
ResponseSource is gone. This enum exposed whether a response came from the cache, network, or both. OkHttp 2 offers more detail with raw access to the cache and network responses in the new
TunnelRequest is gone. It specified how to connect to an HTTP proxy. OkHttp 2 uses the new
Requestclass for this.
Dispatcher is a new class that manages the queue of asynchronous calls. It implements limits on total in-flight calls and in-flight calls per host.
- Support Android
- Drop authentication headers on redirect.
- Added support for compressed data frames.
- Process push promise callbacks in order.
- Update to http/2 draft 12.
- Update to HPACK draft 07.
- Add ALPN support. Maven will use ALPN on OpenJDK 8.
- Update NPN dependency to target
- Ensure SPDY variants support zero-length DELETE and POST.
- Prevent leaking a cache item’s InputStreams when metadata read fails.
- Use a string to identify TLS versions in routes.
- Add frame logger for HTTP/2.
Protocol. Expose HTTP/1.0 as a potential protocol.
Protocolto describe framing.
- Implement write timeouts for HTTP/1.1 streams.
- Avoid use of SPDY stream ID 1, as that’s typically used for UPGRADE.
- Support OAuth in
- Permit a dangling semicolon in media type parsing.