Minor Network MQL pack improvements

Improve wording and add links Signed-off-by: Tim Smith <[email protected]>
mondoohq · Aug 9, 2024 · e8369f6 · e8369f6
1 parent e478722
commit e8369f6
Show file tree

Hide file tree

Showing 11 changed files with 65 additions and 45 deletions.
diff --git a/docs/mql/resources/network-pack/README.md b/docs/mql/resources/network-pack/README.md
@@ -12,30 +12,30 @@ The Network resource pack lets you use MQL to query and assess the security of d
 
 Resources included in this pack:
 
-| ID                                                        | DESCRIPTION                                                               |
-| --------------------------------------------------------- | ------------------------------------------------------------------------- |
-| [certificate](certificate.md)                             | x509 certificate resource                                                 |
-| [certificates](certificates.md)                           | x509 certificates resource                                                |
-| [dns](dns.md)                                             | DNS resource                                                              |
-| [dns.dkimRecord](dns.dkimrecord.md)                       | DKIM public key representation as defined in RFC 6376                     |
-| [dns.mxRecord](dns.mxrecord.md)                           | DNS MX record                                                             |
-| [dns.record](dns.record.md)                               | DNS record                                                                |
-| [domainName](domainname.md)                               | Domain name                                                               |
-| [http](http.md)                                           | HTTP endpoint                                                             |
-| [http.get](http.get.md)                                   | HTTP GET requests                                                         |
-| [http.header](http.header.md)                             | HTTP header                                                               |
-| [http.header.contentType](http.header.contenttype.md)     | Content-Type header                                                       |
-| [http.header.setCookie](http.header.setcookie.md)         | Set-Cookie header                                                         |
-| [http.header.sts](http.header.sts.md)                     | HTTP header for Strict-Transport-Security                                 |
-| [http.header.xssProtection](http.header.xssprotection.md) | HTTP header for X-XSS-Protection, which is now outdated (replaced by CSP) |
-| [openpgp.entities](openpgp.entities.md)                   |                                                                           |
-| [openpgp.entity](openpgp.entity.md)                       | OpenPGP entity                                                            |
-| [openpgp.identity](openpgp.identity.md)                   | OpenPGP identity                                                          |
-| [openpgp.publicKey](openpgp.publickey.md)                 | OpenPGP public key                                                        |
-| [openpgp.signature](openpgp.signature.md)                 | OpenPGP signature                                                         |
-| [pkix.extension](pkix.extension.md)                       | x509 certificate PKIX extension                                           |
-| [pkix.name](pkix.name.md)                                 | x509 certificate PKIX name                                                |
-| [pkix.sanExtension](pkix.sanextension.md)                 | x509 certificate PKIX Subject Alternative Name (SAN) extension            |
-| [socket](socket.md)                                       | Socket                                                                    |
-| [tls](tls.md)                                             | TLS                                                                       |
-| [url](url.md)                                             | URL resource, generally represented as:                                   |
+| ID                                                        | DESCRIPTION                                                           |
+| --------------------------------------------------------- | --------------------------------------------------------------------- |
+| [certificate](certificate.md)                             | X.509 certificate resource                                            |
+| [certificates](certificates.md)                           | X.509 certificates resource                                           |
+| [dns](dns.md)                                             | DNS resource                                                          |
+| [dns.dkimRecord](dns.dkimrecord.md)                       | DKIM public key representation as defined in RFC 6376                 |
+| [dns.mxRecord](dns.mxrecord.md)                           | DNS MX record                                                         |
+| [dns.record](dns.record.md)                               | DNS record                                                            |
+| [domainName](domainname.md)                               | Domain name                                                           |
+| [http](http.md)                                           | HTTP endpoint                                                         |
+| [http.get](http.get.md)                                   | HTTP GET requests                                                     |
+| [http.header](http.header.md)                             | HTTP header                                                           |
+| [http.header.contentType](http.header.contenttype.md)     | HTTP header Content-Type                                              |
+| [http.header.setCookie](http.header.setcookie.md)         | HTTP header Set-Cookie                                                |
+| [http.header.sts](http.header.sts.md)                     | HTTP header Strict-Transport-Security                                 |
+| [http.header.xssProtection](http.header.xssprotection.md) | HTTP header X-XSS-Protection, which is now outdated (replaced by CSP) |
+| [openpgp.entities](openpgp.entities.md)                   |                                                                       |
+| [openpgp.entity](openpgp.entity.md)                       | OpenPGP entity                                                        |
+| [openpgp.identity](openpgp.identity.md)                   | OpenPGP identity                                                      |
+| [openpgp.publicKey](openpgp.publickey.md)                 | OpenPGP public key                                                    |
+| [openpgp.signature](openpgp.signature.md)                 | OpenPGP signature                                                     |
+| [pkix.extension](pkix.extension.md)                       | X.509 certificate PKIX extension                                      |
+| [pkix.name](pkix.name.md)                                 | X.509 certificate PKIX name                                           |
+| [pkix.sanExtension](pkix.sanextension.md)                 | X.509 certificate PKIX Subject Alternative Name (SAN) extension       |
+| [socket](socket.md)                                       | Socket                                                                |
+| [tls](tls.md)                                             | TLS                                                                   |
+| [url](url.md)                                             | URL resource, generally represented as:                               |
diff --git a/docs/mql/resources/network-pack/certificate.md b/docs/mql/resources/network-pack/certificate.md
@@ -3,14 +3,14 @@ title: certificate
 id: certificate
 sidebar_label: certificate
 displayed_sidebar: MQL
