Skip to content

vmware-samples/secureclouds-remediation-jobs

Repository files navigation

VMware Aria Automation for Secure Clouds Remediation Jobs

License

Table of Contents

Abstract

These jobs represent open-sourced remediation jobs to be used in conjunction with the VMware Aria Automation for Secure Clouds remediation worker for python. In order to make use of this code, you must utilize the worker and have a VMware Aria Automation for Secure Clouds worker group properly set up.

Quick Start Guide

There are a couple conventions that must be followed in order to contribute working jobs to this repository:

  • The directory structure and
  • The file names

Each job must be entire self-contained within a directory, which is where the job gets its name from. For example, a directory by the name of s3-remove-public-access will result in a job called s3-remove-public-access

In order to execute a python job, the file must be named the same as the directory with a .py extension. For example, the job s3-remove-public-access must have a s3-remove-publc-access.py file within that directory.

The requirements.txt file and the constraints.txt file are optional but recommended. This ensures the worker can install the requirements in a repeatable fashion, which ensures the VMware Aria Automation for Secure Clouds application will not invalidate jobs due to new requirements being installed.

Job execution

When the worker runs, all requirements found in the (optional) requirements.txt and constraints.txt files will be installed relative to the job directory. When the job is executed, the python runtime is restricted to the requirements in that relative path. This ensures all code being executed is known to the VMware Aria Automation for Secure Clouds worker and can be verified via checksum. The worker also moves the entire folder to a separate working directory to ensure local imports will not work.

The worker executes jobs in a fashion similar to running python ./s3-remove-publc-access/s3-remove-publc-access.py {... finding payload json ...}

The finding payload is in the form:

{
  "notificationInfo": {
    "CloudAccountID" : <string>,
    "RuleID": <string>,
    "RuleName": <string>,
    "RuleDisplayName": <string>,
    "Level": <string>,
    "Service": <string>,
    "FindingInfo": {
      "FindingId": <string>,
      "ObjectId": <string>,
      "ObjectChain": <string>,
      "CloudTags": {
        "<key1>": "<value1>",
        "<key2>": "<value2>",
      },
      "RiskScore": <integer>,
      "Region": <string>,
      "Service": <string>
    }
  },
  "autoRemediate": <boolean>
}

Logging

All stdout and stderr logs are sent to the VMware Aria Automation for Secure Clouds web application for display in the user interface. Take care when logging and make sure not to log sensitive data.

Supported Remediation Jobs

The table below lists all the supported jobs with their links.

Azure Remediation Jobs

