Skip to content

Commit 91da1a6

Browse files
authored
Merge pull request #555 from iterate-ch/issue/554
Connecting using Deprecated Path Style Requests
2 parents c066212 + ab65edd commit 91da1a6

File tree

1 file changed

+43
-58
lines changed

1 file changed

+43
-58
lines changed

protocols/s3/index.md

+43-58
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ z1
4141
```
4242

4343
Transfer files to your [S3](http://aws.amazon.com/s3) account and browse the S3 buckets and files in a hierarchical way.
44-
For a short overview of Amazon S3, refer to the [Wikipedia article](http://en.wikipedia.org/wiki/Amazon_S3).
4544

4645
```{contents} Content
4746
:depth: 2
@@ -58,15 +57,12 @@ in the login prompt.
5857
### IAM User
5958

6059
You can also connect using [IAM](iam.md) credentials that have the `Amazon S3 Full Access` template policy permissions
61-
attached and optionally the `CloudFront Full Access`. Make sure you are connecting with `AWS4-HMAC-SHA256` signature
62-
version (see above).
60+
attached and optionally the `CloudFront Full Access`.
6361

6462
### Generic S3 Profiles
6563

66-
For use with third party S3 installations.
67-
6864
```{note}
69-
Connection profiles can be installed from *Preferences → Profiles*.
65+
Connection profiles for use with third-party S3 installations. can be installed from *Preferences → Profiles*.
7066
```
7167

