Feature/custom http headers on ios (#607)

* Add support for sending additional http headers on iOS

* Update readme with new config parameter

* Correct implementation according to specification in tests

* Add tests for iOS specific additionalHeaders parameter

Also put some of the existing tests into correct group.

* State validation rules in tests for additionalHeaders parameter

* Validate additional headers

* Correct readme

* Format code

* Updated Github config example to include additionalHeaders property

Co-authored-by: Mansoor Siddeeq <mansoor@msiddeeq.com>

Author: carrybit

README.md

@@ -129,6 +129,7 @@ with optional overrides.
   - **authorize** - (`{ [key: string]: value }`) headers to be passed during authorization request.
   - **token** - (`{ [key: string]: value }`) headers to be passed during token retrieval request.
   - **register** - (`{ [key: string]: value }`) headers to be passed during registration request.
+- **additionalHeaders** - (`{ [key: string]: value }`) _IOS_ you can specify additional headers to be passed for all authorize, refresh, and register requests.
 - **useNonce** - (`boolean`) _IOS_ (default: true) optionally allows not sending the nonce parameter, to support non-compliant providers
 - **usePKCE** - (`boolean`) (default: true) optionally allows not sending the code_challenge parameter and skipping PKCE code verification, to support non-compliant providers.
 - **skipCodeExchange** - (`boolean`) (default: false) just return the authorization response, instead of automatically exchanging the authorization code. This is useful if this exchange needs to be done manually (not client-side)

docs/config-examples/github.md

@@ -1,9 +1,5 @@
 # GitHub
 
-** This is Android Only **
-
-Read more about iOS restrictions [here](https://github.com/FormidableLabs/react-native-app-auth/issues/194).
-
 Go to [OAuth Apps](https://github.com/settings/developers) to create your app.
 
 For the Authorization callback URL, choose something like `com.myapp://oauthredirect` and ensure you use `com.myapp` in your `appAuthRedirectScheme` in `android/app/build.gradle`.
@@ -14,6 +10,7 @@ const config = {
   clientId: '<client-id>',
   clientSecret: '<client-secret>',
   scopes: ['identity'],
+  additionalHeaders: { 'Accept': 'application/json' },
   serviceConfiguration: {
     authorizationEndpoint: 'https://github.com/login/oauth/authorize',
     tokenEndpoint: 'https://github.com/login/oauth/access_token',

index.d.ts

@@ -21,6 +21,8 @@ type CustomHeaders = {
   register?: Record<string, string>;
 };
 
+type AdditionalHeaders = Record<string, string>;
+
 interface BuiltInRegistrationParameters {
   client_name?: string;
   logo_uri?: string;
@@ -38,6 +40,7 @@ export type RegistrationConfiguration = BaseConfiguration & {
   additionalParameters?: BuiltInRegistrationParameters & { [name: string]: string };
   dangerouslyAllowInsecureHttpRequests?: boolean;
   customHeaders?: CustomHeaders;
+  additionalHeaders?: AdditionalHeaders;
 };
 
 export interface RegistrationResponse {
@@ -69,6 +72,7 @@ export type AuthConfiguration = BaseAuthConfiguration & {
   clientAuthMethod?: 'basic' | 'post';
   dangerouslyAllowInsecureHttpRequests?: boolean;
   customHeaders?: CustomHeaders;
+  additionalHeaders?: AdditionalHeaders;
   useNonce?: boolean;
   usePKCE?: boolean;
   warmAndPrefetchChrome?: boolean;

index.js

@@ -55,6 +55,20 @@ const validateHeaders = headers => {
   });
 };
 
+const validateAdditionalHeaders = headers => {
+  if (!headers) {
+    return;
+  }
+
+  const errorMessage = 'Config error: additionalHeaders must be { [key: string]: string }';
+
+  invariant(typeof headers === 'object', errorMessage);
+  invariant(
+    Object.values(headers).filter(key => typeof key !== 'string').length === 0,
+    errorMessage
+  );
+};
+
 export const prefetchConfiguration = async ({
   warmAndPrefetchChrome,
   issuer,
@@ -97,9 +111,12 @@ export const register = ({
   serviceConfiguration,
   dangerouslyAllowInsecureHttpRequests = false,
   customHeaders,
+  additionalHeaders,
 }) => {
   validateIssuerOrServiceConfigurationRegistrationEndpoint(issuer, serviceConfiguration);
   validateHeaders(customHeaders);
+  validateAdditionalHeaders(additionalHeaders);
+
   invariant(
     Array.isArray(redirectUrls) && redirectUrls.every(url => typeof url === 'string'),
     'Config error: redirectUrls must be an Array of strings'
@@ -139,6 +156,10 @@ export const register = ({
     nativeMethodArguments.push(customHeaders);
   }
 
+  if (Platform.OS === 'ios') {
+    nativeMethodArguments.push(additionalHeaders);
+  }
+
   return RNAppAuth.register(...nativeMethodArguments);
 };
 
@@ -155,12 +176,14 @@ export const authorize = ({
   clientAuthMethod = 'basic',
   dangerouslyAllowInsecureHttpRequests = false,
   customHeaders,
+  additionalHeaders,
   skipCodeExchange = false,
 }) => {
   validateIssuerOrServiceConfigurationEndpoints(issuer, serviceConfiguration);
   validateClientId(clientId);
   validateRedirectUrl(redirectUrl);
   validateHeaders(customHeaders);
+  validateAdditionalHeaders(additionalHeaders);
   // TODO: validateAdditionalParameters
 
   const nativeMethodArguments = [
@@ -182,6 +205,7 @@ export const authorize = ({
   }
 
   if (Platform.OS === 'ios') {
+    nativeMethodArguments.push(additionalHeaders);
     nativeMethodArguments.push(useNonce);
     nativeMethodArguments.push(usePKCE);
   }
@@ -201,13 +225,15 @@ export const refresh = (
     clientAuthMethod = 'basic',
     dangerouslyAllowInsecureHttpRequests = false,
     customHeaders,
+    additionalHeaders,
   },
   { refreshToken }
 ) => {
   validateIssuerOrServiceConfigurationEndpoints(issuer, serviceConfiguration);
   validateClientId(clientId);
   validateRedirectUrl(redirectUrl);
   validateHeaders(customHeaders);
+  validateAdditionalHeaders(additionalHeaders);
   invariant(refreshToken, 'Please pass in a refresh token');
   // TODO: validateAdditionalParameters
 
@@ -228,6 +254,10 @@ export const refresh = (
     nativeMethodArguments.push(customHeaders);
   }
 
+  if (Platform.OS === 'ios') {
+    nativeMethodArguments.push(additionalHeaders);
+  }
+
   return RNAppAuth.refresh(...nativeMethodArguments);
 };