A simple web API for computing MD5 hash of an arbitrary file on the Internet. If email provided attempts (i.e. no indication if sending fails) to send the result via SMTP. Returns results in a convenient json-compatible format. Has only 2 dependencies (apart from standard library).
Redis (5.0.0) should be installed before using the software. Instructions at redis web site.
Also virtualenv package is needed to set up appropriate environment. Instructions here.
# inside cloned repo:
$ virtualenv -p python3.6 <path_to_desired_env_dir>
$ source <path_to_env_dir>/bin/activate
$ pip install -r requirements.txt
Edit config.py if needed.
Launch md5light.py:
$ python md5light.py
Use either browser (Firefox 63.0 was tested, issues are known with Chrome) or another Terminal window and curl to interact with the API. (the default address is http://localhost:48777)
$ curl -X POST -d "email=user@example.com&url=http://site.com/file.txt" http://localhost:48777/submit
{"id":"0e4fac17-f367-4807-8c28-8a059a2f82ac"}
$ curl -X GET http://localhost:48777/check?0e4fac17-f367-4807-8c28-8a059a2f82ac
{"status":"running"}
$ curl -X GET http://localhost:48777/check?0e4fac17-f367-4807-8c28-8a059a2f82ac
{"md5":"f4afe93ad799484b1d512cc20e93efd1", "status":"done", "url":"http://site.com/file.txt"}
Should NOT be used publicly as only basic security checks are implemented in python http.server.HTTPserver class.
A workaround was implemented for a bug found during the development - redis database fails when 'key' is string which starts with a number. (redis/redis#2864 (comment))
Two types of 'failed' status are implemented. failed-url-error is used to indicate mostly invalid url, while failed-http-code-not-200 indicates that url was succesfully reached but the server responded with not expected http code.
There is an additional type of response error:invalid-query which indicates that the API is being used incorrectly.