Merge pull request #4 from phipzzz/public-page

Public page

Author: phipzzz

.env

@@ -69,7 +69,14 @@ WEB_PASSWORD = 'password'
 
 
 # Lifetime of the login to the web ui (in minutes)
-WEB_APP_SESSION_MAX_LIFETIME = 30 
+WEB_APP_SESSION_MAX_LIFETIME = 30
+
+
+# Dislay a publc page without authentication (default: False).
+# This page only diplays the Network name, Password and the QR code.
+# A manual password re-creation is not possible. It can be useful if
+# the system is operated in offices or public places e.g. cafes.
+WEB_PUBLIC_ENABLED = False
 
 
 # Time zone settings for the docker container (used for logging). See 

README.md

@@ -10,11 +10,12 @@ The fritzbox-wlan-password-rotator is a simple tool which automatically updates
 -   Password protected web ui to easily access WLAN credentials
 -   Dynamic QR code generation for guest WLAN credentials
 -   Trigger manual guest WLAN password renew
+-   Public page with network credentials for offices or public places e.g. cafes (can be enabled/disabled)
 -   Automatic data fetching if the guest WLAN credentials were changed directly on your FRITZ!Box (or somewhere else)
 
 <img src="./docs/qr-code_and_credentials.png" alt="qr code in safari" style="width: 700px; margin-right: 20px;"/>
 
-Further screenshots can be found [here](./docs/).
+Further screenshots can be found [here](./images/).
 
 ## Why
 
@@ -115,9 +116,11 @@ It is also possible to run the application without Docker, but this requires man
 Following FRITZ!Boxes were tested successfully. Feel free to add further ones. I guess almost all current models will work but they haven't been tested so far.
 
 -   **FRITZ!Box 7590 AX**
+
     -   FRITZ!OS 8.00
 
 -   **FRITZ!Box 7530**
+
     -   FRITZ!OS 8.00
 
 -   **FRITZ!Box 7490**

app/config.py

@@ -49,6 +49,8 @@ def get_bool_value(env, default):
 
 WEB_PASSWORD = os.environ.get('WEB_PASSWORD', 'password')
 
+WEB_PUBLIC_ENABLED = get_bool_value(os.environ.get('WEB_PUBLIC_ENABLED'), False)
+
 GUNICORN_PORT = 5000
 
 DEBUG = get_bool_value(os.environ.get('DEBUG'), False)

docs/login_screen.png renamed to images/login_screen.png

@@ -2,6 +2,7 @@
     WEB_PASSWORD,
     WEB_PAGE_TITLE,
     WEB_APP_SESSION_MAX_LIFETIME,
+    WEB_PUBLIC_ENABLED,
     CRON_MINUTE, 
     CRON_HOUR, 
     CRON_DAY, 
@@ -24,7 +25,8 @@
     render_template, 
     redirect, 
     url_for, 
-    session
+    session,
+    g
 )
 from apscheduler.schedulers.background import BackgroundScheduler
 from apscheduler.triggers.cron import CronTrigger
@@ -78,66 +80,104 @@ def update_password():
     current_password = new_password
     app.logger.info(f"New password set: {current_password}")
 
+def render_qr():
+
+    global current_password
+    wifi_data = f"WIFI:S:{ssid};T:WPA;P:{current_password};H:false;"
+
+    qr = qrcode.QRCode(
+        version = 1,
+        error_correction = qrcode.constants.ERROR_CORRECT_L,
+        box_size = 10,
+        border = 4,
+    )
+    qr.add_data(wifi_data)
+    qr.make(fit=True)
+
+    img = qr.make_image(fill_color = "black", back_color = "white")
+    buffer = io.BytesIO()
+    img.save(buffer, format = "PNG")
+    buffer.seek(0)
+
+    return base64.b64encode(buffer.getvalue()).decode()
+
+def render_page(page_name):
+
+    return render_template(page_name, qr_code = render_qr(), password = current_password, WLAN_SSID = ssid, WEB_PAGE_TITLE = WEB_PAGE_TITLE)
+
 @app.before_request
 def check_session():
-    if "authenticated" not in session and request.endpoint not in ["login", "static"]:
+
+    g.user_ip = request.remote_addr
+
+    if "authenticated" not in session and request.endpoint not in [
+        "login",
+        "static",
+        "public",
+        "public_disabled"
+    ]:
+
         return redirect(url_for("login"))
 
 @app.route("/", methods = ["GET", "POST"])
 def login():
+
     if request.method == "POST":
         entered_password = request.form.get("password")
-        user_ip = request.remote_addr
+
         if entered_password == WEB_PASSWORD:
             session["authenticated"] = True
             session.permanent = True
-            app.logger.info(f"{user_ip} - Successfully logged in")
-            return redirect(url_for("qr"))
+            app.logger.info(f"{g.user_ip} - Successfully logged in")
+
+            return redirect(url_for("admin"))
 
         else:
