new: [onion-lookup] skeleton added

adulau · adulau · commit 53d123628221 · 2024-10-04T17:09:25.000+02:00
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# onion-lookup
+
+Software back-end and services for checking the existence of Tor hidden services and retrieving their associated metadata. onion-lookup relies on an AIL instance to obtain the metadata.
+
+# License
+
+This software is licensed under GNU Affero General Public License version 3.
+
+- Copyright (C) 2024 CIRCL - Computer Incident Response Center Luxembourg
+- Copyright (C) 2024 Alexandre Dulaunoy
+- Copyright (C) 2024 AIL Project
diff --git a/app.py b/app.py
@@ -0,0 +1,61 @@
+from starlette.applications import Starlette
+from starlette.exceptions import HTTPException
+from starlette.requests import Request
+from starlette.staticfiles import StaticFiles
+from starlette.routing import Route, Mount
+from starlette.templating import Jinja2Templates
+import uvicorn
+
+
+templates = Jinja2Templates(directory='templates')
+
+
+async def homepage(request):
+    template = "index.html"
+    context = {"request": request}
+    if 'lookup' in request.query_params:
+        print(request.query_params['lookup'])
+    return templates.TemplateResponse(template, context)
+
+
+async def error(request):
+    """
+    Generic catch-call error 
+    """
+    raise RuntimeError("Oh no")
+
+
+async def not_found(request: Request, exc: HTTPException):
+    """
+    Return an HTTP 404 page.
+    """
+    template = "404.html"
+    context = {"request": request}
+    return templates.TemplateResponse(template, context, status_code=404)
+
+
+async def server_error(request: Request, exc: HTTPException):
+    """
+    Return an HTTP 500 page.
+    """
+    template = "500.html"
+    context = {"request": request}
+    return templates.TemplateResponse(template, context, status_code=500)
+
+routes = [
+    Route('/', homepage),
+    Route('/error', error),
+    Mount('/static', app=StaticFiles(directory='statics'), name='static')
+]
+
+exception_handlers = {
+    404: not_found,
+    500: server_error
+}
+
+app = Starlette(debug=True, routes=routes, exception_handlers=exception_handlers)
+
+
+if __name__ == "__main__":
+    uvicorn.run(app, host='0.0.0.0', port=8000)
+    
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,5 @@
+aiofiles
+jinja2
+starlette
+uvicorn
+valkey
diff --git a/scripts/install b/scripts/install
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+python3 -m venv .venv
+source .venv/bin/activate
+pip3 install -r requirements.txt
diff --git a/scripts/run b/scripts/run
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+.venv/bin/python app.py
diff --git a/statics/css/bootstrap.min.css b/statics/css/bootstrap.min.css
diff --git a/statics/js/bootstrap.min.js b/statics/js/bootstrap.min.js
diff --git a/statics/js/jquery-3.7.1.slim.min.js b/statics/js/jquery-3.7.1.slim.min.js
diff --git a/statics/js/popper.min.js b/statics/js/popper.min.js
diff --git a/templates/404.html b/templates/404.html
@@ -0,0 +1,16 @@
+{% extends "base.html" %}
+
+{% block content %}
+<main role="main">
+
+  <!-- Main jumbotron for a primary marketing message or call to action -->
+  <div class="jumbotron">
+    <div class="container">
+      <h1 class="display-3">404</h1>
+      <p>Page not found.</p>
+    </div>
+  </div>
+
+</main>
+{% endblock %}
+
diff --git a/templates/500.html b/templates/500.html
@@ -0,0 +1,16 @@
+{% extends "base.html" %}
+
+{% block content %}
+<main role="main">
+
+  <!-- Main jumbotron for a primary marketing message or call to action -->
+  <div class="jumbotron">
+    <div class="container">
+      <h1 class="display-3">500</h1>
+      <p>Server error.</p>
+    </div>
+  </div>
+
+</main>
+{% endblock %}
+
diff --git a/templates/base.html b/templates/base.html
@@ -0,0 +1,42 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="description" content="">
+    <meta name="author" content="">
+
+    <title>onion-lookup - checking the metadata of a Tor hidden service</title>
+
+    <!-- Bootstrap core CSS -->
+    <link href="{{ url_for('static', path='/css/bootstrap.min.css') }}" rel="stylesheet">
+
+    <!-- Custom styles for this template -->
+    <link href="{{ url_for('static', path='/css/jumbotron.css') }}" rel="stylesheet">
+  </head>
+
+  <body>
+
+    <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark">
+      <a class="navbar-brand" href="#">onion-lookup, everything all always wanted about a Tor hidden service</a>
+      <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
+        <span class="navbar-toggler-icon"></span>
+      </button>
+
+    </nav>
+
+    {% block content %}{% endblock %}
+
+    <footer class="container">
+	    <p>onion-lookup is an open project part of the <a href="https://www.ail-project.org/">AIL Project</a>.</p>
+    </footer>
+
+    <!-- Bootstrap core JavaScript
+    ================================================== -->
+    <!-- Placed at the end of the document so the pages load faster -->
+    <script src="{{ url_for('static', path='/js/jquery-3.7.1.slim.min.js’') }}"></script>
+    <script src="{{ url_for('static', path='/js/popper.min.js') }}"></script>
+    <script src="{{ url_for('static', path='/js/bootstrap.min.js') }}"></script>
+  </body>
+</html>
+
diff --git a/templates/index.html b/templates/index.html
@@ -0,0 +1,33 @@
+{% extends "base.html" %}
+
+{% block content %}
+<main role="main">
+
+  <div class="jumbotron">
+    <div class="container">
+      <h1 class="display-3">onion-lookup</h1>
+      <p>onion-lookup is a service for checking the existence of Tor hidden services and retrieving their associated metadata. onion-lookup relies on an private <a href="https://www.ail-project.org/">AIL</a> instance to obtain the metadata.</p>
+       <form class="form-inline my-2 my-lg-0">
+          <input class="form-control mr-sm-2" name="lookup" type="text" placeholder="Lookup" aria-label="Lookup">
+          <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Lookup</button>
+       </form>
+
+    </div>
+  </div>
+
+  <div class="container">
+    <div class="row">
+      <div class="col-md-4">
+        <h2>API</h2>
+        <p>An OpenAPI is also available to query onion-lookup.</p>
+        <p><a class="btn btn-secondary" href="#" role="button">View details &raquo;</a></p>
+      </div>
+    </div>
+
+    <hr>
+
+  </div> <!-- /container -->
+
+</main>
+{% endblock %}
+

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/bin/bash`
	`2`	`+`
	`3`	`+.venv/bin/python app.py`