small updates and fixes for 1.40

README.html

@@ -341,7 +341,7 @@ <h2>Security Considerations</h2>
 <p>Running a Telegram Bot means it is connected to the public and you never know what's send to your Bot.</p>
 <p>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 <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 untrusted sources (messages, files, network) you must be as careful as possible (e.g. set IFS appropriately, disable globbing with <code>set -f</code> and quote everything). In addition remove unused scripts and examples from your Bot (e.g. everything in <code>example/</code>) and disable/remove all unused bot commands.</p>
-<p>It's important to escape or remove <code>$</code> in input from user, files or network (<em>as bashbot does</em>). One of the powerful features of Unix shells is variable and command substitution using <code>${}</code> and<code>$()</code> can lead to remote code execution (RCE) or remote information disclosure (RID) bugs if unescaped <code>$</code> is included in untrusted input (e.g. <code>$$</code> or <code>$(rm -rf /*)</code>).</p>
+<p>It's important to escape or remove <code>$</code> in input from user, files or network (<em>as bashbot does</em>). One of the powerful features of Unix shells is variable and command substitution using <code>${}</code> and <code>$()</code> can lead to remote code execution (RCE) or remote information disclosure (RID) bugs if unescaped <code>$</code> is included in untrusted input (e.g. <code>$$</code> or <code>$(rm -rf /*)</code>).</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 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 <a href="doc/7_develop.md">test suite</a> to check if important functionality is working as expected.</p>
 <h3>Use printf whenever possible</h3>
 <p>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. <a href="https://unix.stackexchange.com/a/6581">Use printf whenever possible</a>.</p>
@@ -350,8 +350,9 @@ <h3>Run your Bot as a restricted user</h3>
 <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 Linux/Unix systems. See <a href="doc/4_expert.md">Expert use</a> on how to run your Bot as an other user.</p>
 <h3>Secure your Bot installation</h3>
 <p><strong>Your Bot configuration must not be readable by other users.</strong> Everyone who can read your Bots token is able to act as your Bot and has access to all chats the Bot is in!</p>
-<p>Everyone with read access to your Bot files can extract your Bots data. Especially your Bot config in<code>config.jssh</code> 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<code>count.jssh</code> and <code>data-bot-bash</code> only, all other files must be write protected.</p>
-<p>To set access rights for your bashbot installation to a reasonable default run<code>sudo ./bashbot.sh init</code> after every update or change to your installation directory.</p>
+<p>Everyone with read access to your Bot files can extract your Bots data. Especially your Bot config in <code>config.jssh</code> 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 <code>count.jssh</code>, <code>data-bot-bash/</code> and <code>logs/</code> only, all other files must be write protected.</p>
+<p>To set access rights for your bashbot installation to a reasonable default run <code>sudo ./bashbot.sh init</code> after every update or change to your installation directory.</p>
+<p><em>Note</em>: Keep old log files in a safe place or even better delete them, they are GDPR relevant and <a href="https://github.com/topkecleon/telegram-bot-bash/issues/174">may contain information</a> you don't want to be public.</p>
 <h2>FAQ</h2>
 <h3>Is this Bot insecure?</h3>
 <p>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 ...</p>
@@ -365,8 +366,8 @@ <h3>Why Bash and not the much better xyz?</h3>
 <li>no database, not event driven, not object oriented ...</li>
 </ul>
 <h3>Can I have the single bashbot.sh file back?</h3>
