Skip to content

Commit

Permalink
Fixing broken links and example for SecGPT llama-pack (run-llama#14114)
Browse files Browse the repository at this point in the history
* Include SecGPT

* Update SecGPT pack

* add build files

* make SecGPT

* Include unit test for SecGPT

* Update SecGPT package

* fix typo

* fix tests

* Update SecGPTPack

* Fixing broken links (https://llamahub.ai/l/llama-packs/llama-index-packs-secgpt?from=llama-packs) and adding pip dependencies for the example notebook.

---------

Co-authored-by: Yuhao-W <[email protected]>
Co-authored-by: Andrei Fajardo <[email protected]>
Co-authored-by: Yuhao Wu <[email protected]>
Co-authored-by: Andrei Fajardo <[email protected]>
  • Loading branch information
5 people authored Jun 14, 2024
1 parent d6e74b5 commit f8dff84
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
33 changes: 31 additions & 2 deletions llama-index-packs/llama-index-packs-secgpt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,37 @@

SecGPT is an LLM-based system that secures the execution of LLM apps via isolation. The key idea behind SecGPT is to isolate the execution of apps and to allow interaction between apps and the system only through well-defined interfaces with user permission. SecGPT can defend against multiple types of attacks, including app compromise, data stealing, inadvertent data exposure, and uncontrolled system alteration. The architecture of SecGPT is shown in the figure below. Learn more about SecGPT in our [paper](https://arxiv.org/abs/2403.04960).

<p align="center"><img src="./examples/architecture.bmp" alt="workflow" width="400"></p>
<p align="center">
<img src="https://raw.githubusercontent.com/run-llama/llama_index/main/llama-index-packs/llama-index-packs-secgpt/examples/architecture.bmp" alt="Architecture" width="400">
</p>

We develop SecGPT using [LlamaIndex](https://www.llamaindex.ai/), an open-source LLM framework. We use LlamaIndex because it supports several LLMs and apps and can be easily extended to include additional LLMs and apps. We implement SecGPT as a personal assistant chatbot, which the users can communicate with using text messages.

A comprehensive notebook guide is available [here](./examples/SecGPT.ipynb). In the meantime, you can explore its features by comparing the execution flows of SecGPT and VanillaGPT (a non-isolated LLM-based system defined [here](./examples/VanillaGPT.ipynb)) in response to the same query.
A comprehensive notebook guide is available [here](https://github.com/run-llama/llama_index/blob/main/llama-index-packs/llama-index-packs-secgpt/examples/SecGPT.ipynb). In the meantime, you can explore its features by comparing the execution flows of SecGPT and VanillaGPT (a non-isolated LLM-based system defined [here](https://github.com/run-llama/llama_index/blob/main/llama-index-packs/llama-index-packs-secgpt/examples/VanillaGPT.ipynb)) in response to the same query.

SecGPT original GitHub repository link: [https://github.com/llm-platform-security/SecGPT](https://github.com/llm-platform-security/SecGPT)

If you build on this work, considering citing our paper:

## Citation

```plaintext
@article{wu2024secgpt,
title={{SecGPT: An Execution Isolation Architecture for LLM-Based Systems}},
author={Wu, Yuhao and Roesner, Franziska and Kohno, Tadayoshi and Zhang, Ning and Iqbal, Umar},
journal={arXiv preprint arXiv:2403.04960},
year={2024},
}
```

## Contribution and Support

We welcome contributions to the project, e.g., through pull requests to the [original GitHub repo](https://github.com/llm-platform-security/SecGPT). Please also feel free to reach out to us if you have questions about the project and if you would like to contribute.

## Research Team

[Yuhao Wu](https://yuhao-w.github.io) (Washington University in St. Louis)
[Franziska Roesner](https://www.franziroesner.com/) (University of Washington)
[Tadayoshi Kohno](https://homes.cs.washington.edu/~yoshi/) (University of Washington)
[Ning Zhang](https://cybersecurity.seas.wustl.edu/) (Washington University in St. Louis)
[Umar Iqbal](https://umariqbal.com) (Washington University in St. Louis)
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
"metadata": {},
"outputs": [],
"source": [
"#!pip install dirtyjson==1.0.8 jsonschema==4.21.1 llama-index-core==0.10.30 llama-index-llms-openai==0.1.10 langchain_core==0.1.45 pyseccomp==0.1.2 tldextract==5.1.1"
"# !pip install dirtyjson==1.0.8 jsonschema==4.21.1 llama-index-core==0.10.30 llama-index-llms-openai==0.1.10 langchain_core==0.1.45 pyseccomp==0.1.2 tldextract==5.1.1 llama-index-packs-secgpt"
]
},
{
Expand Down

0 comments on commit f8dff84

Please sign in to comment.