diff --git a/README.html b/README.html index 666a693..56e46c0 100644 --- a/README.html +++ b/README.html @@ -224,10 +224,10 @@ Written by Drew (@topkecleon) and Kay M (@gnadelwartz).

Linted by #ShellCheck

Prerequisites

Uses JSON.sh and the magic of sed.

-

Even bashbot is written in bash, it depends on commands typically available in a Linux/Unix Environment. More concrete on the common commands provided by recent versions of coreutils, busybox or toybox, see Developer Notes

-

Note for MacOS and BSD Users: As bashbot heavily uses modern bash and (gnu) grep/sed features, bashbot will not run without installing additional software, see Install Bashbot

-

Note for embedded systems: busybox or toybox ONLY is not sufficient, you need a to install a "real" bash, see also Install Bashbot

-

Bashbot Documentation and Downloads are available on www.github.com

+

Bashbot is written in bash. It depends on commands typically available in a Linux/Unix Environment. For more concrete information on the common commands provided by recent versions of coreutils, busybox or toybox, see Developer Notes.

+

Note for MacOS and BSD Users: Bashbot will not run without installing additional software as it uses modern bash and (gnu) grep/sed features. See Install Bashbot.

+

Note for embedded systems: You need to install a "real" bash as the vanilla installation of busybox or toybox is not sufficient. See Install Bashbot.

+

Bashbot Documentation and Downloads are available on www.github.com.

Documentation

