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.

ImageRenderOptionsBits‑chavealg_id
AES_128128
AES_192192
AES_256256

ImageRenderOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptions
algorithm_namestrImageRenderOptions "AES".
key_bitsintComprimento da chave AES em bits (128, 192 ou 256).
alg_idintIdentificador numérico do algoritmo usado no registro de criptografia OOXML.
key_bytesintComprimento da chave em bytes (key_bits // 8).
block_sizeintImageRenderOptions 16 (tamanho do bloco AES em bytes).

HashAlgorithm

HashAlgorithm é um IntEnum especificando a função hash usada para a derivação de chave PBKDF2.

ImageRenderOptionsBytes de hashalg_id
SHA120
SHA25632
SHA38448
SHA51264

ImageRenderOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptions
algorithm_namestrNome da função hash (por exemplo,., "SHA-512").
hash_bytesintComprimento do digest em bytes.
alg_idintIdentificador 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
)
ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
cipher_algorithmCipherAlgorithmAES_256Comprimento da chave AES a ser usado.
hash_algorithmHashAlgorithmSHA512Função hash para a derivação de chave PBKDF2.
spin_countint100000Nú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

ImageRenderOptionsImageRenderOptionsImageRenderOptions
encryption_typestrImageRenderOptions "agile".
cipher_algorithmCipherAlgorithmCifra configurada.
hash_algorithmHashAlgorithmFunção hash configurada.
spin_countintContagem de iterações do PBKDF2.
salt_sizeintComprimento do sal em bytes (derivado do tamanho do bloco de cifra).
block_sizeintTamanho do bloco de cifra em bytes (sempre 16 para AES).
key_bitsintComprimento 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
) -> None

Lê o arquivo XLSX em input_path, criptografa-o com password usando o especificado encryption_params, e grava o arquivo criptografado em output_path.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
input_pathstrCaminho para o arquivo XLSX de origem.
output_pathstrCaminho de destino para o arquivo criptografado. Pode ser o mesmo que input_path para criptografia no local.
passwordstrSenha de criptografia.
encryption_params`AgileEncryptionParametersStandardEncryptionParameters

decrypt_xlsx

decrypt_xlsx(
    input_path: str,
    output_path: str,
    password: str
) -> bool

Descriptografa 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() -> AgileEncryptionParameters

Retorna 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!")

Veja Também

 Português