Develop

.env.example

@@ -1,4 +1,4 @@
-; Authentication method: LDAP or OIC
+; Authentication method: LDAP or OIDC
 Authentication="LDAP"
 ; LDAP config
 LDAP_HOST="ldaps://..."
@@ -18,11 +18,11 @@ TESTUSER=false
 
 ; OpenID Connect configuration
 ; ID provider
-OIC_IDP="https://xxx"
+OIDC_IDP="https://xxx"
 ; Client ID
-OIC_CLIENT_ID="xxx"
+OIDC_CLIENT_ID="xxx"
 ; Client secret
-OIC_CLIENT_SECRET="xxx"
+OIDC_CLIENT_SECRET="xxx"
 
 ; Path to composer auoload file (without /vendor/autoload.php)
 ; normally set to "."

.github/workflows/ci.yaml

@@ -0,0 +1,83 @@
+on:
+  push:
+  pull_request:
+
+name: CI build
+jobs:
+  build:
+    name: CI build
+    runs-on: ubuntu-latest
+    env:
+      # Use docker.io for Docker Hub if empty
+      REGISTRY: ghcr.io
+      # github.repository as <account>/<repo>
+      IMAGE_NAME: ${{ github.repository }}
+    permissions:
+      contents: read
+      packages: write
+    steps:
+
+    - name: Checkout repo
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+
+
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Log into registry ${{ env.REGISTRY }}
+      if: github.event_name != 'pull_request'
+      uses: docker/login-action@v3
+      with:
+        registry: ${{ env.REGISTRY }}
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    - name: Extract Docker metadata
+      id: meta-php
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-php
+        tags: |
+          type=schedule
+          type=ref,event=branch
+          type=ref,event=tag
+          type=ref,event=pr
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
+          type=raw,value=latest,enable={{is_default_branch}}
+          type=raw,value={{branch}}-{{sha}}-{{date 'X'}},enable=${{ github.event_name != 'pull_request' && !contains(github.ref, 'refs/tags/') }}
+    - name: Build and push
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        file: ./Dockerfile.php
+        push: ${{ github.event_name != 'pull_request' && github.actor != 'dependabot[bot]'}}
+        tags: ${{ steps.meta-php.outputs.tags }}
+        labels: ${{ steps.meta-php.outputs.labels }}
+
+    - name: Extract Docker metadata
+      id: meta-caddy
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-caddy
+        tags: |
+          type=schedule
+          type=ref,event=branch
+          type=ref,event=tag
+          type=ref,event=pr
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
+          type=raw,value=latest,enable={{is_default_branch}}
+          type=raw,value={{branch}}-{{sha}}-{{date 'X'}},enable=${{ github.event_name != 'pull_request' && !contains(github.ref, 'refs/tags/') }}
+    - name: Build and push
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        file: ./Dockerfile.caddy
+        push: ${{ github.event_name != 'pull_request' && github.actor != 'dependabot[bot]'}}
+        tags: ${{ steps.meta-caddy.outputs.tags }}
+        labels: ${{ steps.meta-caddy.outputs.labels }}

Dockerfile.caddy

@@ -0,0 +1,2 @@
+FROM caddy:latest
+COPY . /var/www/html/public

Dockerfile.php

@@ -0,0 +1,12 @@
+FROM php:8.2-fpm
+#WORKDIR /var/www/html 
+COPY ./ /var/www/html/
+
+RUN apt-get update \
+    && apt-get install -y git libzip-dev zip \
+    && docker-php-ext-install zip \
+    && cd /var/www/html \
+    && chmod +x composer_install.sh && ./composer_install.sh \ 
+    && mv composer.phar /usr/local/bin/composer \
+    && composer install \
+    && rm composer_install.sh Dockerfile.caddy Dockerfile.php

README.md

@@ -47,14 +47,14 @@ To get started you need to add a configuration file to the project first. Copy t
 
 | Value            | Type    | Example                                | Description                                                                                                                                        |
 | ---------------- | ------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Authentication   | string  | 'LDAP' or 'OIC'                        | Authentication method: LDAP or OpenID Connect                                                                                                      |
+| Authentication   | string  | 'LDAP' or 'OIDC'                        | Authentication method: LDAP or OpenID Connect                                                                                                      |
 | LDAP_HOST        | string  | "ldaps://...de"                        | The URL of your LDAP server.                                                                                                                       |
 | LDAP_BIND_PW     | string  | secretpassword                         | Password of the user that is trying to bind to the LDAP Server.                                                                                    |
 | LDAP_BASE_DN     | string  | "cn=...,ou=...,dc=..."                 | Distinguised name that is used to initially bind to your LDAP server.                                                                              |
 | LDAP_SEARCH_DN   | string  | "ou=...,dc=..."                        | Distinguished name that is used for authenticating users.                                                                                          |
