Skip to main content

A bot for encryption and decryption using Telegram

Project description

Cryptonit-BOT

CRYPTONIT-BOT

โ–บ Cryptonit-BOT is a Python-based bot designed to interact with cryptocurrency markets. This bot aims to automate trading strategies and provide users with insights and actions based on predefined rules.

license last-commit repo-top-language repo-language-count

Developed with the software and tools below.

Python


๐Ÿ”— Quick Links


๐Ÿ“ Overview

Alt Alt Alt


๐Ÿ“ฆ Features

Features
  • Environment Variable Configuration:

  • Securely retrieves the bot token from an environment variable, ensuring sensitive data is not hard-coded in the source code.

  • Password-based Encryption and Decryption:

    • Uses PBKDF2HMAC with SHA256 to derive encryption keys from passwords.
    • Encrypts and decrypts messages using AES in CBC mode with PKCS7 padding.
  • Secure Key and IV Generation:

    • Generates secure random salt and initialization vectors (IV) for each encryption operation to ensure security.
  • Bot Functionality:

    • Start and Help Commands:
      • Provides a welcome message and instructions for using the bot.
    • Encrypt Command:
      • Prompts the user for a password and the message to encrypt.
      • Returns the encrypted message and saves it to a file.
    • Decrypt Command:
      • Prompts the user for a password and the encrypted message.
      • Returns the decrypted message and saves it to a file.
  • File Handling:

    • Saves encrypted and decrypted messages along with the passwords used to respective files.
    • Includes functionality to read and append additional instructions from a separate file if it exists.
  • MarkdownV2 Escape:

    • Escapes special characters in messages to ensure proper formatting when using Telegram's MarkdownV2.
  • Custom Keyboard Creation:

    • Provides a custom keyboard with options for encrypting, decrypting, and getting help.
  • Error Handling and Logging:

    • Logs warnings and errors during file operations to help diagnose issues.
    • Provides user-friendly error messages in case of decryption failures.
  • File Sending:

    • Sends the encrypted or decrypted message files back to the user as a document via Telegram.
  • User-friendly Interface:

    • Offers a guided step-by-step interaction for encryption and decryption processes, ensuring ease of use.

๐Ÿ“‚ Repository Structure

โ””โ”€โ”€ Cryptonit-BOT/
    โ”œโ”€โ”€ Changelog.md
    โ”œโ”€โ”€ Instructions.txt
    โ”œโ”€โ”€ README.md
    โ”œโ”€โ”€ cryptonit.py
    โ”œโ”€โ”€ data
    โ”‚   โ”œโ”€โ”€ 1.gif
    โ”‚   โ”œโ”€โ”€ 2.gif
    โ”‚   โ”œโ”€โ”€ 4.gif
    โ”‚   โ”œโ”€โ”€ process.png
    โ”‚   โ”œโ”€โ”€ bot.png
    โ”‚   โ””โ”€โ”€ start.png
    โ””โ”€โ”€ requirements.txt
    โ””โ”€โ”€ LICENSE

๐Ÿงฉ Modules

Dependencies
telebot
cryptography
base64
uuid
os
logging

The project requires the following Python packages:

[Dependencies listed in requirements.txt]
File Summary
cryptonit.py โ–บ
Instructions.txt โ–บ
requirements.txt โ–บ

๐Ÿš€ Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

  • Python: version --last

โš™๏ธ Installation

  1. Clone BOT [the Cryptonit-BOT repository]:
git clone https://github.com/ruslanlap/Cryptonit-BOT
  1. Change to the project directory:
cd Cryptonit-BOT
  1. Install the dependencies:
pip install -r requirements.txt
  1. export TELEGRAM token:
export YOUR_BOT_TOKEN=<generated token here>

Telegram Token Setup

Here is an additional section for the README file on how to obtain a token from Telegram:

To use Cryptonit-BOT with Telegram, you need to obtain a bot token. Follow these steps to get your token:

  1. Open the Telegram app and search for the BotFather.
  2. Start a chat with the BotFather by typing /start.
  3. Create a new bot by typing /newbot and follow the instructions to name your bot and choose a username.
  4. After successfully creating the bot, BotFather will provide you with a token.

๐Ÿค– Running Cryptonit-BOT

Use the following command to run Cryptonit-BOT:

python cryptonit.py

Alt Alt


๐Ÿ›  Project Roadmap

  • โ–บ Cooming soon
  • โ–บ add more features
  • โ–บ ...

๐Ÿค Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine using a Git client.
    git clone https://github.com/ruslanlap/Cryptonit-BOT
    
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
    
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
    
  6. Push to GitHub: Push the changes to your forked repository.
    git push origin new-feature-x
    
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.


๐Ÿ“„ License

This project is protected under the MIT LICENSE License. For more details, refer to the LICENSE file.


๐Ÿ‘ Acknowledgments

  • List any resources, contributors, inspiration, etc. here.

Return


Project details


Download files

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

Source Distribution

cryptonitbot-0.0.1.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cryptonitbot-0.0.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file cryptonitbot-0.0.1.tar.gz.

File metadata

  • Download URL: cryptonitbot-0.0.1.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for cryptonitbot-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c3b47983adab7b9ecc3ca329cd07b434f9b8b5521a28e73b59db273c4b7f2df6
MD5 7495a3541de5975db2afa2f8d052dc80
BLAKE2b-256 33e8bbe9a6e06d2e62d66273256fb3a717b40644a3598b17ab6ef75d1df51aed

See more details on using hashes here.

File details

Details for the file cryptonitbot-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: cryptonitbot-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for cryptonitbot-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8e64dc86f254486c68556d53a8ae76fbf91738cf9dd4c323600560fa259d0b70
MD5 90ced8f492457479a43b74b0c8aa83a5
BLAKE2b-256 bc21c2f815ef363a81081950ec27241d7500906c57be1265d52cc86f40d60099

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page