-<p>At the beginning bashbot was simply the file<code>bashbot.sh</code> that you could copy everywhere and run the bot. Now we have 'commands.sh', 'mycommands.sh', 'modules/*.sh' and much more.</p>
-<p>Hey no problem, if you are finished with your cool bot, run<code>dev/make-standalone.sh</code> to create a stripped down version of your bot containing only 'bashbot.sh' and 'commands.sh'! For more information see <a href="doc/7_develop.md">Create a stripped down version of your Bot</a>.</p>
+<p>At the beginning bashbot was simply the file <code>bashbot.sh</code> that you could copy everywhere and run the bot. Now we have 'commands.sh', 'mycommands.sh', 'modules/*.sh' and much more.</p>
+<p>Hey no problem, if you are finished with your cool bot, run <code>dev/make-standalone.sh</code> to create a stripped down version of your bot containing only 'bashbot.sh' and 'commands.sh'! For more information see <a href="doc/7_develop.md">Create a stripped down version of your Bot</a>.</p>
 <h3>Can I send messages from CLI and scripts?</h3>
 <p>Of course you can send messages from command line and scripts! Simply install bashbot as <a href="#Your-really-first-bashbot-in-a-nutshell">described here</a>, send the message '/start' to set yourself as botadmin and then stop the bot with <code>./bashbot.sh stop</code>.</p>
 <p>Bashbot provides some ready to use scripts for sending messages from command line in <code>bin/</code> dir, e.g. <code>send_message.sh</code>.</p>
@@ -391,6 +392,6 @@ <h3>Blocked by telegram?</h3>
 <p>@Gnadelwartz</p>
 <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>
-<h4>$$VERSION$$ v1.40-dev-29-g737be16</h4>
+<h4>$$VERSION$$ v1.40-dev-34-g1440d56</h4>
 </body>
 </html>

README.md

