[iOS] Custom NSURLSession configuration #27701

hakonk · 2020-01-07T19:01:43Z

Summary

While it is possible in the React Native implementation for Android to provide a custom configuration for HTTP requests, the iOS implementation does not allow for the same customization. As the NSURLSession used for HTTP requests on iOS is configured internally, one may for instance not supply an ephemeral configuration for HTTP requests. Other concerns related to the given problem have been addressed in the community: react-native-community/discussions-and-proposals#166. I did make a PR with an RFC in the community repo, but after some discussion in the said repo, I figured I might as well make a PR with a suggestion :)

Changelog

[iOS] [Added] - Allow for configuring the NSURLSessionConfiguration

Implement a C function RCTSetCustomNSURLSessionConfigurationProvider which gives the app programmer the ability to provide a block which provides an NSURLSessionConfiguration that will be used for all HTTP requests instead of the default configuration. The provided block will be called when the session configuration is needed.

Test Plan

Unsure if this can be tested in any other way than uncommenting the example code in RNTester/RNTester/AppDelegate.mm.

…tHandler to allow for configuring the NSURLSession. Add code that is commented out in AppDelegate for testing different configurations

…tter function

facebook-github-bot · 2020-01-07T19:01:54Z

Hi hakonk! Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

facebook-github-bot · 2020-01-07T21:40:10Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

akshetpandey · 2020-01-07T21:57:16Z

+1 On this, this will greatly simplify implementations that need to use their own NSURLSessionConfiguration, ex. RCTCronetHTTPRequestHandler.mm

facebook-github-bot · 2020-01-07T23:33:49Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

zsiegel · 2020-07-16T18:33:57Z

Any movement on this? I am looking for the ability to customize the iOS networking client like you do on Android.

analysis-bot · 2020-07-23T08:32:16Z

Platform	Engine	Arch	Size (bytes)	Diff
android	hermes	arm64-v8a	9,240,042	+50
android	hermes	armeabi-v7a	8,749,734	+50
android	hermes	x86	9,702,640	+38
android	hermes	x86_64	9,667,522	+43
android	jsc	arm64-v8a	10,885,299	+2
android	jsc	armeabi-v7a	9,786,267	+4
android	jsc	x86	10,943,318	+13
android	jsc	x86_64	11,549,717	+12

Base commit: 286fac5

analysis-bot · 2020-07-23T08:37:37Z

Platform	Engine	Arch	Size (bytes)	Diff
ios	-	universal	n/a	--

Base commit: 286fac5

hakonk · 2020-07-24T06:44:10Z

@zsiegel I haven't heard from the review team. I assume they've had their hands full. Not sure if I should tag someone in the discussion, and in that case, who.

safaiyeh · 2020-07-24T17:03:07Z

Hi @hakonk thanks for the PR, I'll see if I can ping someone for this.

hakonk · 2020-07-24T20:01:57Z

Thanks, @safaiyeh 😊

hakonk · 2020-08-10T15:03:49Z

Hey @safaiyeh, did you have any luck finding anyone?

safaiyeh · 2020-08-10T16:45:21Z

Hi @TheSavior, could someone check this out?

namchuai · 2020-12-02T02:53:08Z

Nearly a year already..

hakonk · 2021-01-13T19:54:05Z

Happy new year!

I guess there are more important PRs in the pipe still. Any news @safaiyeh ?

pke · 2021-05-19T14:54:19Z

