chore: working prototype

Author: portswigger-tim

ical-simplejson-proxy/README.md

@@ -2,9 +2,12 @@
 
 ## Configuration
 
-### Environment Variables
+### HTTP Headers
 #### Required
-- `ICAL_URL` - The URL to the iCal feed or file. Examples: `file://path/to/file.ics`,
-  `https://my.calendar.org/feeds/calendar.ics`
+- `X-ICAL-URL` - The URL of the iCal feed.
+#### Optional
+- `X-TAGS` - A comma delimited list of tags for the annotations. Example: `maintenance,IT,planned`
+
+### Environment Variables
 #### Optional
-- `CACHE_TTL` - Default: 1800 - The number of seconds that results should be cached for.
+- `CACHE_TTL` - Default: 1800 - The number of seconds that results should be cached for.

ical-simplejson-proxy/app.py

@@ -1,20 +1,126 @@
-from flask import Flask
+import os
+import requests
+import time
+import icalendar
+
+from datetime import datetime
+from flask import Flask, request, abort
+from flask_cors import CORS
+from requests_file import FileAdapter
+from cachetools import TTLCache, cached
+
+CACHE_TTL = os.environ.get("CACHE_TTL", 1800)
+
+CACHE = TTLCache(maxsize=1000, ttl=CACHE_TTL)
 
 app = Flask(__name__)
 
-_SERVER_NAME = 'iCal SimpleJson Proxy'
+cors = CORS(app)
+app.config["CORS_HEADERS"] = "Content-Type"
+
+methods = ["GET", "POST", "HEAD", "OPTIONS"]
+
 
 @app.route("/")
-def ok():
+def index():
     return "OK"
 
-@app.route("/query")
+
+@app.route("/search", methods=methods)
+def search():
+    return []
+
+
+@app.route("/query", methods=methods)
 def query():
-    return {}
-
-@app.after_request
-def add_cors_headers(response):
-    response.headers['Access-Control-Allow-Headers'] = 'accept, content-type'
-    response.headers['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-    response.headers['Access-Control-Allow-Origin'] = '*'
-    return response
+    return []
+
+
+@app.route("/annotations", methods=methods)
+def annotations():
+    if request.method == "POST":
+        annotation = request.json.get(
+            "annotation",
+            {
+                "name": "Test Annotation",
+                "datasource": {
+                    "type": "grafana-simple-json-datasource",
+                    "uid": "TEST",
+                },
+                "enable": True,
+                "iconColor": "red",
+                "query": "#test",
+            },
+        )
+        ical_url = request.headers.get(
+            "X-ICAL-URL",
+            f"file://{os.path.dirname(os.path.realpath(__file__))}/fixtures/calendar.ics",
+        )
+
+        tags = []
+        if "X-TAGS" in request.headers:
+            tags = request.headers.get("X-TAGS").split(",")
+
+        return _ical_annotations(ical_url, tags, annotation)
+    return []
+
+
+@app.route("/tag-keys", methods=methods)
+def tag_keys():
+    return []
+
+
+@app.route("/tag-values", methods=methods)
+def tag_values():
+    return []
+
+
+def _ical_annotations_cache_key(url: str, tags: list, *args):
+    return f'{url}/{",".join(tags)}'
+
+
+@cached(CACHE, _ical_annotations_cache_key)
+def _ical_annotations(url: str, tags: list, annotation: dict):
+    ical_data = _fetch_ical_data(url)
+    ical_as_annotations = _convert_ical_to_annotations(ical_data, tags)
+
+    return [dict(x, **{"annotation": annotation}) for x in ical_as_annotations]
+
+
+def _fetch_ical_data(url: str):
+    s = requests.Session()
+    s.mount("file://", FileAdapter())
+
+    ical_resp = s.get(url)
+    if ical_resp.status_code != 200:
+        abort(ical_resp.status_code)
+
+    ical_data = ical_resp.text
+    if not ical_data.startswith("BEGIN:VCALENDAR"):
+        abort(400)
+
+    return ical_data
+
+
+def _convert_ical_to_annotations(ical_data, tags):
+    ical_annotations = []
+    ical_calendar = icalendar.Calendar.from_ical(ical_data)
+
+    for component in ical_calendar.walk():
+        if component.name == "VEVENT":
+            try:
+                ical_annotations.append(
+                    {
+                        "time": int(
+                            time.mktime(component.get("dtstart").dt.timetuple()) * 1000
+                        ),
+                        "title": component.get("summary"),
+                        "tags": tags,
+                        "text": component.get("description", ""),
+                    }
+                )
+            except AttributeError:
+                print(
+                    f'level=ERROR msg="decoding event failed" event_summary="{component.get("summary")}" event_dtstart="{component.get("dtstart")}" event_dtstamp="{component.get("dtstamp")}" event_dtend="{component.get("dtend")}"'
+                )
+    return ical_annotations

ical-simplejson-proxy/fixtures/calendar.ics

@@ -0,0 +1,23 @@
+BEGIN:VCALENDAR
+PRODID:-//Google Inc//Google Calendar 70.9054//EN
+VERSION:2.0
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+X-WR-CALNAME:Scheduled Maintenance
+X-WR-TIMEZONE:Europe/London
+X-WR-CALDESC:A calendar for IT/Platform/Other maintenance events
+BEGIN:VEVENT
+DTSTART:20220916T113000Z
+DTEND:20220916T123000Z
+DTSTAMP:20220921T132404Z
+UID:0sgn0d9cqakfvm7rj6a8niq2re@google.com
+CREATED:20220916T093411Z
+DESCRIPTION:Something is happening at this time
+LAST-MODIFIED:20220916T093411Z
+LOCATION:
+SEQUENCE:0
+STATUS:CONFIRMED
+SUMMARY:Test event
+TRANSP:TRANSPARENT
+END:VEVENT
+END:VCALENDAR

ical-simplejson-proxy/fixtures/calendar_annotations.json

@@ -0,0 +1 @@
+[{"annotation":{"datasource":{"type":"grafana-simple-json-datasource","uid":"0x5XTb7Vk"},"enable":true,"iconColor":"red","name":"Default Annotation","query":"#test"},"tags":[],"text":"Something is happening at this time","time":1663327800000,"title":"Test event"}]

ical-simplejson-proxy/requirements.txt

@@ -1 +1,5 @@
 Flask==2.2.2
+Flask-Cors==3.0.10
+requests==2.28.1
+requests-file==1.5.1
+ics==0.7.2