@@ -147,7 +147,7 @@ Whenever you are processing input from untrusted sources (messages, files, netwo
 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 /*)`).
+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
@@ -169,9 +169,11 @@ For the same reason every file your Bot can read is in danger of being disclosed
 ### Secure your Bot installation
 **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.
+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`, `data-bot-bash/` and `logs/` 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.
+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.
+
+*Note*: Keep old log files in a safe place or even better delete them, they are GDPR relevant and [may contain information](https://github.com/topkecleon/telegram-bot-bash/issues/174) you don't want to be public.
 
 ## FAQ
 
@@ -189,9 +191,9 @@ Well, that's a damn good question... maybe because I'm a Unix admin from the sto
 - 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` that you could 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
+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?
@@ -239,4 +241,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!
 
-#### $$VERSION$$ v1.40-dev-29-g737be16
+#### $$VERSION$$ v1.40-dev-34-g1440d56

README.txt

@@ -202,7 +202,7 @@ f and quote everything). In addition remove unused scripts and examples from you
 (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
+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/
@@ -232,11 +232,14 @@ Secure your Bot installation
 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 ./
+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, data-bot-bash/ and logs/ 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.
+Note: Keep old log files in a safe place or even better delete them, they are GDPR
+relevant and may contain information [https://github.com/topkecleon/telegram-bot-bash/
+issues/174] you don't want to be public.
 
 FAQ
 
@@ -264,9 +267,9 @@ 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 that you could copy everywhere and
+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, rundev/make-standalone.sh to
+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].
 
@@ -315,5 +318,5 @@ 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.40-dev-29-g737be16
+$$VERSION$$ v1.40-dev-34-g1440d56
 

bashbot.sh

@@ -30,7 +30,7 @@ BOTCOMMANDS="-h  help  init  start  stop  status  suspendback  resumeback  killb
 #     8 - curl/wget missing
 #     10 - not bash!
 #
-#### $$VERSION$$ v1.40-dev-32-gd876f75
+#### $$VERSION$$ v1.40-dev-34-g1440d56
 ##################################################################
 
 # are we running in a terminal?
@@ -390,13 +390,13 @@ fi
 
 # $1 URL, $2 filename in DATADIR
 # outputs final filename
-#download() {
-#	local empty="no.file" file="${2:-${empty}}"
-#	if [[ "${file}" = *"/"* ]] || [[ "${file}" = "."* ]]; then file="${empty}"; fi
-#	while [ -f "${DATADIR:-.}/${file}" ] ; do file="${RANDOM}-${file}"; done
-#	getJson "$1" >"${DATADIR:-.}/${file}" || return
-#	printf '%s\n' "${DATADIR:-.}/${file}"
-#}
+download() {
+	local empty="no.file" file="${2:-${empty}}"
+	if [[ "${file}" = *"/"* ]] || [[ "${file}" = "."* ]]; then file="${empty}"; fi
+	while [ -f "${DATADIR:-.}/${file}" ] ; do file="${RANDOM}-${file}"; done
+	getJson "$1" >"${DATADIR:-.}/${file}" || return
+	printf '%s\n' "${DATADIR:-.}/${file}"
+}
 
 # $1 postfix, e.g. chatid
 # $2 prefix, back- or startbot-

commands.sh

@@ -8,14 +8,14 @@
 # | |__/ / |_| |  | | | | |_| | |__   | |____( (_| | | |__ _ 
 # |_____/ \___/   |_| |_|\___/ \___)  |_______)____|_|\___)_|
 #
-# this file *MUST* not be edited! place your config and commands in
-# the file "mycommands.sh". a clean version is provided as "mycommands.sh.clean"
+# this file *MUST* not edited! place your config in the file "mycommands.conf"
+# and commands in "mycommands.sh", a clean version is provided as "mycommands.sh.clean"
 #
 
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 #
-#### $$VERSION$$ v1.35-dev-14-g08a0524
+#### $$VERSION$$ v1.40-dev-34-g1440d56
 #
 
 # bashbot locale defaults to c.UTF-8, adjust locale in mycommands.sh if needed

doc/0_install.md

@@ -132,5 +132,5 @@ You must update to [Version 1.20](https://github.com/topkecleon/telegram-bot-bas
 
 #### [Next Create Bot](1_firstbot.md)
 
-#### $$VERSION$$ v1.30-0-g3266427
+#### $$VERSION$$ v1.40-dev-34-g1440d56
 

doc/2_usage.md

@@ -295,7 +295,7 @@ In case you need other response values , the array `UPD` contains complete Teleg
 ## Usage of bashbot functions
 
 #### sending messages
-To send messages use the `send_xxx_message`functions.
+To send messages use the `send_xxx_message` functions.
 To insert line brakes in a message place `\n` in the text. 
 
 To send regular text without any markdown use:
@@ -311,7 +311,7 @@ To send text with html:
 send_html_message "${CHAT[ID]}" "lol <b>bold</b>"
 ```
 
-To forward messages use the `forward`function:
+To forward messages use the `forward` function:
 ```bash
 forward "${CHAT[ID]}" "from_chat_id" "message_id"
 ```
@@ -349,20 +349,20 @@ To send local files or URL's (photo, video, voice, sticker, documents) use the `
 send_file "${CHAT[ID]}" "/home/user/dog.jpg" "Lool" "photo"
 send_file "${CHAT[ID]}" "https://images-na.ssl-images-amazon.com/images/I/81DQ0FpoSNL._AC_SL1500_.jpg"
 ```
-To send custom keyboards use the `send_keyboard`function:
+To send custom keyboards use the `send_keyboard` function:
 ```bash
 send_keyboard "${CHAT[ID]}" "Text that will appear in chat?" '[ "Yep" , "No" ]' # note the single quotes!
 send_keyboard "${CHAT[ID]}" "Text that will appear in chat?" "[ \\"Yep\\" , \\"No\\" ]" # within double quotes you must escape the inside double quots
 ```
-To send locations use the `send_location`function:
+To send locations use the `send_location` function:
 ```bash
 send_location "${CHAT[ID]}" "Latitude" "Longitude"
 ```
-To send venues use the `send_venue`function:
+To send venues use the `send_venue` function:
 ```bash
 send_venue "${CHAT[ID]}" "Latitude" "Longitude" "Title" "Address" "optional foursquare id"
 ```
-To send a chat action use the `send_action`function.
+To send a chat action use the `send_action` function.
 Allowed values: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for locations.
 ```bash
 send_action "${CHAT[ID]}" "action"
@@ -372,5 +372,5 @@ send_action "${CHAT[ID]}" "action"
 #### [Prev Create Bot](1_firstbot.md)
 #### [Next Advanced Usage](3_advanced.md)
 
-#### $$VERSION$$ v1.35-dev-31-ga3eec98
+#### $$VERSION$$ v1.40-dev-34-g1440d56