From 54ddab896796eea6b29792460745273ed2dc1b5d Mon Sep 17 00:00:00 2001 From: Cassie205 Date: Tue, 30 Jan 2024 00:26:09 +0100 Subject: [PATCH 1/3] Note for OAuth without client secret --- protocols/profiles/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/protocols/profiles/index.md b/protocols/profiles/index.md index ce19762e..051311f0 100644 --- a/protocols/profiles/index.md +++ b/protocols/profiles/index.md @@ -66,17 +66,17 @@ All additional schemes are registered as a scheme handler when opening [Mountain - `Disk` Base64 encoded disk TIFF image icon. Multi Page TIFF with formats `64x64` (72dpi) and `128x128` (144dpi) pixels. Use the {download}`disk template file` to create a provider profile image. - `Icon` Base64 encoded disk TIFF image icon to be used in protocol dropdown menu instead of `Disk` icon - `Context` Currently used for -* Login context path for [OpenStack Swift](../openstack/index.md) profiles. -* Prefix all requests with path for [S3](../s3/index.md) profiles. + * Login context path for [OpenStack Swift](../openstack/index.md) profiles. + * Prefix all requests with path for [S3](../s3/index.md) profiles. - `Anonymous Configurable` Boolean if anonymous access is configurable. - `Path Configurable` Boolean if default path is configurable. - `Certificate Configurable` Boolean if client certificate is configurable. - `Region` Region name to limit listing containers of a specific region only for [OpenStack Swift](../openstack/index.md) and [S3](../s3/index.md) profiles. For S3, this value is used for AWS4 signatures when no location can be deferred from the URI for third-party S3 providers. - `Regions` List of regions supported by the provider. This will populate options in the *Regions* dropdown when creating a new [top level folder](../s3/index.md#creating-a-bucket) for [S3](../s3/index.md) and [OpenStack Swift](../openstack/swiftstack.md) connections. - `OAuth Client ID` For protocols using OAuth 2.0 you can override the registered application client ID with the provider. -- `OAuth Client Secret` For protocols using OAuth 2.0 you can override the registered application client secret with the provider. +- `OAuth Client Secret` For protocols using OAuth 2.0 you can override the registered application client secret with the provider. Refer to [Custom OAuth 2.0 Client ID for Google Cloud Storage and Google Drive](google_client_id.md). ```{note} -Refer to [Custom OAuth 2.0 Client ID for Google Cloud Storage and Google Drive](google_client_id.md). +A profile can define an empty OAuth Client Secret key. The OAuth authorization flow will then use no client secret in client parameters to authenticate with the server. ``` - `Authorization` Set to `AWS2` to default to AWS2 signature authentication for S3. Default is `AWS4HMACSHA256`. - `Properties` List of custom protocol-specific properties. You can set [hidden configuration options](../../cyberduck/preferences.md#hidden-configuration-options) for a specific connection profile. Example usages can be found in: From 47591c005c3ce7b4fa4ddce888f3789e84624568 Mon Sep 17 00:00:00 2001 From: Cassie205 Date: Tue, 30 Jan 2024 16:52:48 +0100 Subject: [PATCH 2/3] Additional info for omitted OAuth information --- protocols/profiles/index.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/protocols/profiles/index.md b/protocols/profiles/index.md index 051311f0..d2ef9089 100644 --- a/protocols/profiles/index.md +++ b/protocols/profiles/index.md @@ -75,9 +75,8 @@ All additional schemes are registered as a scheme handler when opening [Mountain - `Regions` List of regions supported by the provider. This will populate options in the *Regions* dropdown when creating a new [top level folder](../s3/index.md#creating-a-bucket) for [S3](../s3/index.md) and [OpenStack Swift](../openstack/swiftstack.md) connections. - `OAuth Client ID` For protocols using OAuth 2.0 you can override the registered application client ID with the provider. - `OAuth Client Secret` For protocols using OAuth 2.0 you can override the registered application client secret with the provider. Refer to [Custom OAuth 2.0 Client ID for Google Cloud Storage and Google Drive](google_client_id.md). -```{note} -A profile can define an empty OAuth Client Secret key. The OAuth authorization flow will then use no client secret in client parameters to authenticate with the server. -``` + * A profile can define an empty OAuth Client Secret key. The OAuth authorization flow will then use no client secret in client parameters to authenticate with the server. + * A profile can omit the OAuth Client ID and Secret to prompt the user for manual input when connecting. - `Authorization` Set to `AWS2` to default to AWS2 signature authentication for S3. Default is `AWS4HMACSHA256`. - `Properties` List of custom protocol-specific properties. You can set [hidden configuration options](../../cyberduck/preferences.md#hidden-configuration-options) for a specific connection profile. Example usages can be found in: * [FTP (Compatibility Mode).cyberduckprofile](https://github.com/iterate-ch/profiles/blob/master/FTP%20(Compatibility%20Mode).cyberduckprofile) From 62406f05cea52ac7bee180493842cd3fad6f10f0 Mon Sep 17 00:00:00 2001 From: Cassie205 Date: Thu, 1 Feb 2024 16:28:50 +0100 Subject: [PATCH 3/3] Correction --- protocols/profiles/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/protocols/profiles/index.md b/protocols/profiles/index.md index d2ef9089..ddd5a860 100644 --- a/protocols/profiles/index.md +++ b/protocols/profiles/index.md @@ -75,8 +75,8 @@ All additional schemes are registered as a scheme handler when opening [Mountain - `Regions` List of regions supported by the provider. This will populate options in the *Regions* dropdown when creating a new [top level folder](../s3/index.md#creating-a-bucket) for [S3](../s3/index.md) and [OpenStack Swift](../openstack/swiftstack.md) connections. - `OAuth Client ID` For protocols using OAuth 2.0 you can override the registered application client ID with the provider. - `OAuth Client Secret` For protocols using OAuth 2.0 you can override the registered application client secret with the provider. Refer to [Custom OAuth 2.0 Client ID for Google Cloud Storage and Google Drive](google_client_id.md). - * A profile can define an empty OAuth Client Secret key. The OAuth authorization flow will then use no client secret in client parameters to authenticate with the server. - * A profile can omit the OAuth Client ID and Secret to prompt the user for manual input when connecting. + * A profile can define an empty value for `OAuth Client Secret`. The OAuth authorization flow will then use no client secret in client parameters to authenticate with the server. + * A profile can omit the `OAuth Client ID` and/or `OAuth Client Secret` keys to prompt the user for manual input when connecting. - `Authorization` Set to `AWS2` to default to AWS2 signature authentication for S3. Default is `AWS4HMACSHA256`. - `Properties` List of custom protocol-specific properties. You can set [hidden configuration options](../../cyberduck/preferences.md#hidden-configuration-options) for a specific connection profile. Example usages can be found in: * [FTP (Compatibility Mode).cyberduckprofile](https://github.com/iterate-ch/profiles/blob/master/FTP%20(Compatibility%20Mode).cyberduckprofile)