Skip to main content

Fast Telegram Crypto Library for Python

Project description

TgCrypto

Fast and Portable Telegram Crypto Library for Python

TgCrypto is a Telegram Crypto Library written in C89 as a Python extension. It is designed to be portable, fast, easy to install and use. TgCrypto is intended for Pyrogram and implements the crypto algorithms Telegram requires, namely:

Python wheels are available for hassle-free installations; they are automatically built and tested using Travis CI (Linux, macOS) and AppVeyor (Windows), for both 32-bit and 64-bit architectures.

Even though TgCrypto is primarily intended for use with Pyrogram, you are free and welcome to use it for any other Python project too, as it's shipped as standalone package.

More info: https://docs.pyrogram.org/topics/tgcrypto

Requirements

  • Python 3.4 or higher.

Installation

$ pip3 install -U tgcrypto

API

TgCrypto API consists of these six methods:

def ige256_encrypt(data: bytes, key: bytes, iv: bytes) -> bytes: ...
def ige256_decrypt(data: bytes, key: bytes, iv: bytes) -> bytes: ...

def ctr256_encrypt(data: bytes, key: bytes, iv: bytes, state: bytes) -> bytes: ...
def ctr256_decrypt(data: bytes, key: bytes, iv: bytes, state: bytes) -> bytes: ...

def cbc256_encrypt(data: bytes, key: bytes, iv: bytes) -> bytes: ...
def cbc256_decrypt(data: bytes, key: bytes, iv: bytes) -> bytes: ...

Usage

IGE Mode

Note: Data must be padded to match a multiple of the block size (16 bytes).

import os

import tgcrypto

data = os.urandom(10 * 1024 * 1024 + 7)  # 10 MB of random data + 7 bytes to show padding
key = os.urandom(32)  # Random Key
iv = os.urandom(32)  # Random IV

# Pad with zeroes: -7 % 16 = 9
data += bytes(-len(data) % 16)

ige_encrypted = tgcrypto.ige256_encrypt(data, key, iv)
ige_decrypted = tgcrypto.ige256_decrypt(ige_encrypted, key, iv)

print(data == ige_decrypted)  # True

CTR Mode (single chunk)

import os

import tgcrypto

data = os.urandom(10 * 1024 * 1024)  # 10 MB of random data

key = os.urandom(32)  # Random Key

enc_iv = bytearray(os.urandom(16))  # Random IV
dec_iv = enc_iv.copy()  # Keep a copy for decryption

ctr_encrypted = tgcrypto.ctr256_encrypt(data, key, enc_iv, bytes(1))
ctr_decrypted = tgcrypto.ctr256_decrypt(ctr_encrypted, key, dec_iv, bytes(1))

print(data == ctr_decrypted)  # True

CTR Mode (stream)

import os
from io import BytesIO

import tgcrypto

data = BytesIO(os.urandom(10 * 1024 * 1024))  # 10 MB of random data

key = os.urandom(32)  # Random Key

enc_iv = bytearray(os.urandom(16))  # Random IV
dec_iv = enc_iv.copy()  # Keep a copy for decryption

enc_state = bytes(1)  # Encryption state, starts from 0
dec_state = bytes(1)  # Decryption state, starts from 0

encrypted_data = BytesIO()  # Encrypted data buffer
decrypted_data = BytesIO()  # Decrypted data buffer

while True:
    chunk = data.read(1024)

    if not chunk:
        break

    # Write 1K encrypted bytes into the encrypted data buffer
    encrypted_data.write(tgcrypto.ctr256_encrypt(chunk, key, enc_iv, enc_state))

# Reset position. We need to read it now
encrypted_data.seek(0)

while True:
    chunk = encrypted_data.read(1024)

    if not chunk:
        break

    # Write 1K decrypted bytes into the decrypted data buffer
    decrypted_data.write(tgcrypto.ctr256_decrypt(chunk, key, dec_iv, dec_state))

print(data.getvalue() == decrypted_data.getvalue())  # True

CBC Mode

Note: Data must be padded to match a multiple of the block size (16 bytes).

import os

import tgcrypto

data = os.urandom(10 * 1024 * 1024 + 7)  # 10 MB of random data + 7 bytes to show padding
key = os.urandom(32)  # Random Key

enc_iv = bytearray(os.urandom(16))  # Random IV
dec_iv = enc_iv.copy()  # Keep a copy for decryption

# Pad with zeroes: -7 % 16 = 9
data += bytes(-len(data) % 16)

