Skip to content

Commit

Permalink
Add nmap resource pack to docs (#507)
Browse files Browse the repository at this point in the history 
New resource pack. Also pull in the updated aws resources

Signed-off-by: Tim Smith <[email protected]>
  • Loading branch information
@tas50
tas50 authored Dec 17, 2024
1 parent aa7061e commit 55fd3c9
Show file tree
Hide file tree
Showing 16 changed files with 233 additions and 81 deletions.
4 changes: 2 additions & 2 deletions .github/actions/spelling/expect.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,6 @@ loggingservice
LQp
LThh
lun
mailsec
managedrulegroupstatement
managedzone
MANIFESTFILE
Expand Down Expand Up @@ -245,6 +244,7 @@ networkinterface
networkservice
newkey
nginx
nmap
noarch
nodegroup
nodepool
Expand Down Expand Up @@ -365,7 +365,7 @@ vdcs
vjtestpriv
Vkt
Vnet
vnic
VNic
Vtpm
Vtz
vulnerabilityassessment
Expand Down
1 change: 1 addition & 0 deletions docs/mql/resources/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ These specialized packs let you deep-dive into attributes unique to the platform
- [Kubernetes resource pack](./k8s-pack)
- [Microsoft 365 resource pack](./ms365-pack)
- [Mondoo Platform resource pack](./mondoo-pack)
- [Nmap resource pack](./nmap-pack)
- [Okta resource pack](./okta-pack)
- [OPC UA resource pack](./opcua-pack)
- [Oracle Cloud Infrastructure (OCI) resource pack](./oci-pack)
Expand Down
3 changes: 2 additions & 1 deletion docs/mql/resources/aws-pack/aws.cloudfront.function.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Amazon CloudFront function
| status | string | Status of the CloudFront function |
| arn | string | ARN of the CloudFront function |
| lastModifiedTime | time | Date and time when the function was last updated |
| createdTime | time | Date and time when the function was created |
| createdTime | time | Deprecated (use `createdAt` instead) |
| createdAt | time | Date and time the function was created |
| stage | string | Stage that the function is in |
| comment | string | Comment to describe the function |
| runtime | string | Runtime environment for the function |
3 changes: 2 additions & 1 deletion docs/mql/resources/aws-pack/aws.dynamodb.table.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ The `aws.dynamodb.table` resource provides fields representing a DynamoDB table.
| provisionedThroughput | dict | Provisioned throughput settings for the table |
| continuousBackups | dict | Continuous backups and point-in-time recovery settings for the table |
| tags | map[string]string | Tags for the table |
| createdTime | time | Creation time of the table |
| createdTime | time | Deprecated (use `createdAt` instead) |
| createdAt | time | Date and time the table was created |
| deletionProtectionEnabled | bool | Whether deletion protection is enabled |
| globalTableVersion | string | Global table version |
| items | int | Number of items in the table |
Expand Down
3 changes: 2 additions & 1 deletion docs/mql/resources/aws-pack/aws.elb.loadbalancer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ The `aws.elb.loadbalancer` resource provides fields for assessing the configurat
| scheme | string | Scheme for the load balancer: internet-facing or internal |
| attributes | &#91;&#93;dict | A list of attributes for the load balancer |
| vpcId | string | Deprecated: Use `vpc` instead |
| createdTime | time | Date and time when the load balancer was created |
| createdTime | time | Deprecated (use `createdAt` instead) |
| createdAt | time | Date and time the load balancer was created |
| availabilityZones | &#91;&#93;string | Availability zone where the load balancer runs |
| securityGroups | &#91;&#93;[aws.ec2.securitygroup](aws.ec2.securitygroup.md) | VPC security groups for the load balancer |
| hostedZoneId | string | ID of the Amazon Route 53 hosted zone associated with the load balancer |
Expand Down
3 changes: 2 additions & 1 deletion docs/mql/resources/aws-pack/aws.rds.dbcluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ The `aws.rds.dbcluster` resource provides fields for assessing the configuration
| storageIops | int | Storage IOPS provisioned on the cluster |
| storageType | string | Type of storage provisioned on the cluster |
| status | string | Current state of the cluster |
| createdTime | time | Creation date of the RDS cluster |
| createdTime | time | Deprecated (use `createdAt` instead) |
| createdAt | time | Date and time the RDS cluster was created |
| backupRetentionPeriod | int | Number of days automated snapshots are retained |
| autoMinorVersionUpgrade | bool | Whether minor version patches are applied automatically |
| clusterDbInstanceClass | string | Name of the compute and memory capacity class of the cluster database instances |
Expand Down
3 changes: 2 additions & 1 deletion docs/mql/resources/aws-pack/aws.rds.dbinstance.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ The `aws.rds.dbinstance` resource provides fields for assessing the configuratio
| securityGroups | &#91;&#93;[aws.ec2.securitygroup](aws.ec2.securitygroup.md) | List of VPC security group elements that the database instance belongs to |
| status | string | Current state of this database |
| autoMinorVersionUpgrade | bool | Whether minor version patches are applied automatically |
| createdTime | time | Creation date of the RDS instance |
| createdTime | time | Deprecated (use `createdAt` instead) |
| createdAt | time | Date and time the RDS instance was created |
| port | int | Port that the database instance listens on. If the database instance is part of a DB cluster, this can be a different port than the DB cluster port. |
| endpoint | string | Connection endpoint for the database instance |
| masterUsername | string | Master username for the database instance |
Expand Down
3 changes: 2 additions & 1 deletion docs/mql/resources/aws-pack/aws.s3.bucket.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ The `aws.s3.bucket` resource provides fields for assessing the configuration of
| encryption | dict | Bucket encryption configuration |
| publicAccessBlock | dict | Public access block configuration for the bucket |
| exists | bool | Whether the bucket still exists (stale reference) |
| createdTime | time | Date the bucket was created |
| createdTime | time | Deprecated (use `createdAt` instead) |
| createdAt | time | Date and time the bucket was created |

**References**

Expand Down
1 change: 1 addition & 0 deletions docs/mql/resources/github-pack/github.organization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ GitHub organization
| createdAt | time | Create time for the organization |
| updatedAt | time | Update time for the organization |
| totalPrivateRepos | int | Number of private repositories |
| totalPublicRepos | int | Number of public repositories |
| ownedPrivateRepos | int | Number of owned private repositories for the organization |
| privateGists | int | Number of private gists |
| diskUsage | int | Disk usage for the organization |
Expand Down
21 changes: 21 additions & 0 deletions docs/mql/resources/nmap-pack/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Nmap Resource Pack - MQL Resources
id: nmap.pack
sidebar_label: Nmap Resource Pack
displayed_sidebar: MQL
description: The Nmap resource pack lets you use MQL to query and assess the network devices with Nmap.
---

# Mondoo Nmap Resource Pack Reference

The Nmap resource pack lets you use MQL to query and assess the network devices with Nmap.

Resources included in this pack:

| ID | DESCRIPTION |
| ----------------------------------------------------- | ------------------------ |
| [nmap](nmap.md) | Nmap |
| [nmap.host](nmap.host.md) | Nmap host |
| [nmap.network](nmap.network.md) | Nmap network |
| [nmap.port](nmap.port.md) | Nmap port |
| [nmap.versionInformation](nmap.versioninformation.md) | Nmap version information |
32 changes: 32 additions & 0 deletions docs/mql/resources/nmap-pack/nmap.host.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: nmap.host
id: nmap.host
sidebar_label: nmap.host
displayed_sidebar: MQL
description: Nmap host
---

# nmap.host

**Description**

Nmap host

**Init**

nmap.host(name string)

**Fields**

| ID | TYPE | DESCRIPTION |
| --------- | ----------------------------------- | ------------------------------------------- |
| name | string | Name of the host |
| distance | dict | Distance to the host |
| os | dict | Information about the host operating system |
| endTime | time | |
| comment | string | Comments about the host |
| trace | dict | Trace route information |
| addresses | &#91;&#93;dict | Addresses associated with the host |
| hostnames | &#91;&#93;dict | Hostnames associated with the host |
| ports | &#91;&#93;[nmap.port](nmap.port.md) | Ports on the host |
| state | string | State of the host (e.g., up or down) |
Loading

0 comments on commit 55fd3c9

Please sign in to comment.