pybde文档api翻译
使用pybde的示例，用于访问 BitLocker 驱动器加密 (BDE) 加密卷的库和工具。
网址：https://github.com/libyal/libbde/wiki/Python-development
Import 导入
import pybde
Get version 获取版本
pybde.get_version()
Open volume 打开卷
bde_volume = pybde.volume()
bde_volume.open("image.raw")
...
bde_volume.close()
不需要显式调用bde_volume.close()。只有当卷上的所有操作都完成后，才必须调用Close。
Open a volume using a file-like object 使用类文件对象打开卷
file_object = open("image.raw", "rb")
bde_volume = pybde.volume()
bde_volume.open_file_object(file_object)
...
bde_volume.close()
不需要显式调用bde_volume.close()。只有在卷上的所有操作都已完成时才必须调用Close，并且它不会关闭类文件对象本身。 另请参阅:
import pybde
help(pybde)
help(pybde.volume)
help(pybde)的输出经过AI翻译后的结果：
Help on module pybde:
pybde 模块帮助文档：
NAME
pybde - Python libbde module (pybde).
pybde - Python 版 libbde 模块（pybde）。
CLASSES
builtins.object
encryption_methods
key_protection_types
key_protector
key_protectors
volume
class encryption_methods(builtins.object)
| pybde encryption methods object (wraps LIBBDE_ENCRYPTION_METHODS)
| pybde 加密方式对象（封装 LIBBDE_ENCRYPTION_METHODS 枚举）
|
| Methods defined here:
| 此处定义的方法：
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
| 初始化自身实例。有关准确的参数签名，请参阅 help(type(self))。
|
| ----------------------------------------------------------------------
| Static methods defined here:
| 此处定义的静态方法：
|
| __new__(*args, **kwargs) from builtins.type
| Create and return a new object. See help(type) for accurate signature.
| 创建并返回一个新对象。有关准确的参数签名，请参阅 help(type)。
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
| 此处定义的数据和其他属性：
|
| AES_128_CBC = 32770
| AES_128_CBC（128位AES加密-CBC模式） = 32770
|
| AES_128_CBC_DIFFUSER = 32768
| AES_128_CBC_DIFFUSER（128位AES加密-CBC模式+扩散器） = 32768
|
| AES_128_XTS = 32772
| AES_128_XTS（128位AES加密-XTS模式） = 32772
|
| AES_256_CBC = 32771
| AES_256_CBC（256位AES加密-CBC模式） = 32771
|
| AES_256_CBC_DIFFUSER = 32769
| AES_256_CBC_DIFFUSER（256位AES加密-CBC模式+扩散器） = 32769
|
| AES_256_XTS = 32773
| AES_256_XTS（256位AES加密-XTS模式） = 32773
class key_protection_types(builtins.object)
| pybde key protection types object (wraps LIBBDE_KEY_PROTECTION_TYPES)
| pybde 密钥保护类型对象（封装 LIBBDE_KEY_PROTECTION_TYPES 枚举）
|
| Methods defined here:
| 此处定义的方法：
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
| 初始化自身实例。有关准确的参数签名，请参阅 help(type(self))。
|
| ----------------------------------------------------------------------
| Static methods defined here:
| 此处定义的静态方法：
|
| __new__(*args, **kwargs) from builtins.type
| Create and return a new object. See help(type) for accurate signature.
| 创建并返回一个新对象。有关准确的参数签名，请参阅 help(type)。
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
| 此处定义的数据和其他属性：
|
| CLEAR_KEY = 0
| CLEAR_KEY（明文密钥） = 0
|
| PASSWORD = 8192
| PASSWORD（密码） = 8192
|
| RECOVERY_PASSWORD = 2048
| RECOVERY_PASSWORD（恢复密码） = 2048
|
| STARTUP_KEY = 512
| STARTUP_KEY（启动密钥） = 512
|
| TPM = 256
| TPM（可信平台模块） = 256
|
| TPM_AND_PIN = 1280
| TPM_AND_PIN（TPM+PIN码） = 1280
class key_protector(builtins.object)
| pybde key protector object (wraps libbde_key_protector_t)
| pybde 密钥保护器对象（封装 libbde_key_protector_t 结构体）
|
| Methods defined here:
| 此处定义的方法：
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
| 初始化自身实例。有关准确的参数签名，请参阅 help(type(self))。
|
| get_identifier(...)
| get_identifier() -> Unicode string
| 获取标识符() -> Unicode 字符串
|
| Retrieves the identifier.
| 检索（获取）标识符。
|
| get_type(...)
| get_type() -> Integer
| 获取类型() -> 整数
|
| Retrieves the type.
| 检索（获取）类型。
|
| ----------------------------------------------------------------------
| Static methods defined here:
| 此处定义的静态方法：
|
| __new__(*args, **kwargs) from builtins.type
| Create and return a new object. See help(type) for accurate signature.
| 创建并返回一个新对象。有关准确的参数签名，请参阅 help(type)。
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
| 此处定义的数据描述符：
|
| identifier
| The identifier.
| 标识符。
|
| type
| The type.
| 类型。
class key_protectors(builtins.object)
| pybde sequence and iterator object of key protectors
| pybde 密钥保护器的序列与迭代器对象
|
| Methods defined here:
| 此处定义的方法：
|
| __getitem__(self, key, /)
| Return self[key].
| 返回 self[key]（通过索引获取元素）。
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
| 初始化自身实例。有关准确的参数签名，请参阅 help(type(self))。
|
| __iter__(self, /)
| Implement iter(self).
| 实现 iter(self)（支持迭代）。
|
| __len__(self, /)
| Return len(self).
| 返回 len(self)（获取长度）。
|
| __next__(self, /)
| Implement next(self).
| 实现 next(self)（迭代下一个元素）。
|
| ----------------------------------------------------------------------
| Static methods defined here:
| 此处定义的静态方法：
|
| __new__(*args, **kwargs) from builtins.type
| Create and return a new object. See help(type) for accurate signature.
| 创建并返回一个新对象。有关准确的参数签名，请参阅 help(type)。
class volume(builtins.object)
| pybde volume object (wraps libbde_volume_t)
| pybde 卷对象（封装 libbde_volume_t 结构体）
|
| Methods defined here:
| 此处定义的方法：
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
| 初始化自身实例。有关准确的参数签名，请参阅 help(type(self))。
|
| close(...)
| close() -> None
| 关闭() -> 无返回值
|
| Closes a volume.
| 关闭一个卷。
|
| get_creation_time(...)
| get_creation_time() -> Datetime
| 获取创建时间() -> 日期时间对象
|
| Retrieves the creation date and time.
| 检索（获取）创建的日期和时间。
|
| get_creation_time_as_integer(...)
| get_creation_time_as_integer() -> Integer or None
| 以整数形式获取创建时间() -> 整数 或 空值
|
| Retrieves the creation date and time as a 64-bit integer containing a FILETIME value.
| 以包含 FILETIME 数值的 64 位整数形式，检索（获取）创建的日期和时间。
|
| get_description(...)
| get_description() -> Unicode string or None
| 获取描述信息() -> Unicode 字符串 或 空值
|
| Retrieves the description.
| 检索（获取）描述信息。
|
| get_encryption_method(...)
| get_encryption_method() -> Integer
| 获取加密方式() -> 整数
|
| Retrieves the encryption method.
| 检索（获取）加密方式。
|
| get_key_protector(...)
| get_key_protector(key_protector_index) -> Object
| 获取密钥保护器(key_protector_index) -> 对象
|
| Retrieves the volume master key protector specified by the index.
| 检索（获取）由索引指定的卷主密钥保护器。
|
| get_number_of_key_protectors(...)
| get_number_of_key_protectors() -> Integer
| 获取密钥保护器数量() -> 整数
|
| Retrieves the number of volume master key protectors.
| 检索（获取）卷主密钥保护器的数量。
|
| get_offset(...)
| get_offset() -> Integer
| 获取偏移量() -> 整数
|
| Retrieves the current offset within the unencrypted data.
| 检索（获取）未加密数据中的当前偏移量。
|
| get_size(...)
| get_size() -> Integer
| 获取大小() -> 整数
|
| Retrieves the size of the unencrypted data.
| 检索（获取）未加密数据的大小。
|
| get_volume_identifier(...)
| get_volume_identifier() -> Unicode string or None
| 获取卷标识符() -> Unicode 字符串 或 空值
|
| Retrieves the volume identifier.
| 检索（获取）卷标识符。
|
| is_locked(...)
| is_locked() -> Boolean or None
| 检查是否锁定() -> 布尔值 或 空值
|
| Determines if the volume is locked.
| 判断卷是否处于锁定状态。
|
| open(...)
| open(filename, mode='r') -> None
| 打开(filename, mode='r') -> 无返回值
|
| Opens a volume.
| 打开一个卷。
|
| open_file_object(...)
| open_file_object(file_object, mode='r') -> None
| 通过文件对象打开(file_object, mode='r') -> 无返回值
|
| Opens a volume using a file-like object.
| 通过类文件对象打开一个卷。
|
| read(...)
| read(size) -> Bytes
| 读取(size) -> 字节数据
|
| Reads a buffer of unencrypted data.
| 读取一段未加密数据的缓冲区。
|
| read_buffer(...)
| read_buffer(size) -> Bytes
| 读取缓冲区(size) -> 字节数据
|
| Reads a buffer of unencrypted data.
| 读取一段未加密数据的缓冲区。
|
| read_buffer_at_offset(...)
| read_buffer_at_offset(size, offset) -> Bytes
| 从指定偏移量读取缓冲区(size, offset) -> 字节数据
|
| Reads a buffer of unencrypted data at a specific offset.
| 从指定偏移量位置，读取一段未加密数据的缓冲区。
|
| read_startup_key(...)
| read_startup_key(filename) -> None
| 读取启动密钥(filename) -> 无返回值
|
| Reads the startup key from a file.
| 从文件中读取启动密钥。
|
| seek(...)
| seek(offset, whence) -> None
| 移动偏移量(offset, whence) -> 无返回值
|
| Seeks an offset within the unencrypted data.
| 在未加密数据中移动到指定偏移量。
|
| seek_offset(...)
| seek_offset(offset, whence) -> None
| 移动偏移量(offset, whence) -> 无返回值
|
| Seeks an offset within the unencrypted data.
| 在未加密数据中移动到指定偏移量。
|
| set_keys(...)
| set_keys(full_volume_encryption_key, tweak_key) -> None
| 设置密钥(full_volume_encryption_key, tweak_key) -> 无返回值
|
| Sets the keys.
| 设置密钥（全卷加密密钥、调整密钥）。
|
| set_password(...)
| set_password(password) -> None
| 设置密码(password) -> 无返回值
|
| Sets the password.
| 设置密码。
|
| set_recovery_password(...)
| set_recovery_password(recovery_password) -> None
| 设置恢复密码(recovery_password) -> 无返回值
|
| Sets the recovery password.
| 设置恢复密码。
|
| signal_abort(...)
| signal_abort() -> None
| 发送中止信号() -> 无返回值
|
| Signals the volume to abort the current activity.
| 向卷发送中止当前操作的信号。
|
| tell(...)
| tell() -> Integer
| 告知当前偏移量() -> 整数
|
| Retrieves the current offset within the unencrypted data.
| 检索（获取）未加密数据中的当前偏移量。
|
| unlock(...)
| unlock() -> Boolean
| 解锁() -> 布尔值
|
| Unlocks the volume.
| 解锁卷（返回解锁是否成功）。
|
| ----------------------------------------------------------------------
| Static methods defined here:
| 此处定义的静态方法：
|
| __new__(*args, **kwargs) from builtins.type
| Create and return a new object. See help(type) for accurate signature.
| 创建并返回一个新对象。有关准确的参数签名，请参阅 help(type)。
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
| 此处定义的数据描述符：
|
| creation_time
| The creation date and time.
| 创建的日期和时间。
|
| description
| The description.
| 描述信息。
|
| encryption_method
| The encryption method.
| 加密方式。
|
| identifier
| The volume identifier.
| 卷标识符。
|
| key_protectors
| The volume master key protectors.
| 卷主密钥保护器集合。
|
| locked
| Value to indicate the volume is locked.
| 标识卷是否锁定的数值。
|
| number_of_key_protectors
| The number of volume master key protectors.
| 卷主密钥保护器的数量。
|
| size
| The size.
| （未加密数据的）大小。
FUNCTIONS
check_volume_signature(...)
check_volume_signature(filename) -> Boolean
检查卷签名(filename) -> 布尔值
Checks if a volume has a BitLocker Drive Encryption (BDE) volume signature.
检查指定卷是否包含 BitLocker 驱动器加密（BDE）卷签名。
check_volume_signature_file_object(...)
check_volume_signature_file_object(file_object) -> Boolean
通过文件对象检查卷签名(file_object) -> 布尔值
Checks if a volume has a BitLocker Drive Encryption (BDE) volume signature using a file-like object.
通过类文件对象，检查指定卷是否包含 BitLocker 驱动器加密（BDE）卷签名。
get_version(...)
get_version() -> String
获取版本号() -> 字符串
Retrieves the version.
检索（获取）模块版本号。
open(...)
open(filename, mode='r') -> Object
打开卷(filename, mode='r') -> 对象
Opens a volume.
打开一个卷（返回卷对象）。
open_file_object(...)
open_file_object(file_object, mode='r') -> Object
通过文件对象打开卷(file_object, mode='r') -> 对象
Opens a volume using a file-like object.
通过类文件对象打开一个卷（返回卷对象）。
FILE
/usr/local/lib/python3.11/dist-packages/pybde.cpython-311-x86_64-linux-gnu.so
/usr/local/lib/python3.11/dist-packages/pybde.cpython-311-x86_64-linux-gnu.so
help(pybde.volume)的输出经过AI翻译后的结果：
Help on class volume in pybde:
pybde 模块中 volume 类的帮助文档：
pybde.volume = class volume(builtins.object)
| pybde volume object (wraps libbde_volume_t)
| pybde 卷对象（封装 libbde_volume_t 结构体）
|
| Methods defined here:
| 此处定义的方法：
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
| 初始化自身实例。有关准确的参数签名，请参阅 help(type(self))。
|
| close(...)
| close() -> None
| 关闭() -> 无返回值
|
| Closes a volume.
| 关闭一个卷。
|
| get_creation_time(...)
| get_creation_time() -> Datetime
| 获取创建时间() -> 日期时间对象
|
| Retrieves the creation date and time.
| 检索（获取）卷的创建日期和时间。
|
| get_creation_time_as_integer(...)
| get_creation_time_as_integer() -> Integer or None
| 以整数形式获取创建时间() -> 整数 或 空值
|
| Retrieves the creation date and time as a 64-bit integer containing a FILETIME value.
| 以包含 FILETIME 时间戳数值的 64 位整数形式，检索（获取）卷的创建日期和时间。
|
| get_description(...)
| get_description() -> Unicode string or None
| 获取描述信息() -> Unicode 字符串 或 空值
|
| Retrieves the description.
| 检索（获取）卷的描述信息。
|
| get_encryption_method(...)
| get_encryption_method() -> Integer
| 获取加密方式() -> 整数
|
| Retrieves the encryption method.
| 检索（获取）卷所使用的加密方式（返回值对应 encryption_methods 类的枚举值）。
|
| get_key_protector(...)
| get_key_protector(key_protector_index) -> Object
| 获取密钥保护器(key_protector_index) -> 密钥保护器对象
|
| Retrieves the volume master key protector specified by the index.
| 检索（获取）由索引值指定的卷主密钥保护器。
|
| get_number_of_key_protectors(...)
| get_number_of_key_protectors() -> Integer
| 获取密钥保护器数量() -> 整数
|
| Retrieves the number of volume master key protectors.
| 检索（获取）卷中包含的主密钥保护器总数。
|
| get_offset(...)
| get_offset() -> Integer
| 获取偏移量() -> 整数
|
| Retrieves the current offset within the unencrypted data.
| 检索（获取）当前在未加密数据区域中的偏移位置。
|
| get_size(...)
| get_size() -> Integer
| 获取数据大小() -> 整数
|
| Retrieves the size of the unencrypted data.
| 检索（获取）卷中未加密数据的总大小。
|
| get_volume_identifier(...)
| get_volume_identifier() -> Unicode string or None
| 获取卷标识符() -> Unicode 字符串 或 空值
|
| Retrieves the volume identifier.
| 检索（获取）卷的唯一标识符。
|
| is_locked(...)
| is_locked() -> Boolean or None
| 检查卷是否锁定() -> 布尔值 或 空值
|
| Determines if the volume is locked.
| 判断该卷是否处于加密锁定状态。
|
| open(...)
| open(filename, mode='r') -> None
| 打开卷(filename, mode='r') -> 无返回值
|
| Opens a volume.
| 打开指定路径的 BitLocker 加密卷（mode 默认为只读模式）。
|
| open_file_object(...)
| open_file_object(file_object, mode='r') -> None
| 通过文件对象打开卷(file_object, mode='r') -> 无返回值
|
| Opens a volume using a file-like object.
| 通过类文件对象（如已打开的文件句柄）打开 BitLocker 加密卷。
|
| read(...)
| read(size) -> Bytes
| 读取数据(size) -> 字节数据
|
| Reads a buffer of unencrypted data.
| 从当前偏移位置读取指定大小的未加密数据缓冲区。
|
| read_buffer(...)
| read_buffer(size) -> Bytes
| 读取缓冲区(size) -> 字节数据
|
| Reads a buffer of unencrypted data.
| 从当前偏移位置读取指定大小的未加密数据缓冲区（功能同 read 方法）。
|
| read_buffer_at_offset(...)
| read_buffer_at_offset(size, offset) -> Bytes
| 从指定偏移量读取缓冲区(size, offset) -> 字节数据
|
| Reads a buffer of unencrypted data at a specific offset.
| 从指定的偏移位置开始，读取指定大小的未加密数据缓冲区。
|
| read_startup_key(...)
| read_startup_key(filename) -> None
| 读取启动密钥(filename) -> 无返回值
|
| Reads the startup key from a file.
| 从指定文件中读取 BitLocker 启动密钥（用于解锁卷）。
|
| seek(...)
| seek(offset, whence) -> None
| 移动读取偏移量(offset, whence) -> 无返回值
|
| Seeks an offset within the unencrypted data.
| 在未加密数据区域中移动到指定的偏移位置（whence 定义偏移基准：0=起始位置，1=当前位置，2=末尾位置）。
|
| seek_offset(...)
| seek_offset(offset, whence) -> None
| 移动偏移量(offset, whence) -> 无返回值
|
| Seeks an offset within the unencrypted data.
| 在未加密数据区域中移动到指定的偏移位置（功能同 seek 方法）。
|
| set_keys(...)
| set_keys(full_volume_encryption_key, tweak_key) -> None
| 设置加密密钥(full_volume_encryption_key, tweak_key) -> 无返回值
|
| Sets the keys.
| 设置卷的加密密钥（全卷加密密钥 + 调整密钥），用于解密数据。
|
| set_password(...)
| set_password(password) -> None
| 设置解锁密码(password) -> 无返回值
|
| Sets the password.
| 设置用于解锁 BitLocker 卷的密码。
|
| set_recovery_password(...)
| set_recovery_password(recovery_password) -> None
| 设置恢复密码(recovery_password) -> 无返回值
|
| Sets the recovery password.
| 设置用于解锁 BitLocker 卷的恢复密码（应急解锁用）。
|
| signal_abort(...)
| signal_abort() -> None
| 发送中止信号() -> 无返回值
|
| Signals the volume to abort the current activity.
| 向卷发送中止信号，终止其当前正在执行的操作（如读取、解锁等）。
|
| tell(...)
| tell() -> Integer
| 获取当前偏移量() -> 整数
|
| Retrieves the current offset within the unencrypted data.
| 检索（获取）当前在未加密数据区域中的偏移位置（同 get_offset 方法）。
|
| unlock(...)
| unlock() -> Boolean
| 解锁卷() -> 布尔值
|
| Unlocks the volume.
| 尝试解锁 BitLocker 卷，返回布尔值表示解锁是否成功（需先设置密码/密钥）。
|
| ----------------------------------------------------------------------
| Static methods defined here:
| 此处定义的静态方法：
|
| __new__(*args, **kwargs) from builtins.type
| Create and return a new object. See help(type) for accurate signature.
| 创建并返回一个新的 volume 对象。有关准确的参数签名，请参阅 help(type)。
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
| 此处定义的数据描述符（属性）：
|
| creation_time
| The creation date and time.
| 卷的创建日期和时间（同 get_creation_time 方法返回值）。
|
| description
| The description.
| 卷的描述信息（同 get_description 方法返回值）。
|
| encryption_method
| The encryption method.
| 卷的加密方式（同 get_encryption_method 方法返回值）。
|
| identifier
| The volume identifier.
| 卷的唯一标识符（同 get_volume_identifier 方法返回值）。
|
| key_protectors
| The volume master key protectors.
| 卷的所有主密钥保护器集合（可迭代对象）。
|
| locked
| Value to indicate the volume is locked.
| 标识卷是否锁定的状态值（同 is_locked 方法返回值）。
|
| number_of_key_protectors
| The number of volume master key protectors.
| 卷的主密钥保护器总数（同 get_number_of_key_protectors 方法返回值）。
|
| size
| The size.
| 卷中未加密数据的总大小（同 get_size 方法返回值）。