Version 0.94

This commit is contained in:
Kay Marquardt (Gnadelwartz) 2020-05-17 13:51:32 +02:00
parent bdb50c8716
commit 7aa409fbc8
57 changed files with 92 additions and 68 deletions

View File

@ -179,6 +179,10 @@ It features background tasks and interactive chats, and can serve as an interfac
<p>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 <a href="https://unix.stackexchange.com/questions/171346/security-implications-of-forgetting-to-quote-a-variable-in-bash-posix-shells">Implications of wrong quoting</a></p>
<p>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.</p>
<p>A powerful tool to improve your scripts is <code>shellcheck</code>. You can <a href="https://www.shellcheck.net/">use it online</a> or <a href="https://github.com/koalaman/shellcheck#installing">install shellcheck locally</a>. 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 <a href="doc/7_develop.md">test suite</a> to check if important functionality is working as expected.</p>
<h3>Do not use #!/usr/bin/env bash</h3>
<p>We stay with /bin/bash shebang, because using the system bash is more save from security perspective.</p>
<p>It makes it harder for attackers and users to place alternative versions of bash and avoids using possibly broken, mangled or compromised bash executables.</p>
<p>If you are a MacOS user or forced to use an alternative bash, see <a href="doc/0_install.md">Install Bashbot</a></p>
<h3>Run your Bot as a restricted user</h3>
<p><strong>I recommend to run your bot as a user, with almost no access rights.</strong> 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.</p>
<p><strong>Never run your Bot as root, this is the most dangerous you can do!</strong> Usually the user 'nobody' has almost no rights on Unix/Linux systems. See <a href="doc/4_expert.md">Expert use</a> on how to run your Bot as an other user.</p>
@ -224,6 +228,6 @@ It features background tasks and interactive chats, and can serve as an interfac
<p>@Gnadelwartz</p>
<h2>That's it!</h2>
<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$$ v0.94-5-g6531fec</h4>
<h4>$$VERSION$$ V0.94-0-gbdb50c8</h4>
</body>
</html>

View File

@ -112,6 +112,15 @@ Whenever you are processing input from from untrusted sources (messages, files,
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 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](doc/7_develop.md) to check if important functionality is working as expected.
### Do not use #!/usr/bin/env bash
We stay with /bin/bash shebang, because using the system bash is more save from security perspective.
It makes it harder for attackers and users to place alternative versions of bash and avoids using
possibly broken, mangled or compromised bash executables.
If you are a MacOS user or forced to use an alternative bash, see [Install Bashbot](doc/0_install.md)
### 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.
@ -183,4 +192,4 @@ This may happen if to many wrong requests are sent to api.telegram.org, e.g. usi
If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
#### $$VERSION$$ v0.94-5-g6531fec
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -154,6 +154,18 @@ 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.
### Do not use #!/usr/bin/env bash
We stay with /bin/bash shebang, because using the system bash is more save from
security perspective.
It makes it harder for attackers and users to place alternative versions of
bash and avoids using
possibly broken, mangled or compromised bash executables.
If you are a MacOS user or forced to use an alternative bash, see [Install
Bashbot](doc/0_install.md)
### 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
@ -257,4 +269,4 @@ tor proxy on your server you may uncomment the ```BASHBOT_CURL_ARGS``` line in
If you feel that there's something missing or if you found a bug, feel free to
submit a pull request!
#### $$VERSION$$ v0.94-5-g6531fec
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -4,7 +4,7 @@
# this addon counts how many files, e.g. stickers, are sent to
# a chat and takes actions if threshold is reached
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# used events:
#

View File

@ -4,7 +4,7 @@
# Addons can register to bashbot events at statup
# by providing their name and a callback per event
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
#
# If an event occours each registered event function is called.
#

View File

@ -1,7 +1,7 @@
#!/bin/sh
# description: Start or stop telegram-bash-bot
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# shellcheck disable=SC2009
# shellcheck disable=SC2181

View File

@ -11,7 +11,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-5-g6531fec
#### $$VERSION$$ V0.94-0-gbdb50c8
#
# Exit Codes:
# - 0 sucess (hopefully)

View File

@ -15,7 +15,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-1-gf13a2d0
#### $$VERSION$$ V0.94-0-gbdb50c8
#
# adjust your language setting here, e.g.when run from other user or cron.

View File

@ -1,7 +1,7 @@
#!/usr/bin/env bash
# this has to run once atfer git clone
# and every time we create new hooks
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# magic to ensure that we're always inside the root of our application,
# no matter from which directory we'll run script

View File

@ -3,7 +3,7 @@
#
# works together with git pre-push.sh and ADD all changed files since last push
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# magic to ensure that we're always inside the root of our application,
# no matter from which directory we'll run script

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
############
# NOTE: you MUST run install-hooks.sh again when updating this file!

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
############
# NOTE: you MUST run install-hooks.sh again when updating this file!

View File

@ -1,7 +1,7 @@
#!/usr/bin/env bash
# this has to run once atfer git clone
# and every time we create new hooks
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# magic to ensure that we're always inside the root of our application,
# no matter from which directory we'll run script

View File

@ -2,7 +2,7 @@
# file: make-distribution.sh
# creates files and arcchives to dirtribute bashbot
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# magic to ensure that we're always inside the root of our application,
# no matter from which directory we'll run script

View File

@ -5,7 +5,7 @@
# If you your bot is finished you can use make-standalone.sh to create the
# the old all-in-one bashbot: bashbot.sh and commands.sh only!
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# magic to ensure that we're always inside the root of our application,
# no matter from which directory we'll run script

View File

@ -1,4 +1,4 @@
# list of additional files to check from shellcheck
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
bashbot.rc
mycommands.sh.clean

View File

