Skip to content

Commit 5f1cca2

Browse files
karenc-bqkarenc-bq
authored
fix: set the default SSL Secure setting to true (#848)
1 parent 3ab4322 commit 5f1cca2

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

‎aws_advanced_python_wrapper/utils/properties.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,8 +300,9 @@ class WrapperProperties:
300300
60)
301301

302302
SSL_SECURE = WrapperProperty("ssl_secure",
303-
"Whether the SSL session is to be secure and the server's certificates will be verified",
304-
False)
303+
"Whether the SSL session is to be secure and the server's certificates will be verified."
304+
" We do not recommend disabling this for production use.",
305+
True)
305306

306307
IDP_NAME = WrapperProperty("idp_name",
307308
"The name of the Identity Provider implementation used",

‎docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ In the case of AD FS, the user signs into the AD FS sign in page. This generates
4141
| `iam_default_port` | String | No | This property overrides the default port that is used to generate the IAM token. The default port is determined based on the underlying driver protocol. For now, there is support for PostgreSQL and MySQL. Target drivers with different protocols will require users to provide a default port. | `None` | `1234` |
4242
| `iam_token_expiration` | Integer | No | Overrides the default IAM token cache expiration in seconds | `870` | `123` |
4343
| `http_request_connect_timeout` | Integer | No | The timeout value in seconds to send the HTTP request data used by the FederatedAuthPlugin. | `60` | `60` |
44-
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `False` | `True` |
44+
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `True` | `False` |
4545

4646
## Sample code
4747
[MySQLFederatedAuthentication.py](../../examples/MySQLFederatedAuthentication.py)

‎docs/using-the-python-driver/using-plugins/UsingTheOktaAuthenticationPlugin.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@ In the case of AD FS, the user signs into the AD FS sign in page. This generates
2424
4. Specify parameters that are required or specific to your case.
2525

2626
### Federated Authentication Plugin Parameters
27-
| Parameter | Value | Required | Description | Default Value | Example Value |
28-
|--------------------------------|:-------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|--------------------------------------------------------|
29-
| `db_user` | String | Yes | The user name of the IAM user with access to your database. <br>If you have previously used the IAM Authentication Plugin, this would be the same IAM user. <br>For information on how to connect to your Aurora Database with IAM, see this [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.Connecting.html). | `None` | `some_user_name` |
30-
| `idp_username` | String | Yes | The user name for the `idp_endpoint` server. If this parameter is not specified, the plugin will fallback to using the `user` parameter. | `None` | `[email protected]` |
31-
| `idp_password` | String | Yes | The password associated with the `idp_endpoint` username. If this parameter is not specified, the plugin will fallback to using the `password` parameter. | `None` | `some_random_password` |
32-
| `idp_endpoint` | String | Yes | The hosting URL for the service that you are using to authenticate into AWS Aurora. | `None` | `ec2amaz-ab3cdef.example.com` |
33-
| `iam_role_arn` | String | Yes | The ARN of the IAM Role that is to be assumed to access AWS Aurora. | `None` | `arn:aws:iam::123456789012:role/adfs_example_iam_role` |
34-
| `iam_idp_arn` | String | Yes | The ARN of the Identity Provider. | `None` | `arn:aws:iam::123456789012:saml-provider/adfs_example` |
35-
| `iam_region` | String | Yes | The IAM region where the IAM token is generated. | `None` | `us-east-2` |
36-
| `iam_host` | String | No | Overrides the host that is used to generate the IAM token. | `None` | `database.cluster-hash.us-east-1.rds.amazonaws.com` |
37-
| `iam_default_port` | String | No | This property overrides the default port that is used to generate the IAM token. The default port is determined based on the underlying driver protocol. For now, there is support for PostgreSQL and MySQL. Target drivers with different protocols will require users to provide a default port. | `None` | `1234` |
38-
| `iam_token_expiration` | Integer | No | Overrides the default IAM token cache expiration in seconds | `870` | `123` |
39-
| `http_request_connect_timeout` | Integer | No | The timeout value in seconds to send the HTTP request data used by the FederatedAuthPlugin. | `60` | `60` |
40-
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `False` | `True` |
27+
| Parameter | Value | Required | Description | Default Value | Example Value |
28+
|--------------------------------|:-------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------|
29+
| `db_user` | String | Yes | The user name of the IAM user with access to your database. <br>If you have previously used the IAM Authentication Plugin, this would be the same IAM user. <br>For information on how to connect to your Aurora Database with IAM, see this [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.Connecting.html). | `None` | `some_user_name` |
30+
| `idp_username` | String | Yes | The user name for the `idp_endpoint` server. If this parameter is not specified, the plugin will fallback to using the `user` parameter. | `None` | `[email protected]` |
31+
| `idp_password` | String | Yes | The password associated with the `idp_endpoint` username. If this parameter is not specified, the plugin will fallback to using the `password` parameter. | `None` | `some_random_password` |
32+
| `idp_endpoint` | String | Yes | The hosting URL for the service that you are using to authenticate into AWS Aurora. | `None` | `ec2amaz-ab3cdef.example.com` |
33+
| `iam_role_arn` | String | Yes | The ARN of the IAM Role that is to be assumed to access AWS Aurora. | `None` | `arn:aws:iam::123456789012:role/adfs_example_iam_role` |
34+
| `iam_idp_arn` | String | Yes | The ARN of the Identity Provider. | `None` | `arn:aws:iam::123456789012:saml-provider/adfs_example` |
35+
| `iam_region` | String | Yes | The IAM region where the IAM token is generated. | `None` | `us-east-2` |
36+
| `iam_host` | String | No | Overrides the host that is used to generate the IAM token. | `None` | `database.cluster-hash.us-east-1.rds.amazonaws.com` |
37+
| `iam_default_port` | String | No | This property overrides the default port that is used to generate the IAM token. The default port is determined based on the underlying driver protocol. For now, there is support for PostgreSQL and MySQL. Target drivers with different protocols will require users to provide a default port. | `None` | `1234` |
38+
| `iam_token_expiration` | Integer | No | Overrides the default IAM token cache expiration in seconds | `870` | `123` |
39+
| `http_request_connect_timeout` | Integer | No | The timeout value in seconds to send the HTTP request data used by the FederatedAuthPlugin. | `60` | `60` |
40+
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `True` | `False` |
4141

4242
## Sample code
4343
[MySQLOktaAuthentication.py](../../examples/MySQLOktaAuthentication.py)

0 commit comments

Comments
 (0)