From c9593c8ffd6c015d8a453287af9bbb7862342492 Mon Sep 17 00:00:00 2001 From: Venca24 Date: Sat, 17 Mar 2018 13:54:00 +0100 Subject: [PATCH 1/7] [enh] add plugin converting strings into hash digests --- AUTHORS.rst | 2 +- searx/plugins/__init__.py | 2 ++ searx/plugins/hash_plugin.py | 54 ++++++++++++++++++++++++++++++++++++ tests/unit/test_plugins.py | 47 +++++++++++++++++++++++++++++++ 4 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 searx/plugins/hash_plugin.py diff --git a/AUTHORS.rst b/AUTHORS.rst index 6538c090..0de17dbb 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -96,7 +96,7 @@ generally made searx better: - Alice Ferrazzi @aliceinwire - @LiquidLemon - @dadosch -- @Venca24 +- Václav Zouzalík @Venca24 - @ZEROF - Ivan Skytte Jørgensen @isj-privacore - @miicha diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py index 2f02e224..b6dc4875 100644 --- a/searx/plugins/__init__.py +++ b/searx/plugins/__init__.py @@ -28,6 +28,7 @@ from searx import logger, settings, static_path logger = logger.getChild('plugins') from searx.plugins import (oa_doi_rewrite, + hash_plugin, https_rewrite, infinite_scroll, self_info, @@ -163,6 +164,7 @@ def sha_sum(filename): plugins = PluginStore() plugins.register(oa_doi_rewrite) +plugins.register(hash_plugin) plugins.register(https_rewrite) plugins.register(infinite_scroll) plugins.register(self_info) diff --git a/searx/plugins/hash_plugin.py b/searx/plugins/hash_plugin.py new file mode 100644 index 00000000..50d3b318 --- /dev/null +++ b/searx/plugins/hash_plugin.py @@ -0,0 +1,54 @@ +''' +searx is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +searx is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with searx. If not, see < http://www.gnu.org/licenses/ >. + +(C) 2015 by Adam Tauber, +(C) 2018 by Vaclav Zouzalik +''' + +from flask_babel import gettext +import hashlib +import re + +name = "Hash plugin" +description = gettext("Converts strings to different hash digests.") +default_on = True + +parser_re = re.compile(b'(md5|sha1|sha224|sha256|sha384|sha512) (.*)', re.I) + +def post_search(request, search): + # process only on first page + if search.search_query.pageno > 1: + return True + m = parser_re.match(search.search_query.query) + if not m: + # wrong query + return True + + # end if the string is empty + function, string = m.groups() + if string.strip().__len__() == 0: + return True + + # select hash function + f = hashlib.new(function.lower()) + #f = hash_function[function.lower()] + + # make digest from the given string + f.update(string.strip()) + digest = f.hexdigest() + + # print result + search.result_container.answers.clear() + search.result_container.answers.add(function + " " + gettext('hash function') + ": " + digest) + return True \ No newline at end of file diff --git a/tests/unit/test_plugins.py b/tests/unit/test_plugins.py index 838c1d57..69345316 100644 --- a/tests/unit/test_plugins.py +++ b/tests/unit/test_plugins.py @@ -83,3 +83,50 @@ class SelfIPTest(SearxTestCase): search = get_search_mock(query='What is my User-Agent?', pageno=2) store.call(store.plugins, 'post_search', request, search) self.assertFalse('user-agent' in search.result_container.answers) + +class HashPluginTest(SearxTestCase): + + def test_PluginStore_init(self): + store = plugins.PluginStore() + store.register(plugins.hash_plugin) + + self.assertTrue(len(store.plugins) == 1) + + request = Mock(remote_addr='127.0.0.1') + request.headers.getlist.return_value = [] + + # MD5 + search = get_search_mock(query=b'md5 test', pageno=1) + store.call(store.plugins, 'post_search', request, search) + self.assertTrue('md5 hash function: 098f6bcd4621d373cade4e832627b4f6' in search.result_container.answers) + + search = get_search_mock(query=b'md5 test', pageno=2) + store.call(store.plugins, 'post_search', request, search) + self.assertFalse('md5 hash function: 098f6bcd4621d373cade4e832627b4f6' in search.result_container.answers) + + # SHA1 + search = get_search_mock(query=b'sha1 test', pageno=1) + store.call(store.plugins, 'post_search', request, search) + self.assertTrue('sha1 hash function: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3' in search.result_container.answers) + + # SHA224 + search = get_search_mock(query=b'sha224 test', pageno=1) + store.call(store.plugins, 'post_search', request, search) + self.assertTrue('sha224 hash function: 90a3ed9e32b2aaf4c61c410eb925426119e1a9dc53d4286ade99a809' in search.result_container.answers) + + # SHA256 + search = get_search_mock(query=b'sha256 test', pageno=1) + store.call(store.plugins, 'post_search', request, search) + self.assertTrue('sha256 hash function: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08' in search.result_container.answers) + + # SHA384 + search = get_search_mock(query=b'sha384 test', pageno=1) + store.call(store.plugins, 'post_search', request, search) + self.assertTrue('sha384 hash function: 768412320f7b0aa5812fce428dc4706b3cae50e02a64caa16a782249bfe8efc4b' \ + '7ef1ccb126255d196047dfedf17a0a9' in search.result_container.answers) + + # SHA512 + search = get_search_mock(query=b'sha512 test', pageno=1) + store.call(store.plugins, 'post_search', request, search) + self.assertTrue('sha512 hash function: ee26b0dd4af7e749aa1a8ee3c10ae9923f618980772e473f8819a5d4940e0db27a' \ +'c185f8a0e1d5f84f88bc887fd67b143732c304cc5fa9ad8e6f57f50028a8ff' in search.result_container.answers) From 1ea9438f5dcc190129298c1030ea75309be057e8 Mon Sep 17 00:00:00 2001 From: Venca24 Date: Sat, 17 Mar 2018 13:56:46 +0100 Subject: [PATCH 2/7] [fix] hash plugin --- searx/plugins/hash_plugin.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/searx/plugins/hash_plugin.py b/searx/plugins/hash_plugin.py index 50d3b318..6a25a7b8 100644 --- a/searx/plugins/hash_plugin.py +++ b/searx/plugins/hash_plugin.py @@ -42,7 +42,6 @@ def post_search(request, search): # select hash function f = hashlib.new(function.lower()) - #f = hash_function[function.lower()] # make digest from the given string f.update(string.strip()) @@ -51,4 +50,4 @@ def post_search(request, search): # print result search.result_container.answers.clear() search.result_container.answers.add(function + " " + gettext('hash function') + ": " + digest) - return True \ No newline at end of file + return True From 69e5a580582c59ccddfffdc8b5ed3213b5c35836 Mon Sep 17 00:00:00 2001 From: Venca24 Date: Sat, 17 Mar 2018 14:17:45 +0100 Subject: [PATCH 3/7] [fix] code style --- searx/plugins/hash_plugin.py | 1 + tests/unit/test_plugins.py | 20 +++++++++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/searx/plugins/hash_plugin.py b/searx/plugins/hash_plugin.py index 6a25a7b8..3612bab6 100644 --- a/searx/plugins/hash_plugin.py +++ b/searx/plugins/hash_plugin.py @@ -26,6 +26,7 @@ default_on = True parser_re = re.compile(b'(md5|sha1|sha224|sha256|sha384|sha512) (.*)', re.I) + def post_search(request, search): # process only on first page if search.search_query.pageno > 1: diff --git a/tests/unit/test_plugins.py b/tests/unit/test_plugins.py index 69345316..49bdd8d1 100644 --- a/tests/unit/test_plugins.py +++ b/tests/unit/test_plugins.py @@ -84,6 +84,7 @@ class SelfIPTest(SearxTestCase): store.call(store.plugins, 'post_search', request, search) self.assertFalse('user-agent' in search.result_container.answers) + class HashPluginTest(SearxTestCase): def test_PluginStore_init(self): @@ -107,26 +108,31 @@ class HashPluginTest(SearxTestCase): # SHA1 search = get_search_mock(query=b'sha1 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha1 hash function: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3' in search.result_container.answers) + self.assertTrue('sha1 hash function: a94a8fe5ccb19ba61c4c0873d391e9879' + '82fbbd3' in search.result_container.answers) # SHA224 search = get_search_mock(query=b'sha224 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha224 hash function: 90a3ed9e32b2aaf4c61c410eb925426119e1a9dc53d4286ade99a809' in search.result_container.answers) + self.assertTrue('sha224 hash function: 90a3ed9e32b2aaf4c61c410eb9254261' + '19e1a9dc53d4286ade99a809' in search.result_container.answers) # SHA256 search = get_search_mock(query=b'sha256 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha256 hash function: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08' in search.result_container.answers) + self.assertTrue('sha256 hash function: 9f86d081884c7d659a2feaa0c55ad015a' + '3bf4f1b2b0b822cd15d6c15b0f00a08' in search.result_container.answers) # SHA384 search = get_search_mock(query=b'sha384 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha384 hash function: 768412320f7b0aa5812fce428dc4706b3cae50e02a64caa16a782249bfe8efc4b' \ - '7ef1ccb126255d196047dfedf17a0a9' in search.result_container.answers) + self.assertTrue('sha384 hash function: 768412320f7b0aa5812fce428dc4706b3c' + 'ae50e02a64caa16a782249bfe8efc4b7ef1ccb126255d196047dfedf1' + '7a0a9' in search.result_container.answers) # SHA512 search = get_search_mock(query=b'sha512 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha512 hash function: ee26b0dd4af7e749aa1a8ee3c10ae9923f618980772e473f8819a5d4940e0db27a' \ -'c185f8a0e1d5f84f88bc887fd67b143732c304cc5fa9ad8e6f57f50028a8ff' in search.result_container.answers) + self.assertTrue('sha512 hash function: ee26b0dd4af7e749aa1a8ee3c10ae9923f6' + '18980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5' + 'fa9ad8e6f57f50028a8ff' in search.result_container.answers) From 40c552c11e25dc440781717260c053221f60920b Mon Sep 17 00:00:00 2001 From: Venca24 Date: Sat, 17 Mar 2018 15:21:26 +0100 Subject: [PATCH 4/7] [fix] hash plugin --- searx/plugins/hash_plugin.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/searx/plugins/hash_plugin.py b/searx/plugins/hash_plugin.py index 3612bab6..7754763c 100644 --- a/searx/plugins/hash_plugin.py +++ b/searx/plugins/hash_plugin.py @@ -36,9 +36,10 @@ def post_search(request, search): # wrong query return True - # end if the string is empty function, string = m.groups() + function = str(function.decode('UTF-8')) # convert to string for python3 if string.strip().__len__() == 0: + # end if the string is empty return True # select hash function From 1cbcf2ccb64c2bc2cc0dfd5d37462f4fbc7c9a2d Mon Sep 17 00:00:00 2001 From: Venca24 Date: Fri, 23 Oct 2020 21:35:13 +0200 Subject: [PATCH 5/7] [mod] adapt hash plugin to current version of searx --- searx/plugins/hash_plugin.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/searx/plugins/hash_plugin.py b/searx/plugins/hash_plugin.py index 7754763c..d255997b 100644 --- a/searx/plugins/hash_plugin.py +++ b/searx/plugins/hash_plugin.py @@ -13,7 +13,7 @@ You should have received a copy of the GNU Affero General Public License along with searx. If not, see < http://www.gnu.org/licenses/ >. (C) 2015 by Adam Tauber, -(C) 2018 by Vaclav Zouzalik +(C) 2018, 2020 by Vaclav Zouzalik ''' from flask_babel import gettext @@ -24,7 +24,7 @@ name = "Hash plugin" description = gettext("Converts strings to different hash digests.") default_on = True -parser_re = re.compile(b'(md5|sha1|sha224|sha256|sha384|sha512) (.*)', re.I) +parser_re = re.compile('(md5|sha1|sha224|sha256|sha384|sha512) (.*)', re.I) def post_search(request, search): @@ -37,7 +37,6 @@ def post_search(request, search): return True function, string = m.groups() - function = str(function.decode('UTF-8')) # convert to string for python3 if string.strip().__len__() == 0: # end if the string is empty return True @@ -46,10 +45,10 @@ def post_search(request, search): f = hashlib.new(function.lower()) # make digest from the given string - f.update(string.strip()) - digest = f.hexdigest() + f.update(string.encode('utf-8').strip()) + answer = function + " " + gettext('hash digest') + ": " + f.hexdigest() # print result search.result_container.answers.clear() - search.result_container.answers.add(function + " " + gettext('hash function') + ": " + digest) + search.result_container.answers['hash'] = { 'answer': answer } return True From 2b93e70a264c8509e94fc432011f3c752e97c5e0 Mon Sep 17 00:00:00 2001 From: Venca24 Date: Sat, 24 Oct 2020 09:20:55 +0200 Subject: [PATCH 6/7] [fix] code style --- searx/plugins/hash_plugin.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/searx/plugins/hash_plugin.py b/searx/plugins/hash_plugin.py index d255997b..1d3baaed 100644 --- a/searx/plugins/hash_plugin.py +++ b/searx/plugins/hash_plugin.py @@ -50,5 +50,5 @@ def post_search(request, search): # print result search.result_container.answers.clear() - search.result_container.answers['hash'] = { 'answer': answer } + search.result_container.answers['hash'] = {'answer': answer} return True From 35577051e218dad81a40a12ec97d152f74c0a8b3 Mon Sep 17 00:00:00 2001 From: Venca24 Date: Sat, 24 Oct 2020 10:25:33 +0200 Subject: [PATCH 7/7] [fix] hash plugin test --- tests/unit/test_plugins.py | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/tests/unit/test_plugins.py b/tests/unit/test_plugins.py index 49bdd8d1..969630c4 100644 --- a/tests/unit/test_plugins.py +++ b/tests/unit/test_plugins.py @@ -97,42 +97,43 @@ class HashPluginTest(SearxTestCase): request.headers.getlist.return_value = [] # MD5 - search = get_search_mock(query=b'md5 test', pageno=1) + search = get_search_mock(query='md5 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('md5 hash function: 098f6bcd4621d373cade4e832627b4f6' in search.result_container.answers) + self.assertTrue('md5 hash digest: 098f6bcd4621d373cade4e832627b4f6' + in search.result_container.answers['hash']['answer']) search = get_search_mock(query=b'md5 test', pageno=2) store.call(store.plugins, 'post_search', request, search) - self.assertFalse('md5 hash function: 098f6bcd4621d373cade4e832627b4f6' in search.result_container.answers) + self.assertFalse('hash' in search.result_container.answers) # SHA1 - search = get_search_mock(query=b'sha1 test', pageno=1) + search = get_search_mock(query='sha1 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha1 hash function: a94a8fe5ccb19ba61c4c0873d391e9879' - '82fbbd3' in search.result_container.answers) + self.assertTrue('sha1 hash digest: a94a8fe5ccb19ba61c4c0873d391e9879' + '82fbbd3' in search.result_container.answers['hash']['answer']) # SHA224 - search = get_search_mock(query=b'sha224 test', pageno=1) + search = get_search_mock(query='sha224 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha224 hash function: 90a3ed9e32b2aaf4c61c410eb9254261' - '19e1a9dc53d4286ade99a809' in search.result_container.answers) + self.assertTrue('sha224 hash digest: 90a3ed9e32b2aaf4c61c410eb9254261' + '19e1a9dc53d4286ade99a809' in search.result_container.answers['hash']['answer']) # SHA256 - search = get_search_mock(query=b'sha256 test', pageno=1) + search = get_search_mock(query='sha256 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha256 hash function: 9f86d081884c7d659a2feaa0c55ad015a' - '3bf4f1b2b0b822cd15d6c15b0f00a08' in search.result_container.answers) + self.assertTrue('sha256 hash digest: 9f86d081884c7d659a2feaa0c55ad015a' + '3bf4f1b2b0b822cd15d6c15b0f00a08' in search.result_container.answers['hash']['answer']) # SHA384 - search = get_search_mock(query=b'sha384 test', pageno=1) + search = get_search_mock(query='sha384 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha384 hash function: 768412320f7b0aa5812fce428dc4706b3c' + self.assertTrue('sha384 hash digest: 768412320f7b0aa5812fce428dc4706b3c' 'ae50e02a64caa16a782249bfe8efc4b7ef1ccb126255d196047dfedf1' - '7a0a9' in search.result_container.answers) + '7a0a9' in search.result_container.answers['hash']['answer']) # SHA512 - search = get_search_mock(query=b'sha512 test', pageno=1) + search = get_search_mock(query='sha512 test', pageno=1) store.call(store.plugins, 'post_search', request, search) - self.assertTrue('sha512 hash function: ee26b0dd4af7e749aa1a8ee3c10ae9923f6' + self.assertTrue('sha512 hash digest: ee26b0dd4af7e749aa1a8ee3c10ae9923f6' '18980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5' - 'fa9ad8e6f57f50028a8ff' in search.result_container.answers) + 'fa9ad8e6f57f50028a8ff' in search.result_container.answers['hash']['answer'])