Sr.No. Rule Id Rule Name Job
1. 5c8c26997a550e1fb6560cd9 Blob container has public read access enabled azure-blob-remove-public-access
2. 5c8c26687a550e1fb6560c72 Logging For Keyvault Enabled azure-key-vault-logging-for-keyvault-enabled
3. 5c8c26847a550e1fb6560cab Network security group should restrict SSH port (22) from public access azure-network-security-group-close-port-22
4. 5c8c267e7a550e1fb6560c9c Network security group should restrict Remote Desktop port (3389) from public access azure-network-security-group-close-port-3389
5. 3abf3147-ea53-4302-b237-caab4d764c77 DDoS Protection Standard should be enabled azure-security-center-enable-ddos-protection
6. 5c8c268a7a550e1fb6560cb9 SQL Server Auditing should be enabled azure-sql-auditing-on-server
7. 5c8c268d7a550e1fb6560cc0 SQL data encryption should be enabled azure-sql-data-encryption-on
8. 5c8c26947a550e1fb6560cce SQL server should have Azure Defender for SQL enabled azure-sql-threat-detection-on-server
9. 5c8c269a7a550e1fb6560cdb Storage account is not configured to allow HTTPS-only traffic azure-storage-account-allow-https-traffic-only
10. 99d645b8-aa87-11ea-bb37-0242ac130002 Storage account is publicly accessible azure-storage-default-network-access-deny
11. 02b672b7-a590-4434-8188-19325b2d1864 Storage account encryption at rest is not configured with customer-managed key (CMK) azure-storage-encryption-at-rest-not-configured-with-customer-managed-key
12. 643eb5fc-7747-4df4-b217-41c4e97e0c07 Storage account blob service is not configured with soft delete azure-storage-soft-delete-not-enabled
13. d7a3ad03-860c-4928-9ba8-789e84a835be Virtual machine scale set VMs are publicly accessible to the internet via SSH port (22) azure-vm-close-port-22
14. 5c8c26677a550e1fb6560c6e An encryption key has no scheduled expiration azure-key-vault-expiry-date-set-for-all-keys
15. 5c8c26687a550e1fb6560c70 A Key Vault secret has no scheduled expiration azure-key-vault-expiry-date-set-for-all-secrets
16. e2090e34-3580-4088-a815-2ead6a72700f Key Vault should be recoverable azure-key-vault-is-recoverable
17. 677cbf2f-3096-4111-af16-05da43d95d80 MySQL server should have Enforce SSL connection enabled azure-mysql-enforce-ssl-connection-enable
18. e25a319c-0ca7-4e6a-b4b9-19beba480b3b PostgreSQL server should have Enforce SSL connection enabled azure-postgresql-enforce-ssl-connection-enable
19. 5c8c26977a550e1fb6560cd6 SQL server should have Advanced Threat Protection types set to all azure-sql-threat-detection-types-all-server
20. 7ba94354-ab4c-11ea-bb37-0242ac130002 Storage account is not configured to have access from trusted Microsoft services azure-storage-trusted-microsoft-services-access-enabled
21. 7406e56f-bbf0-4571-8e50-21bd344e0fdb SQL server should have TDE protector encrypted with customer-managed key azure-sql-tde-protector-encrypted-cmk
22. 9b7b5a71-5eaa-4418-a6b0-17f796e8ebaa PostgreSQL server access from Azure services should be disabled azure-postgresql-allow-access-to-azure-service-disabled
23. 4e27676b-7e87-4e2e-b756-28c96ed4fdf8 Network security group should restrict public access to UDP ports azure-security-udp-access-restricted-from-internet

AWS Remediation Jobs

