https://github.com/gaogaotiantian/soss

Utility tool to upload encrypted files to Aliyun OSS
https://github.com/gaogaotiantian/soss

Last synced: 26 days ago
JSON representation

Utility tool to upload encrypted files to Aliyun OSS

• Host: GitHub
• URL: https://github.com/gaogaotiantian/soss
• Owner: gaogaotiantian
• License: apache-2.0
• Created: 2024-03-13T03:50:14.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-03-16T11:30:09.000Z (8 months ago)
• Last Synced: 2024-10-07T19:41:16.881Z (about 1 month ago)
• Language: Python
• Size: 11.7 KB
• Stars: 26
• Watchers: 2
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SOSS (Secure Object Storage Service)

一个可以在把文件上传到阿里云OSS之前加密，下载时自动解密的小工具。

## 准备工作

```

pip install -r requirements.txt

```

在你的阿里云管理系统内，找到下面的内容：

* OSS Bucket的endpoint（例如`oss-cn-hangzhou.aliyuncs.com`）

* OSS Bucket的名字

* 你的用户的access key（推荐使用RAM用户）

    * `export OSS_ACCESS_KEY_ID=`

    * `export OSS_ACCESS_KEY_SECRET=`

在`config.json`中，配置好`endpoint`和`bucket`。如果不想使用`config.json`，也可以在命令行作为参数输入。

## 使用说明

### 文件列表

```

# 如果配置好了config.json

python soss.py list

python soss.py list --prefix data/

# 如果想在命令行输入bucket和endpoint

python soss.py list -b bucket_name -e endpoint

```

### 上传文件

```

python soss.py upload -k my_password text.txt image.png

# 支持上传整个文件夹的内容，文件夹所有内容会保持结构上传到bucket根目录

python soss.py upload -k my_password data/

# 设置bucket保存路径的prefix，文件夹所有内容会保持结构上传到data/目录

python soss.py upload -k my_password --prefix data/ data/

# 如果encrypt key是一个32或者64位的hex，则直接作为AES的key使用，否则进行SHA256，转换成32 byte的key

python soss.py upload -k deadbeef12345678deadbeef87654321 text.txt

# 同样也可以传入bucket和endpoint

python soss.py upload -b bucket -e endpoint -k my_password text.txt

```

### 下载文件

```

python soss.py download -k my_password text.txt image.png

# 指定保存文件夹

python soss.py download -k my_password --output_dir ./data text.txt image.png

# 剩下的参数和upload一样

```

### LICENSE

Copyright 2024 Tian Gao.

Distributed under the terms of the [Apache 2.0 license](LICENSE)