-description: x509 certificate resource
+description: X.509 certificate resource
 ---
 
 # certificate
 
 **Description**
 
-x509 certificate resource
+X.509 certificate resource
 
 **Fields**
 

diff --git a/docs/mql/resources/network-pack/certificates.md b/docs/mql/resources/network-pack/certificates.md
@@ -3,14 +3,14 @@ title: certificates
 id: certificates
 sidebar_label: certificates
 displayed_sidebar: MQL
-description: x509 certificates resource
+description: X.509 certificates resource
 ---
 
 # certificates
 
 **Description**
 
-x509 certificates resource
+X.509 certificates resource
 
 **List**
 

diff --git a/docs/mql/resources/network-pack/http.header.contenttype.md b/docs/mql/resources/network-pack/http.header.contenttype.md
@@ -3,7 +3,7 @@ title: http.header.contentType
 id: http.header.contentType
 sidebar_label: http.header.contentType
 displayed_sidebar: MQL
-description: Content-Type header
+description: HTTP header Content-Type
 ---
 
 # http.header.contentType
@@ -14,11 +14,15 @@ experimental
 
 **Description**
 
-Content-Type header
+HTTP header Content-Type
 
 **Fields**
 
 | ID     | TYPE              | DESCRIPTION                                 |
 | ------ | ----------------- | ------------------------------------------- |
 | type   | string            | MIME type for the content                   |
 | params | map[string]string | Additional parameters for this content type |
+
+**References**
+
+- [X-Content-Type-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options)
diff --git a/docs/mql/resources/network-pack/http.header.md b/docs/mql/resources/network-pack/http.header.md
@@ -29,3 +29,7 @@ HTTP header
 | contentType         | [http.header.contentType](http.header.contenttype.md)     | Content-Type header                                                       |
 | setCookie           | [http.header.setCookie](http.header.setcookie.md)         | Set-Cookie header                                                         |
 | csp                 | map[string]string                                         | Content-Security-Policy header                                            |
+
+**References**
+
+- [HTTP Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers)
diff --git a/docs/mql/resources/network-pack/http.header.setcookie.md b/docs/mql/resources/network-pack/http.header.setcookie.md
@@ -3,7 +3,7 @@ title: http.header.setCookie
 id: http.header.setCookie
 sidebar_label: http.header.setCookie
 displayed_sidebar: MQL
-description: Set-Cookie header
+description: HTTP header Set-Cookie
 ---
 
 # http.header.setCookie
@@ -14,7 +14,7 @@ experimental
 
 **Description**
 
-Set-Cookie header
+HTTP header Set-Cookie
 
 **Fields**
 
