attr_encrypted 项目使用教程

attr_encrypted 项目使用教程

attr_encryptedGenerates attr_accessors that encrypt and decrypt attributes项目地址:https://gitcode.com/gh_mirrors/at/attr_encrypted

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

attr_encrypted 是一个用于在 Ruby 中加密属性的 gem。以下是其基本的目录结构：

attr_encrypted/
├── lib/
│   ├── attr_encrypted/
│   │   ├── adapter.rb
│   │   ├── version.rb
│   │   └── ...
│   ├── attr_encrypted.rb
│   └── ...
├── spec/
│   ├── attr_encrypted/
│   │   └── ...
│   └── ...
├── Gemfile
├── Gemfile.lock
├── README.md
├── Rakefile
└── attr_encrypted.gemspec

目录结构介绍：

• lib/: 包含项目的核心代码。
  • attr_encrypted/: 包含与加密相关的具体实现。
    • adapter.rb: 适配器代码。
    • version.rb: 版本信息。
  • attr_encrypted.rb: 主入口文件。
• spec/: 包含测试代码。
• Gemfile: 定义项目依赖。
• Gemfile.lock: 锁定依赖版本。
• README.md: 项目说明文档。
• Rakefile: 定义 Rake 任务。
• attr_encrypted.gemspec: gem 的规范文件。

2. 项目的启动文件介绍

attr_encrypted 的启动文件是 lib/attr_encrypted.rb。这个文件负责加载项目的核心功能和依赖项。

require 'openssl'
require 'base64'
require 'attr_encrypted/version'
require 'attr_encrypted/adapters'
require 'attr_encrypted/encryptor'
require 'attr_encrypted/deprecations'
require 'attr_encrypted/extensions'
require 'attr_encrypted/engine' if defined?(Rails)

启动文件介绍：

• require 'openssl': 引入 OpenSSL 库，用于加密和解密。
• require 'base64': 引入 Base64 编码库，用于编码和解码加密数据。
• require 'attr_encrypted/version': 引入版本信息。
• require 'attr_encrypted/adapters': 引入适配器代码。
• require 'attr_encrypted/encryptor': 引入加密器代码。
• require 'attr_encrypted/deprecations': 引入废弃功能处理代码。
• require 'attr_encrypted/extensions': 引入扩展功能代码。
• require 'attr_encrypted/engine': 引入 Rails 引擎代码（如果使用 Rails）。

3. 项目的配置文件介绍

attr_encrypted 的配置主要通过在模型中调用 attr_encrypted 方法来完成。以下是一个示例配置：

class User
  attr_encrypted :email, key: 'This is a key that is 256 bits'
  attr_encrypted :ssn, key: 'a different secret key'
end

配置文件介绍：

• attr_encrypted :email, key: 'This is a key that is 256 bits': 定义 email 属性为加密属性，并指定加密密钥。
• attr_encrypted :ssn, key: 'a different secret key': 定义 ssn 属性为加密属性，并指定不同的加密密钥。

通过这种方式，可以在模型中灵活地配置需要加密的属性及其对应的密钥。

---

以上是 attr_encrypted 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

attr_encryptedGenerates attr_accessors that encrypt and decrypt attributes项目地址:https://gitcode.com/gh_mirrors/at/attr_encrypted