Skip to content

fix: set the default SSL Secure setting to true #848

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

Merged
merged 2 commits into from
Mar 14, 2025
Merged

fix: set the default SSL Secure setting to true #848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e13021
fix: set the default SSL Secure setting to true
karenc-bq Mar 13, 2025
08c0070
fix: linter errors
karenc-bq Mar 13, 2025
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
5 changes: 3 additions & 2 deletions aws_advanced_python_wrapper/utils/properties.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,8 +300,9 @@ class WrapperProperties:
60)

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

IDP_NAME = WrapperProperty("idp_name",
"The name of the Identity Provider implementation used",
Expand Down
2 changes: 1 addition & 1 deletion .../using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ In the case of AD FS, the user signs into the AD FS sign in page. This generates
| `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` |
| `iam_token_expiration` | Integer | No | Overrides the default IAM token cache expiration in seconds | `870` | `123` |
| `http_request_connect_timeout` | Integer | No | The timeout value in seconds to send the HTTP request data used by the FederatedAuthPlugin. | `60` | `60` |
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `False` | `True` |
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `True` | `False` |

## Sample code
[MySQLFederatedAuthentication.py](../../examples/MySQLFederatedAuthentication.py)
Expand Down
28 changes: 14 additions & 14 deletions docs/using-the-python-driver/using-plugins/UsingTheOktaAuthenticationPlugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ In the case of AD FS, the user signs into the AD FS sign in page. This generates
4. Specify parameters that are required or specific to your case.

### Federated Authentication Plugin Parameters
| Parameter | Value | Required | Description | Default Value | Example Value |
|--------------------------------|:-------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|--------------------------------------------------------|
| `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` |
| `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` | `jimbob@example.com` |
| `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` |
| `idp_endpoint` | String | Yes | The hosting URL for the service that you are using to authenticate into AWS Aurora. | `None` | `ec2amaz-ab3cdef.example.com` |
| `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` |
| `iam_idp_arn` | String | Yes | The ARN of the Identity Provider. | `None` | `arn:aws:iam::123456789012:saml-provider/adfs_example` |
| `iam_region` | String | Yes | The IAM region where the IAM token is generated. | `None` | `us-east-2` |
| `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` |
| `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` |
| `iam_token_expiration` | Integer | No | Overrides the default IAM token cache expiration in seconds | `870` | `123` |
| `http_request_connect_timeout` | Integer | No | The timeout value in seconds to send the HTTP request data used by the FederatedAuthPlugin. | `60` | `60` |
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `False` | `True` |
| Parameter | Value | Required | Description | Default Value | Example Value |
|--------------------------------|:-------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------|
| `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` |
| `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` | `jimbob@example.com` |
| `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` |
| `idp_endpoint` | String | Yes | The hosting URL for the service that you are using to authenticate into AWS Aurora. | `None` | `ec2amaz-ab3cdef.example.com` |
| `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` |
| `iam_idp_arn` | String | Yes | The ARN of the Identity Provider. | `None` | `arn:aws:iam::123456789012:saml-provider/adfs_example` |
| `iam_region` | String | Yes | The IAM region where the IAM token is generated. | `None` | `us-east-2` |
| `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` |
| `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` |
| `iam_token_expiration` | Integer | No | Overrides the default IAM token cache expiration in seconds | `870` | `123` |
| `http_request_connect_timeout` | Integer | No | The timeout value in seconds to send the HTTP request data used by the FederatedAuthPlugin. | `60` | `60` |
| `ssl_secure` | Boolean | No | Whether the SSL session is to be secure and the server's certificates will be verified | `True` | `False` |

## Sample code
[MySQLOktaAuthentication.py](../../examples/MySQLOktaAuthentication.py)
Expand Down