cbc_encrypted = tgcrypto.cbc256_encrypt(data, key, enc_iv)
cbc_decrypted = tgcrypto.cbc256_decrypt(cbc_encrypted, key, dec_iv)

print(data == cbc_decrypted)  # True

Testing

  1. Clone this repository: git clone https://github.com/pyrogram/tgcrypto.
  2. Enter the directory: cd tgcrypto.
  3. Run tests: python3 setup.py test.

License

LGPLv3+ © 2017-2020 Dan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

TgCrypto-1.2.1-cp38-cp38-win_amd64.whl (44.8 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

TgCrypto-1.2.1-cp38-cp38-win32.whl (44.6 kB view hashes)

Uploaded CPython 3.8 Windows x86

TgCrypto-1.2.1-cp38-cp38-manylinux2010_x86_64.whl (63.5 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.12+ x86-64

TgCrypto-1.2.1-cp38-cp38-manylinux2010_i686.whl (60.3 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.12+ i686

TgCrypto-1.2.1-cp38-cp38-manylinux1_x86_64.whl (63.5 kB view hashes)

Uploaded CPython 3.8

TgCrypto-1.2.1-cp38-cp38-manylinux1_i686.whl (60.3 kB view hashes)

Uploaded CPython 3.8

TgCrypto-1.2.1-cp38-cp38-macosx_10_9_x86_64.whl (44.2 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

TgCrypto-1.2.1-cp37-cp37m-win_amd64.whl (44.7 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

TgCrypto-1.2.1-cp37-cp37m-win32.whl (44.6 kB view hashes)

Uploaded CPython 3.7m Windows x86

TgCrypto-1.2.1-cp37-cp37m-manylinux2010_x86_64.whl (64.5 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

TgCrypto-1.2.1-cp37-cp37m-manylinux2010_i686.whl (61.3 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.12+ i686

TgCrypto-1.2.1-cp37-cp37m-manylinux1_x86_64.whl (64.5 kB view hashes)

Uploaded CPython 3.7m

TgCrypto-1.2.1-cp37-cp37m-manylinux1_i686.whl (61.3 kB view hashes)

Uploaded CPython 3.7m

TgCrypto-1.2.1-cp37-cp37m-macosx_10_6_intel.whl (59.2 kB view hashes)

Uploaded CPython 3.7m macOS 10.6+ intel

TgCrypto-1.2.1-cp36-cp36m-win_amd64.whl (44.7 kB view hashes)

Uploaded CPython 3.6m Windows x86-64

TgCrypto-1.2.1-cp36-cp36m-win32.whl (44.6 kB view hashes)

Uploaded CPython 3.6m Windows x86

TgCrypto-1.2.1-cp36-cp36m-manylinux2010_x86_64.whl (63.6 kB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

TgCrypto-1.2.1-cp36-cp36m-manylinux2010_i686.whl (60.5 kB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.12+ i686

TgCrypto-1.2.1-cp36-cp36m-manylinux1_x86_64.whl (63.6 kB view hashes)

Uploaded CPython 3.6m

TgCrypto-1.2.1-cp36-cp36m-manylinux1_i686.whl (60.5 kB view hashes)

Uploaded CPython 3.6m

TgCrypto-1.2.1-cp36-cp36m-macosx_10_6_intel.whl (59.2 kB view hashes)

Uploaded CPython 3.6m macOS 10.6+ intel

TgCrypto-1.2.1-cp35-cp35m-win_amd64.whl (44.7 kB view hashes)

Uploaded CPython 3.5m Windows x86-64

TgCrypto-1.2.1-cp35-cp35m-win32.whl (44.6 kB view hashes)

Uploaded CPython 3.5m Windows x86

TgCrypto-1.2.1-cp35-cp35m-manylinux2010_x86_64.whl (63.3 kB view hashes)

Uploaded CPython 3.5m manylinux: glibc 2.12+ x86-64

TgCrypto-1.2.1-cp35-cp35m-manylinux2010_i686.whl (60.2 kB view hashes)

Uploaded CPython 3.5m manylinux: glibc 2.12+ i686

TgCrypto-1.2.1-cp35-cp35m-manylinux1_x86_64.whl (63.3 kB view hashes)

Uploaded CPython 3.5m

TgCrypto-1.2.1-cp35-cp35m-manylinux1_i686.whl (60.2 kB view hashes)

Uploaded CPython 3.5m

TgCrypto-1.2.1-cp35-cp35m-macosx_10_6_intel.whl (59.2 kB view hashes)

Uploaded CPython 3.5m macOS 10.6+ intel

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page