add dnsbl-query to api

Author: superstes

src/riskdb/api/apidocs/check_dnsbl_ip.yml

@@ -0,0 +1,38 @@
+---
+
+summary: 'Query IP in Risk-Database DNS-BL'
+
+parameters:
+  - in: 'path'
+    name: 'ip'
+    description: 'IP to query'
+    type: 'string'
+
+definitions:
+  IPStatus:
+    type: 'object'
+    properties:
+      listed:
+        type: 'boolean'
+        description: 'If the IP is listed in the DNS-BL'
+      category:
+        type: 'string'
+        description: 'The category the IP for which the IP was reported as'
+    required: ['listed', 'category']
+
+  ErrorMsg:
+    type: 'object'
+    properties:
+      msg:
+        type: 'string'
+        description: 'Error Message'
+
+responses:
+  200:
+    description: 'Risk-Database DNS-BL status of the IP'
+    schema:
+      $ref: '#/definitions/IPStatus'
+  400:
+    description: 'Invalid IP provided'
+    schema:
+      $ref: '#/definitions/ErrorMsg'

src/riskdb/api/main.py

@@ -21,6 +21,8 @@
 from flasgger import swag_from, Swagger
 from flask import Flask, request, Response, json, redirect
 from oxl_utils.valid.net import valid_public_ip, valid_asn, get_ipv
+from dnsbl_check import CheckIP
+from dnsbl_check.provider_config import CUSTOM_PROVIDERS
 
 from riskdb.users import USER_TOKENS
 from riskdb.config import BUILD_DIR, KIND_FILES, REPORT_DIR, RISK_CATEGORIES, NET_SIZE, \
@@ -225,6 +227,23 @@ def list_asn_kind(kind: str) -> Response:
     return _response_json(code=200, data={'asn': ASN_KIND_DATA[kind]})
 
 
+@app.route('/api/dnsbl/ip/<ip>', methods=['GET'])
+@swag_from('apidocs/check_dnsbl_ip.yml')
+def check_dnsbl_ip(ip) -> Response:
+    if not valid_public_ip(ip):
+        return _response_json(code=400, data={'msg': 'Invalid IP provided'})
+
+    provider = CUSTOM_PROVIDERS['ip.dnsbl.risk.oxl.app']()
+
+    with CheckIP(providers=[provider]) as checker:
+        result = checker.check(ip).to_dict()
+
+    return _response_json(code=200, data={
+        'listed': result['detected'],
+        'category': None if len(result['categories']) == 0 else result['categories'][0],
+    })
+
+
 @app.route('/')
 def catch_base():
     return redirect('/api/docs/', code=302)

src/riskdb/api/requirements.txt

@@ -2,4 +2,5 @@ flask
 waitress
 maxminddb
 oxl-utils
-flasgger
+flasgger
+dnsbl-check