summaryrefslogtreecommitdiff
path: root/tidal_dl_ng
diff options
context:
space:
mode:
authorRobert Honz <exislow+github@gmail.com>2025-07-03 09:45:18 +0200
committerRobert Honz <exislow+github@gmail.com>2025-07-03 09:45:18 +0200
commit4662d18fdfc25d42d496cf6abb1c8d44be0c76dd (patch)
treea5e625565e2439ad92c590f7f9d2aeaf49824fe9 /tidal_dl_ng
parent5b110638e0b1c2005ed04887537c1167e4a3b927 (diff)
downloadtidal-dl-ng-4662d18fdfc25d42d496cf6abb1c8d44be0c76dd.tar.gz
refactor(decryption): ✨ Improve docstring for `decrypt_security_token` function
- Enhanced clarity of the function's purpose and usage. - Added detailed descriptions for arguments and return values.
Diffstat (limited to 'tidal_dl_ng')
-rw-r--r--tidal_dl_ng/helper/decryption.py12
1 files changed, 10 insertions, 2 deletions
diff --git a/tidal_dl_ng/helper/decryption.py b/tidal_dl_ng/helper/decryption.py
index 17ea19b..2f38fc5 100644
--- a/tidal_dl_ng/helper/decryption.py
+++ b/tidal_dl_ng/helper/decryption.py
@@ -7,9 +7,17 @@ from Crypto.Util import Counter
def decrypt_security_token(security_token: str) -> (str, str):
"""
- Decrypts security token into key and nonce pair
+ The `decrypt_security_token` function decrypts a security token into a key and nonce pair using AES
+ encryption.
- security_token should match the securityToken value from the web response
+ Args:
+ security_token (str): The `security_token` parameter in the `decrypt_security_token` function is a
+ string that represents an encrypted security token. This function decrypts the security token into a
+ key and nonce pair using AES encryption. security_token should match the securityToken value from the web response.
+
+ Returns:
+ The `decrypt_security_token` function returns a tuple containing the key and nonce extracted from
+ the decrypted security token.
"""
# Do not change this