Sr.No. Rule Id Rule Name Remediation Job Link
1. 5c8c26417a550e1fb6560c3f EC2 instance should restrict public access to SSH port (22) ec2-close-port-22
2. 5c8c26437a550e1fb6560c42 EC2 security group should restrict public access to Remote Desktop port (3389) ec2-close-port-3389
3. 657c46b7-1cd0-4cce-80bb-9d195f49c987 Elastic Load Balancer access logs are not enabled elb-enable-access-logs
4. 5c8c264a7a550e1fb6560c4d The RDS backup retention period is less than 30 days rds-backup-retention-30-days
5. 5c8c265e7a550e1fb6560c67 S3 access logging should be enabled s3-enable-access-logging
6. 1d187035-9fff-48b2-a7c3-ffc56a4da5e6 S3 bucket default encryption should be enabled s3-enable-default-encryption
7. 5c8c26507a550e1fb6560c57 S3 bucket should restrict full public access s3-remove-public-access
8. 5c8c26517a550e1fb6560c59 S3 bucket should restrict public read access s3-remove-public-access
9. 5c8c26537a550e1fb6560c5a S3 bucket should restrict public read ACL access s3_remove_public_access
10. 5c8c26537a550e1fb6560c5b S3 bucket should restrict public write access s3-remove-public-access
11. 5c8c26547a550e1fb6560c5c S3 bucket should restrict public write ACL access s3-remove-public-access
12. 5c8c26637a550e1fb6560c6b S3 bucket policy should restrict public get access s3-remove-public-access
13. 5c8c26617a550e1fb6560c69 S3 bucket policy should restrict full public access s3-remove-public-access
14. 5c8c25ec7a550e1fb6560bbe EC2 security group should restrict public access to SSH port (22) security-group-close-port-22
15. 5c8c25ef7a550e1fb6560bc4 EC2 instance should restrict public access to Remote Desktop port (3389) security-group-close-port-3389
16. 5c8c25f07a550e1fb6560bc6 EC2 instance should restrict public access to PostgreSQL server port (5432) security-group-close-port-5432
17. 5c8c25e47a550e1fb6560bac CloudTrail logs should be encrypted aws-cloudtrail-logs-encrypted
18. 5c8c26217a550e1fb6560c12 KMS automated key rotation is not enabled aws-kms-key-rotates
19. 5c8c265c7a550e1fb6560c63 CloudTrail S3 buckets should have access logging enabled s3-enable-access-logging
20. 5c8c265d7a550e1fb6560c65 CloudTrail S3 buckets should restrict access to required users aws-s3-cloudtrail-public-access
21. 688d093c-3b8d-11eb-adc1-0242ac120002 S3 bucket should allow only HTTPS requests aws-s3-bucket-policy-allow-https
22. 09639b9d-98e8-493b-b8a4-916775a7dea9 SQS queue policy should restricted access to required users aws-sqs-queue-publicly-accessible
23. 1ec4a1f2-3e08-11eb-b378-0242ac130002 Network ACL should restrict administration ports (3389 and 22) from public access aws-ec2-administration-ports-ingress-allowed
24. ce603728-d631-4bae-8657-c22da6e5944e Kinesis data stream should be encrypted kinesis-encrypt-stream
25. 5c8c263d7a550e1fb6560c39 EC2 instance should restrict public access to FTP data port (20) ec2-close-port-20
26. 4823ede0-7bed-4af0-a182-81c2ada80203 EC2 instance should restrict public access to Kibana (5601) ec2-close-port-5601
27. 5c8c26427a550e1fb6560c41 EC2 instance should restrict public access to MySQL server port (3306) ec2-close-port-3306
28. 5c8c26417a550e1fb6560c3e EC2 instance should restrict public access to Oracle SQL port (1521) ec2-close-port-1521
29. 5c8c26417a550e1fb6560c3d EC2 instance should restrict public access to SQL Server port (1433) ec2-close-port-1433
30. 5c8c263e7a550e1fb6560c3b EC2 instance should restrict public access to Telnet port (23) ec2-close-port-23
31. 5c8c263d7a550e1fb6560c3a EC2 instance should restrict public access to FTP port (21) ec2-close-port-21
32. 04700175-adbe-49e1-bc7a-bc9605597ce2 EC2 instance should restrict public access to Elasticsearch ports (9200,9300) ec2-close-port-9200_9300
33. 5c8c26427a550e1fb6560c40 EC2 instance should restrict public access to MongoDB port (27017) ec2-close-port-27017
34. 5c8c26407a550e1fb6560c3c EC2 instance should restrict public access to TCP port (8080) ec2-close-port-8080
35. 5c8c26447a550e1fb6560c44 EC2 instance should restrict public access to Redshift port (5439) ec2-close-port-5439
36. 2cdb8877-7ac3-4483-9ed0-1e792171d125 EBS volume snapshot should be private ebs-private-snapshot
37. 5c8c26467a550e1fb6560c48 RDS instance should restrict public access rds-remove-public-endpoint
38. 5c8c264a7a550e1fb6560c4c RDS should have automatic minor version upgrades enabled rds-enable-version-update
39. 5c8c25f37a550e1fb6560bca EC2 VPC default security group should restrict all access aws-ec2-default-security-group-traffic
40. 5c8c260b7a550e1fb6560bf4 IAM password policy should set a minimum length aws-iam-password-policy-min-length
41. 5c8c26107a550e1fb6560bfc IAM password policy should prevent password reuse aws-iam-password-reuse-prevention
42. 7fe4eb28-3b82-11eb-adc1-0242ac120002 IAM server certificates that are expired should be removed aws-iam-server-certificate-expired
43. bd9d77b6-635d-4e06-9760-8957d8eaeb38 EC2 instance should restrict public access to Memcache UDP port (11211) aws_ec2_close_port_11211
44. 5c8c26487a550e1fb6560c4a RDS snapshot should restrict public access aws-rds-snapshot-remove-publicaccess
45. 5c8c26567a550e1fb6560c5d S3 bucket should not give full access to all authenticated users aws_s3_remove_fullaccess_authenticatedusers

Contributing

The VMware Aria Automation for Secure Clouds team welcomes welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

For more detailed information, refer to CONTRIBUTING.md.

Repository Administrator Resources

Board Members

Board members are volunteers from the community and VMware staff members, board members are not held responsible for any issues which may occur from running of samples from this repository.

Members:

  • Paul Allen (VMware)

VMware Resources

Feedback

If you find a bug, please open a GitHub issue.

About

Secure State team and its customers can contribute with remediation rules and build a community around it

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages