https://github.com/jfrog/xray-aws-security-hub
JFrog Xray's integration brings Xray’s security and license violations intel inside AWS Security Hub.
https://github.com/jfrog/xray-aws-security-hub
aws aws-sam aws-sam-cli aws-security-hub javascript jfrog jfrog-xray lambda-functions
Last synced: 7 months ago
JSON representation
JFrog Xray's integration brings Xray’s security and license violations intel inside AWS Security Hub.
- Host: GitHub
- URL: https://github.com/jfrog/xray-aws-security-hub
- Owner: jfrog
- License: apache-2.0
- Created: 2022-07-06T21:01:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T19:42:52.000Z (over 1 year ago)
- Last Synced: 2024-10-30T23:12:32.795Z (over 1 year ago)
- Topics: aws, aws-sam, aws-sam-cli, aws-security-hub, javascript, jfrog, jfrog-xray, lambda-functions
- Language: JavaScript
- Homepage: https://jfrog.com/help/r/jfrog-integrations-documentation/xray-integration-with-aws-security-hub
- Size: 745 KB
- Stars: 2
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Xray AWS Security Hub Integration
This project contains source code and supporting files for a serverless application that you can deploy with the SAM CLI. It includes the following files and folders.
- authorizer - Code for the application's Lambda function for API Gateway authorizer.
- eventProcessor - Code for the application's Lambda function for processing Xray webhook event.
- issueProcessor - Code for the application's Lambda function for processing Xray webhook issues in each event.
- transformer - Code for the application's Lambda function for transforming Xray webhook issue into ASFF finding and import them into Security Hub.
- events - Invocation events that you can use to invoke the functions.
- envs - Environment variable files for testing the functions.
- template.yaml - A template that defines the application's AWS resources.
The application uses several AWS resources, including Lambda functions and an API Gateway API. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code.
If you prefer to use an integrated development environment (IDE) to build and test your application, you can use the AWS Toolkit.
The AWS Toolkit is an open source plug-in for popular IDEs that uses the SAM CLI to build and deploy serverless applications on AWS. The AWS Toolkit also adds a simplified step-through debugging experience for Lambda function code. See the following links to get started.
* [CLion](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [GoLand](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [IntelliJ](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [WebStorm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [Rider](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [PhpStorm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [PyCharm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [RubyMine](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [DataGrip](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [VS Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/welcome.html)
* [Visual Studio](https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/welcome.html)
## Deploy the application
The Serverless Application Model Command Line Interface (SAM CLI) is an extension of the AWS CLI that adds functionality for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that matches Lambda. It can also emulate your application's build environment and API.
To use the SAM CLI, you need the following tools.
* SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
* Node.js - [Install Node.js 16](https://nodejs.org/en/), including the NPM package management tool.
* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community)
To build and deploy your application for the first time, run the following in your shell:
```sh
sam build
sam deploy --guided
```
The first command will build the source of your application. The second command will package and deploy your application to AWS, with a series of prompts:
* **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region, and a good starting point would be something matching your project name.
* **AWS Region**: The AWS region you want to deploy your app to.
* **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual review. If set to no, the AWS SAM CLI will automatically deploy application changes.
* **Allow SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command.
* **Save arguments to samconfig.toml**: If set to yes, your choices will be saved to a configuration file inside the project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application.
**Beware** that when `DeploymentEnvironment` parameter is set to `dev`, full HTTP requests/responses data are sent to CloudWatch Logs. This include the API authorization token (if set). You can manually switch this off with API Gateway Stage's 'Log full requests/responses data' setting.
You can find your API Gateway Endpoint URL in the output values displayed after deployment.
### Deploy into VPC
If the application is required to be deployed in private VPC, it should be created and managed separately. There are several ways of doing that -
in the console, using separate CFT or adding VPC resource to the SAM template directly. Check the following examples for the reference:
- [JFrog CFT VPC template example](https://github.com/aws-quickstart/quickstart-jfrog-artifactory/blob/main/templates/jfrog-ami-vpc.template.yaml).
- [AWS CFT VPC examples](https://github.com/awslabs/aws-cloudformation-templates/tree/master/aws/services/VPC).
When VPC and VPC endpoint are created, please add following configuration to `AWS::Serverless::Api` resource:
```yaml
EndpointConfiguration:
Type: PRIVATE
VPCEndpointIds:
- vpce-123a123a
- vpce-321a321a
```
[AWS documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-endpointconfiguration.html) for endpoint configuration.
### Uninstall the application with SAM CLI
Run `sam delete` to delete the application.
**Note:** S3 bucket and DynamoDB, created by the application, won't be deleted automatically and require to be removed manually.
## Package and Publish the application
Create a new S3 bucket (`jfrog-xray-aws-security-hub`) to store the SAM build artifact:
```sh
aws cloudformation create-stack --stack-name xray-aws-security-hub-bucket --template-body file://cfts/serverless-application-repository-s3.yml --region us-west-1
```
You can use `--parameters` option to override the S3 bucket name:
```sh
aws cloudformation create-stack --stack-name xray-aws-security-hub-bucket --template-body file://cfts/serverless-application-repository-s3.yml --region us-west-1 --parameters ParameterKey=S3BucketName,ParameterValue=some-other-bucket-name
```
Update Serverless Repository application version in `Metadata::AWS::ServerlessRepo::Application::SemanticVersion` and `Globals::Function::Environment::Variables::APP_VERSION` in `template.yaml`
Use the SAM CLI to first build and package this application then [publish it to Serverless Application Repository](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-publishing-applications.html#serverless-sam-template-publishing-applications-prerequisites)
> [!IMPORTANT]
> Make sure you are using the JFrog Seller account (595206835686) credential for publishing the application.
```sh
sam build
sam package --output-template-file packaged.yaml --s3-bucket jfrog-xray-aws-security-hub-1 --region us-west-1
sam publish --template packaged.yaml --region us-west-1
```
## Use the SAM CLI to build and test locally
Build your application with the `sam build` command.
```sh
sam build
```
The SAM CLI installs dependencies defined in each Lambda's `package.json`, creates a deployment package, and saves it in the `.aws-sam/build` folder.
Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project.
Run functions locally and invoke them with the `sam local invoke` command. e.g.
```sh
sam local invoke EventProcessorFunction --event events/eventProcessor/xray_license_issues_payload_string.json -n envs/test.json --region us-west-2
```
The region must match the region for the SQS queue (defined in env var json file).
For security reason, only a sample env var file (`envs/sample.json`) is provided in this repo. Make your own copy from it and fill in appropriate values for your test environment.
The SAM CLI can also emulate your application's API. Use the `sam local start-api` to run the API locally on port 3000.
```sh
sam local start-api
curl http://localhost:3000/
```
The SAM CLI reads the application template to determine the API's routes and the functions that they invoke. The `Events` property on each function's definition includes the route and method for each path.
```yaml
EventProcessorFunction:
Properties:
Events:
ProcessCallPayload:
Type: Api
Properties:
Path: /send
Method: post
```
## Fetch, tail, and filter Lambda function logs
To simplify troubleshooting, SAM CLI has a command called `sam logs`. `sam logs` lets you fetch logs generated by your deployed Lambda function from the command line. In addition to printing the logs on the terminal, this command has several nifty features to help you quickly find the bug.
`NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using SAM.
```sh
sam logs -n EventProcessorFunction --stack-name xray-aws-security-hub --tail
```
You can find more information and examples about filtering Lambda function logs in the [SAM CLI Documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-logging.html).
## Cleanup
To delete the sample application that you created, use the AWS CLI. Assuming you used your project name for the stack name, you can run the following:
```sh
aws cloudformation delete-stack --stack-name xray-aws-security-hub
```
## Resources
See the [AWS SAM developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) for an introduction to SAM specification, the SAM CLI, and serverless application concepts.
Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples and learn how authors developed their applications: [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/)