A telegram bot to generate OTPs
Project description
Yet Another OTP Bot
A Telegram Bot to generate OTPs.
Architecture
Software
Yaotpbot is written in Python and use telegram-bot-api to interact with Telegram.
Infrastructure
A DynamoDB table it's used to store the identifiers of the chats and all the related seeds, needed to generate OTPs. All those information are stored encrypted and just decrpyted at runtime, using dynamodb-encryption-sdk library with AES encryption.
Deployment
CI/CD is automated with GitOps. in particular:
- The pipeline
- Builds the artifact and publishes it on Pypi;
- Builds the container using buildx to support multiple architecture and push the images on GitLab container registry.
- The operator deploys and keep synced the manifests created on a local k3s cluster.
Installation and usage
The bot can either be used as a container (registry) or installed directly with pip running
pip3 install --upgrade yaotpbot
Note that following environment variables must be set:
| Name | Description |
|---|---|
| TELEGRAM_API_TOKEN | Telegram Api Token of your bot needed to interact with Telegram. You always get a new one when creating a new bot. |
| DYNAMO_DB_ENDPOINT | A custom DynamoDB endpoint when not using AWS. By default the bot looks for a table called yaotpbot-table using the credentials provided. |
| DYNAMO_AES_SIGN_KEY | Key used to sign encrypted data stored on DynamoDB. Can be generated running python scrips/keys.py |
| DYNAMO_AES_ENCRYPTION_KEY | Key used to encrypt data stored on DynamoDB. Can be generated running python scrips/keys.py |
| AWS_ACCESS_KEY_ID | AWS access key id. Used with AWS_SECRET_ACCESS_KEY to interact with DynamoDB. |
| AWS_SECRET_ACCESS_KEY | AWS secret access key. Used with AWS_ACCESS_KEY_ID to interact with DynamoDB. |
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
yaotpbot-0.0.10.tar.gz
(55.3 kB
view hashes)
Built Distribution
yaotpbot-0.0.10-py3-none-any.whl
(14.0 kB
view hashes)
Close
Hashes for yaotpbot-0.0.10-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ec42340ca7b583413ae45e0d13d009168b01e4d6dba832e3427b539920955f12 |
|
| MD5 | add20c0d0acf174b009675db9e5bc663 |
|
| BLAKE2b-256 | 5704964e4581f5a92799e486bb35d766fea65ad4ab9c78e45acbefc2f952e09b |
