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

Add example for custom OAuth profile configuration for Google #568

Merged
merged 4 commits into from
Sep 2, 2024
Merged

Add example for custom OAuth profile configuration for Google #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f48eec6
Add example
Cassie205 Aug 23, 2024
86304cf
Change image to code
Cassie205 Sep 2, 2024
e2c82be
Delete unused.
dkocher Sep 2, 2024
9054008
Add enumeration.
dkocher Sep 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
Binary file removed tutorials/_images/Edit_Custom_Client_ID_Profile.png
View file
Open in desktop
Binary file not shown.
90 changes: 65 additions & 25 deletions tutorials/custom_oauth_client_id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,32 +93,72 @@ Workaround to register your own Custom OAuth 2.0 Client ID for [Google Cloud Sto

## Add Custom Connection Profile

Download the [template](../protocols/profiles/google_client_id.md#sample-google-drive-with-custom-oauth-client-id-connection-profile) for Google Drive or Google Cloud Storage:
- {download}`Google Drive Custom OAuth Client ID.cyberduckprofile<../protocols/profiles/_static/Google Drive Custom OAuth Client ID.cyberduckprofile>`
- {download}`Google Storage Custom OAuth Client ID.cyberduckprofile<../protocols/profiles/_static/Google Storage Custom OAuth Client ID.cyberduckprofile>`


Use the _OAuth Client ID_ created to edit the `OAuth Client ID` and `OAuth Redirect Url` in the template connection profile leaving other keys unchanged.

```xml
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
…
<key>OAuth Client ID</key>
<string>NUMBER-ID.apps.googleusercontent.com</string>
<key>OAuth Redirect Url</key>
<string>com.googleusercontent.apps.NUMBER-ID:oauth</string>
…
</dict>
</plist>
```

- `OAuth Client ID`. Override the registered application OAuth Client ID.
- `OAuth Redirect Url`. Use the reverse notation of the OAuth Client ID and append `:oauth` to it.

1. Download the [template](../protocols/profiles/google_client_id.md#sample-google-drive-with-custom-oauth-client-id-connection-profile) for Google Drive or Google Cloud Storage:
- {download}`Google Drive Custom OAuth Client ID.cyberduckprofile<../protocols/profiles/_static/Google Drive Custom OAuth Client ID.cyberduckprofile>`
- {download}`Google Storage Custom OAuth Client ID.cyberduckprofile<../protocols/profiles/_static/Google Storage Custom OAuth Client ID.cyberduckprofile>`

1. Use the _OAuth Client ID_ created to edit the `OAuth Client ID`, `OAuth Redirect Url`, and optionally the `OAuth Client Secret` in the template connection profile, leaving other keys unchanged.

:::::{tabs}
::::{tab} Configuration

```xml
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
…
<key>OAuth Redirect Url</key>
<string>com.googleusercontent.apps.NUMBER-ID:oauth</string>
<key>OAuth Client ID</key>
<string>NUMBER-ID.apps.googleusercontent.com</string>
<key>OAuth Client Secret</key>
<string>Client secret</string>
</dict>
</plist>
```

- `OAuth Redirect Url`. Use the reverse notation of the OAuth Client ID and append `:oauth` to it.
- `OAuth Client ID`. Override the registered application OAuth Client ID.

::::
::::{tab} Example

Based on the credentials shown in step 11 the correct configuration would look like this:

```xml
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Protocol</key>
<string>googledrive</string>
<key>Vendor</key>
<string>googledrive_custom</string>
<key>Description</key>
<string>Google Drive Custom OAuth Client ID</string>
<key>Default Hostname</key>
<string>www.googleapis.com</string>
<key>OAuth Authorization Url</key>
<string>https://accounts.google.com/o/oauth2/auth</string>
<key>OAuth Token Url</key>
<string>https://accounts.google.com/o/oauth2/token</string>
<key>Scopes</key>
<array>
<string>https://www.googleapis.com/auth/drive</string>
</array>
<key>OAuth Redirect Url</key>
<string>com.googleusercontent.apps.293168482058-dvjk8lh6u6n43kio156uerkqcgjl2i5k:oauth</string>
<key>OAuth Client ID</key>
<string>293168482058-dvjk8lh6u6n43kio156uerkqcgjl2i5k.apps.googleusercontent.com</string>
<key>OAuth Client Secret</key>
<string>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</string>
</dict>
</plist>
```

:::
::::

Double-click the connection profile to open and register or copy to the _Profiles_ folder in the [application support folder](../cyberduck/support.md#application-support-folder).
1. Double-click the connection profile to open and register or copy to the _Profiles_ folder in the [application support folder](../cyberduck/support.md#application-support-folder).

## Update Protocol Selection in Bookmark

Expand Down
Loading