Doc changes for trust_server_certificate option in mssql_session resource (#86)

* Committed doc changes for mssql session resource from https://github.com/inspec/inspec/pull/7791/changes

Signed-off-by: Nik08 <nikita.mathur@progress.com>

* Fixes to lint pipelines

Signed-off-by: Nik08 <nikita.mathur@progress.com>

* Editorial mssql_session.md

Signed-off-by: Lisa Barry <lbarry@progress.com>

* Editing

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

---------

Signed-off-by: Nik08 <nikita.mathur@progress.com>
Signed-off-by: Lisa Barry <lbarry@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: Nik08 <nikita.mathur@progress.com>
Co-authored-by: lbarry316 <118758673+lbarry316@users.noreply.github.com>
Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>

Author: 4 people

content/resources/core/mssql_session.md

@@ -34,10 +34,49 @@ end
 
 where:
 
-- `mssql_session` declares a username and password with permission to run the query. Omitting the username or password parameters results in the use of Windows authentication as the user Chef InSpec is executing as. You may also optionally pass a host and instance name. If omitted, they will default to host: localhost and the default instance.
+- `mssql_session` declares credentials and connection settings used to connect to Microsoft SQL Server
 - `query('QUERY')` contains the query to be run
 - `its('value') { should eq('') }` compares the results of the query against the expected result in the test
 
+### Optional parameters
+
+This resource has the following parameters:
+
+`user`
+: The SQL Server username for SQL authentication.
+
+  If `user` or `password` is omitted, `mssql_session` uses Windows authentication as the user running Chef InSpec.
+
+`password`
+: The SQL Server password for SQL authentication.
+
+`pass` (deprecated)
+: Deprecated alias for `password`. Use `password` instead.
+
+`host`
+: The SQL Server host name. Default value: `localhost`.
+
+`port`
+: The SQL Server port. By default, no explicit port is passed.
+
+`instance`
+: The SQL Server instance name. By default, the server's default instance is used.
+
+`db_name`
+: The database name to connect to before running the query.
+
+`local_mode`
+: Set to `true` to run in local mode.
+
+  In local mode, the resource doesn't pass the host or port to `sqlcmd`.
+
+`trust_server_certificate`
+: Set `trust_server_certificate: true` to pass `-C` to the underlying `sqlcmd`.
+
+  Use this when you need encrypted connectivity, but certificate validation would otherwise fail due to missing certificate-chain configuration (for example, SQL Server uses a self-signed certificate or a private CA that isn't available in the runner's trust store).
+
+  This option is less secure than full certificate validation because it trusts the server certificate without strict verification. Use this only if necessary. Instead, install the correct CA certificate or SQL Server certificate on the target system when possible.
+
 ## Examples
 
 The following examples show how to use this Chef InSpec audit resource.
@@ -82,6 +121,16 @@ describe sql.query("SELECT Name AS result FROM Product WHERE ProductID == 1").ro
 end
 ```
 
+### Trust the SQL Server certificate
+
+```ruby
+sql = mssql_session(user: 'my_user', password: 'password', trust_server_certificate: true)
+
+describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
+  its("value") { should_not be_empty }
+end
+```
+
 ## Matchers
 
 {{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}

cspell.yaml

@@ -39,6 +39,7 @@ ignoreRegExpList:
 words:
   - TCPS
   - tnsnames
+  - sqlcmd
 languageSettings:
   - languageId: markdown
     ignoreRegExpList: