TgCrypto

Warnings

• breaking API function names changed from `ige_encrypt`, `ige_decrypt`, `ctr_encrypt`, `ctr_decrypt` (in v1.0.x) to `ige256_encrypt`, `ige256_decrypt`, `ctr256_encrypt`, `ctr256_decrypt` (in v1.2.x). Code using older, non-suffixed function names will break.
  Fix: Update function calls to use the `256` suffix (e.g., `tgcrypto.ige256_encrypt(...)`).
• breaking The official `pyrogram/tgcrypto` GitHub repository was archived on December 23, 2024, and the project is explicitly stated as no longer maintained or supported by its original authors. This means no further updates, bug fixes, or security patches are expected from the original maintainers.
  Fix: Users should be aware of the lack of ongoing maintenance. Consider migrating to actively maintained forks or alternatives if long-term support is critical, such as `TgCryptoX` or `tgcrypto-pyrofork`.
• gotcha Installing `tgcrypto` often requires C/C++ build tools on the system (e.g., Visual C++ Build Tools on Windows, Xcode Command Line Tools on macOS, `gcc`/`clang` and Python development headers (`python3-dev`) on Linux), especially if pre-compiled wheels are not available for your specific Python version and operating system. Installation may fail with compiler errors without these tools.
  Fix: Ensure the necessary build tools are installed for your operating system before attempting to `pip install tgcrypto`.
• gotcha When using AES-256-IGE mode, the input `data` *must* be explicitly padded to a multiple of the block size (16 bytes) before encryption. The library does not handle padding automatically. Failure to pre-pad the data will result in a `ValueError` during encryption or incorrect decryption.
  Fix: Manually pad your data to a multiple of 16 bytes before calling `ige256_encrypt`. A common method is `data += bytes(-len(data) % 16)`.

Install

• pip install tgcrypto Install latest version

Imports

• tgcrypto

  import tgcrypto

Quickstart

This quickstart demonstrates basic usage of the AES-256-IGE encryption and decryption functions, including the necessary data padding for IGE mode. Pyrogram will automatically use TgCrypto if installed.

import os
import tgcrypto

# Data for IGE mode must be padded to a multiple of the block size (16 bytes)
# This example adds 7 bytes to demonstrate padding
data = os.urandom(10 * 1024 * 1024 + 7)
key = os.urandom(32) # AES-256 key (32 bytes)
iv = os.urandom(32)  # AES-256-IGE IV (32 bytes)

# Pad with zeroes to be a multiple of 16 bytes
data += bytes(-len(data) % 16)

# Perform IGE encryption and decryption
ige_encrypted = tgcrypto.ige256_encrypt(data, key, iv)
ige_decrypted = tgcrypto.ige256_decrypt(ige_encrypted, key, iv)

assert data == ige_decrypted
print("IGE encryption/decryption successful!")