octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-11-28 10:16:28 +00:00
Code Issues Projects Releases Wiki Activity

credits to dcoomber

Browse Source
This commit is contained in:
Kay Marquardt (Gnadelwartz) 2021-01-02 10:18:58 +01:00
parent 5415f28a38
commit dad68a95d0
8 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

@ -219,7 +219,7 @@ Bashbot - A Telegram bot written in bash.
</h2> </h2>
Written by Drew (@topkecleon) and Kay M (@gnadelwartz). Written by Drew (@topkecleon) and Kay M (@gnadelwartz).
<p>Contributions by Daniil Gentili (@danogentili), JuanPotato, BigNerd95, TiagoDanin, and iicc1.</p> <p>Contributions by Daniil Gentili (@danog), JuanPotato, BigNerd95, TiagoDanin, iicc1 and dcoomber.</p>
<p>Released to the public domain wherever applicable. Elsewhere, consider it released under the <a href="http://www.wtfpl.net/txt/copying/">WTFPLv2</a>.</p> <p>Released to the public domain wherever applicable. Elsewhere, consider it released under the <a href="http://www.wtfpl.net/txt/copying/">WTFPLv2</a>.</p>
<p>Linted by <a href="https://github.com/koalaman/shellcheck">#ShellCheck</a></p> <p>Linted by <a href="https://github.com/koalaman/shellcheck">#ShellCheck</a></p>
<h2>Prerequisites</h2> <h2>Prerequisites</h2>
@ -390,6 +390,6 @@ It features background tasks and interactive chats, and can serve as an interfac
<p>@Gnadelwartz</p> <p>@Gnadelwartz</p>
<h2>That's it all guys!</h2> <h2>That's it all guys!</h2>
<p>If you feel that there's something missing or if you found a bug, feel free to submit a pull request!</p> <p>If you feel that there's something missing or if you found a bug, feel free to submit a pull request!</p>
<h4>$$VERSION$$ v1.21-dev-34-ga5307e3</h4> <h4>$$VERSION$$ v1.21-pre-28-g5415f28</h4>
</body> </body>
</html> </html>

4
README.md
View File