7268
`````{tabs}
@@ -75,84 +71,66 @@ Connection profiles can be installed from *Preferences → Profiles*.
7571
7672
**Authentication with signature version AWS4-HMAC-SHA256**
7773
78-
**HTTP**</br>
7974
```{Important}
8075
It is discouraged to enable this option to connect plaintext to Amazon S3.
8176
```
8277
8378
If you have an S3 installation without SSL configured, you need an optional connection profile to connect using HTTP only without transport layer security. You will then have the added option S3 (HTTP) in the protocol dropdown selection in the [Connection](../../cyberduck/connection) and [Bookmark](../../cyberduck/bookmarks) panels.
8479
85-
The default port is `80`.
86-
87-
* {download}`Download<https://profiles.cyberduck.io/S3%20(HTTP).cyberduckprofile>` the *S3 (HTTP) profile* for preconfigured settings.
88-
89-
**HTTPS**</br>
90-
91-
The default port is `443`.
92-
93-
- {download}`Download<https://profiles.cyberduck.io/S3%20(HTTPS).cyberduckprofile>` the *S3 (HTTPS) profile* for preconfigured settings.
80+
- {download}`Download<https://profiles.cyberduck.io/S3%20(HTTP).cyberduckprofile>` the *S3 (HTTP) profile* for preconfigured settings.
81+
- *S3 (HTTPS) profile* bundled by default.
9482
````
9583
9684
````{tab} AWS2
9785
98-
```{attention}
99-
Connection profiles using legacy AWS2 signature authentication are not recommended to be used with AWS S3 as some features like _Key Management Service_ and _CloudFront configuration_ won't be supported
100-
```
101-
10286
**Authentication with signature version AWS2**
10387
104-
An incomplete list of known providers that require the use of AWS2
105-
- Riak Cloud Storage
106-
- EMC Elastic Cloud Storage
107-
108-
**HTTP**</br>
109-
110-
The default port is `80`.
88+
```{attention}
89+
Connection profiles using legacy AWS2 signature authentication are not recommended to be used with AWS S3 as some regions and features like _Key Management Service_ and _CloudFront configuration_ are not supported.
90+
```
11191
11292
- {download}`Download<https://profiles.cyberduck.io/S3%20AWS2%20Signature%20Version%20(HTTP).cyberduckprofile>` the S3 AWS2 Signature Version (HTTP) profile for preconfigured settings.
113-
114-
**HTTPS**</br>
115-
116-
The default port is `443`.
117-
11893
- {download}`Download<https://profiles.cyberduck.io/S3%20AWS2%20Signature%20Version%20(HTTPS).cyberduckprofile>` the S3 AWS2 Signature Version (HTTPS) profile for preconfigured settings.
11994
120-
121-
12295
````
123-
`````
12496
125-
### AWS Gov Cloud
97+
````{tab} AWS Gov Cloud
12698
127-
#### S3 GovCloud (US-East)
99+
**S3 GovCloud (US-East)**
128100
129101
Use the endpoint `s3.us-gov-east-1.amazonaws.com` or install the connection profile
130102
131103
- {download}`Download<https://profiles.cyberduck.io/S3%20GovCloud%20(US-East).cyberduckprofile>` the *S3 GovCloud (
132104
US-East) profile* for preconfigured settings.
133105
134-
#### S3 GovCloud (Us-West)
106+
**S3 GovCloud (Us-West)**
135107
136108
Use the endpoint `s3.us-gov-west-1.amazonaws.com` or install the connection profile
137109
138110
- {download}`Download<https://profiles.cyberduck.io/S3%20GovCloud%20(US-East).cyberduckprofile>` the *S3 GovCloud (
139111
US-West) profile* for preconfigured settings.
140112
141-
### AWS China (Beijiing)
113+
````
142114
143-
Connect to the region *AWS China (Beijing)*
115+
````{tab} AWS China (Beijing)
116+
**Connect to the region _AWS China (Beijing)_**
144117
145118
- {download}`Download<https://profiles.cyberduck.io/S3%20China%20(Beijing).cyberduckprofile>` the *S3 China (Beijing)
146119
profile* for preconfigured settings.
120+
- {download}`Download<https://profiles.cyberduck.io/S3%20China%20(Ningxia).cyberduckprofile>` the *S3 China (Ningxia)
121+
profile* for preconfigured settings.
147122
148-
### AWS Private Link
123+
````
149124
150-
Connect
151-
to [S3 interface VPC endpoint](https://docs.aws.amazon.com/AmazonS3/latest/userguide/privatelink-interface-endpoints.html)
125+
````{tab} AWS Private Link
152126
153-
-
154-
{download}`Download<https://profiles.cyberduck.io/AWS%20PrivateLink%20for%20Amazon%20S3%20(VPC%20endpoint).cyberduckprofile>`
127+
**Connect to [S3 interface VPC endpoint](https://docs.aws.amazon.com/AmazonS3/latest/userguide/privatelink-interface-endpoints.html)**
128+
129+
- {download}`Download<https://profiles.cyberduck.io/AWS%20PrivateLink%20for%20Amazon%20S3%20(VPC%20endpoint).cyberduckprofile>`
155130
the *AWS PrivateLink for Amazon S3 (VPC endpoint) profile*.
131+
````
132+
133+
`````
156134

157135
### Connecting to a Single Bucket
158136

@@ -168,6 +146,24 @@ You can access buckets owned by someone else if the ACL allows you to access it
168146
No regional endpoint should be set while connecting to a single bucket. The endpoint will be determined automatically by querying the region of the bucket.
169147
```
170148

149+
### Connecting using Deprecated Path Style Requests
150+
151+
For S3 compatible storage only supporting path style requests to reference buckets. Connect with a connection profile
152+
disabling virtual host style requests.
153+
154+
- {download}`Download<https://profiles.cyberduck.io/S3%20(Deprecated%20path%20style%20requests).cyberduckprofile>` the
155+
*S3 (Deprecated path style requests) profile* for preconfigured settings.
156+
157+
Alternatively set the [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) `s3.bucket.virtualhost.disable`
158+
to `true`.
159+
160+
```{admonition} Interoperability
161+
:class: note
162+
163+
Attempting to connect using the regular S3 connection profile to a server with no support for virtual host style requests will cause
164+
the error `Cannot read container configuration` with the message _DNS is the network service that translates a server name to its Internet address. This error is most often caused by having no connection to the Internet or a misconfigured network. It can also be caused by an unresponsive DNS server or a firewall preventing access to the network._
165+
```
166+
171167
### Connecting with OpenID Connect (OIDC) Identity Provider
172168

173169
```{important}
@@ -200,8 +196,7 @@ When connecting the user is requested to enter the Role ARN of the IAM role that
200196

201197
##### S3 with Azure Active Directory (Azure AD)
202198

203-
-
204-
{download}`Download<https://profiles.cyberduck.io/AWS%20S3%2BSTS%20%26%20Azure%20Active%20Directory%20%28Azure%20AD%29%20OpenID%20Connect.cyberduckprofile>`
199+
- {download}`Download<https://profiles.cyberduck.io/AWS%20S3%2BSTS%20%26%20Azure%20Active%20Directory%20%28Azure%20AD%29%20OpenID%20Connect.cyberduckprofile>`
205200
the *AWS S3+STS &amp; Azure Active Directory (Azure AD) profile* for preconfigured settings
206201

207202
##### S3 with Google OpenID Connect
@@ -226,8 +221,7 @@ change the role name `s3access` to match your IAM configuration.
226221
Instead of providing Access Key ID and Secret Access Key, authenticate using credentials managed in `~/aws/credentials`
227222
on macOS or `%USERPROFILE%\.aws\credentials` on Windows using third-party tools.
228223

229-
-
230-
{download}`Download<https://profiles.cyberduck.io/S3%20(Credentials%20from%20AWS%20Command%20Line%20Interface).cyberduckprofile>`
224+
- {download}`Download<https://profiles.cyberduck.io/S3%20(Credentials%20from%20AWS%20Command%20Line%20Interface).cyberduckprofile>`
231225
the *S3 (Credentials from AWS Command Line Interface) profile* for preconfigured settings.
232226

233227
You must provide configuration in the standard credentials property file `~/.aws/credentials` on macOS
@@ -846,15 +840,6 @@ necessary if you want to view the timestamps set in the browser.
846840

847841
The timestamp metadata is interoperable with [rclone](https://rclone.org/s3/#modified-time).
848842

849-
### Disable use of Virtual Host Style Requests
850-
851-
Set the [hidden preference](../../cyberduck/preferences.md#hidden-configuration-options) `s3.bucket.virtualhost.disable`
852-
to `true` if your S3 compatible storage does only support path style requests to reference buckets. Alternatively a
853-
custom connection [profile](../profiles/index.md) with the property set in `Properties`.
854-
855-
- {download}`Download<https://profiles.cyberduck.io/S3%20(Deprecated%20path%20style%20requests).cyberduckprofile>` the
856-
*S3 (Deprecated path style requests) profile* for preconfigured settings.
857-
858843
### `Listing directory / failed.` with Path in Custom S3 Endpoint
859844

860845
When connecting to a service that requires a path prefix in all requests, you must set the `Context` property in a

0 commit comments

Comments
 (0)