Added support for [customPostAuthPage] (#561)

google · Apr 2, 2024 · 1631558 · 1631558
1 parent 285ab46
commit 1631558
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/googleapis_auth/CHANGELOG.md b/googleapis_auth/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 1.6.0
+- Added support for custom post-auth html page
+
 ## 1.5.1
 
 - `auth_browser.dart`: handle pop-up closed errors correctly. 

diff --git a/googleapis_auth/lib/auth_io.dart b/googleapis_auth/lib/auth_io.dart
@@ -116,13 +116,19 @@ Future<AutoRefreshingAuthClient> clientViaApplicationDefaultCredentials({
 /// {@macro googleapis_auth_close_the_client}
 /// {@macro googleapis_auth_not_close_the_baseClient}
 /// {@macro googleapis_auth_listen_port}
+///
+/// {@template googleapis_auth_custom_post_auth_page}
+/// If provided, default post authentication page is replaced with html code
+/// specified in [customPostAuthPage] variable.
+/// {@endtemplate}
 Future<AutoRefreshingAuthClient> clientViaUserConsent(
   ClientId clientId,
   List<String> scopes,
   PromptUserForConsent userPrompt, {
   Client? baseClient,
   String? hostedDomain,
   int listenPort = 0,
+  String? customPostAuthPage,
   AuthEndpoints authEndpoints = const GoogleAuthEndpoints(),
 }) async {
   var closeUnderlyingClient = false;
@@ -139,6 +145,7 @@ Future<AutoRefreshingAuthClient> clientViaUserConsent(
     userPrompt,
     hostedDomain: hostedDomain,
     listenPort: listenPort,
+    customPostAuthPage: customPostAuthPage,
   );
 
   AccessCredentials credentials;
@@ -237,6 +244,8 @@ Future<AutoRefreshingAuthClient> clientViaUserConsentManual(
 ///
 /// Generally you want to specify an explicit port so you can configure it
 /// on the Google Cloud console.
+///
+/// {@macro googleapis_auth_custom_post_auth_page}
 /// {@endtemplate}
 Future<AccessCredentials> obtainAccessCredentialsViaUserConsent(
   ClientId clientId,
@@ -245,6 +254,7 @@ Future<AccessCredentials> obtainAccessCredentialsViaUserConsent(
   PromptUserForConsent userPrompt, {
   String? hostedDomain,
   int listenPort = 0,
+  String? customPostAuthPage,
   AuthEndpoints authEndpoints = const GoogleAuthEndpoints(),
 }) =>
     AuthorizationCodeGrantServerFlow(
@@ -255,6 +265,7 @@ Future<AccessCredentials> obtainAccessCredentialsViaUserConsent(
       userPrompt,
       hostedDomain: hostedDomain,
       listenPort: listenPort,
+      customPostAuthPage: customPostAuthPage,
     ).run();
 
 /// Obtain oauth2 [AccessCredentials] using the oauth2 authentication code flow.

diff --git a/googleapis_auth/lib/src/oauth2_flows/authorization_code_grant_server_flow.dart b/googleapis_auth/lib/src/oauth2_flows/authorization_code_grant_server_flow.dart
@@ -25,6 +25,7 @@ class AuthorizationCodeGrantServerFlow
     extends AuthorizationCodeGrantAbstractFlow {
   final PromptUserForConsent userPrompt;
   final int listenPort;
+  final String? customPostAuthPage;
 
   AuthorizationCodeGrantServerFlow(
     super.authEndpoints,
@@ -34,6 +35,7 @@ class AuthorizationCodeGrantServerFlow
     this.userPrompt, {
     super.hostedDomain,
     this.listenPort = 0,
+    this.customPostAuthPage,
   });
 
   @override
@@ -94,12 +96,12 @@ class AuthorizationCodeGrantServerFlow
           codeVerifier: codeVerifier,
         );
 
-        // TODO: We could introduce a user-defined redirect page.
         request.response
           ..statusCode = 200
           ..headers.set('content-type', 'text/html; charset=UTF-8')
           ..write(
-            '''
+            customPostAuthPage ??
+                '''
 <!DOCTYPE html>
 
 <html>

diff --git a/googleapis_auth/pubspec.yaml b/googleapis_auth/pubspec.yaml
@@ -1,5 +1,5 @@
 name: googleapis_auth
-version: 1.5.1
+version: 1.6.0
 description: Obtain Access credentials for Google services using OAuth 2.0
 repository: https://github.com/google/googleapis.dart/tree/master/googleapis_auth