Skip to content

Latest commit

 

History

History
 
 

s3_enable_access_logging

README.md

Enable S3 Access Logging

This job enables Access Logging for an S3 Bucket. It checks for a target bucket with name "vss-logging-target-{cloud_account_id}-{region}", if the bucket exists then it gives log delivery permissions to that bucket and then stores the logs into it. If the bucket does not exist then it creates one.

Applicable Rule

Rule ID:
  • 5c8c265e7a550e1fb6560c67
  • 5c8c265c7a550e1fb6560c63
Rule Name:
  • S3 access logging is not enabled
  • Access logging is not enabled for CloudTrail S3 buckets

Getting Started

Prerequisites

The provided AWS credential must have access to s3:PutBucketLogging, s3:CreateBucket, s3:GetBucketAcl, s3:PutBucketAcl, s3:ListBucket and s3:PutEncryptionConfiguration.

You may find the latest example policy file here

Running the script

You may run this script using following commands:

  pip install -r ../../requirements.txt
  python3 s3_enable_access_logging.py

Running the tests

You may run test using following command under vss-remediation-worker-job-code-python directory:

    python3 -m pytest test

Deployment

  1. Provision a Virtual Machine Create an EC2 instance to use for the worker. The minimum required specifications are 128 MB memory and 1/2 Core CPU.
  2. Setup Docker Install Docker on the newly provisioned EC2 instance. You can refer to the docs here for more information.
  3. Deploy the worker image SSH into the EC2 instance and run the command below to deploy the worker image:
  docker run --rm -it --name worker \
  -e VSS_CLIENT_ID={ENTER CLIENT ID}
  -e VSS_CLIENT_SECRET={ENTER CLIENT SECRET} \
  vmware/vss-remediation-worker:latest-python

Contributing

The Secure State 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.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • VMware Secure State - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License - see the LICENSE file for details