-
  • Examples Dir
    • +
  • Examples Directory
    • -

    Your really first bashbot in a nutshell

    +

    Your very first bashbot in a nutshell

    To install and run bashbot you need access to a Linux/Unix command line with bash, a Telegram client and a mobile phone with a Telegram account.

    First you need to create a new Telegram Bot token for your bot and write it down.

    Now open a Linux/Unix terminal with bash, create a new directory, change to it and install telegram-bot-bash:

    @@ -312,7 +312,7 @@ Written by Drew (@topkecleon) and Kay M (@gnadelwartz). Bot Name: yourbotname_bot Session Name: yourbotname_bot-startbot Bot started successfully. -

    Now open the Telegram App on your mobile phone and start a chatting with your bot (your bot's username is shown after 'Bot Name:'):

    +

    Now open the Telegram App on your mobile phone and start a chat with your bot (your bot's username is shown after 'Bot Name:'):

    /start
 
 You are Botadmin
@@ -325,56 +325,56 @@ You are Botadmin
 
 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

    +

    For more Information on how to install, customize and use your new bot, read the Documentation.

    Log files

    -

    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

    +

    Bashbot actions are logged to BASHBOT.log. Telegram send/receive errors are logged to ERROR.log. Start bashbot in debug mode to see all messages sent to / received from Telegram, as well as bash command error messages.

    +

    To enable debug mode, start bashbot with debug as third argument: bashbot start debug

    ├── logs 
 │   ├── BASHBOT.log      # log what your bot is doing ...
-│   ├── ERROR.log        # connection errors from / to telegram API
+│   ├── ERROR.log        # connection errors from / to Telegram API
 │   │
 │   ├── DEBUG.log        # stdout/stderr of you bot (debug mode enabled)
 │   └── MESSAGE.log      # full text of all message send/received (debug mode enabled)

    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 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 remote code execution (RCE) or remote information disclosure (RID) 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.

    +

    Bash scripts in general are not designed to be bulletproof, 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 appropriately, disable globbing with set -f and quote everything). In addition remove unused scripts and examples from your Bot (e.g. everything in example/) and disable/remove all unused 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 is variable and command substitution using ${} and$() can lead to remote code execution (RCE) or remote information disclosure (RID) 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

    +

    If you're writing a script that accepts external input (e.g. from the user as arguments or the file system), you shouldn't use echo to display it. Use printf whenever possible.

    Run your Bot as a restricted user

    -

    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. Restrict your Bots access rights to the absolute minimum.

    +

    I recommend running your bot as a user with almost no access rights. All files your Bot has write access to are in danger of being overwritten/deleted if your bot is hacked. For the same reason every file your Bot can read is in danger of being disclosed. Restrict 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 Linux/Unix 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!

    +

    Your Bot configuration must not be readable by 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 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 ...

    +

    Bashbot is not more (in)secure than a Bot written in another 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: Up to version 0.941 (mai/22/2020) telegram-bot-bash had a remote code execution bug, please update if you use an older version!

    Why Bash and not the much better xyz?

    -

    Well, that's a damn good question... maybe because I'm a Unix admin from stone age. Nevertheless there are more reasons from my side:

    +

    Well, that's a damn good question... maybe because I'm a Unix admin from the stone age. Nevertheless there are more reasons from my side:

    Can I have the single bashbot.sh file back?

    -

    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

    +

    At the beginning bashbot was simply the filebashbot.sh that you could 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 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.

    +

    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
    -

    You can also source bashbot for use in your scripts, for more information see Expert Use

    +

    You can also source bashbot for use in your scripts, for more information see Expert Use.

    Blocked by telegram?

    -

    This may happen if to many or wrong requests are sent to api.telegram.org, e.g. using a invalid token or not existing API calls. If the block stay for longer time you can ask telegram service to unblock your IP-Adress.

    +

    This may happen if too many or wrong requests are sent to api.telegram.org, e.g. using a invalid token or invalid API calls. If the block stay for longer time you can ask telegram service to unblock your IP-Address.

    You can check with curl or wget if you are blocked by Telegram:

    curl -m 10  https://api.telegram.org/bot
 #curl: (28) Connection timed out after 10001 milliseconds
@@ -385,7 +385,7 @@ It features background tasks and interactive chats, and can serve as an interfac
 nc -w 2 api.telegram.org 443 || echo "your IP seems blocked by telegram"
 #your IP seems blocked by telegram

    Bashbot offers the option to recover from broken connections (blocked). Therefore you can provide a function named bashbotBlockRecover() in mycommands.sh, the function is called every time when a broken connection is detected.

    -

    Possible actions are: Check if network is working, change IP-Adress or simply wait some time. See mycommnds.sh.dist for an example.

    +

    Possible actions are: Check if network is working, change IP-Address or simply wait some time. See mycommnds.sh.dist for an example.

    @Gnadelwartz

    That's it all guys!

    diff --git a/README.md b/README.md index a9695c0..2069554 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,14 @@ Linted by [#ShellCheck](https://github.com/koalaman/shellcheck) ## Prerequisites Uses [JSON.sh](http://github.com/dominictarr/JSON.sh) and the magic of sed. -Even bashbot is written in bash, it depends on commands typically available in a Linux/Unix Environment. -More concrete on the common commands provided by recent versions of [coreutils](https://en.wikipedia.org/wiki/List_of_GNU_Core_Utilities_commands), [busybox](https://en.wikipedia.org/wiki/BusyBox#Commands) or [toybox](https://landley.net/toybox/help.html), see [Developer Notes](doc/7_develop.md#common-commands) +Bashbot is written in bash. It depends on commands typically available in a Linux/Unix Environment. +For more concrete information on the common commands provided by recent versions of [coreutils](https://en.wikipedia.org/wiki/List_of_GNU_Core_Utilities_commands), [busybox](https://en.wikipedia.org/wiki/BusyBox#Commands) or [toybox](https://landley.net/toybox/help.html), see [Developer Notes](doc/7_develop.md#common-commands). -**Note for MacOS and BSD Users:** As bashbot heavily uses modern bash and (gnu) grep/sed features, bashbot will not run without installing additional software, see [Install Bashbot](doc/0_install.md) +**Note for MacOS and BSD Users:** Bashbot will not run without installing additional software as it uses modern bash and (gnu) grep/sed features. See [Install Bashbot](doc/0_install.md). -**Note for embedded systems:** busybox or toybox ONLY is not sufficient, you need a to install a "real" bash, see also [Install Bashbot](doc/0_install.md) +**Note for embedded systems:** You need to install a "real" bash as the vanilla installation of busybox or toybox is not sufficient. See [Install Bashbot](doc/0_install.md). -Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are available on www.github.com +Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are available on [www.github.com](https://www.github.com). ## Documentation * [Introduction to Telegram Bots](https://core.telegram.org/bots) @@ -63,9 +63,9 @@ Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Do * Modules, addons, events * Setup your environment * Bashbot test suite -* [Examples Dir](examples/README.md) +* [Examples Directory](examples/README.md) -### Your really first bashbot in a nutshell +### Your very first bashbot in a nutshell To install and run bashbot you need access to a Linux/Unix command line with bash, a [Telegram client](https://telegram.org) and a mobile phone [with a Telegram account](https://telegramguide.com/create-a-telegram-account/). @@ -98,7 +98,7 @@ Session Name: yourbotname_bot-startbot Bot started successfully. ``` -Now open the Telegram App on your mobile phone and start a chatting with your bot (_your bot's username is shown after 'Bot Name:'_): +Now open the Telegram App on your mobile phone and start a chat with your bot (_your bot's username is shown after 'Bot Name:'_): ``` /start @@ -114,19 +114,19 @@ You are Botadmin 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](#Documentation) +For more Information on how to install, customize and use your new bot, read the [Documentation](#Documentation). ### Log files -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. +Bashbot actions are logged to `BASHBOT.log`. Telegram send/receive errors are logged to `ERROR.log`. +Start bashbot in debug mode to see all messages sent to / received from Telegram, as well as bash command error messages. -To enable debug mode start bashbot with debug as third argument: `bashbot start debug` +To enable debug mode, start bashbot with debug as third argument: `bashbot start debug` ``` ├── logs │   ├── BASHBOT.log # log what your bot is doing ... -│   ├── ERROR.log # connection errors from / to telegram API +│   ├── ERROR.log # connection errors from / to Telegram API │   │ │   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled) │   └── MESSAGE.log # full text of all message send/received (debug mode enabled) @@ -137,37 +137,36 @@ To enable debug mode start bashbot with debug as third argument: `bashbot start ## 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 scripts in general are not designed to be bulletproof, so consider this Bot as a proof of concept. Bash programmers often struggle with 'quoting hell' and globbing, -see [Implications of wrong quoting](https://unix.stackexchange.com/questions/171346/security-implications-of-forgetting-to-quote-a-variable-in-bash-posix-shells) +see [Implications of wrong quoting](https://unix.stackexchange.com/questions/171346/security-implications-of-forgetting-to-quote-a-variable-in-bash-posix-shells). -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. +Whenever you are processing input from untrusted sources (messages, files, network) you must be as careful as possible +(e.g. set IFS appropriately, disable globbing with `set -f` and quote everything). In addition remove unused scripts and examples +from your Bot (e.g. everything in `example/`) and disable/remove all unused 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 remote code execution (RCE) or remote information disclosure (RID) bugs if unescaped `$` is included in untrusted input, e.g. `$$` or `$(rm -rf /*)` +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 is variable and command substitution using `${}` and`$()` can lead to remote code execution (RCE) or remote information disclosure (RID) 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](https://www.shellcheck.net/) or [install shellcheck locally](https://github.com/koalaman/shellcheck#installing). 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. +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](doc/7_develop.md) 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](https://unix.stackexchange.com/a/6581) +If you're writing a script that accepts external input (e.g. from the user as arguments or the file system), +you shouldn't use echo to display it. [Use printf whenever possible](https://unix.stackexchange.com/a/6581). ### Run your Bot as a restricted user -**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. Restrict your Bots access rights to the absolute minimum. +**I recommend running your bot as a user with almost no access rights.** +All files your Bot has write access to are in danger of being overwritten/deleted if your bot is hacked. +For the same reason every file your Bot can read is in danger of being disclosed. Restrict 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 Linux/Unix systems. See [Expert use](doc/4_expert.md) 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! +**Your Bot configuration must not be readable by 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. @@ -176,26 +175,26 @@ To set access rights for your bashbot installation to a reasonable default run`s ## 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 ... +Bashbot is not more (in)secure than a Bot written in another 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:** Up to version 0.941 (mai/22/2020) telegram-bot-bash had a remote code execution bug, please update if you use an older version! ### Why Bash and not the much better xyz? -Well, that's a damn good question... maybe because I'm a Unix admin from stone age. Nevertheless there are more reasons from my side: +Well, that's a damn good question... maybe because I'm a Unix admin from the stone age. Nevertheless there are more reasons from my side: -- bashbot will run everywhere where bash and (gnu) sed is available, from embedded Linux to mainframe +- bashbot will run wherever bash and (gnu) sed is available, from embedded Linux to mainframe - easy to integrate with other shell scripts, e.g. for sending system message / health status - no need to install or learn a new programming language, library or framework - 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. +At the beginning bashbot was simply the file`bashbot.sh` that you could 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](doc/7_develop.md) +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](doc/7_develop.md). ### Can I send messages from CLI and scripts? -Of course, you can send messages from command line and scripts, simply install bashbot as [described here](#Your-really-first-bashbot-in-a-nutshell), +Of course you can send messages from command line and scripts! Simply install bashbot as [described here](#Your-really-first-bashbot-in-a-nutshell), 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`. @@ -206,12 +205,12 @@ bin/send_message.sh BOTADMIN "This is my first message send from CLI" bin/send_message.sh --help ``` -You can also source bashbot for use in your scripts, for more information see [Expert Use](doc/8_custom.md) +You can also source bashbot for use in your scripts, for more information see [Expert Use](doc/8_custom.md). ### Blocked by telegram? -This may happen if to many or wrong requests are sent to api.telegram.org, e.g. using a invalid token or not existing API calls. -If the block stay for longer time you can ask telegram service to unblock your IP-Adress. +This may happen if too many or wrong requests are sent to api.telegram.org, e.g. using a invalid token or invalid API calls. +If the block stay for longer time you can ask telegram service to unblock your IP-Address. You can check with curl or wget if you are blocked by Telegram: ```bash @@ -228,7 +227,7 @@ nc -w 2 api.telegram.org 443 || echo "your IP seems blocked by telegram" Bashbot offers the option to recover from broken connections (blocked). Therefore you can provide a function named `bashbotBlockRecover()` in `mycommands.sh`, the function is called every time when a broken connection is detected. -Possible actions are: Check if network is working, change IP-Adress or simply wait some time. +Possible actions are: Check if network is working, change IP-Address or simply wait some time. See `mycommnds.sh.dist` for an example. --- diff --git a/README.txt b/README.txt index 30a1cec..fca44ac 100644 --- a/README.txt +++ b/README.txt @@ -17,24 +17,25 @@ Linted by [#ShellCheck](https://github.com/koalaman/shellcheck) ## Prerequisites Uses [JSON.sh](http://github.com/dominictarr/JSON.sh) and the magic of sed. -Even bashbot is written in bash, it depends on commands typically available in +Bashbot is written in bash. It depends on commands typically available in a Linux/Unix Environment. -More concrete on the common commands provided by recent versions of +For more concrete information on the common commands provided by recent versions of [coreutils](https://en.wikipedia.org/wiki/List_of_GNU_Core_Utilities_commands), [busybox](https://en.wikipedia.org/wiki/BusyBox#Commands) or [toybox](https://landley.net/toybox/help.html), see [Developer -Notes](doc/7_develop.md#common-commands) +Notes](doc/7_develop.md#common-commands). -**Note for MacOS and BSD Users:** As bashbot heavily uses modern bash and (gnu) -grep/sed features, bashbot will not run without installing additional software, -see [Install Bashbot](doc/0_install.md) +**Note for MacOS and BSD Users:** Bashbot will not run without installing +additional software as it uses modern bash and (gnu) grep/sed features. +See [Install Bashbot](doc/0_install.md). -**Note for embedded systems:** busybox or toybox ONLY is not sufficient, you -need a to install a "real" bash, see also [Install Bashbot](doc/0_install.md) +**Note for embedded systems:** You need to install a "real" bash as the +vanilla installation of busybox or toybox is not sufficient. +See [Install Bashbot](doc/0_install.md). Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are -available on www.github.com +available on [www.github.com](https://www.github.com). ## Documentation * [Introduction to Telegram Bots](https://core.telegram.org/bots) @@ -77,9 +78,9 @@ available on www.github.com * Modules, addons, events * Setup your environment * Bashbot test suite -* [Examples Dir](examples/README.md) +* [Examples Directory](examples/README.md) -### Your really first bashbot in a nutshell +### Your very first bashbot in a nutshell To install and run bashbot you need access to a Linux/Unix command line with bash, a [Telegram client](https://telegram.org) and a mobile phone [with a @@ -120,7 +121,7 @@ Session Name: yourbotname_bot-startbot Bot started successfully. ``` -Now open the Telegram App on your mobile phone and start a chatting with your +Now open the Telegram App on your mobile phone and start a chat with your bot (_your bot's username is shown after 'Bot Name:'_): ``` @@ -139,22 +140,22 @@ 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](#Documentation) +the [Documentation](#Documentation). ### Log files -Bashbot actions are logged to `BASHBOT.log`, Telegram send/receive errors are +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. +Start bashbot in debug mode to see all messages sent to / received from +Telegram, as well as bash command error messages. -To enable debug mode start bashbot with debug as third argument: `bashbot start +To enable debug mode, start bashbot with debug as third argument: `bashbot start debug` ``` ├── logs │   ├── BASHBOT.log # log what your bot is doing ... -│   ├── ERROR.log # connection errors from / to telegram API +│   ├── ERROR.log # connection errors from / to Telegram API │   │ │   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled) │   └── MESSAGE.log # full text of all message send/received (debug mode @@ -167,50 +168,50 @@ enabled) 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 +Bash scripts in general are not designed to be bulletproof, so consider this Bot as a proof of concept. Bash programmers often struggle with 'quoting hell' and globbing, see [Implications of wrong quoting](https://unix.stackexchange.com/questions/171346/security-implications-o -f-forgetting-to-quote-a-variable-in-bash-posix-shells) +f-forgetting-to-quote-a-variable-in-bash-posix-shells). 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 +network) you must be as careful as possible +(e.g. set IFS appropriately, disable globbing wity `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 +from your Bot (e.g. everything in `example/`) and disable/remove all unused 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 remote code execution (RCE) or remote information disclosure -(RID) bugs if unescaped `$` is included in untrusted input, e.g. `$$` or `$(rm --rf /*)` +(_as bashbot does_). +One of the powerful features of Unix shells is variable and command +substitution using `${}` and`$()` +can lead to remote code execution (RCE) or remote information disclosure +(RID) 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](https://www.shellcheck.net/) or [install shellcheck locally](https://github.com/koalaman/shellcheck#installing). 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. +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](doc/7_develop.md) 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...), +If you're writing a script that accepts external input (e.g. from the user as +arguments or the file system), you shouldn't use echo to display it. [Use printf whenever -possible](https://unix.stackexchange.com/a/6581) +possible](https://unix.stackexchange.com/a/6581). ### Run your Bot as a restricted user -**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 +**I recommend running your bot as a user with almost no access rights.** +All files your Bot has write access to are in danger of being overwritten/deleted if your bot is hacked. -For the same reason every file your Bot can read is in danger to be disclosed. +For the same reason every file your Bot can read is in danger of being disclosed. Restrict your Bots access rights to the absolute minimum. **Never run your Bot as root, this is the most dangerous you can do!** Usually @@ -218,7 +219,7 @@ the user 'nobody' has almost no rights on Linux/Unix systems. See [Expert use](doc/4_expert.md) 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 +**Your Bot configuration must not be readable by 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! @@ -235,7 +236,7 @@ directory. ## FAQ ### Is this Bot insecure? -Bashbot is not more (in)secure as any Bot written in an other language, we have +Bashbot is not more (in)secure than a Bot written in another 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 ... @@ -244,9 +245,9 @@ execution bug, please update if you use an older version! ### Why Bash and not the much better xyz? Well, that's a damn good question... maybe because I'm a Unix admin from -stone age. Nevertheless there are more reasons from my side: +the stone age. Nevertheless there are more reasons from my side: -- bashbot will run everywhere where bash and (gnu) sed is available, from +- bashbot will run wherever bash and (gnu) sed is available, from embedded Linux to mainframe - easy to integrate with other shell scripts, e.g. for sending system message / health status @@ -254,18 +255,18 @@ health status - 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 +At the beginning bashbot was simply the file`bashbot.sh` that you could 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 +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](doc/7_develop.md) +down version of your Bot](doc/7_develop.md). ### Can I send messages from CLI and scripts? -Of course, you can send messages from command line and scripts, simply install +Of course you can send messages from command line and scripts! Simply install bashbot as [described here](#Your-really-first-bashbot-in-a-nutshell), send the message '/start' to set yourself as botadmin and then stop the bot with `./bashbot.sh stop`. @@ -280,14 +281,14 @@ bin/send_message.sh --help ``` You can also source bashbot for use in your scripts, for more information see -[Expert Use](doc/8_custom.md) +[Expert Use](doc/8_custom.md). ### Blocked by telegram? -This may happen if to many or wrong requests are sent to api.telegram.org, e.g. -using a invalid token or not existing API calls. +This may happen if too many or wrong requests are sent to api.telegram.org, e.g. +using a invalid token or invalid API calls. If the block stay for longer time you can ask telegram service to unblock your -IP-Adress. +IP-Address. You can check with curl or wget if you are blocked by Telegram: ```bash @@ -307,7 +308,7 @@ Therefore you can provide a function named `bashbotBlockRecover()` in `mycommands.sh`, the function is called every time when a broken connection is detected. -Possible actions are: Check if network is working, change IP-Adress or simply +Possible actions are: Check if network is working, change IP-Address or simply wait some time. See `mycommnds.sh.dist` for an example. diff --git a/doc/4_expert.md b/doc/4_expert.md index f6d2d9a..7dc42ab 100644 --- a/doc/4_expert.md +++ b/doc/4_expert.md @@ -262,7 +262,7 @@ This is also useful if you want to force bashbot to always use full pathnames in #### Change config values ##### BASHBOT_URL -Uses given URL instead of official telegram API URL, useful if you have your own telegram server or for testing. +Uses given URL instead of official Telegram API URL, useful if you have your own telegram server or for testing. ```bash unset BASHBOT_URL # use Telegram URL https://api.telegram.org/bot (default) diff --git a/doc/7_develop.md b/doc/7_develop.md index f2323e4..5ae89fc 100644 --- a/doc/7_develop.md +++ b/doc/7_develop.md @@ -175,7 +175,7 @@ BASHBOT_EVENT_TIMER["example_10min","$(( (EVENT_TIMER+10) * -1 ))"]="example_in1 ---- -#### Create a stripped down Version of your Bot +#### Create a stripped down version of your Bot Currently bashbot is more a bot development environment than a bot, containing examples, developer scripts, modules, documentation and more. You don't need all these files after you're finished with your cool new bot.