Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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-2019 Dan

Download files

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

Files for TgCrypto, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size TgCrypto-1.2.0-cp34-cp34m-macosx_10_6_intel.whl (59.4 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp34-cp34m-manylinux1_i686.whl (40.6 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp34-cp34m-manylinux1_x86_64.whl (41.7 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp34-cp34m-win32.whl (43.4 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp34-cp34m-win_amd64.whl (41.4 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp35-cp35m-macosx_10_6_intel.whl (59.5 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp35-cp35m-manylinux1_i686.whl (40.8 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp35-cp35m-manylinux1_x86_64.whl (41.9 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp35-cp35m-win32.whl (44.5 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp35-cp35m-win_amd64.whl (44.7 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp36-cp36m-macosx_10_6_intel.whl (59.5 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp36-cp36m-manylinux1_i686.whl (41.0 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp36-cp36m-manylinux1_x86_64.whl (42.0 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp36-cp36m-win32.whl (44.5 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp36-cp36m-win_amd64.whl (44.7 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp37-cp37m-macosx_10_6_intel.whl (59.5 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp37-cp37m-manylinux1_i686.whl (42.0 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp37-cp37m-manylinux1_x86_64.whl (43.0 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp37-cp37m-win32.whl (44.5 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0-cp37-cp37m-win_amd64.whl (44.7 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size TgCrypto-1.2.0.tar.gz (36.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page