Document the crypto/ module

telethon/crypto/aes_ctr.py

@@ -1,3 +1,6 @@
+"""
+This module holds the AESModeCTR wrapper class.
+"""
 import pyaes
 
 
@@ -6,6 +9,12 @@ class AESModeCTR:
     # TODO Maybe make a pull request to pyaes to support iv on CTR
 
     def __init__(self, key, iv):
+        """
+        Initializes the AES CTR mode with the given key/iv pair.
+
+        :param key: the key to be used as bytes.
+        :param iv: the bytes initialization vector. Must have a length of 16.
+        """
         # TODO Use libssl if available
         assert isinstance(key, bytes)
         self._aes = pyaes.AESModeOfOperationCTR(key)
@@ -15,7 +24,19 @@ class AESModeCTR:
         self._aes._counter._counter = list(iv)
 
     def encrypt(self, data):
+        """
+        Encrypts the given plain text through AES CTR.
+
+        :param data: the plain text to be encrypted.
+        :return: the encrypted cipher text.
+        """
         return self._aes.encrypt(data)
 
     def decrypt(self, data):
+        """
+        Decrypts the given cipher text through AES CTR
+
+        :param data: the cipher text to be decrypted.
+        :return: the decrypted plain text.
+        """
         return self._aes.decrypt(data)