Interesting that this important (for SSL Pinning that can't use sizzling) PR is still not merged.

elicwhite · 2021-05-25T16:13:25Z

packages/rn-tester/RNTester/AppDelegate.mm

@@ -82,6 +82,12 @@ @implementation AppDelegate
 - (BOOL)application:(__unused UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
  RCTEnableTurboModule(YES);
+  // uncomment to configure NSURLSession


We probably don’t need to add commented code here as this is an uncommon use case. Perhaps this explanation of usage should just live in the documentation.

Alright, I can add a section about that. Would it be appropriate to add a section here for instance?

I have created a PR that contains the needed documentation now: facebook/react-native-website#2629

Also, the commented code has been removed in: 1634c87

@TheSavior Please see messages above 🙂

facebook-github-bot · 2021-05-25T16:21:41Z

@sshic has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Moved example code to PR in RN documentation website

facebook-github-bot · 2021-06-03T00:24:58Z

@JoshuaGross has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

facebook-github-bot · 2021-06-03T01:40:09Z

@JoshuaGross merged this pull request in 58444c7.

Summary: While it is possible in the React Native implementation for Android to provide a custom configuration for HTTP requests, the iOS implementation does not allow for the same customization. As the NSURLSession used for HTTP requests on iOS is configured internally, one may for instance not supply an ephemeral configuration for HTTP requests. Other concerns related to the given problem have been addressed in the community: react-native-community/discussions-and-proposals#166. I did make a PR with an RFC in the community repo, but after some discussion in the said repo, I figured I might as well make a PR with a suggestion :) ## Changelog [iOS] [Added] - Allow for configuring the NSURLSessionConfiguration Implement a C function `RCTSetCustomNSURLSessionConfigurationProvider` which gives the app programmer the ability to provide a block which provides an NSURLSessionConfiguration that will be used for all HTTP requests instead of the default configuration. The provided block will be called when the session configuration is needed. Pull Request resolved: facebook#27701 Test Plan: Unsure if this can be tested in any other way than uncommenting the example code in `RNTester/RNTester/AppDelegate.mm`. Reviewed By: yungsters Differential Revision: D28680384 Pulled By: JoshuaGross fbshipit-source-id: ae24399955581a1cc9f4202f0f6f497bfe067a5c

Summary: While it is possible in the React Native implementation for Android to provide a custom configuration for HTTP requests, the iOS implementation does not allow for the same customization. As the NSURLSession used for HTTP requests on iOS is configured internally, one may for instance not supply an ephemeral configuration for HTTP requests. Other concerns related to the given problem have been addressed in the community: react-native-community/discussions-and-proposals#166. I did make a PR with an RFC in the community repo, but after some discussion in the said repo, I figured I might as well make a PR with a suggestion :) ## Changelog [iOS] [Added] - Allow for configuring the NSURLSessionConfiguration Implement a C function `RCTSetCustomNSURLSessionConfigurationProvider` which gives the app programmer the ability to provide a block which provides an NSURLSessionConfiguration that will be used for all HTTP requests instead of the default configuration. The provided block will be called when the session configuration is needed. Pull Request resolved: #27701 Test Plan: Unsure if this can be tested in any other way than uncommenting the example code in `RNTester/RNTester/AppDelegate.mm`. Reviewed By: yungsters Differential Revision: D28680384 Pulled By: JoshuaGross fbshipit-source-id: ae24399955581a1cc9f4202f0f6f497bfe067a5c

Summary: While it is possible in the React Native implementation for Android to provide a custom configuration for HTTP requests, the iOS implementation does not allow for the same customization. As the NSURLSession used for HTTP requests on iOS is configured internally, one may for instance not supply an ephemeral configuration for HTTP requests. Other concerns related to the given problem have been addressed in the community: react-native-community/discussions-and-proposals#166. I did make a PR with an RFC in the community repo, but after some discussion in the said repo, I figured I might as well make a PR with a suggestion :) ## Changelog [iOS] [Added] - Allow for configuring the NSURLSessionConfiguration Implement a C function `RCTSetCustomNSURLSessionConfigurationProvider` which gives the app programmer the ability to provide a block which provides an NSURLSessionConfiguration that will be used for all HTTP requests instead of the default configuration. The provided block will be called when the session configuration is needed. Pull Request resolved: facebook#27701 Test Plan: Unsure if this can be tested in any other way than uncommenting the example code in `RNTester/RNTester/AppDelegate.mm`. Reviewed By: yungsters Differential Revision: D28680384 Pulled By: JoshuaGross fbshipit-source-id: ae24399955581a1cc9f4202f0f6f497bfe067a5c

taylorkline · 2021-08-10T17:10:57Z

@pke you mentioned this is useful for SSL pinning.

Can you elaborate on how? From what I can tell, Apple's docs on performing manual server trust authentication state that we should provide an NSURLSessionDelegate that evaluates sever trust within urlSession(_:didReceive:completionHandler:) (or URLSession:didReceiveChallenge:completionHandler: in obj-c).

This PR does not allow us to set our own NSURLSessionDelegate, so how would this be useful in evaluating server trust?

@hakonk definitely open to your input as well. Thank you for this PR.

hakonk · 2021-08-10T19:53:37Z

@taylorkline I believe you are right in that you would have to implement NSURLSessionDelegate as a part of implementing certificate or public key pinning, and this PR does not address that particular problem. In RCTHTTPRequestHandler.mm:99, you can see that self is assigned as the delegate for the NSURLSession instance. Thus, there is currently no way of supplying the delegate implementation from outside of React Native.

You can make use of swizzling when you do not have the means to implement NSURLSessionDelegate yourself. While I guess this would work most of the time, this mandates potential use of swizzling in other dependencies or your own code. Not really a problem in itself, it just isn't so transparent given that funky stuff happens at runtime. https://github.com/datatheorem/TrustKit does actually allow for implementing public key pinning with swizzling. That could possibly be useful if you want to achieve certificate or public key pinning in a React Native app.

taylorkline · 2021-08-10T19:58:32Z

@hakonk Thank you for confirming and thank you for your time.

pke · 2021-08-10T20:42:26Z

@taylorkline iirc one can only sizzle functions once. So if one react native module sizzles the NSURLSession (for certificate pinning) then no other module could sizzle the session. The ability to provide the pinning configuration for the sessions directly removes the need to use sizzling for it. So thanks for merging this!

taylorkline · 2021-08-17T19:45:39Z

Is this in v0.65.0? The commit does not appear to be tagged with v0.65.0.

elicwhite · 2021-08-18T05:31:23Z

0.65 was cut on April 28th, before this PR was merged. This PR will be included in 0.66

hakonk · 2021-08-18T06:51:22Z

@TheSavior I'm a bit confused. The changelog for 0.65.0 lists this PR.

elicwhite · 2021-08-18T07:39:06Z

Ah, I was looking at the tags on the commit as @taylorkline mentioned. It looks like this commit was cherry picked and thus doesn't have the same hash in the release branch. This commit is in 0.65.0 here: c299694

Sorry for the confusion! 😅

hakonk · 2021-08-18T07:40:50Z

Alright, thanks for answering so quickly! 😄

hakonk added 3 commits January 6, 2020 18:32

[feat] Implement NSURLSession configuration provider in RCTHTTPReques…

21bf443

…tHandler to allow for configuring the NSURLSession. Add code that is commented out in AppDelegate for testing different configurations

[fix] place comment in correct place

4091c30

[fix] typo in comment, header doc for NSURL configuration provider se…

98bc9d0

…tter function

react-native-bot added Platform: iOS iOS applications. Type: Enhancement A new feature or enhancement of an existing feature. labels Jan 7, 2020

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 7, 2020

Merge branch 'master' into feat/custom-nsurl-session-configuration

1dccd21

Merge branch 'master' into feat/custom-nsurl-session-configuration

17379bf

oailloud mentioned this pull request Sep 15, 2020

Invalid cast in GTMSessionFetcherService google/gtm-session-fetcher#190

Open

hakonk added 4 commits December 12, 2020 12:46

sync with master branch

da7c252

Merge branch 'master' into feat/custom-nsurl-session-configuration

716794f

Merge branch 'master' into feat/custom-nsurl-session-configuration

b7c371a

Merge branch 'master' into feat/custom-nsurl-session-configuration

cfbaa35

hakonk added 2 commits May 19, 2021 22:29

Merge branch 'master' into feat/custom-nsurl-session-configuration

e7cc0cf

Merge branch 'master' into feat/custom-nsurl-session-configuration

4b21637

Merge branch 'master' into feat/custom-nsurl-session-configuration

3a46388

elicwhite added the Needs: React Native Team Attention label May 25, 2021

elicwhite reviewed May 25, 2021

View reviewed changes

hakonk mentioned this pull request May 27, 2021

Documentation about proposed RCTSetCustomNSURLSessionConfigurationProvider facebook/react-native-website#2629

Merged

hakonk added 5 commits May 27, 2021 17:02

Remove commented out code from packages/rntester/AppDelegate.mm

1634c87

Moved example code to PR in RN documentation website

Merge branch 'master' into feat/custom-nsurl-session-configuration

b35507b

Merge branch 'master' into feat/custom-nsurl-session-configuration

49cc656

Merge branch 'master' into feat/custom-nsurl-session-configuration

ae69c6b

Merge branch 'master' into feat/custom-nsurl-session-configuration

6d19223

facebook-github-bot closed this in 58444c7 Jun 3, 2021

facebook-github-bot added the Merged This PR has been merged. label Jun 3, 2021

Simek mentioned this pull request Aug 18, 2021

backport NSURLSession docs to 0.65 facebook/react-native-website#2730

Merged

Oref mentioned this pull request Feb 28, 2022

NSURLSession with custom delegate (didReceiveChallenge) or custom NSURLSession #33195

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[iOS] Custom NSURLSession configuration #27701

[iOS] Custom NSURLSession configuration #27701

hakonk commented Jan 7, 2020

facebook-github-bot commented Jan 7, 2020

facebook-github-bot commented Jan 7, 2020

akshetpandey commented Jan 7, 2020

facebook-github-bot commented Jan 7, 2020

zsiegel commented Jul 16, 2020

analysis-bot commented Jul 23, 2020 •

edited

Loading

analysis-bot commented Jul 23, 2020 •

edited

Loading

hakonk commented Jul 24, 2020

safaiyeh commented Jul 24, 2020

hakonk commented Jul 24, 2020

hakonk commented Aug 10, 2020 •

edited

Loading

safaiyeh commented Aug 10, 2020

namchuai commented Dec 2, 2020

hakonk commented Jan 13, 2021

pke commented May 19, 2021

elicwhite May 25, 2021

hakonk May 26, 2021

elicwhite May 26, 2021

hakonk May 27, 2021

hakonk May 27, 2021

hakonk Jun 1, 2021

facebook-github-bot commented May 25, 2021

facebook-github-bot commented Jun 3, 2021

facebook-github-bot commented Jun 3, 2021

taylorkline commented Aug 10, 2021 •

edited

Loading

hakonk commented Aug 10, 2021

taylorkline commented Aug 10, 2021

pke commented Aug 10, 2021

taylorkline commented Aug 17, 2021

elicwhite commented Aug 18, 2021

hakonk commented Aug 18, 2021

elicwhite commented Aug 18, 2021

hakonk commented Aug 18, 2021

[iOS] Custom NSURLSession configuration #27701

[iOS] Custom NSURLSession configuration #27701

Conversation

hakonk commented Jan 7, 2020

Summary

Changelog

Test Plan

facebook-github-bot commented Jan 7, 2020

facebook-github-bot commented Jan 7, 2020

akshetpandey commented Jan 7, 2020

facebook-github-bot commented Jan 7, 2020

zsiegel commented Jul 16, 2020

analysis-bot commented Jul 23, 2020 • edited Loading

analysis-bot commented Jul 23, 2020 • edited Loading

hakonk commented Jul 24, 2020

safaiyeh commented Jul 24, 2020

hakonk commented Jul 24, 2020

hakonk commented Aug 10, 2020 • edited Loading

safaiyeh commented Aug 10, 2020

namchuai commented Dec 2, 2020

hakonk commented Jan 13, 2021

pke commented May 19, 2021

elicwhite May 25, 2021

Choose a reason for hiding this comment

hakonk May 26, 2021

Choose a reason for hiding this comment

elicwhite May 26, 2021

Choose a reason for hiding this comment

hakonk May 27, 2021

Choose a reason for hiding this comment

hakonk May 27, 2021

Choose a reason for hiding this comment

hakonk Jun 1, 2021

Choose a reason for hiding this comment

facebook-github-bot commented May 25, 2021

facebook-github-bot commented Jun 3, 2021

facebook-github-bot commented Jun 3, 2021

taylorkline commented Aug 10, 2021 • edited Loading

hakonk commented Aug 10, 2021

taylorkline commented Aug 10, 2021

pke commented Aug 10, 2021

taylorkline commented Aug 17, 2021

elicwhite commented Aug 18, 2021

hakonk commented Aug 18, 2021

elicwhite commented Aug 18, 2021

hakonk commented Aug 18, 2021

analysis-bot commented Jul 23, 2020 •

edited

Loading

analysis-bot commented Jul 23, 2020 •

edited

Loading

hakonk commented Aug 10, 2020 •

edited

Loading

taylorkline commented Aug 10, 2021 •

edited

Loading