Encryption — Aspose.Cells FOSS for Python API Reference
aspose-cells-foss stöder AES-kryptering och -dekryptering av XLSX-filer via modulnivåfunktionerna encrypt_xlsx och decrypt_xlsx. Två parameterklasser konfigurerar chifferalgoritmen, hash-algoritmen och PBKDF2-rotationsantalet. Det rekommenderade standardvärdet är AgileEncryptionParameters med AES-256 och 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 är en IntEnum som specificerar AES-nyckellängden. Alla varianter använder AES i CBC-läge med en blockstorlek på 16 byte.
| ImageRenderOptions | Nyckelbitar | alg_id |
|---|---|---|
AES_128 | 128 | — |
AES_192 | 192 | — |
AES_256 | 256 | — |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
algorithm_name | str | ImageRenderOptions "AES". |
key_bits | int | AES-nyckellängd i bitar (128, 192 eller 256). |
alg_id | int | Numerisk algoritmidentifierare som används i OOXML-krypteringsposten. |
key_bytes | int | Nyckellängd i byte (key_bits // 8). |
block_size | int | ImageRenderOptions 16 (AES blockstorlek i byte). |
HashAlgorithm
HashAlgorithm är en IntEnum som specificerar hash-funktionen som används för PBKDF2-nyckelderivering.
| ImageRenderOptions | Hash-bytes | alg_id |
|---|---|---|
SHA1 | 20 | — |
SHA256 | 32 | — |
SHA384 | 48 | — |
SHA512 | 64 | — |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
algorithm_name | str | Hash-funktionsnamn (t.ex., "SHA-512"). |
hash_bytes | int | Digest-längd i byte. |
alg_id | int | Numerisk algoritmidentifierare som används i OOXML‑krypteringsposten. |
AgileEncryptionParameters
AgileEncryptionParameters konfigurerar Agile Encryption‑schemat (ECMA-376, del 4), som är standard‑ och rekommenderat format för moderna Excel‑filer (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 | AES-nyckellängd att använda. |
hash_algorithm | HashAlgorithm | SHA512 | Hashfunktion för PBKDF2‑nyckelderivering. |
spin_count | int | 100000 | Antal PBKDF2-iterationer. Högre värden ökar motståndet mot brute‑force på bekostnad av öppnings‑/sparningstid. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
encryption_type | str | ImageRenderOptions "agile". |
cipher_algorithm | CipherAlgorithm | Konfigurerad chiffer. |
hash_algorithm | HashAlgorithm | Konfigurerad hash‑funktion. |
spin_count | int | PBKDF2-iterationsantal. |
salt_size | int | Saltlängd i byte (härrör från chifferblockets storlek). |
block_size | int | Chifferblockstorlek i byte (alltid 16 för AES). |
key_bits | int | Nyckellängd i bitar. |
StandardEncryptionParameters
StandardEncryptionParameters konfigurerar standardkrypteringsschemat för kompatibilitet med Excel 2007. Föredra AgileEncryptionParameters för nya filer.
ImageRenderOptions
StandardEncryptionParameters(
cipher_algorithm=CipherAlgorithm.AES_128,
hash_algorithm=HashAlgorithm.SHA1,
spin_count=50000
)Egenskaperna speglar de för AgileEncryptionParameters. Den encryption_type egenskapen är "standard".
Modulfunktioner
encrypt_xlsx
encrypt_xlsx(
input_path: str,
output_path: str,
password: str,
encryption_params=None
) -> NoneLäser XLSX‑filen på input_path, krypterar den med password med den angivna encryption_params, och skriver den krypterade filen till output_path.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
input_path | str | Sökväg till källfilen XLSX. |
output_path | str | Målsökväg för den krypterade filen. Kan vara densamma som input_path för kryptering på plats. |
password | str | Krypteringslösenord. |
encryption_params | `AgileEncryptionParameters | StandardEncryptionParameters |
decrypt_xlsx
decrypt_xlsx(
input_path: str,
output_path: str,
password: str
) -> boolDekrypterar XLSX-filen på input_path med hjälp av password och skriver den klartext XLSX till output_path. Returnerar True om dekryptering lyckades, False om lösenordet var felaktigt eller filen inte var krypterad.
get_default_encryption_params
get_default_encryption_params() -> AgileEncryptionParametersReturnerar en AgileEncryptionParameters instans konfigurerad med AES_256, SHA512, och spin_count=100000. Använd detta för att inspektera eller klona bibliotekets standardinställningar innan anpassning.
ImageRenderOptions
Kryptera en arbetsbok
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)Dekryptera en arbetsbok
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.")Öppna en krypterad fil direkt
ImageRenderOptions Workbook konstruktorn accepterar också en password parameter för att öppna krypterade filer utan ett separat dekrypteringssteg:
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!")