Add configuration option to disable automatically trusting all certificates #1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,22 +14,69 @@ Future<String?> _getProxyPort() async { | |
| } | ||
|
|
||
| class HttpProxyOverride extends HttpOverrides { | ||
| /// The host part of the proxy address. | ||
| final String? host; | ||
|
|
||
| /// The port part of the proxy address. | ||
| final String? port; | ||
|
|
||
| /// Configures whether a secure connection to a host should be allowed with | ||
| /// a server certificate that cannot be authenticated by any of the trusted | ||
| /// root certificates. | ||
| final bool ignoreBadCertificates; | ||
|
|
||
| final SecurityContext securityContext; | ||
|
|
||
| HttpProxyOverride._( | ||
| this.host, this.port, this.ignoreBadCertificates, this.securityContext); | ||
|
|
||
| /// Create an instance of [HttpProxyOverride]. | ||
| /// | ||
| /// Reads the configured proxy host and port from the underlying platform | ||
| /// and configures the [HttpClient] to use the proxy. The proxy settings are | ||
| /// read once at creation time. | ||
| /// | ||
| /// [ignoreBadCertificates] configures whether a secure connection to a host | ||
| /// should be allowed with a server certificate that cannot be authenticated | ||
| /// by any of our trusted root certificates. | ||
| /// For example, this can be useful when using debugging proxies like Charles | ||
| /// or mitmproxy during development. | ||
| /// **Do not enable this in production unless you are 100% sure.** Setting | ||
| /// this enables MITM attacks. | ||
| /// Default: `false`. | ||
| /// | ||
| /// With [securityContext] a [SecurityContext] can be provided that is used to | ||
| /// construct the [HttpClient]. This can be useful to provide a | ||
| /// [SecurityContext] that is configured with certificates that a proxy | ||
| /// server requires. | ||
| /// | ||
| /// Supported platforms to read proxy settings from are **iOS** and | ||
| /// **Android**. | ||
| static Future<HttpProxyOverride> create( | ||
|
Owner
There was a problem hiding this comment. I think since this library aims to use for debugging purposes
e.g. static Future<HttpProxyOverride?> create(
{bool ignoreBadCertificates = true,
SecurityContext? securityContext}) async {
if (!ignoreBadCertificates) return null;
return HttpProxyOverride._(
await _getProxyHost(),
await _getProxyPort(),
ignoreBadCertificates,
securityContext ?? SecurityContext.defaultContext);
} |
||
| {bool ignoreBadCertificates = false, | ||
| SecurityContext? securityContext}) async { | ||
| return HttpProxyOverride._( | ||
| await _getProxyHost(), | ||
| await _getProxyPort(), | ||
| ignoreBadCertificates, | ||
| securityContext ?? SecurityContext.defaultContext); | ||
| } | ||
|
|
||
| @override | ||
| HttpClient createHttpClient(SecurityContext? context) { | ||
| if (context == null) { | ||
|
Owner
There was a problem hiding this comment. The final context = SecurityContext.defaultContext;
context.setTrustedCertificatesBytes(...);
HttpClient httpClient = HttpClient(context: context);
HttpProxyOverride httpProxyOverride = await HttpProxyOverride.create();but not HttpClient httpClient = HttpClient();
final context = SecurityContext.defaultContext;
context.setTrustedCertificatesBytes(...);
HttpProxyOverride httpProxyOverride = await HttpProxyOverride.create(securityContext: context); |
||
| context = this.securityContext; | ||
| } | ||
|
|
||
| var client = super.createHttpClient(context); | ||
|
|
||
| if (ignoreBadCertificates) { | ||
| client.badCertificateCallback = | ||
| (X509Certificate cert, String host, int port) { | ||
| return true; | ||
| }; | ||
| } | ||
|
|
||
| return client; | ||
| } | ||
|
|
||
|
|
@@ -47,8 +94,8 @@ class HttpProxyOverride extends HttpOverrides { | |
| environment['http_proxy'] = '$host:$port'; | ||
| environment['https_proxy'] = '$host:$port'; | ||
| } else { | ||
|
Owner
There was a problem hiding this comment. Good catch, but I'm not sure if it can be set to |
||
| environment['http_proxy'] = '$host'; | ||
| environment['https_proxy'] = '$host'; | ||
| } | ||
|
|
||
| return super.findProxyFromEnvironment(url, environment); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you should mark this function as
@deprecatedinstead remove it directly, to avoid break change at this time