Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Marketplace UI #31

Merged
merged 2 commits into from
Sep 11, 2024
Merged

Marketplace UI #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45c65cc
chore: update readme and branding color
emmanuelgautier Sep 11, 2024
c0f61c4
chore: add more description about vulnapi project
emmanuelgautier Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 47 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,36 @@
# VulnAPI GitHub Action
<p align="center">
<img src="https://vulnapi.cerberauth.com/logo-ascii-text-art.png" height="150" alt="vulnapi logo">
</p>

Use this action to scan your project for vulnerabilities using the VulnAPI.
---

Find out more about the VulnAPI project at
[https://github.com/cerberauth/vulnapi](https://github.com/cerberauth/vulnapi).
[![Join Discord](https://img.shields.io/discord/1242773130137833493?label=Discord&style=for-the-badge)](https://vulnapi.cerberauth.com/discord)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cerberauth/vulnapi/ci.yml?branch=main&label=core%20build&style=for-the-badge)](https://github.com/cerberauth/vulnapi/actions/workflows/ci.yml)
![Latest version](https://img.shields.io/github/v/release/cerberauth/vulnapi?sort=semver&style=for-the-badge)
[![Github Repo Stars](https://img.shields.io/github/stars/cerberauth/vulnapi?style=for-the-badge)](https://github.com/cerberauth/vulnapi)
![License](https://img.shields.io/github/license/cerberauth/vulnapi?style=for-the-badge)

# VulnAPI: An API Security Vulnerability Scanner

VulnAPI is an Open-Source DAST designed to help you scan your APIs for common
security vulnerabilities and weaknesses.

By using this tool, you can detect and mitigate security vulnerabilities in your
APIs before they are exploited by attackers.

<!-- ![Demo](demo.gif) -->

Use this action to scan your project for vulnerabilities with VulnAPI.

## Vulnerabilities Detected

All the vulnerabilities detected by the project are listed at this URL:
[API Vulnerabilities Detected](https://vulnapi.cerberauth.com/docs/vulnerabilities?utm_source=github&utm_medium=readme).

> More vulnerabilities and best practices will be added in future releases. If
> you have any suggestions or requests for additional vulnerabilities or best
> practices to be included, please feel free to open an issue or submit a pull
> request.

## Example usage

Expand Down Expand Up @@ -42,20 +69,28 @@ jobs:

### Curl Scan Options

| Name | Required | Description | Default |
| ------------ | -------- | ------------------------- | ------- |
| curl_command | true | The curl command to scan. | |
| Name | Required | Description | Default |
| ---- | -------- | ------------------------- | ------- |
| curl | false | The curl command to scan. | |

### OpenAPI Scan Options

| Name | Required | Description | Default |
| ----------- | -------- | ---------------- | ------- |
| openapi_url | true | The URL to scan. | |
| Name | Required | Description | Default |
| ------- | -------- | --------------------------------------- | ------- |
| openapi | false | The OpenAPI file location (path or URL) | |

## Outputs

No outputs.
Scan results are output to the console.

## Disclaimer

This scanner is provided for educational and informational purposes only. It
should not be used for malicious purposes or to attack any system without proper
authorization. Always respect the security and privacy of others.

## License

This project is licensed under the [MIT License](./LICENSE).
This repository is licensed under the
[MIT License](https://github.com/cerberauth/vulnapi-action/blob/main/LICENSE) @
[CerberAuth](https://www.cerberauth.com/).
6 changes: 3 additions & 3 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: 'VulnAPI Action'
description:
"GitHub Action to use CerberAuth's VulnAPI to check for vulnerabilities in
your API"
'VulnAPI is an open-source project designed to help you scan your APIs for
common security vulnerabilities and weaknesses.'
author: 'CerberAuth'
branding:
icon: 'shield'
color: 'purple'
color: 'gray-dark'

inputs:
version:
Expand Down
Loading