@ -1,6 +1,6 @@
#!/bin/bash
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# shellcheck disable=SC2016
#
# Easy Versioning in git:

View File

@ -1,16 +1,5 @@
#### [Home](../README.md)
## Note for Users of MacOS
You must install a more current version of bash, as the default bash is way to old,
see e.g. [Install Bash on Mac](http://macappstore.org/bash/)
After installation / update of bashbot you must change the shebang line to point to your bash location
e.g. with the provided script ˋexamples/bash2env.shˋ
We stay with /bin/bash shebang, because using the system bash is more save. It makes it harder
for attackers or users to place broken, mangled or compromised bash executables.
## Install bashbot
1. Go to the directory you want to install bashbot, e.g.
@ -54,6 +43,16 @@ If you modified 'commands.sh' move your changes to 'mycommands.sh', this avoids
Now you can restart your bashbot instances.
### Note for MacOS Users
You must install a more current version of bash, as the default bash is way to old,
see e.g. [Install Bash on Mac](http://macappstore.org/bash/)
After installation / update of bashbot you must change the shebang line to point to your bash location
e.g. with the provided script ˋexamples/bash2env.shˋ
We stay with /bin/bash shebang, because using the system bash is more save, see [Security Considerations](../README.md#Security Considerations)
### Notes on Updates
#### removal of TMUX
@ -98,5 +97,5 @@ The old format is supported for backward compatibility, but may fail for corner
#### [Next Create Bot](1_firstbot.md)
#### $$VERSION$$ v0.94-5-g6531fec
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -65,5 +65,5 @@ group. This step is up to you actually.
#### [Prev Installation](0_install.md)
#### [Next Getting started](2_usage.md)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -240,5 +240,5 @@ send_action "${CHAT[ID]}" "action"
#### [Prev Create Bot](1_firstbot.md)
#### [Next Advanced Usage](3_advanced.md)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -180,5 +180,5 @@ See also [answer_inline_multi, answer_inline_compose](6_reference.md#answer_inli
#### [Prev Getting started](2_usage.md)
#### [Next Expert Use](4_expert.md)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -348,5 +348,5 @@ for every poll until the maximum of BASHBOT_SLEEP ms.
#### [Prev Advanced Use](3_advanced.md)
#### [Next Best Practice](5_practice.md)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -152,5 +152,5 @@ The second warning is about an unused variable, this is true because in our exam
#### [Prev Best Practice](5_practice.md)
#### [Next Functions Reference](6_reference.md)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -973,5 +973,5 @@ The name of your bot is availible as bash variable "$ME", there is no need to ca
#### [Prev Best Practice](5_practice.md)
#### [Next Notes for Developers](7_develop.md)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -328,5 +328,5 @@ fi
#### [Prev Function Reference](6_reference.md)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -55,6 +55,6 @@ convert existing bots.
**external-use** will contain some examples on how to send messages from external scripts to Telegram chats or users.
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8

View File

@ -4,7 +4,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -2,7 +2,7 @@
# file: run_filename
# background job to display content of all new files in WATCHDIR
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -2,7 +2,7 @@
# file: run_filename
# background job to display all new files in WATCHDIR
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -4,7 +4,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -6,7 +6,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#### $$VERSION$$ v0.94-3-g96fda44
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -2,7 +2,7 @@
# file. multibot.sh
# description: run multiple telegram bots from one installation
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
if [ "${2}" = "" ] || [ "${2}" = "-h" ]; then
echo "Usage: $0 botname command"

View File

@ -7,7 +7,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
SHELL=/bin/sh

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -4,7 +4,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# adjust your language setting here
# https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment

View File

@ -1,7 +1,7 @@
# file: botacl
# a user not listed here, will return false from 'user_is_allowed'
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# Format:
# user:ressource:chat

View File

@ -5,7 +5,7 @@
# to show how you can customize bashbot by only editing mycommands.sh
# NOTE: this is not tested, simply copied from original source and reworked!
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
#
# shellcheck disable=SC2154
# shellcheck disable=SC2034

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
#
# source from commands.sh to use the aliases

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# source from commands.sh to use the inline functions

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# source from commands.sh if you want ro use interactive or background jobs

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-1-gf13a2d0
#### $$VERSION$$ V0.94-0-gbdb50c8
# source once magic, function named like file
eval "$(basename "${BASH_SOURCE[0]}")(){ :; }"

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
#
# source from commands.sh to use jsonDB functions
#

View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# source once magic, function named like file
eval "$(basename "${BASH_SOURCE[0]}")(){ :; }"

View File

@ -8,7 +8,7 @@
# #### if you start to develop your own bot, use the clean version of this file:
# #### mycommands.clean
#
#### $$VERSION$$ v0.94-2-g93f4966
#### $$VERSION$$ V0.94-0-gbdb50c8
#
# uncomment the following lines to overwrite info and help messages

View File

@ -4,7 +4,7 @@
# files: mycommands.sh.clean
# copy to mycommands.sh and add all your commands and functions here ...
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
#
##########

View File

@ -2,7 +2,7 @@
#
# ADD a new test skeleton to test dir, but does not activate test
#
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# magic to ensure that we're always inside the root of our application,
# no matter from which directory we'll run script

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# common variables
export TESTME DIRME TESTDIR LOGFILE REFDIR TESTNAME

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
../dev/hooks/pre-commit.sh

View File

@ -1,6 +1,6 @@
#!/usr/bin/env bash
# file: b-example-test.sh
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh

View File

@ -1,5 +1,5 @@
#!/usr/bin/env bash
#### $$VERSION$$ v0.94-0-gaaa71c8
#### $$VERSION$$ V0.94-0-gbdb50c8
# include common functions and definitions
# shellcheck source=test/ALL-tests.inc.sh