Encryption — Aspose.Cells FOSS for Python API Reference
aspose-cells-foss підтримує шифрування та розшифрування XLSX‑файлів за допомогою AES через функції рівня модуля encrypt_xlsx і decrypt_xlsx. Два класи параметрів налаштовують алгоритм шифру, алгоритм хешування та кількість обертів PBKDF2. Рекомендованим значенням за замовчуванням є AgileEncryptionParameters з AES-256 та SHA-512.
Enumerations: aspose.cells_foss
from aspose.cells_foss import (
CipherAlgorithm, HashAlgorithm,
AgileEncryptionParameters, StandardEncryptionParameters,
encrypt_xlsx, decrypt_xlsx, get_default_encryption_params,
)CipherAlgorithm
CipherAlgorithm є IntEnum що вказує довжину ключа AES.
| Enumerations | Біти ключа | alg_id |
|---|---|---|
AES_128 | 128 | — |
AES_192 | 192 | — |
AES_256 | 256 | — |
Enumerations
| Enumerations | Enumerations | Enumerations |
|---|---|---|
algorithm_name | str | Enumerations "AES". |
key_bits | int | Довжина ключа AES у бітах (128, 192 або 256). |
alg_id | int | Числовий ідентифікатор алгоритму, що використовується в записі шифрування OOXML. |
key_bytes | int | Довжина ключа в байтах (key_bits // 8). |
block_size | int | Enumerations 16 (розмір блоку AES в байтах). |
HashAlgorithm
HashAlgorithm є IntEnum вказує хеш-функцію, що використовується для виведення ключа PBKDF2.
| Enumerations | Байти хешу | alg_id |
|---|---|---|
SHA1 | 20 | — |
SHA256 | 32 | — |
SHA384 | 48 | — |
SHA512 | 64 | — |
Enumerations
| Enumerations | Enumerations | Enumerations |
|---|---|---|
algorithm_name | str | Назва хеш-функції (наприклад,., "SHA-512"). |
hash_bytes | int | Довжина дайджесту в байтах. |
alg_id | int | Числовий ідентифікатор алгоритму, що використовується в записі шифрування OOXML. |
AgileEncryptionParameters
AgileEncryptionParameters Налаштовує схему Agile Encryption (ECMA-376, частина 4), яка є форматом за замовчуванням і рекомендованим для сучасних файлів Excel (Excel 2010+).
Enumerations
AgileEncryptionParameters(
cipher_algorithm=CipherAlgorithm.AES_256,
hash_algorithm=HashAlgorithm.SHA512,
spin_count=100000
)| Enumerations | Enumerations | Enumerations | Enumerations |
|---|---|---|---|
cipher_algorithm | CipherAlgorithm | AES_256 | Довжина ключа AES, що використовується. |
hash_algorithm | HashAlgorithm | SHA512 | Хеш‑функція для виведення ключа PBKDF2. |
spin_count | int | 100000 | Кількість ітерацій PBKDF2. Вищі значення підвищують стійкість до брутфорсу за рахунок часу відкриття/збереження. |
Enumerations
| Enumerations | Enumerations | Enumerations |
|---|---|---|
encryption_type | str | Enumerations "agile". |
cipher_algorithm | CipherAlgorithm | Налаштований шифр. |
hash_algorithm | HashAlgorithm | Налаштована хеш‑функція. |
spin_count | int | Кількість ітерацій PBKDF2. |
salt_size | int | Довжина солі в байтах (визначається за розміром блоку шифру). |
block_size | int | Розмір блоку шифру в байтах (завжди 16 для AES). |
key_bits | int | Довжина ключа в бітах. |
StandardEncryptionParameters
StandardEncryptionParameters налаштовує схему Standard Encryption для сумісності з Excel 2007. Рекомендується AgileEncryptionParameters для нових файлів.
Enumerations
StandardEncryptionParameters(
cipher_algorithm=CipherAlgorithm.AES_128,
hash_algorithm=HashAlgorithm.SHA1,
spin_count=50000
)Властивості збігаються з AgileEncryptionParameters. Це encryption_type властивість є "standard".
Функції модуля
encrypt_xlsx
encrypt_xlsx(
input_path: str,
output_path: str,
password: str,
encryption_params=None
) -> NoneЗчитує файл XLSX за input_path, шифрує його за допомогою password використовуючи вказаний encryption_params, і записує зашифрований файл у output_path.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
input_path | str | Шлях до вихідного файлу XLSX. |
output_path | str | Шлях призначення для зашифрованого файлу. Може бути таким же, як input_path для шифрування на місці. |
password | str | Пароль шифрування. |
encryption_params | `AgileEncryptionParameters | StandardEncryptionParameters |
decrypt_xlsx
decrypt_xlsx(
input_path: str,
output_path: str,
password: str
) -> boolРозшифровує файл XLSX за адресою input_path використовуючи password і записує відкритий XLSX у output_path. Повертає True якщо розшифрування успішне, False якщо пароль був неправильний або файл не був зашифрований.
get_default_encryption_params
get_default_encryption_params() -> AgileEncryptionParametersПовертає AgileEncryptionParameters екземпляр, налаштований AES_256, SHA512, і spin_count=100000. Використовуйте це для перегляду або клонування типових налаштувань бібліотеки перед їх налаштуванням.
Enumerations
Зашифрувати робочу книгу
from aspose.cells_foss import Workbook, encrypt_xlsx, AgileEncryptionParameters, CipherAlgorithm, HashAlgorithm
# 1. Build and save an unencrypted workbook
wb = Workbook()
ws = wb.worksheets[0]
ws.cells["A1"].put_value("Confidential data")
wb.save("report.xlsx")
# 2. Encrypt with default AES-256/SHA-512 settings
encrypt_xlsx("report.xlsx", "report_secure.xlsx", password="MyP@ssw0rd!")
# 3. Alternatively, use a lower spin count for faster open/save cycles during development
params = AgileEncryptionParameters(
cipher_algorithm=CipherAlgorithm.AES_256,
hash_algorithm=HashAlgorithm.SHA256,
spin_count=10000,
)
encrypt_xlsx("report.xlsx", "report_dev.xlsx", password="dev_only", encryption_params=params)Розшифрувати робочу книгу
from aspose.cells_foss import decrypt_xlsx, Workbook
success = decrypt_xlsx("report_secure.xlsx", "report_decrypted.xlsx", password="MyP@ssw0rd!")
if success:
wb = Workbook("report_decrypted.xlsx")
print(wb.worksheets[0].cells["A1"].value)
else:
print("Incorrect password or file is not encrypted.")Відкрити зашифрований файл безпосередньо
Enumerations Workbook конструктор також приймає password параметр для відкриття зашифрованих файлів без окремого кроку розшифрування:
from aspose.cells_foss import Workbook
wb = Workbook("report_secure.xlsx", password="MyP@ssw0rd!")
print(wb.worksheets[0].cells["A1"].value)
wb.save("report_updated_secure.xlsx", password="MyP@ssw0rd!")