Skip to content

Commit 9ae7827

Browse files
committed
updated for v0.3.0
1 parent 98c01bb commit 9ae7827

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.markdown

+24-5
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ repositories {
3333
}
3434
3535
dependencies {
36-
compile 'com.commonsware.cwac:netsecurity:0.2.1'
37-
compile 'com.squareup.okhttp3:okhttp:3.4.1'
36+
compile 'com.commonsware.cwac:netsecurity:0.3.0'
37+
compile 'com.squareup.okhttp3:okhttp:3.5.0'
3838
}
3939
```
4040

@@ -111,13 +111,30 @@ If you have them in the XML, they will be ignored.
111111
OkHttp3 should support the full range of network security configuration
112112
XML features.
113113

114+
The `<certificates src="user" />` cannot really be supported prior to Android 7.0,
115+
insofar as the system will check user certificates any time it checks for
116+
system certificates. If you include such an element in a configuration:
117+
118+
- If you are using `withManifestConfig()`, a warning will be logged to LogCat,
119+
and the element will be treated as if it were `<certificates src="system" />`
120+
121+
- If you are using anything else (e.g., `withConfig()`), your app will crash
122+
at startup, with an error indicating that `<certificates src="user" />` is not
123+
supported
124+
114125
## Advanced Usage
115126

116127
If you want to do more sophisticated things with the network security
117128
configuration backport and/or `TrustManagerBuilder`, there is a
118129
[separate page of documentation](https://github.com/commonsguy/cwac-netsecurity/blob/master/docs/ADVANCED_USAGE.markdown)
119130
for that.
120131

132+
## Notes for Upgraders
133+
134+
If you are upgrading to v0.3.0 or higher from v0.2.1 or older, and you
135+
are using `<certificates src="user" />`, note that this is no longer supported
136+
(see above).
137+
121138
## Compiling from Source and Running the Test Suites
122139

123140
The instrumentation tests in `androidTest/` are divided into two
@@ -155,8 +172,9 @@ module with the CRT file that matches your self-signed certificate that
155172
## Dependencies
156173

157174
`netsecurity` has a `provided` dependency on OkHttp3. This library
158-
should fairly closely track the latest OkHttp3 release, presently
159-
**3.4.1**. If you find
175+
should fairly closely track the latest OkHttp3 release. Version 0.3.0
176+
of this library uses OkHttp version
177+
**3.5.0**. If you find
160178
that the library has fallen behind, please
161179
[file an issue](https://github.com/commonsguy/cwac-netsecurity/issues)
162180
if one has not already been filed.
@@ -167,7 +185,7 @@ Otherwise, there are no external dependencies.
167185

168186
## Version
169187

170-
The current version is **0.2.1**.
188+
The current version is **0.3.0**.
171189

172190
## Demo
173191

@@ -213,6 +231,7 @@ Do not ask for help via social media.
213231

214232
|Library Version|AOSP Code Base |Release Notes|
215233
|:-------------:|:------------------------------------------------------------------------------------------------------:|-------------|
234+
|v0.3.0 |Android 7.1 source code from the SDK, plus [the `android-7.1.0_r7` tagged edition of `conscrypt`](https://android.googlesource.com/platform/external/conscrypt/+/android-7.1.0_r7)|`user` validation per [issue #5](https://github.com/commonsguy/cwac-netsecurity/issues/5)|
216235
|v0.2.1 |Android 7.1 source code from the SDK, plus [the `android-7.1.0_r7` tagged edition of `conscrypt`](https://android.googlesource.com/platform/external/conscrypt/+/android-7.1.0_r7)|bug fix per [issue #3](https://github.com/commonsguy/cwac-netsecurity/issues/3)|
217236
|v0.2.0 |Android 7.0 source code from the SDK, plus [the `android-7.0.0_r1` tagged edition of `conscrypt`](https://android.googlesource.com/platform/external/conscrypt/+/android-7.0.0_r1)|`HttpURLConnection` no longer requires `setHost()` call|
218237
|v0.1.0 |Android 7.0 source code from the SDK, plus [the `android-7.0.0_r1` tagged edition of `conscrypt`](https://android.googlesource.com/platform/external/conscrypt/+/android-7.0.0_r1)|update for new version of Android|

0 commit comments

Comments
 (0)