Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cgulliver committed Sep 5, 2023
1 parent b3634e8 commit dd89a93
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ This solution contains a test environment AWS CloudFormation stack that you can

1. Creates two EC2 instances running [Amazon Linux](https://aws.amazon.com/amazon-linux-ami/) with an [AWS Identity and Access Management (IAM)](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) role for CloudWatch Logs access. Note: In order to provide sample HIDS alert data, the two EC2 instances are configured automatically to generate simulated HIDS alerts locally.
2. Installs and configures OSSEC, the [CloudWatch Logs agent](http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/QuickStartEC2Instance.html), and additional packages used for the test environment.
3. Creates the target HIDS Amazon ES domain.
3. Creates the target HIDS Amazon OpenSearch domain.
4. Creates the target HIDS CloudWatch Logs group.
5. Creates the Lambda function and CloudWatch Logs Subscription in order to send HIDS alerts to Amazon ES.
5. Creates the Lambda function and CloudWatch Logs Subscription in order to send HIDS alerts to Amazon OpenSearch.

### How the Solution Works
1. On the target EC2 instances, the OSSEC HIDS generates alerts that the CloudWatch Logs agent captures. The HIDS performs log analysis, integrity checking, Windows registry monitoring, rootkit detection, realtime alerting, and active response. For more information, see [Getting started with OSSEC](http://ossec.github.io/docs/manual/non-technical-overview.html).
2. The CloudWatch Logs group receives the alerts as events.
3. A CloudWatch Logs subscription is applied to the target log group to forward the events through AWS Lambda to Amazon ES.
3. A CloudWatch Logs subscription is applied to the target log group to forward the events through AWS Lambda to Amazon OpenSearch.
4. Amazon OpenSearch loads the logged alert data.
5. OpenSearch visualizes the alerts in near real time. OpenSearch Dashboards is an open-source visualization tool designed to work with OpenSearch. Amazon OpenSearch Service provides an installation of OpenSearch Dashboards with every OpenSearch Service domain.

Expand All @@ -30,8 +30,8 @@ You also must provide a trusted source IP address or CIDR block for access to th

1. HIDSInstanceSize:
EC2 instance size for test server
2. ESInstanceSize:
Elasticsearch instance size
2. OpenSearchInstanceSize:
OpenSearch instance size
In region S3 key for Lambda zipped deployment package
3. VPCId:
An Amazon VPC into which to deploy the solution
Expand All @@ -40,10 +40,10 @@ A SubnetId with outbound connectivity within the VPC you selected (requires Inte
4. AssignPublicIP:
Set to true if your subnet is configured to connect through an Internet gateway; set to false if your subnet is configured to connect through a NAT gateway
5. MyTrustedNetwork:
Your trusted source IP or CIDR block that is used to whitelist access to the EC2 instances and the Amazon ES endpoint
Your trusted source IP or CIDR block that is used to whitelist access to the EC2 instances and the Amazon OpenSearch endpoint


If you already have a VPC Subnet configured with internet access, you can launch the stack using the [CloudFormation Template](https://raw.githubusercontent.com/awslabs/hids-cloudwatchlogs-elasticsearch-template/master/cloudformation/hids-cwl-es.template).
If you already have a VPC Subnet configured with internet access, you can launch the stack using the [CloudFormation Template](https://raw.githubusercontent.com/awslabs/hids-cloudwatchlogs-elasticsearch-template/master/cloudformation/hids-cwl-opensearch.template).

### Thanks
Thanks to the [OSSEC Project Team](http://ossec.github.io/about.html#ossec-team) for authoring the OSSEC HIDS.
Expand Down

0 comments on commit dd89a93

Please sign in to comment.