mirror of
https://github.com/r4sas/PBinCLI
synced 2025-03-13 05:41:08 +00:00
A more robust logic to parse API settings.
All key-value settings in api.py were parsed through the following syntax:
```python
if settings["something"] is None:
...
```
This is problematic because it forces downstream implementations to also
provide all the fields, also when they are not required.
In particular, when new fields are added, downstream implementations
also have to provide them, or the integration will break.
The `settings.get("something")` syntax should be preferred, and settings
itself should also be initialized to a dict by default to prevent
dereferencing a `None` (I mean, if no settings are provided at all the
code should probably still break, but with a relevant error instead of a
fuzzier `TypeError`).
Closes: #51
Closes: #52
Closes: https://github.com/Pioverpie/privatebin-api#12
This commit is contained in:
Fabio Manganiello
R4SAS
parent
41bc3b3745
commit
03bdfe6782
307
pbincli/api.py
307
pbincli/api.py
@ -2,98 +2,119 @@ import requests
|
||||
from requests import HTTPError
|
||||
from pbincli.utils import PBinCLIError
|
||||
|
||||
|
||||
def _config_requests(settings=None, shortener=False):
|
||||
if settings['no_insecure_warning']:
|
||||
settings = settings or {}
|
||||
if settings.get("no_insecure_warning"):
|
||||
from requests.packages.urllib3.exceptions import InsecureRequestWarning
|
||||
|
||||
requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
|
||||
|
||||
session = requests.Session()
|
||||
session.verify = not settings['no_check_certificate']
|
||||
session.verify = not settings.get("no_check_certificate")
|
||||
|
||||
if settings['auth'] and not shortener: # do not leak PrivateBin authorization to shortener services
|
||||
if settings['auth'] == 'basic' and settings['auth_user'] and settings['auth_pass']:
|
||||
session.auth = (settings['auth_user'], settings['auth_pass'])
|
||||
elif settings['auth'] == 'custom' and settings['auth_custom']:
|
||||
if (
|
||||
settings.get("auth") and not shortener
|
||||
): # do not leak PrivateBin authorization to shortener services
|
||||
auth = settings["auth"]
|
||||
if auth == "basic" and all(
|
||||
[settings.get("auth_user"), settings.get("auth_pass")]
|
||||
):
|
||||
session.auth = (settings["auth_user"], settings["auth_pass"])
|
||||
elif auth == "custom" and settings.get("auth_custom"):
|
||||
from json import loads as json_loads
|
||||
auth = json_loads(settings['auth_custom'])
|
||||
|
||||
auth = json_loads(settings["auth_custom"])
|
||||
session.headers.update(auth)
|
||||
else:
|
||||
PBinCLIError("Incorrect authorization configuration")
|
||||
|
||||
if settings['proxy']:
|
||||
scheme = settings['proxy'].split('://')[0]
|
||||
if (scheme.startswith("socks")):
|
||||
session.proxies.update({
|
||||
"http": settings['proxy'],
|
||||
"https": settings['proxy']
|
||||
})
|
||||
if settings["proxy"]:
|
||||
scheme = settings["proxy"].split("://")[0]
|
||||
if scheme.startswith("socks"):
|
||||
session.proxies.update(
|
||||
{"http": settings["proxy"], "https": settings["proxy"]}
|
||||
)
|
||||
else:
|
||||
session.proxies.update({scheme: settings['proxy']})
|
||||
session.proxies.update({scheme: settings["proxy"]})
|
||||
|
||||
return session
|
||||
|
||||
|
||||
class PrivateBin:
|
||||
def __init__(self, settings=None):
|
||||
self.server = settings['server']
|
||||
self.headers = {'X-Requested-With': 'JSONHttpRequest'}
|
||||
settings = settings or {}
|
||||
if not settings.get("server"):
|
||||
PBinCLIError("No server specified - unable to continue")
|
||||
|
||||
self.server = settings["server"]
|
||||
self.headers = {"X-Requested-With": "JSONHttpRequest"}
|
||||
|
||||
self.session = _config_requests(settings, False)
|
||||
|
||||
def post(self, request):
|
||||
result = self.session.post(
|
||||
url = self.server,
|
||||
headers = self.headers,
|
||||
data = request)
|
||||
result = self.session.post(url=self.server, headers=self.headers, data=request)
|
||||
|
||||
try:
|
||||
return result.json()
|
||||
except ValueError:
|
||||
PBinCLIError("Unable parse response as json. Received (size = {}):\n{}".format(len(result.text), result.text))
|
||||
|
||||
PBinCLIError(
|
||||
"Unable parse response as json. Received (size = {}):\n{}".format(
|
||||
len(result.text), result.text
|
||||
)
|
||||
)
|
||||
|
||||
def get(self, request):
|
||||
return self.session.get(
|
||||
url = self.server + "?" + request,
|
||||
headers = self.headers).json()
|
||||
|
||||
url=self.server + "?" + request, headers=self.headers
|
||||
).json()
|
||||
|
||||
def delete(self, request):
|
||||
# using try as workaround for versions < 1.3 due to we cant detect
|
||||
# if server used version 1.2, where auto-deletion is added
|
||||
try:
|
||||
result = self.session.post(
|
||||
url = self.server,
|
||||
headers = self.headers,
|
||||
data = request).json()
|
||||
url=self.server, headers=self.headers, data=request
|
||||
).json()
|
||||
except ValueError:
|
||||
# unable parse response as json because it can be empty (1.2), so simulate correct answer
|
||||
print("NOTICE: Received empty response. We interpret that as our paste has already been deleted.")
|
||||
print(
|
||||
"NOTICE: Received empty response. We interpret that as our paste has already been deleted."
|
||||
)
|
||||
from json import loads as json_loads
|
||||
|
||||
result = json_loads('{"status":0}')
|
||||
|
||||
if not result['status']:
|
||||
if not result["status"]:
|
||||
print("Paste successfully deleted!")
|
||||
elif result['status']:
|
||||
PBinCLIError("Something went wrong...\nError:\t\t{}".format(result['message']))
|
||||
elif result["status"]:
|
||||
PBinCLIError(
|
||||
"Something went wrong...\nError:\t\t{}".format(result["message"])
|
||||
)
|
||||
else:
|
||||
PBinCLIError("Something went wrong...\nError: Empty response.")
|
||||
|
||||
|
||||
def getVersion(self):
|
||||
result = self.session.get(
|
||||
url = self.server + '?jsonld=paste',
|
||||
headers = self.headers)
|
||||
url=self.server + "?jsonld=paste", headers=self.headers
|
||||
)
|
||||
try:
|
||||
jsonldSchema = result.json()
|
||||
return jsonldSchema['@context']['v']['@value'] \
|
||||
if ('@context' in jsonldSchema and
|
||||
'v' in jsonldSchema['@context'] and
|
||||
'@value' in jsonldSchema['@context']['v']) \
|
||||
return (
|
||||
jsonldSchema["@context"]["v"]["@value"]
|
||||
if (
|
||||
"@context" in jsonldSchema
|
||||
and "v" in jsonldSchema["@context"]
|
||||
and "@value" in jsonldSchema["@context"]["v"]
|
||||
)
|
||||
else 1
|
||||
)
|
||||
except ValueError:
|
||||
PBinCLIError("Unable parse response as json. Received (size = {}):\n{}".format(len(result.text), result.text))
|
||||
|
||||
PBinCLIError(
|
||||
"Unable parse response as json. Received (size = {}):\n{}".format(
|
||||
len(result.text), result.text
|
||||
)
|
||||
)
|
||||
|
||||
def getServer(self):
|
||||
return self.server
|
||||
@ -103,80 +124,98 @@ class Shortener:
|
||||
"""Some parts of this class was taken from
|
||||
python-yourls (https://github.com/tflink/python-yourls/) library
|
||||
"""
|
||||
def __init__(self, settings=None):
|
||||
self.api = settings['short_api']
|
||||
|
||||
def __init__(self, settings=None):
|
||||
settings = settings or {}
|
||||
self.api = settings.get("short_api")
|
||||
if self.api is None:
|
||||
PBinCLIError("Unable to activate link shortener without short_api.")
|
||||
|
||||
# we checking which service is used, because some services doesn't require
|
||||
# any authentication, or have only one domain on which it working
|
||||
if self.api == 'yourls':
|
||||
if self.api == "yourls":
|
||||
self._yourls_init(settings)
|
||||
elif self.api == 'isgd' or self.api == 'vgd':
|
||||
elif self.api == "isgd" or self.api == "vgd":
|
||||
self._gd_init()
|
||||
elif self.api == 'custom':
|
||||
self.apiurl = settings['short_url']
|
||||
elif self.api == "custom":
|
||||
self.apiurl = settings.get("short_url")
|
||||
if not self.apiurl:
|
||||
PBinCLIError("short_url is required for custom shortener")
|
||||
|
||||
self.session = _config_requests(settings, True)
|
||||
|
||||
|
||||
def _yourls_init(self, settings):
|
||||
if not settings['short_url']:
|
||||
apiurl = settings["short_url"]
|
||||
if not apiurl:
|
||||
PBinCLIError("YOURLS: An API URL is required")
|
||||
|
||||
# setting API URL
|
||||
apiurl = settings['short_url']
|
||||
if apiurl.endswith('/yourls-api.php'):
|
||||
if apiurl.endswith("/yourls-api.php"):
|
||||
self.apiurl = apiurl
|
||||
elif apiurl.endswith('/'):
|
||||
self.apiurl = apiurl + 'yourls-api.php'
|
||||
elif apiurl.endswith("/"):
|
||||
self.apiurl = apiurl + "yourls-api.php"
|
||||
else:
|
||||
PBinCLIError("YOURLS: Incorrect URL is provided.\n" +
|
||||
"It must contain full address to 'yourls-api.php' script (like https://example.com/yourls-api.php)\n" +
|
||||
"or just contain instance URL with '/' at the end (like https://example.com/)")
|
||||
PBinCLIError(
|
||||
"YOURLS: Incorrect URL is provided.\n"
|
||||
+ "It must contain full address to 'yourls-api.php' script (like https://example.com/yourls-api.php)\n"
|
||||
+ "or just contain instance URL with '/' at the end (like https://example.com/)"
|
||||
)
|
||||
|
||||
# validating for required credentials
|
||||
if settings['short_user'] and settings['short_pass'] and settings['short_token'] is None:
|
||||
self.auth_args = {'username': settings['short_user'], 'password': settings['short_pass']}
|
||||
elif settings['short_user'] is None and settings['short_pass'] is None and settings['short_token']:
|
||||
self.auth_args = {'signature': settings['short_token']}
|
||||
elif settings['short_user'] is None and settings['short_pass'] is None and settings['short_token'] is None:
|
||||
if (
|
||||
settings.get("short_user")
|
||||
and settings.get("short_pass")
|
||||
and settings.get("short_token") is None
|
||||
):
|
||||
self.auth_args = {
|
||||
"username": settings["short_user"],
|
||||
"password": settings["short_pass"],
|
||||
}
|
||||
elif (
|
||||
settings.get("short_user") is None
|
||||
and settings.get("short_pass") is None
|
||||
and settings.get("short_token")
|
||||
):
|
||||
self.auth_args = {"signature": settings["short_token"]}
|
||||
elif (
|
||||
settings.get("short_user") is None
|
||||
and settings.get("short_pass") is None
|
||||
and settings.get("short_token") is None
|
||||
):
|
||||
self.auth_args = {}
|
||||
else:
|
||||
PBinCLIError("YOURLS: either username and password or token are required. Otherwise set to default (None)")
|
||||
|
||||
PBinCLIError(
|
||||
"YOURLS: either username and password or token are required. Otherwise set to default (None)"
|
||||
)
|
||||
|
||||
def _gd_init(self):
|
||||
if self.api == 'isgd':
|
||||
self.apiurl = 'https://is.gd/'
|
||||
if self.api == "isgd":
|
||||
self.apiurl = "https://is.gd/"
|
||||
else:
|
||||
self.apiurl = 'https://v.gd/'
|
||||
self.useragent = 'Mozilla/5.0 (compatible; pbincli - https://github.com/r4sas/pbincli/)'
|
||||
|
||||
self.apiurl = "https://v.gd/"
|
||||
self.useragent = (
|
||||
"Mozilla/5.0 (compatible; pbincli - https://github.com/r4sas/pbincli/)"
|
||||
)
|
||||
|
||||
def getlink(self, url):
|
||||
# that is api -> function mapper for running service-related function when getlink() used
|
||||
servicesList = {
|
||||
'yourls': self._yourls,
|
||||
'clckru': self._clckru,
|
||||
'tinyurl': self._tinyurl,
|
||||
'isgd': self._gd,
|
||||
'vgd': self._gd,
|
||||
'cuttly': self._cuttly,
|
||||
'custom': self._custom
|
||||
"yourls": self._yourls,
|
||||
"clckru": self._clckru,
|
||||
"tinyurl": self._tinyurl,
|
||||
"isgd": self._gd,
|
||||
"vgd": self._gd,
|
||||
"cuttly": self._cuttly,
|
||||
"custom": self._custom,
|
||||
}
|
||||
# run function selected by choosen API
|
||||
return servicesList[self.api](url)
|
||||
|
||||
|
||||
def _yourls(self,url):
|
||||
request = {'action': 'shorturl', 'format': 'json', 'url': url}
|
||||
def _yourls(self, url):
|
||||
request = {"action": "shorturl", "format": "json", "url": url}
|
||||
request.update(self.auth_args)
|
||||
|
||||
result = self.session.post(
|
||||
url = self.apiurl,
|
||||
data = request)
|
||||
result = self.session.post(url=self.apiurl, data=request)
|
||||
|
||||
try:
|
||||
result.raise_for_status()
|
||||
@ -184,103 +223,115 @@ class Shortener:
|
||||
try:
|
||||
response = result.json()
|
||||
except ValueError:
|
||||
PBinCLIError("YOURLS: Unable parse response. Received (size = {}):\n{}".format(len(result.text), result.text))
|
||||
PBinCLIError(
|
||||
"YOURLS: Unable parse response. Received (size = {}):\n{}".format(
|
||||
len(result.text), result.text
|
||||
)
|
||||
)
|
||||
else:
|
||||
PBinCLIError("YOURLS: Received error from API: {} with JSON {}".format(result, response))
|
||||
PBinCLIError(
|
||||
"YOURLS: Received error from API: {} with JSON {}".format(
|
||||
result, response
|
||||
)
|
||||
)
|
||||
else:
|
||||
response = result.json()
|
||||
|
||||
if {'status', 'statusCode', 'message'} <= set(response.keys()):
|
||||
if response['status'] == 'fail':
|
||||
PBinCLIError("YOURLS: Received error from API: {}".format(response['message']))
|
||||
if not 'shorturl' in response:
|
||||
PBinCLIError("YOURLS: Unknown error: {}".format(response['message']))
|
||||
if {"status", "statusCode", "message"} <= set(response.keys()):
|
||||
if response["status"] == "fail":
|
||||
PBinCLIError(
|
||||
"YOURLS: Received error from API: {}".format(
|
||||
response["message"]
|
||||
)
|
||||
)
|
||||
if not "shorturl" in response:
|
||||
PBinCLIError(
|
||||
"YOURLS: Unknown error: {}".format(response["message"])
|
||||
)
|
||||
else:
|
||||
return response['shorturl']
|
||||
return response["shorturl"]
|
||||
else:
|
||||
PBinCLIError("YOURLS: No status, statusCode or message fields in response! Received:\n{}".format(response))
|
||||
|
||||
PBinCLIError(
|
||||
"YOURLS: No status, statusCode or message fields in response! Received:\n{}".format(
|
||||
response
|
||||
)
|
||||
)
|
||||
|
||||
def _clckru(self, url):
|
||||
request = {'url': url}
|
||||
request = {"url": url}
|
||||
|
||||
try:
|
||||
result = self.session.post(
|
||||
url = "https://clck.ru/--",
|
||||
data = request)
|
||||
result = self.session.post(url="https://clck.ru/--", data=request)
|
||||
return result.text
|
||||
except Exception as ex:
|
||||
PBinCLIError("clck.ru: unexcepted behavior: {}".format(ex))
|
||||
|
||||
|
||||
def _tinyurl(self, url):
|
||||
request = {'url': url}
|
||||
request = {"url": url}
|
||||
|
||||
try:
|
||||
result = self.session.post(
|
||||
url = "https://tinyurl.com/api-create.php",
|
||||
data = request)
|
||||
url="https://tinyurl.com/api-create.php", data=request
|
||||
)
|
||||
return result.text
|
||||
except Exception as ex:
|
||||
PBinCLIError("TinyURL: unexcepted behavior: {}".format(ex))
|
||||
|
||||
|
||||
def _gd(self, url):
|
||||
request = {
|
||||
'format': 'json',
|
||||
'url': url,
|
||||
'logstats': 0 # we don't want use any statistics
|
||||
"format": "json",
|
||||
"url": url,
|
||||
"logstats": 0, # we don't want use any statistics
|
||||
}
|
||||
headers = { 'User-Agent': self.useragent}
|
||||
headers = {"User-Agent": self.useragent}
|
||||
|
||||
try:
|
||||
result = self.session.post(
|
||||
url = self.apiurl + "create.php",
|
||||
headers = headers,
|
||||
data = request)
|
||||
url=self.apiurl + "create.php", headers=headers, data=request
|
||||
)
|
||||
|
||||
response = result.json()
|
||||
|
||||
if 'shorturl' in response:
|
||||
return response['shorturl']
|
||||
if "shorturl" in response:
|
||||
return response["shorturl"]
|
||||
else:
|
||||
PBinCLIError("{}: got error {} from API: {}".format(
|
||||
"is.gd" if self.api == 'isgd' else 'v.gd',
|
||||
response['errorcode'],
|
||||
response['errormessage']))
|
||||
PBinCLIError(
|
||||
"{}: got error {} from API: {}".format(
|
||||
"is.gd" if self.api == "isgd" else "v.gd",
|
||||
response["errorcode"],
|
||||
response["errormessage"],
|
||||
)
|
||||
)
|
||||
|
||||
except Exception as ex:
|
||||
PBinCLIError("{}: unexcepted behavior: {}".format(
|
||||
"is.gd" if self.api == 'isgd' else 'v.gd',
|
||||
ex))
|
||||
|
||||
PBinCLIError(
|
||||
"{}: unexcepted behavior: {}".format(
|
||||
"is.gd" if self.api == "isgd" else "v.gd", ex
|
||||
)
|
||||
)
|
||||
|
||||
def _cuttly(self, url):
|
||||
request = {
|
||||
'url': url,
|
||||
'domain': 0
|
||||
}
|
||||
request = {"url": url, "domain": 0}
|
||||
|
||||
try:
|
||||
result = self.session.post(
|
||||
url = "https://cutt.ly/scripts/shortenUrl.php",
|
||||
data = request)
|
||||
url="https://cutt.ly/scripts/shortenUrl.php", data=request
|
||||
)
|
||||
return result.text
|
||||
except Exception as ex:
|
||||
PBinCLIError("cutt.ly: unexcepted behavior: {}".format(ex))
|
||||
|
||||
|
||||
def _custom(self, url):
|
||||
if self.apiurl is None:
|
||||
PBinCLIError("No short_url specified - link will not be shortened.")
|
||||
|
||||
from urllib.parse import quote
|
||||
qUrl = quote(url, safe="") # urlencoded paste url
|
||||
|
||||
qUrl = quote(url, safe="") # urlencoded paste url
|
||||
rUrl = self.apiurl.replace("{{url}}", qUrl)
|
||||
|
||||
try:
|
||||
result = self.session.get(
|
||||
url = rUrl)
|
||||
result = self.session.get(url=rUrl)
|
||||
return result.text
|
||||
except Exception as ex:
|
||||
PBinCLIError("Shorter: unexcepted behavior: {}".format(ex))
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user