@@ -23,3 +23,7 @@ Set-Cookie header
 | name   | string            | Name of the cookie to set                     |
 | value  | string            | Value of the cookie to set                    |
 | params | map[string]string | Additional parameters for setting this cookie |
+
+**References**
+
+- [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie)
diff --git a/docs/mql/resources/network-pack/http.header.sts.md b/docs/mql/resources/network-pack/http.header.sts.md
@@ -3,7 +3,7 @@ title: http.header.sts
 id: http.header.sts
 sidebar_label: http.header.sts
 displayed_sidebar: MQL
-description: HTTP header for Strict-Transport-Security
+description: HTTP header Strict-Transport-Security
 ---
 
 # http.header.sts
@@ -14,7 +14,7 @@ experimental
 
 **Description**
 
-HTTP header for Strict-Transport-Security
+HTTP header Strict-Transport-Security
 
 **Fields**
 
@@ -23,3 +23,7 @@ HTTP header for Strict-Transport-Security
 | maxAge            | time | How long to cache HTTPS-only policy in seconds |
 | includeSubDomains | bool | Whether caching applies to subdomains          |
 | preload           | bool | Non-standard directive for preloading STS      |
+
+**References**
+
+- [Strict-Transport-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security)
diff --git a/docs/mql/resources/network-pack/http.header.xssprotection.md b/docs/mql/resources/network-pack/http.header.xssprotection.md
@@ -3,7 +3,7 @@ title: http.header.xssProtection
 id: http.header.xssProtection
 sidebar_label: http.header.xssProtection
 displayed_sidebar: MQL
-description: HTTP header for X-XSS-Protection, which is now outdated (replaced by CSP)
+description: HTTP header X-XSS-Protection, which is now outdated (replaced by CSP)
 ---
 
 # http.header.xssProtection
@@ -14,7 +14,7 @@ experimental
 
 **Description**
 
-HTTP header for X-XSS-Protection, which is now outdated (replaced by CSP)
+HTTP header X-XSS-Protection, which is now outdated (replaced by CSP)
 
 **Fields**
 
@@ -23,3 +23,7 @@ HTTP header for X-XSS-Protection, which is now outdated (replaced by CSP)
 | enabled | bool   | Whether the header is enabled (Enabled when the header value is set to 1; disabled if set to 0) |
 | mode    | string | Mode for XSS filtering                                                                          |
 | report  | string | Report endpoint for violations (Chromium only)                                                  |
+
+**References**
+
+- [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection)
diff --git a/docs/mql/resources/network-pack/pkix.extension.md b/docs/mql/resources/network-pack/pkix.extension.md
@@ -3,14 +3,14 @@ title: pkix.extension
 id: pkix.extension
 sidebar_label: pkix.extension
 displayed_sidebar: MQL
-description: x509 certificate PKIX extension
+description: X.509 certificate PKIX extension
 ---
 
 # pkix.extension
 
 **Description**
 
-x509 certificate PKIX extension
+X.509 certificate PKIX extension
 
 **Fields**
 

diff --git a/docs/mql/resources/network-pack/pkix.name.md b/docs/mql/resources/network-pack/pkix.name.md
@@ -3,14 +3,14 @@ title: pkix.name
 id: pkix.name
 sidebar_label: pkix.name
 displayed_sidebar: MQL
-description: x509 certificate PKIX name
+description: X.509 certificate PKIX name
 ---
 
 # pkix.name
 
 **Description**
 
-x509 certificate PKIX name
+X.509 certificate PKIX name
 
 **Fields**
 

diff --git a/docs/mql/resources/network-pack/pkix.sanextension.md b/docs/mql/resources/network-pack/pkix.sanextension.md
@@ -3,14 +3,14 @@ title: pkix.sanExtension
 id: pkix.sanExtension
 sidebar_label: pkix.sanExtension
 displayed_sidebar: MQL
-description: x509 certificate PKIX Subject Alternative Name (SAN) extension
+description: X.509 certificate PKIX Subject Alternative Name (SAN) extension
 ---
 
 # pkix.sanExtension
 
 **Description**
 
-x509 certificate PKIX Subject Alternative Name (SAN) extension
+X.509 certificate PKIX Subject Alternative Name (SAN) extension
 
 **Fields**