diff --git a/README.html b/README.html index 35c0535..c8f5e59 100644 --- a/README.html +++ b/README.html @@ -327,7 +327,7 @@ This is bashbot, the Telegram bot written entirely in bash. It features background tasks and interactive chats, and can serve as an interface for CLI programs.
For more Information on how to install, customize and use your new bot, read the Documentation
Bashbot actions are logged in BASHBOT.log, Telegram send/receive errors are logged to ERROR.log. Start bashbot in debug mode to get all messages send to / received from Telegram and error messages of bash commands also.
+Bashbot actions are logged to BASHBOT.log
, Telegram send/receive errors are logged to ERROR.log
. Start bashbot in debug mode to get all messages send to / received from Telegram and error messages of bash commands also.
To enable debug mode start bashbot with debug as third argument: bashbot start debug
├── logs
│ ├── BASHBOT.log # log what your bot is doing ...
@@ -339,8 +339,8 @@ It features background tasks and interactive chats, and can serve as an interfac
Security Considerations
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 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.
-One of the most powerful features of unix shells 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. So it's more secure to escape or remove '$' in input from user, files or network.
+Whenever you are processing input 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 remove unused scripts and examples from your Bot, e.g. everything in example/
and disable/remove all not needed bot commands.
+It's important to escape or remove $
in input from user, files or network (as bashbot does) One of the powerful features of unix shells are variable and command substitution using ${}
and$()
, this can lead to remove code execution (RCE) or information disclosing bugs if unescaped $
is included in untrusted input, e.g. $$
or $(rm -rf /*)
A powerful tool to improve your scripts is shellcheck
. You can use it online or install shellcheck locally. Shellcheck is used extensively in bashbot development to ensure 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.
Use printf whenever possible
If you're writing a script and it is taking external input (from the user as arguments or file system...), you shouldn't use echo to display it. Use printf whenever possible
@@ -349,8 +349,8 @@ It features background tasks and interactive chats, and can serve as an interfac
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.
Secure your Bot installation
Your Bot configuration must no be readable from other users. Everyone who can read your Bots token is able to act as your Bot and has access to all chats the Bot is in!
-Everyone with read access to your Bot files can extract your Bots data. Especially your Bot config in config.jssh
must be protected against other users. No one except you should have write access to the Bot files. The Bot should be restricted to have write access to count.jssh
and data-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.
+Everyone with read access to your Bot files can extract your Bots data. Especially your Bot config inconfig.jssh
must be protected against other users. No one except you should have write access to the Bot files. The Bot should be restricted to have write access tocount.jssh
and data-bot-bash
only, all other files must be write protected.
+To set access rights for your bashbot installation to a reasonable default runsudo ./bashbot.sh init
after every update or change to your installation directory.
FAQ
Is this Bot insecure?
Bashbot is not more (in)secure as any Bot written in an 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 ...
@@ -364,11 +364,11 @@ It features background tasks and interactive chats, and can serve as an interfac
no database, not event driven, not object oriented ...
Can I have the single bashbot.sh file back?
-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
+At the beginning bashbot was simply the filebashbot.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 rundev/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
Can I send messages from CLI and scripts?
-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 stop
.
-Bashbot provides some ready to use scripts ro send messages from command line in bin/
dir, e.g. send_message.sh
.
+Of course, you can send messages from command line and scripts, simply install bashbot as described here, send the message '/start' to set yourself as botadmin and then stop the bot with ./bashbot.sh stop
.
+Bashbot provides some ready to use scripts for sending messages from command line in bin/
dir, e.g. send_message.sh
.
bin/send_message.sh BOTADMIN "This is my first message send from CLI"
bin/send_message.sh --help
@@ -390,6 +390,6 @@ It features background tasks and interactive chats, and can serve as an interfac
@Gnadelwartz
That's it all guys!
If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
-$$VERSION$$ v1.21-dev-28-g43f5536
+$$VERSION$$ v1.21-dev-33-gd083390