Skip to content

Commit

Permalink
Merge pull request #29 from bosch-aisecurity-aishield/bugfix/security…
Browse files Browse the repository at this point in the history
…-vulnerability

chore: Update dependencies and remove unused files
  • Loading branch information
Avphadke authored Oct 25, 2024
2 parents ba00a12 + 477f538 commit 1e7c095
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 277 deletions.
32 changes: 0 additions & 32 deletions Dockerfile

This file was deleted.

56 changes: 2 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@ further enhances its market standing by providing advanced security solutions.
- [Prerequisite](#prerequisite)
- [Inspect Jupyter Notebooks and Model Using](#prerequisite)
- [CLI](#cli)
- [UI](#ui)
- [UI-Docker](#ui-docker)
- [Playground](#playground)
- [Reports](#reports)
- [Features](#features)
- [Benefits](#benefits)
Expand All @@ -53,8 +50,7 @@ For using AIShield Watchtower, clone Watchtower repo. Install prerequisites and

### Prerequisites

- For running Watchtower in CLI or UI version, python3 and pip should be installed in the host system.
- For running UI-Docker version, docker and docker-compose should be installed in the host system. For docker users, refer [UI-Docker](#ui-docker)
- For running Watchtower in CLI, python3 and pip should be installed in the host system.

Cloning Watchtower repo

Expand Down Expand Up @@ -127,58 +123,12 @@ python watchtower.py --repo_type=folder --path=<Enter path of Folder>

---

#### UI

For using Watchtower UI, execute following command

```python
python watchtower_webapp.py
```

open browser and paste: <http://localhost:5015/watchtower-aishield>

![Watchtower UI](./img/AIShield_watchtower_UI.gif)

---

#### UI-Docker

For using Watchtower UI, build docker image for Watchtower and run Watchtower image

```bash
cd watchtower
docker-compose build
docker-compose up
```

open browser and paste: <http://localhost:5015/watchtower-aishield>

On successful completion of scan, Watchtower vulnerability reports will be available in reports folder in Watchtower root folder.

For stopping and removing Watchtower image execute following

```bash
docker-compose down
```

---

### Playground

For quick getting started, you may try Watchtower Playground by visiting <https://app-watchtower.boschaishield.com>

In the Watchtower Playground, users can scan Notebooks and AI/ML models available in public Github Repos by providing public Github Repo URL. After completion of vulnerability scan, reports will be available to download in the Playground screen.

## Reports

On successful completion of the Watchtower scan, three reports will be generated in the following path :

- For CLI Mode - all three reports will be available inside the Watchtower src folder. Users may refer last line of the summary report in the console for the complete path of the reports location

- For UI Mode - all three will be reports will be available inside the Watchtower src folder. Users may refer to the success message on the UI to get the path of the reports location

- For UI-Docker Mode - all three reports will be available inside the Watchtower reports folder. Users may refer to the success message on the UI to get the path of the reports location

01. Summary Report - In summary report will provide information on number of model files and notebook files detected, Number of vulnerabilities detected and Count of those vulnerabilities mapped to Critical, High, Medium and low. Sample snippet of Summary Report:

```json
Expand Down Expand Up @@ -234,7 +184,6 @@ On successful completion of the Watchtower scan, three reports will be generated
- **Scanning**:Executes thorough scans of the models and notebooks to detect potential safety and security concerns.
- **Report Generation**: Produces comprehensive reports that classify the scanned files containing "low," "medium,", "high" and "critical" risk.
- **Supported Repositories** : AIShield Watchtower supports integration with GitHub and AWS S3 buckets, allowing for automated scanning of Git repositories and AWS S3 buckets to identify potential risks.
- **User Interface (UI)**: Offers an intuitive user interface for conducting repository scans.

---

Expand Down Expand Up @@ -293,8 +242,7 @@ On successful completion of the Watchtower scan, three reports will be generated

1. Repositories cloned from GitHub and Hugging Face during watchtower analysis will not be automatically removed
post-analysis. It is advisable to manually delete these folders found within the 'src' directory.


2. The Docker and UI versions of the playground, previously available, have been removed due to a reported [security issue](https://github.com/bosch-aisecurity-aishield/watchtower/issues/28). While these features may be reintroduced in future updates, developers are encouraged to extend the application to create their own UI and Docker deployments.
---

## Contribution
Expand Down
17 changes: 0 additions & 17 deletions docker-compose.yml

This file was deleted.

Binary file removed img/AIShield_watchtower_UI.gif
Binary file not shown.
Binary file removed img/AIShield_watchtower_ui.png
Binary file not shown.
16 changes: 8 additions & 8 deletions src/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ tensorflow==2.15.0
flask==3.0.2
waitress==3.0.0
jupyterlab==4.1.1
safety==3.0.1
detect-secrets==1.4.0
presidio-analyzer==2.2.353
whispers==2.2.0
GitPython==3.1.42
safety==3.2.8
detect-secrets==1.5.0
presidio-analyzer==2.2.355
whispers==2.2.1
GitPython==3.1.43
boto3==1.34.43
tqdm==4.66.3
flask_restx==1.3.0
flask_cors==4.0.0
torch==2.3.0
torch==2.5.0
safetensors==0.4.2
transformers==4.38.2
picklescan==0.0.16
transformers==4.45.2
picklescan==0.0.17
166 changes: 0 additions & 166 deletions src/watchtower_webapp.py

This file was deleted.

0 comments on commit 1e7c095

Please sign in to comment.