diff --git a/DEVELOP.md b/DEVELOP.md new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 19c1689..ef38cbd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,65 @@ -# duefuse -duefuse🔩: Data Usage Enforcement Filesystem in Userspace +

duefuse🔩: 基于FUSE的数据使用控制执行点

+

+pre-commit.ci status +LICENSE +Releases +Pre Releases +Last Commit +

+ +

+中文 | English +

+ +## 简介 + +> duefuse是DataUCON项目中的组件之一,DataUCON项目旨在为数据使用控制提供支持。[了解DataUCON](https://dataucon.idslab.io/)。 + +duefuse🔩是一个基于[FUSE](https://www.kernel.org/doc/html/next/filesystems/fuse.html)的数据使用控制执行点,它可以对接任何可信数据格式引擎,或直接对接决策执行点,以实现对客户端数据访问的控制。 + + + +在[ABAUC控制模型](https://github.com/hitsz-ids/dataucon)当中,duetector可作为PEP(Policy Enforcement Point)来拦截用户请求,与可信数据格式引擎、PDP(Policy Decision Point)等其他组件通信以决定是否允许用户请求。 + +## 目录 + +- [主要特性](#主要特性) +- [安装](#安装) +- [快速开始](#快速开始) +- [API文档](#API文档) +- [维护者](#维护者) +- [如何贡献](#如何贡献) +- [许可证](#许可证) + +## 主要特性 + +TBD + + +## 安装 + +TBD + +## 快速开始 + +TBD + +更多文档和例子可以在[这里](./docs/)找到。 + +## API文档 + +TBD + +## 维护者 + +本项目由**哈尔滨工业大学(深圳)数据安全研究院**发起,若您对本项目以及DataUCON项目感兴趣并愿意一起完善它,欢迎加入我们的开源社区。 + +## 如何贡献 + +非常欢迎你的加入![提一个 Issue](https://github.com/hitsz-ids/duefuse/issues/new) 或者提交一个 Pull Request。 + +开发环境配置和其他注意事项请参考[开发者文档](./DEVELOP.md)。 + +## 许可证 + +本项目使用 Apache-2.0 license,有关协议请参考[LICENSE](https://github.com/hitsz-ids/duefuse/blob/main/LICENSE)。 diff --git a/README_en.md b/README_en.md new file mode 100644 index 0000000..477151b --- /dev/null +++ b/README_en.md @@ -0,0 +1,3 @@ +# duefuse + +duefuse🔩: Data Usage Enforcement Filesystem in Userspace diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..e69de29