@ -3,7 +3,7 @@ Bashbot - A Telegram bot written in bash.
</h2> </h2>
Written by Drew (@topkecleon) and Kay M (@gnadelwartz). Written by Drew (@topkecleon) and Kay M (@gnadelwartz).
Contributions by Daniil Gentili (@danogentili), JuanPotato, BigNerd95, TiagoDanin, and iicc1. Contributions by Daniil Gentili (@danog), JuanPotato, BigNerd95, TiagoDanin, iicc1 and dcoomber.
Released to the public domain wherever applicable. Released to the public domain wherever applicable.
Elsewhere, consider it released under the [WTFPLv2](http://www.wtfpl.net/txt/copying/). Elsewhere, consider it released under the [WTFPLv2](http://www.wtfpl.net/txt/copying/).
@ -238,4 +238,4 @@ See `mycommnds.sh.dist` for an example.
If you feel that there's something missing or if you found a bug, feel free to submit a pull request! 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-34-ga5307e3 #### $$VERSION$$ v1.21-pre-28-g5415f28

68
README.txt
View File

@ -5,8 +5,8 @@ Bashbot - A Telegram bot written in bash.
</h2> </h2>
Written by Drew (@topkecleon) and Kay M (@gnadelwartz). Written by Drew (@topkecleon) and Kay M (@gnadelwartz).
Contributions by Daniil Gentili (@danogentili), JuanPotato, BigNerd95, Contributions by Daniil Gentili (@danog), JuanPotato, BigNerd95, TiagoDanin,
TiagoDanin, and iicc1. iicc1 and dcoomber.
Released to the public domain wherever applicable. Released to the public domain wherever applicable.
Elsewhere, consider it released under the Elsewhere, consider it released under the
@ -17,21 +17,22 @@ Linted by [#ShellCheck](https://github.com/koalaman/shellcheck)
## Prerequisites ## Prerequisites
Uses [JSON.sh](http://github.com/dominictarr/JSON.sh) and the magic of sed. Uses [JSON.sh](http://github.com/dominictarr/JSON.sh) and the magic of sed.
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
a Linux/Unix Environment. Linux/Unix Environment.
For more concrete information 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), [coreutils](https://en.wikipedia.org/wiki/List_of_GNU_Core_Utilities_commands),
[busybox](https://en.wikipedia.org/wiki/BusyBox#Commands) or [busybox](https://en.wikipedia.org/wiki/BusyBox#Commands) or
[toybox](https://landley.net/toybox/help.html), see [Developer [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:** Bashbot will not run without installing **Note for MacOS and BSD Users:** Bashbot will not run without installing
additional software as it uses modern bash and (gnu) grep/sed features. additional software as it uses modern bash and (gnu) grep/sed features. See
See [Install Bashbot](doc/0_install.md). [Install Bashbot](doc/0_install.md).
**Note for embedded systems:** You need to install a "real" bash as the **Note for embedded systems:** You need to install a "real" bash as the vanilla
vanilla installation of busybox or toybox is not sufficient. installation of busybox or toybox is not sufficient. See [Install
See [Install Bashbot](doc/0_install.md). Bashbot](doc/0_install.md).
Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and
[Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are [Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are
@ -121,8 +122,8 @@ Session Name: yourbotname_bot-startbot
Bot started successfully. Bot started successfully.
``` ```
Now open the Telegram App on your mobile phone and start a chat with your Now open the Telegram App on your mobile phone and start a chat with your bot
bot (_your bot's username is shown after 'Bot Name:'_): (_your bot's username is shown after 'Bot Name:'_):
``` ```
/start /start
@ -149,8 +150,8 @@ logged to `ERROR.log`.
Start bashbot in debug mode to see all messages sent to / received from Start bashbot in debug mode to see all messages sent to / received from
Telegram, as well as bash command error messages. 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
debug` start debug`
``` ```
├── logs ├── logs
@ -177,18 +178,17 @@ f-forgetting-to-quote-a-variable-in-bash-posix-shells).
Whenever you are processing input from untrusted sources (messages, files, Whenever you are processing input from untrusted sources (messages, files,
network) you must be as careful as possible network) you must be as careful as possible
(e.g. set IFS appropriately, disable globbing wity `set -f` and quote everything). In (e.g. set IFS appropriately, disable globbing with `set -f` and quote
addition remove unused scripts and examples everything). In addition remove unused scripts and examples
from your Bot (e.g. everything in `example/`) and disable/remove all unused from your Bot (e.g. everything in `example/`) and disable/remove all unused bot
bot commands. commands.
It's important to escape or remove `$` in input from user, files or network It's important to escape or remove `$` in input from user, files or network
(_as bashbot does_). (_as bashbot does_).
One of the powerful features of Unix shells is variable and command One of the powerful features of Unix shells is variable and command
substitution using `${}` and`$()` substitution using `${}` and`$()` can lead to remote code execution (RCE) or
can lead to remote code execution (RCE) or remote information disclosure remote information disclosure (RID) bugs if unescaped `$` is included in
(RID) bugs if unescaped `$` is included in untrusted input (e.g. `$$` or `$(rm untrusted input (e.g. `$$` or `$(rm -rf /*)`).
-rf /*)`).
A powerful tool to improve your scripts is `shellcheck`. You can [use it A powerful tool to improve your scripts is `shellcheck`. You can [use it
online](https://www.shellcheck.net/) or online](https://www.shellcheck.net/) or
@ -209,10 +209,10 @@ possible](https://unix.stackexchange.com/a/6581).
### Run your Bot as a restricted user ### Run your Bot as a restricted user
**I recommend running your bot as a user with almost no access rights.** **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 All files your Bot has write access to are in danger of being
if your bot is hacked. overwritten/deleted if your bot is hacked.
For the same reason every file your Bot can read is in danger of being disclosed. For the same reason every file your Bot can read is in danger of being
Restrict your Bots access rights to the absolute minimum. 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 **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 the user 'nobody' has almost no rights on Linux/Unix systems. See [Expert
@ -244,11 +244,11 @@ bot commands you wrote and you should know about the risks ...
execution bug, please update if you use an older version! execution bug, please update if you use an older version!
### Why Bash and not the much better xyz? ### Why Bash and not the much better xyz?
Well, that's a damn good question... maybe because I'm a Unix admin from Well, that's a damn good question... maybe because I'm a Unix admin from the
the stone age. Nevertheless there are more reasons from my side: stone age. Nevertheless there are more reasons from my side:
- bashbot will run wherever bash and (gnu) sed is available, from - bashbot will run wherever bash and (gnu) sed is available, from embedded
embedded Linux to mainframe Linux to mainframe
- easy to integrate with other shell scripts, e.g. for sending system message / - easy to integrate with other shell scripts, e.g. for sending system message /
health status health status
- no need to install or learn a new programming language, library or framework - no need to install or learn a new programming language, library or framework
@ -285,8 +285,8 @@ You can also source bashbot for use in your scripts, for more information see
### Blocked by telegram? ### Blocked by telegram?
This may happen if too many or wrong requests are sent to api.telegram.org, e.g. This may happen if too many or wrong requests are sent to api.telegram.org,
using a invalid token or invalid API calls. 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 If the block stay for longer time you can ask telegram service to unblock your
IP-Address. IP-Address.
@ -321,4 +321,4 @@ See `mycommnds.sh.dist` for an example.
If you feel that there's something missing or if you found a bug, feel free to If you feel that there's something missing or if you found a bug, feel free to
submit a pull request! submit a pull request!
#### $$VERSION$$ v1.21-dev-34-ga5307e3 #### $$VERSION$$ v1.21-pre-28-g5415f28

6
bashbot.sh
View File

@ -8,8 +8,8 @@
# Description: bashbot, the Telegram bot written in bash. # Description: bashbot, the Telegram bot written in bash.
# #
# Written by Drew (@topkecleon) KayM (@gnadelwartz). # Written by Drew (@topkecleon) KayM (@gnadelwartz).
# Also contributed: Daniil Gentili (@danogentili), JuanPotato, # Also contributed: Daniil Gentili (@danog), JuanPotato, BigNerd95,
# BigNerd95, TiagoDanin, iicc1. # TiagoDanin, iicc1, dcoomber
# https://github.com/topkecleon/telegram-bot-bash # https://github.com/topkecleon/telegram-bot-bash
# #
# This file is public domain in the USA and all free countries. # This file is public domain in the USA and all free countries.
@ -30,7 +30,7 @@
# 8 - curl/wget missing # 8 - curl/wget missing
# 10 - not bash! # 10 - not bash!
# #
#### $$VERSION$$ v1.21-pre-20-g051e603 #### $$VERSION$$ v1.21-pre-28-g5415f28
################################################################## ##################################################################
# emmbeded system may claim bash but it is not # emmbeded system may claim bash but it is not

2
doc/4_expert.md
View File

@ -378,5 +378,5 @@ for every poll until the maximum of BASHBOT_SLEEP ms.
#### [Prev Advanced Use](3_advanced.md) #### [Prev Advanced Use](3_advanced.md)
#### [Next Best Practice](5_practice.md) #### [Next Best Practice](5_practice.md)
#### $$VERSION$$ v1.21-dev-34-ga5307e3 #### $$VERSION$$ v1.21-pre-28-g5415f28

2
doc/7_develop.md
View File

@ -358,5 +358,5 @@ fi
#### [Prev Function Reference](6_reference.md) #### [Prev Function Reference](6_reference.md)
#### $$VERSION$$ v1.21-dev-40-g889fe8e #### $$VERSION$$ v1.21-pre-28-g5415f28

2
examples/bash2env.sh
View File

@ -6,7 +6,7 @@
# This file is public domain in the USA and all free countries. # This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying) # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
# shellcheck disable=SC1117 # shellcheck disable=SC1117
#### $$VERSION$$ v1.21-pre-14-ga93dc56 #### $$VERSION$$ v1.21-pre-28-g5415f28
# adjust your language setting here # adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment # https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

2
examples/bashbot-multi.sh
View File

@ -2,7 +2,7 @@
# file. multibot.sh # file. multibot.sh
# description: run multiple telegram bots from one installation # description: run multiple telegram bots from one installation
# #
#### $$VERSION$$ v1.21-pre-14-ga93dc56 #### $$VERSION$$ v1.21-pre-28-g5415f28
if [ "${2}" = "" ] || [ "${2}" = "-h" ]; then if [ "${2}" = "" ] || [ "${2}" = "-h" ]; then
echo "Usage: $0 botname command" echo "Usage: $0 botname command"