Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for [customPostAuthPage] #561

Merged
merged 7 commits into from
Apr 2, 2024
Merged

Added support for [customPostAuthPage] #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
776797c
Added support for [customPostAuthPage]
Aug 26, 2023
02f3a42
Removed "TODO: We could introduce a user-defined redirect page."
Aug 26, 2023
dad7c41
Added template googleapis_auth_custom_post_auth_page
krll-kov Aug 29, 2023
f268987
Merge branch 'master' into master
krll-kov Mar 28, 2024
10ba2c8
Merge branch 'google:master' into master
krll-kov Apr 2, 2024
3104ec4
Update pubspec.yaml
krll-kov Apr 2, 2024
e88343c
Update CHANGELOG.md
krll-kov Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions googleapis_auth/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
11 changes: 11 additions & 0 deletions googleapis_auth/lib/auth_io.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -139,6 +145,7 @@ Future<AutoRefreshingAuthClient> clientViaUserConsent(
userPrompt,
hostedDomain: hostedDomain,
listenPort: listenPort,
customPostAuthPage: customPostAuthPage,
);

AccessCredentials credentials;
Expand Down Expand Up @@ -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,
Expand All @@ -245,6 +254,7 @@ Future<AccessCredentials> obtainAccessCredentialsViaUserConsent(
PromptUserForConsent userPrompt, {
String? hostedDomain,
int listenPort = 0,
String? customPostAuthPage,
AuthEndpoints authEndpoints = const GoogleAuthEndpoints(),
}) =>
AuthorizationCodeGrantServerFlow(
Expand All @@ -255,6 +265,7 @@ Future<AccessCredentials> obtainAccessCredentialsViaUserConsent(
userPrompt,
hostedDomain: hostedDomain,
listenPort: listenPort,
customPostAuthPage: customPostAuthPage,
).run();

/// Obtain oauth2 [AccessCredentials] using the oauth2 authentication code flow.
Expand Down
6 changes: 4 additions & 2 deletions googleapis_auth/lib/src/oauth2_flows/authorization_code_grant_server_flow.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ class AuthorizationCodeGrantServerFlow
extends AuthorizationCodeGrantAbstractFlow {
final PromptUserForConsent userPrompt;
final int listenPort;
final String? customPostAuthPage;

AuthorizationCodeGrantServerFlow(
super.authEndpoints,
Expand All @@ -34,6 +35,7 @@ class AuthorizationCodeGrantServerFlow
this.userPrompt, {
super.hostedDomain,
this.listenPort = 0,
this.customPostAuthPage,
});

@override
Expand Down Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion googleapis_auth/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading