Django-pgcrypto-fields 项目教程

Django-pgcrypto-fields 项目教程

django-pgcrypto-fieldsTransparent field level encryption for Django using the pgcrypto postgresql extension.项目地址:https://gitcode.com/gh_mirrors/dj/django-pgcrypto-fields

1. 项目的目录结构及介绍

django-pgcrypto-fields/
├── django_pgcrypto_fields/
│   ├── __init__.py
│   ├── fields.py
│   ├── forms.py
│   ├── models.py
│   ├── utils.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_fields.py
│   ├── test_models.py
│   └── ...
├── setup.py
├── README.md
├── requirements.txt
└── ...

目录结构介绍

• django_pgcrypto_fields/: 核心代码目录，包含了所有与加密字段相关的实现。
  • __init__.py: 初始化文件，用于导入模块。
  • fields.py: 定义了各种加密字段类。
  • forms.py: 包含了与表单相关的加密字段实现。
  • models.py: 包含了与模型相关的加密字段实现。
  • utils.py: 包含了项目中使用的工具函数。
• tests/: 测试代码目录，包含了项目的单元测试。
  • __init__.py: 初始化文件，用于导入测试模块。
  • test_fields.py: 测试加密字段的单元测试。
  • test_models.py: 测试模型中加密字段的单元测试。
• setup.py: 项目的安装脚本。
• README.md: 项目的说明文档。
• requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

项目中没有明确的“启动文件”，因为 django-pgcrypto-fields 是一个 Django 的扩展库，而不是一个独立的应用程序。它的主要功能是通过在 Django 模型中定义加密字段来实现的。

3. 项目的配置文件介绍

Django 配置

在使用 django-pgcrypto-fields 时，需要在 Django 项目的 settings.py 文件中进行一些配置。以下是一些关键配置项：

import os

BASEDIR = os.path.dirname(os.path.dirname(__file__))

# 公钥和私钥的路径
PUBLIC_PGP_KEY_PATH = os.path.abspath(os.path.join(BASEDIR, 'public_key'))
PRIVATE_PGP_KEY_PATH = os.path.abspath(os.path.join(BASEDIR, 'private_key'))

# 公钥和私钥的内容
PUBLIC_PGP_KEY = open(PUBLIC_PGP_KEY_PATH).read()
PRIVATE_PGP_KEY = open(PRIVATE_PGP_KEY_PATH).read()

# 用于 TextHMACField 和 PGPSymmetricKeyField 的密钥
PGCRYPTO_KEY = 'ultrasecret'

# 数据库配置
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'your_db_name',
        'USER': 'your_db_user',
        'PASSWORD': 'your_db_password',
        'HOST': 'localhost',
        'PORT': '5432',
    }
}

配置项说明

• PUBLIC_PGP_KEY_PATH 和 PRIVATE_PGP_KEY_PATH: 公钥和私钥文件的路径。
• PUBLIC_PGP_KEY 和 PRIVATE_PGP_KEY: 公钥和私钥的内容。
• PGCRYPTO_KEY: 用于 TextHMACField 和 PGPSymmetricKeyField 的密钥。
• DATABASES: 数据库配置，确保使用 PostgreSQL 数据库。

通过以上配置，你可以在 Django 项目中使用 django-pgcrypto-fields 提供的加密字段功能。

django-pgcrypto-fieldsTransparent field level encryption for Django using the pgcrypto postgresql extension.项目地址:https://gitcode.com/gh_mirrors/dj/django-pgcrypto-fields