Skip to content

Commit f2ca6ea

Browse files
committed
Document Role Configurable.
1 parent df034c2 commit f2ca6ea

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

protocols/profiles/aws_oidc.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Custom connection profile using OpenID Connect provider and AssumeRoleWithWebIde
88
* Mountain Duck [4.15.0](https://mountainduck.io/changelog/) or later required
99
:::
1010

11-
Connection [profiles](index.md#technical-file-format-specification) must include the `OAuth Authorization Url`, `OAuth Token Url`, `OAuth Redirect Url` and `Scopes` of the OpenID Connect (OIDC) identity provider and the `STS Endpoint` for the STS API endpoint which defaults to `https://sts.amazonaws.com/`. Set the property `s3.assumerole.rolearn` in the connection profile to the Role ARN configured in AWS. Set it to `s3.assumerole.rolearn=` for a prompt to enter on login.
11+
Connection [profiles](index.md#technical-file-format-specification) require the `Role Configurable` key to be set to `true` to enable authentication with temporary tokens from STS API. and include the `OAuth Authorization Url`, `OAuth Token Url`, `OAuth Redirect Url` and `Scopes` of the OpenID Connect (OIDC) identity provider and the `STS Endpoint` for the STS API endpoint which defaults to `https://sts.amazonaws.com/`. Set the property `role_arn` in the connection profile to the Role ARN configured in AWS to omit a prompt on login.
12+
13+
Profiles
1214

1315
## Prerequisites
1416

@@ -59,6 +61,8 @@ Refer to [Sample connection profiles for S3 and OpenID Connect Federation](https
5961
<false/>
6062
<key>Token Configurable</key>
6163
<false/>
64+
<key>Role Configurable</key>
65+
<true/>
6266
<key>Username Placeholder</key>
6367
<string>Username</string>
6468
<key>STS Endpoint</key>
@@ -73,12 +77,12 @@ Refer to [Sample connection profiles for S3 and OpenID Connect Federation](https
7377
```
7478

7579
::::{tip}
76-
Alternatively set the `s3.assumerole.rolearn` per user in a `.duck` [bookmark](../../tutorials/hidden_properties.md#in-duck-bookmark-files) file.
80+
Alternatively set the `role_arn` per user in a `.duck` [bookmark](../../tutorials/hidden_properties.md#in-duck-bookmark-files) file.
7781

7882
```xml
7983
<key>Custom</key>
8084
<dict>
81-
<key>s3.assumerole.rolearn</key>
85+
<key>role_arn</key>
8286
<string>arn:aws:iam::…</string>
8387
</dict>
8488
```

protocols/profiles/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ The value of `Vendor` must be unique among all installed connection profiles.
7575
- `Anonymous Configurable` Boolean if anonymous access is configurable.
7676
- `Path Configurable` Boolean if default path is configurable.
7777
- `Certificate Configurable` Boolean if client certificate is configurable.
78+
- `Role Configurable`. Boolean if role is configurable. Typically an ARN referencing the AWS IAM role to assume using AWS STS API.
7879
- `Region` Location constraint for [OpenStack Swift](../openstack/index.md) and [S3](../s3/index.md) profiles.
7980
:::{admonition} S3
8081
:class: tip
@@ -88,7 +89,7 @@ The value of `Vendor` must be unique among all installed connection profiles.
8889
* 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.
8990
* A profile can omit the `OAuth Client Secret` to prompt the user for manual input when connecting.
9091
- `Authorization` Set to `AWS2` to default to AWS2 signature authentication for S3. Default is `AWS4HMACSHA256`.
91-
- `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:
92+
- `Properties` Dictionary 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:
9293
* [FTP (Compatibility Mode).cyberduckprofile](https://github.com/iterate-ch/profiles/blob/master/FTP%20(Compatibility%20Mode).cyberduckprofile)
9394
* [FTP-SSL (Compatibility Mode).cyberduckprofile](https://github.com/iterate-ch/profiles/blob/master/FTP-SSL%20(Compatibility%20Mode).cyberduckprofile)
9495
* [S3 (Deprecated path style requests).cyberduckprofile](https://github.com/iterate-ch/profiles/blob/master/S3%20(Deprecated%20path%20style%20requests).cyberduckprofile)
@@ -186,5 +187,5 @@ Create a *multi-TIFF* containing the needed icon sizes:
186187
187188
### S3 and OpenID Connect Federation
188189
189-
Customization of connection profiles using OpenID Connect provider and AssumeRoleWithWebIdentity STS API
190+
Customization of connection profiles using OpenID Connect provider and AssumeRoleWithWebIdentity STS API.
190191
- [Sample connection profiles for S3 and OpenID Connect Federation](aws_oidc.md)

0 commit comments

Comments
 (0)