-            app.logger.warning(f"{user_ip} - Failed login attempt")
+            app.logger.warning(f"{g.user_ip} - Failed login attempt")
+
             return render_template("login.html", WEB_PAGE_TITLE = WEB_PAGE_TITLE, error = "Wrong password!")
+        
     return render_template("login.html", WEB_PAGE_TITLE = WEB_PAGE_TITLE)
 
-@app.route("/qr")
-def qr():
+@app.route("/admin")
+def admin():
 
     if not session.get("authenticated"):
         return redirect(url_for("login"))
 
-    global current_password
-    wifi_data = f"WIFI:S:{ssid};T:WPA;P:{current_password};H:false;"
+    return render_page("admin.html")
 
-    qr = qrcode.QRCode(
-        version = 1,
-        error_correction = qrcode.constants.ERROR_CORRECT_L,
-        box_size = 10,
-        border = 4,
-    )
-    qr.add_data(wifi_data)
-    qr.make(fit=True)
-
-    img = qr.make_image(fill_color = "black", back_color = "white")
-    buffer = io.BytesIO()
-    img.save(buffer, format = "PNG")
-    buffer.seek(0)
-    img_base64 = base64.b64encode(buffer.getvalue()).decode()
+@app.route("/public")
+def public():
 
-    return render_template("qr.html", qr_code = img_base64, password = current_password, WLAN_SSID = ssid, WEB_PAGE_TITLE = WEB_PAGE_TITLE)
+    if not WEB_PUBLIC_ENABLED:
+        return redirect(url_for("public_disabled"))
+    
+    return render_page("public.html")
 
 @app.route("/update-password", methods=["POST"])
 def trigger_update_password():
-    app.logger.info(f"Password update maually triggered")
+
+    app.logger.info(f"Password update maually triggered by {g.user_ip}")
     update_password()
-    return redirect(url_for("qr"))
+
+    return redirect(url_for("admin"))
 
 @app.route("/logout")
 def logout():
+
     session.pop("authenticated", None)
-    user_ip = request.remote_addr
-    app.logger.info(f"{user_ip} - Successfully logged out")
+    app.logger.info(f"{g.user_ip} - Successfully logged out")
+
     return redirect(url_for("login"))
 
+@app.route("/public_disabled")
+def public_disabled():
+    
+    app.logger.info(f"{g.user_ip} - Public page disabled")
+
+    return render_template("public_disabled.html")
+
 scheduler = BackgroundScheduler()
 
 def start_scheduler():

docs/qr-code_and_credentials-mobile.png renamed to images/qr-code_and_credentials-mobile.png

@@ -12,7 +12,7 @@ body {
     padding: 0 15px;
 }
 
-h1 {
+.container > h1 {
     text-align: center;
     font-size: 2.8rem;
 }
@@ -28,9 +28,6 @@ img {
     margin: 0 auto;
 }
 
-/* .container > form {
-} */
-
 .btn {
     display: block;
     width: 100%;

docs/qr-code_and_credentials.png renamed to images/qr-code_and_credentials.png

@@ -13,7 +13,7 @@
         <div class="container">
             <h1>{{ WEB_PAGE_TITLE }}</h1>
             <p>
-                SSID: <strong>{{ WLAN_SSID }}</strong><br />
+                Network name: <strong>{{ WLAN_SSID }}</strong><br />
                 Password: <strong>{{ password }}</strong>
             </p>
             <img src="data:image/png;base64,{{ qr_code }}" alt="QR-Code" />

main.py

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <link
+            rel="stylesheet"
+            href="{{ url_for('static', filename='src/styles/styles.css') }}"
+        />
+        <title>{{ WEB_PAGE_TITLE }}</title>
+    </head>
+    <body>
+        <div class="container">
+            <h1>{{ WEB_PAGE_TITLE }}</h1>
+            <p>
+                Network name: <strong>{{ WLAN_SSID }}</strong><br />
+                Password: <strong>{{ password }}</strong>
+            </p>
+            <img src="data:image/png;base64,{{ qr_code }}" alt="QR-Code" />
+        </div>
+        <script src="{{ url_for('static', filename='src/script/main.js') }}"></script>
+    </body>
+</html>

static/src/styles/styles.css

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <link
+            rel="stylesheet"
+            href="{{ url_for('static', filename='src/styles/styles.css') }}"
+        />
+        <title>{{ WEB_PAGE_TITLE }} - Error</title>
+    </head>
+    <body>
+        <h1>Error: Public page not enabled</h1>
+        <p>
+            The public page has not been enabled. Please contact your
+            administrator.
+        </p>
+        <script src="{{ url_for('static', filename='src/script/main.js') }}"></script>
+    </body>
+</html>