Encryption — Aspose.Cells FOSS for Python API Reference
aspose-cells-foss suporta criptografia e descriptografia AES de arquivos XLSX via as funções de nível de módulo encrypt_xlsx e decrypt_xlsx. Duas classes de parâmetros configuram o algoritmo de cifra, o algoritmo de hash e a contagem de iterações PBKDF2. O padrão recomendado é AgileEncryptionParameters com AES-256 e SHA-512.
ImageRenderOptions: aspose.cells_foss
from aspose.cells_foss import (
CipherAlgorithm, HashAlgorithm,
AgileEncryptionParameters, StandardEncryptionParameters,
encrypt_xlsx, decrypt_xlsx, get_default_encryption_params,
)CipherAlgorithm
CipherAlgorithm é um IntEnum especificando o comprimento da chave AES. Todas as variantes usam AES no modo CBC com um tamanho de bloco de 16 bytes.
| ImageRenderOptions | Bits‑chave | alg_id |
|---|---|---|
AES_128 | 128 | — |
AES_192 | 192 | — |
AES_256 | 256 | — |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
algorithm_name | str | ImageRenderOptions "AES". |
key_bits | int | Comprimento da chave AES em bits (128, 192 ou 256). |
alg_id | int | Identificador numérico do algoritmo usado no registro de criptografia OOXML. |
key_bytes | int | Comprimento da chave em bytes (key_bits // 8). |
block_size | int | ImageRenderOptions 16 (tamanho do bloco AES em bytes). |
HashAlgorithm
HashAlgorithm é um IntEnum especificando a função hash usada para a derivação de chave PBKDF2.
| ImageRenderOptions | Bytes de hash | alg_id |
|---|---|---|
SHA1 | 20 | — |
SHA256 | 32 | — |
SHA384 | 48 | — |
SHA512 | 64 | — |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
algorithm_name | str | Nome da função hash (por exemplo,., "SHA-512"). |
hash_bytes | int | Comprimento do digest em bytes. |
alg_id | int | Identificador numérico do algoritmo usado no registro de criptografia OOXML. |
AgileEncryptionParameters
AgileEncryptionParameters configura o esquema Agile Encryption (ECMA-376, parte 4), que é o formato padrão e recomendado para arquivos Excel modernos (Excel 2010+).
ImageRenderOptions
AgileEncryptionParameters(
cipher_algorithm=CipherAlgorithm.AES_256,
hash_algorithm=HashAlgorithm.SHA512,
spin_count=100000
)| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
cipher_algorithm | CipherAlgorithm | AES_256 | Comprimento da chave AES a ser usado. |
hash_algorithm | HashAlgorithm | SHA512 | Função hash para a derivação de chave PBKDF2. |
spin_count | int | 100000 | Número de iterações PBKDF2. Valores mais altos aumentam a resistência a ataques de força bruta ao custo de tempo de abertura/salvamento. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
encryption_type | str | ImageRenderOptions "agile". |
cipher_algorithm | CipherAlgorithm | Cifra configurada. |
hash_algorithm | HashAlgorithm | Função hash configurada. |
spin_count | int | Contagem de iterações do PBKDF2. |
salt_size | int | Comprimento do sal em bytes (derivado do tamanho do bloco de cifra). |
block_size | int | Tamanho do bloco de cifra em bytes (sempre 16 para AES). |
key_bits | int | Comprimento da chave em bits. |
StandardEncryptionParameters
StandardEncryptionParameters configura o esquema de Criptografia Padrão para compatibilidade com o Excel 2007. Prefira AgileEncryptionParameters para novos arquivos.
ImageRenderOptions
StandardEncryptionParameters(
cipher_algorithm=CipherAlgorithm.AES_128,
hash_algorithm=HashAlgorithm.SHA1,
spin_count=50000
)As propriedades espelham as de AgileEncryptionParameters. O encryption_type propriedade é "standard".
Funções do Módulo
encrypt_xlsx
encrypt_xlsx(
input_path: str,
output_path: str,
password: str,
encryption_params=None
) -> NoneLê o arquivo XLSX em input_path, criptografa-o com password usando o especificado encryption_params, e grava o arquivo criptografado em output_path.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
input_path | str | Caminho para o arquivo XLSX de origem. |
output_path | str | Caminho de destino para o arquivo criptografado. Pode ser o mesmo que input_path para criptografia no local. |
password | str | Senha de criptografia. |
encryption_params | `AgileEncryptionParameters | StandardEncryptionParameters |
decrypt_xlsx
decrypt_xlsx(
input_path: str,
output_path: str,
password: str
) -> boolDescriptografa o arquivo XLSX em input_path usando password e grava o XLSX em texto simples em output_path. Retorna True se a descriptografia foi bem-sucedida, False se a senha estava incorreta ou o arquivo não estava criptografado.
get_default_encryption_params
get_default_encryption_params() -> AgileEncryptionParametersRetorna uma AgileEncryptionParameters instância configurada com AES_256, SHA512, e spin_count=100000. Use isso para inspecionar ou clonar as configurações padrão da biblioteca antes de personalizar.
ImageRenderOptions
Criptografar uma Pasta de Trabalho
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)Descriptografar uma Pasta de Trabalho
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.")Abrir um Arquivo Criptografado Diretamente
ImageRenderOptions Workbook construtor também aceita um password parâmetro para abrir arquivos criptografados sem uma etapa de descriptografia separada:
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!")