-| OIC_IDP          | string  | "https://...."                         | URL of the Identity provider supporting OpenID Connect.                                                                                            |
-| OIC_CLIENT_ID    | string  | "..."                                  | Client Id for this application in Identity provider.                                                                                               |
-| OIC_CLIENT_SECRET | string  | "..."                                 | Secret key for OpenID Connect.                                                                                                                     |
+| OIDC_IDP          | string  | "https://...."                         | URL of the Identity provider supporting OpenID Connect.                                                                                            |
+| OIDC_CLIENT_ID    | string  | "..."                                  | Client Id for this application in Identity provider.                                                                                               |
+| OIDC_CLIENT_SECRET | string  | "..."                                 | Secret key for OpenID Connect.                                                                                                                     |
 | COMPOSER_PATH    | string  | "..."                                  | Path to PHP Composer libariries (only needed for OpenID Connect).                                                                                                                     |
 | OPENAI_API_KEY   | string  | sk-...                                 | Open AI Api key                                                                                                                                    |
 | IMPRINT_LOCATION | string  | https://your-university/imprint        | A link to your imprint. Alternatively you can replace the file index.php under /impressum with your own html/ php of your imprint.                 |

api.php

@@ -1,8 +1,10 @@
 <?php
 session_start();
 
-$env = parse_ini_file('.env');
-$apiKey = $env["OPENAI_API_KEY"];
+if (file_exists(".env")){
+	$env = parse_ini_file('.env');
+}
+$apiKey = isset($env) ? $env['OPENAI_API_KEY'] : getenv('OPENAI_API_KEY');;
 
 if (!isset($_SESSION['username'])) {
 	http_response_code(401);

composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "jumbojett/openid-connect-php": "^0.9.10"
+    }
+}

composer_install.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+EXPECTED_CHECKSUM="$(php -r 'copy("https://composer.github.io/installer.sig", "php://stdout");')"
+php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+ACTUAL_CHECKSUM="$(php -r "echo hash_file('sha384', 'composer-setup.php');")"
+
+if [ "$EXPECTED_CHECKSUM" != "$ACTUAL_CHECKSUM" ]
+then
+    >&2 echo 'ERROR: Invalid installer checksum'
+    rm composer-setup.php
+    exit 1
+fi
+
+php composer-setup.php --quiet
+RESULT=$?
+rm composer-setup.php
+exit $RESULT

datenschutz/index.php

@@ -1,6 +1,8 @@
 <?php
-$env = parse_ini_file('../.env');
-$privacyLocation = $env["PRIVACY_LOCATION"];
+if (file_exists(".env")){
+    $env = parse_ini_file('.env');
+}	
+$privacyLocation = isset($env) ? $env["PRIVACY_LOCATION"] : getenv("PRIVACY_LOCATION");
 
 header("Location: $privacyLocation");
 exit;

impressum/index.php

@@ -1,6 +1,8 @@
 <?php
-$env = parse_ini_file('../.env');
-$imprintLocation = $env["IMPRINT_LOCATION"];
+if (file_exists(".env")){
+    $env = parse_ini_file('.env');
+}	
+$imprintLocation = isset($env) ? $env["IMPRINT_LOCATION"] : getenv("IMPRINT_LOCATION");
 
 header("Location: $imprintLocation");
 exit;

interface.php

@@ -7,10 +7,25 @@
 }
 
 ?>
-
+<head>
+	<title>HAWKI</title>
+	<?php 
+  if (file_exists(".env")){
+	$env = parse_ini_file('.env');
+  }
+  $favicon = isset($env) ? ($env["FAVICON_URI"]??false) : getenv("FAVICON_URI");
+  if ($favicon) {
+	echo 
+	'<link rel="shortcut icon" type="image/x-icon" href="'. $favicon .'" media="screen" />
+	<link rel="icon" type="image/x-icon" href="'. $favicon .'" media="screen" />
+	';
+  }
+ ?>
+ </head>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 
-<link rel="stylesheet" href="app.css">	
+<link rel="stylesheet" href="app.css">
+
 
 <div class="wrapper">
   <div class="sidebar">
@@ -97,7 +112,13 @@
 	<div class="info">
 	  <a href="#" onclick="load(this, 'about.htm')">Über HAWKI</a>
 	  <a href="#" id="feedback" onclick="load(this, 'userpost.php')">Feedback</a>
-	  <a href="logout.php">Abmelden</a>
+	  <a href=<?php 
+	  	if (file_exists(".env")){
+			$env = parse_ini_file('.env');
+		}
+		if ((isset($env) ? $env["Authentication"] : getenv("Authentication")) == "OIDC"){
+		echo "oidc_logout.php";
+		} else echo "logout.php" ?>>Abmelden (<?php echo $_SESSION['username']?>)</a>
 	  <br>
 	  <a href="/datenschutz" target="_blank" >Datenschutz</a>
 	  <a href="/impressum" target="_blank">Impressum</a>
@@ -415,7 +436,7 @@ function addMessage(message){
 		if(message.role == "assistant"){
 			messageElement.querySelector(".message-icon").textContent = "AI";
 		}else{
-			messageElement.querySelector(".message-icon").textContent = '<?= $_SESSION['username'] ?>';
+			messageElement.querySelector(".message-icon").textContent = '<?= isset($_SESSION['initials']) ? $_SESSION['initials']: $_SESSION['username'] ?>';
 			messageElement.querySelector(".message").classList.add("me");
 		}
 
@@ -462,7 +483,7 @@ function modalClick(element){
 		const inputField = document.querySelector(".userpost-field");
 
 		let message = {};
-		message.role = '<?= $_SESSION['username'] ?>';
+		message.role = '<?= isset($_SESSION['initials']) ? $_SESSION['initials']: $_SESSION['username'] ?>';
 		message.content = inputField.value.trim();
 
 		fetch('userpost.php', {