Overview
It is recommended that the user options database flag for a Cloud SQL SQL Server instance is not configured.
Rationale
The user options flag specifies global defaults for all users. A list of default query processing options is established for the duration of a user's work session. The user options option allows you to change the default values of the SET options (if the server's default settings are not appropriate).
A user can override these defaults by using the SET statement. You can configure user options dynamically for new logins. After you change the setting of user options, new login sessions use the new setting; current login sessions are not affected. This recommendation is applicable to SQL Server database instances.
Impact
Setting custom flags via command line on certain instances will cause all omitted flags to be reset to defaults. This may cause you to lose custom flags and could result in unforeseen complications or instance restarts. Because of this, it is recommended you apply these flags changes during a period of low usage.
Remediation guidance
From Google Cloud Console
- Go to the
Cloud SQL Instancespage in the Google Cloud Console by visiting https://console.cloud.google.com/sql/instances - Select the SQL Server instance where the database flag needs to be enabled
- Click
EDIT - Scroll down to the
Flagssection - Click the bin icon next to the
user optionsflag to remove it - Click
SAVE - Confirm the changes under
Flagson theOverviewpage
Using Google Cloud CLI
- List all Cloud SQL database instances:
gcloud sql instances list
- Clear the
user optionsdatabase flag for every Cloud SQL SQL Server instance using either of the commands below:
2.1 Clear all flags to their default value
gcloud sql instances patch <instanceName> --clear-database-flags
OR
2.2 To clear only the user options database flag, configure the database flags and override the user options. Exclude the user options flag and its value, and keep all other flags you want to configure.
gcloud sql instances patch <instanceName> --database-flags [FLAG1=VALUE1,FLAG2=VALUE2]
This command will overwrite all database flags previously set. To keep those and add new ones, include the values for all flags you want set on the instance; any flag not specifically included is set to its default value. For flags that do not take a value, specify the flag name followed by an equals sign ("=").
Default Value
By default 'user options' is not configured.
References
- https://cloud.google.com/sql/docs/sqlserver/flags
- https://learn.microsoft.com/en-us/sql/database-engine/configure-windows/configure-the-user-connections-server-configuration-option?view=sql-server-ver15
- https://www.stigviewer.com/stig/ms_sql_server_2016_instance/2018-03-09/finding/V-79119
Additional information
WARNING: This patch modifies database flag values, which may require the instance to be restarted. Check the list of supported flags https://cloud.google.com/sql/docs/sqlserver/flags - to see if your instance will be restarted when this patch is submitted.
Note: Configuring the above flag restarts the Cloud SQL instance.
Service-wide remediation
Recommended when many resources are affected: fix the platform baseline first so new resources inherit the secure setting, then remediate the existing flagged resources in batches.
Google Cloud
Use organization or folder policies where available, shared project templates, logs and alerting baselines, and IaC modules so new resources inherit the secure setting.
Operational rollout
- Fix the baseline first at the account, subscription, project, cluster, or tenant scope that owns this control.
- Remediate the currently affected resources in batches, starting with internet-exposed and production assets.
- Re-scan and track approved exceptions with an owner and expiry date.
Query logic
These are the stored checks tied to this control.
Ensure 'user options' database flag for Cloud SQL SQL Server instance is not configured
Connectors
Covered asset types
Expected check: eq []
{
cloudSqlInstances(
where: {
engine: "sqlserver"
cloudProvider: "gcp"
dbFlags_SOME: { name: "user options" }
}
) {
...AssetFragment
}
}
Google Cloud