style: update md style
This commit is contained in:
parent
bfb5c27bcb
commit
fbeb783dbe
16
README_en.md
16
README_en.md
@ -7,6 +7,7 @@ This project is designed for the National Cryptography Competition and is implem
|
|||||||
The project uses the Chinese national standard cryptography algorithm to implement distributed proxy re-encryption (TPRE).
|
The project uses the Chinese national standard cryptography algorithm to implement distributed proxy re-encryption (TPRE).
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
.
|
.
|
||||||
├── basedockerfile (being used to build base iamge)
|
├── basedockerfile (being used to build base iamge)
|
||||||
├── dockerfile (being used to build application)
|
├── dockerfile (being used to build application)
|
||||||
@ -22,35 +23,43 @@ The project uses the Chinese national standard cryptography algorithm to impleme
|
|||||||
## Environment Dependencies
|
## Environment Dependencies
|
||||||
|
|
||||||
### Bare mental version(UNTESTED)
|
### Bare mental version(UNTESTED)
|
||||||
|
|
||||||
System requirements:
|
System requirements:
|
||||||
|
|
||||||
- Linux
|
- Linux
|
||||||
- Windows(may need to complie and install gmssl yourself)
|
- Windows(may need to complie and install gmssl yourself)
|
||||||
|
|
||||||
The project relies on the following software:
|
The project relies on the following software:
|
||||||
|
|
||||||
- Python 3.11
|
- Python 3.11
|
||||||
- gmssl
|
- gmssl
|
||||||
- gmssl-python
|
- gmssl-python
|
||||||
|
|
||||||
### Docker version
|
### Docker version
|
||||||
|
|
||||||
docker version:
|
docker version:
|
||||||
|
|
||||||
- Version: 24.0.5
|
- Version: 24.0.5
|
||||||
- API version: 1.43
|
- API version: 1.43
|
||||||
- Go version: go1.20.6
|
- Go version: go1.20.6
|
||||||
|
|
||||||
## Installation Steps
|
## Installation Steps
|
||||||
|
|
||||||
### Pre-installation
|
### Pre-installation
|
||||||
|
|
||||||
This project depends on gmssl, so you need to compile it from source first.
|
This project depends on gmssl, so you need to compile it from source first.
|
||||||
Visit [GmSSL](https://github.com/guanzhi/GmSSL) to learn how to install.
|
Visit [GmSSL](https://github.com/guanzhi/GmSSL) to learn how to install.
|
||||||
|
|
||||||
Then install essential python libs
|
Then install essential python libs
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
|
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Docker Installation
|
## Docker Installation
|
||||||
|
|
||||||
### Use base image and build yourself
|
### Use base image and build yourself
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build . -f basedockerfile -t git.mamahaha.work/sangge/tpre:base
|
docker build . -f basedockerfile -t git.mamahaha.work/sangge/tpre:base
|
||||||
docker pull git.mamahaha.work/sangge/tpre:base
|
docker pull git.mamahaha.work/sangge/tpre:base
|
||||||
@ -59,6 +68,7 @@ docker run your_image_name
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Use pre-build image
|
### Use pre-build image
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull git.mamahaha.work/sangge/tpre:latest
|
docker pull git.mamahaha.work/sangge/tpre:latest
|
||||||
docker run git.mamahaha.work/sangge/tpre:latest
|
docker run git.mamahaha.work/sangge/tpre:latest
|
||||||
@ -66,11 +76,11 @@ docker run git.mamahaha.work/sangge/tpre:latest
|
|||||||
|
|
||||||
## Usage Instructions
|
## Usage Instructions
|
||||||
|
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
[TPRE Algorithm Blog Post](https://www.cnblogs.com/pam-sh/p/17364656.html#tprelib%E7%AE%97%E6%B3%95)
|
[TPRE Algorithm Blog Post](https://www.cnblogs.com/pam-sh/p/17364656.html#tprelib%E7%AE%97%E6%B3%95)
|
||||||
[Gmssl-python library](https://github.com/GmSSL/GmSSL-Python)
|
[Gmssl-python library](https://github.com/GmSSL/GmSSL-Python)
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE v3
|
GNU GENERAL PUBLIC LICENSE v3
|
||||||
|
Loading…
x
Reference in New Issue
Block a user