diff --git a/README.html b/README.html index 2f7f285..90f2a8a 100644 --- a/README.html +++ b/README.html @@ -143,7 +143,7 @@ Written by Drew (@topkecleon), Daniil Gentili (@danogentili), and Kay M (@gnadel
Create a new directory and change to it: mkdir tbb; cd tbb
and download the latest '*.tar.gz' file from https://github.com/topkecleon/telegram-bot-bash/releases. This can be done with the commands:
Extract the '*.tar.gz' file and change to bashbot directory: tar -xzf *.tar.gz; cd telegram-bot-bash
, install bashbot: ./bashbot.sh init
and enter your bot token when asked. All other questions can be answered by hitting the <Return> key.
Thats all, now you can start your bot with ./bashbot.sh start
and send him messages:
That's all, now you can start your bot with ./bashbot.sh start
and send him messages:
/start
You are Botadmin
@@ -187,11 +187,11 @@ It features background tasks and interactive chats, and can serve as an interfac
Running a Telegram Bot means it is connected to the public and you never know whats send to your Bot.
+Running a Telegram Bot means it is connected to the public and you never know what's send to your Bot.
Bash scripts in general are not designed to be bullet proof, so consider this Bot as a proof of concept. Bash programmers often struggle with 'quoting hell' and globbing, see Implications of wrong quoting
-Whenever you are processing input from from untrusted sources (messages, files, network) you must be as carefull as possible, e.g. set IFS appropriate, disable globbing (set -f) and quote everthing. In addition delete unused scripts and examples from your Bot, e.g. scripts 'notify', 'calc', 'question', and disable all not used commands.
+Whenever you are processing input from from untrusted sources (messages, files, network) you must be as careful as possible, e.g. set IFS appropriate, disable globbing (set -f) and quote everything. In addition delete unused scripts and examples from your Bot, e.g. scripts 'notify', 'calc', 'question', and disable all not used commands.
Note: Until v0.941 (mai/22/2020) telegram-bot-bash had a remote code execution (RCE) bug, pls update if you use an older version! see Issue #125
-One of the most powerful features of unix shells like bash is variable and command substitution using ${}
and $()
, but as they are expanded in doble quotes, this can lead to RCE and information disclosing bugs in complex scripts like bashbot even bash does much to avoid this. So it's more secure to escape or remove '$' in input from user, files or network.
One of the most powerful features of unix shells like bash is variable and command substitution using ${}
and $()
, but as they are expanded in double quotes, this can lead to RCE and information disclosing bugs in complex scripts like bashbot even bash does much to avoid this. So it's more secure to escape or remove '$' in input from user, files or network.
A powerful tool to improve your scripts is shellcheck
. You can use it online or install shellcheck locally. Shellcheck is used extensive in bashbot development to enshure a high code quality, e.g. it's not allowed to push changes without passing all shellcheck tests. In addition bashbot has a test suite to check if important functionality is working as expected.
If you're writing a script and it is taking external input (from the user as arguments, or file names from the file system...), you shouldn't use echo to display it. Use printf whenever possible
@@ -212,20 +212,20 @@ It features background tasks and interactive chats, and can serve as an interfacUsing a fixed path to the system provided bash makes it harder for attackers or users to place alternative versions of bash and avoids using a possibly broken, mangled or compromised bash executable.
If you are a BSD / MacOS user or must to use an other bash location, see Install Bashbot
I recommend to run your bot as a user, with almost no access rights. All files your Bot have write access to are in danger to be overwritten/deleted if your bot is hacked. For the same reason ervery file your Bot can read is in danger to be disclosed. Restict your Bots access rigths to the absolute minimum.
+I recommend to run your bot as a user, with almost no access rights. All files your Bot have write access to are in danger to be overwritten/deleted if your bot is hacked. For the same reason every file your Bot can read is in danger to be disclosed. Restict your Bots access rights to the absolute minimum.
Never run your Bot as root, this is the most dangerous you can do! Usually the user 'nobody' has almost no rights on Unix/Linux systems. See Expert use on how to run your Bot as an other user.
Your Bot configuration must no be readable from other users. Everyone who can read your Bots token can act as your Bot and has access to all chats your Bot is in!
-Everyone with read access to your Bot files can extract your Bots data. Especially your Bot Token in token
must be protected against other users. No one exept you must have write access to the Bot files. The Bot must be restricted to have write access to count
and tmp-bot-bash
only, all other files must be write protected.
Everyone with read access to your Bot files can extract your Bots data. Especially your Bot Token in token
must be protected against other users. No one except you must have write access to the Bot files. The Bot must be restricted to have write access to count
and tmp-bot-bash
only, all other files must be write protected.
To set access rights for your bashbot installation to a reasonable default run sudo ./bashbot.sh init
after every update or change to your installation directory.
Bashbot is not more (in)secure as any other Bot written in any other language, we have done our best to make it as secure as possible. But YOU are responsible for the bot commands you wrote and you should know about the risks ...
Note: Until v0.941 (mai/22/2020) telegram-bot-bash has a remote code execution bug, pls update if you use an older version!
Well, thats a damn good question ... may be because I'm an Unix/Linux admin from stone age. Nevertheless there are more reasons from my side:
+Well, that's a damn good question ... may be because I'm an Unix/Linux admin from stone age. Nevertheless there are more reasons from my side:
At the beginning bashbot was simply the file bashbot.sh
you can copy everywhere and run the bot. Now we have 'commands.sh', 'mycommands.sh', 'modules/*.sh' and much more.
Hey no Problem, if you are finished with your cool bot run dev/make-standalone.sh
to create a stripped down Version of your bot containing only 'bashbot.sh' and 'commands.sh'! For more information see Create a stripped down Version of your Bot
Of course, you can send messages from CLI and scripts, simply install bashbot as described here, send the messsage '/start' to set yourself as botadmin and stop the bot with ./bashbot.sh kill
.
Of course, you can send messages from CLI and scripts, simply install bashbot as described here, send the message '/start' to set yourself as botadmin and stop the bot with ./bashbot.sh kill
.
Run the following commands in your bash shell or script while you are in the installation directory:
# prepare bash / script to send commands
export BASHBOT_HOME="$(pwd)"
@@ -257,6 +257,6 @@ It features background tasks and interactive chats, and can serve as an interfac
@Gnadelwartz
That's it!
If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
-$$VERSION$$ v0.98-dev-69-gafa8d87
+$$VERSION$$ v0.98-dev-70-g694ee61