Authorization
Telegram Web App Authenticator utilities.
TelegramAuthenticator
Telegram Web App Authenticator.
Source code in telegram_webapp_auth/auth.py
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
|
__decode_signature(val)
staticmethod
Decode a base64-encoded signature, appending padding if necessary.
:param val: A base64-encoded string. :return: Decoded signature as bytes.
Source code in telegram_webapp_auth/auth.py
__ed25519_verify(public_key, signature, message)
staticmethod
Verify the Ed25519 signature of the message using the public key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
public_key | Ed25519PublicKey | public key | required |
signature | bytes | signature | required |
message | bytes | original message in bytes format | required |
Returns:
Name | Type | Description |
---|---|---|
bool | bool | True if the signature is valid, False otherwise |
Source code in telegram_webapp_auth/auth.py
__init__(secret)
Initialize the authenticator with a secret key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret | bytes | secret key generated from the Telegram Bot Token | required |
__parse_init_data(data)
staticmethod
Convert init_data string into dictionary.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | str | the query string passed by the webapp | required |
Source code in telegram_webapp_auth/auth.py
__parse_json(data)
staticmethod
Convert JSON string value from WebAppInitData to Python dictionary.
Links
https://core.telegram.org/bots/webapps#webappinitdata
Source code in telegram_webapp_auth/auth.py
__serialize_init_data(init_data_dict)
Serialize the init data dictionary into WebAppInitData object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
init_data_dict | Dict[str, Any] | the init data dictionary | required |
Returns:
Name | Type | Description |
---|---|---|
WebAppInitData | WebAppInitData | the serialized WebAppInitData object |
Source code in telegram_webapp_auth/auth.py
validate(init_data, expr_in=None)
Validates the data received via the Mini App. Returns a parsed init data object if is valid.
Links
https://core.telegram.org/bots/webapps#validating-data-received-via-the-mini-app
Parameters:
Name | Type | Description | Default |
---|---|---|---|
init_data | str | init data from mini app | required |
expr_in | Optional[timedelta] | time delta to check if the token is expired | None |
Returns:
Name | Type | Description |
---|---|---|
WebAppInitData | WebAppInitData | parsed init a data object |
Raises:
Type | Description |
---|---|
InvalidInitDataError | if the init data is invalid |
ExpiredInitDataError | if the init data is expired |
Source code in telegram_webapp_auth/auth.py
validate_third_party(init_data, bot_id, expr_in=None, is_test=False)
Validates the data for Third-Party Use, using the method from Telegram documentation.
Links
https://core.telegram.org/bots/webapps#validating-data-for-third-party-use
Parameters:
Name | Type | Description | Default |
---|---|---|---|
init_data | str | init data from mini app | required |
bot_id | int | Telegram Bot ID | required |
expr_in | Optional[timedelta] | time delta to check if the token is expired | None |
is_test | bool | true if the init data was issued in Telegram production environment | False |
Returns:
Name | Type | Description |
---|---|---|
WebAppInitData | WebAppInitData | parsed init a data object |
Raises:
Type | Description |
---|---|
InvalidInitDataError | if the init data is invalid |
ExpiredInitDataError | if the init data is expired |
Source code in telegram_webapp_auth/auth.py
generate_secret_key(token)
Generates a secret key from a Telegram token.
Links
https://core.telegram.org/bots/webapps#validating-data-received-via-the-mini-app
Parameters:
Name | Type | Description | Default |
---|---|---|---|
token | str | Telegram Bot Token | required |
Returns:
Name | Type | Description |
---|---|---|
bytes | bytes | secret key |