Verschlüsselung der .env Datei

In modernen Anwendungen wie z.B. Laravel, werden häufig „.env“ Dateien verwendet, um Zugangsdaten für die Datenbanken, API-Token oder andere Zugangsschlüssel zu speichern (siehe https://dotenv.org/). Dies hat den Vorteil, dass diese nicht im Quellcode der Anwendung hinterlegt werden müssen und so an einer zentralen Stelle gespeichert werden. Außerdem kommen sie so nicht in die Versionskontrolle wo sie ggf. von Personen außerhalb des Projektes gelesen werden könnten.

Sobald ein neuer Wert in dieser Datei hinterlegt wird, muss dieser auch bei allen Entwickler im Team hinterlegt werden oder in die produktive Umgebung eingespielt werden. Gerade wenn es hierfür keinen richtigen Prozess gibt, wie die Zugangsdaten dann verteilt werden, könnte dies wieder unsicher übertragen werden. Vielleicht wird hier eine Rundmail geschrieben oder mit einer Message via Slack, Teams oder gar in WhatsApp verschickt. Und sollten sich die Werte auch nicht in Produktion automatisch oder per Deployment aktualisieren, dann muss hier auch immer händisch noch der richtige Wert hinterlegt werden.

Eine Lösung hierfür kommt von Dotenv selbst und bietet eine Synchronisierung. Doch wer Kosten sparen möchte oder eine Cloud Lösung nicht in Frage kommt, der steht wieder vor dem Ausgangsproblem.

Darum habe ich ein kleines Package gebaut, mit dem man die .env Datei sicher im Repository hinterlegen kann, ohne das es hier zu Bedenken der Sicherheit kommt. Mit dem Package lässt sich die lokale .env Datei sicher verschlüsseln und damit auch in das Repository einchecken. Andere Personen im Team können diese dann auschecken und dann wieder entschlüsseln. Das gleiche geht auch für die produktive Umgebung. So muss nur noch der geheime Schlüssel bekannt sein, welcher nur für ausgewählte Personen im Team bekannt ist.

Das Package findest du wie immer bei GitHub. Es befindet sich noch in der aller ersten Version: https://github.com/TobyMaxham/laravel-envcrypter

Meine Tech-Pläne für 2022

Die letzte Woche aus 2021 hat nun begonnen. Zeit das vergangene Jahr nochmal zu reflektieren und zu schauen, was man alles erreicht hat, vielleicht gerade noch daran arbeitet oder aus verschiedensten Gründen dieses Jahr nicht mehr erreichen wird. Wie jedes Jahr habe ich das auch zusammen gefasst und muss sagen, daß ich allgemein ganz zufrieden bin. Hier geht es zum Beitrag

In diesem Beitrag soll es nun aber um die technischen Ziele gehen, welche ich mir für das nächste Jahr gesetzt habe. Da ich 2021 noch nicht alles erreicht habe, was ich mir vorgenommen habe, werde ich an einigen Projekten wohl noch weiter arbeiten.

Projekt UX9 URL Shortener

In meiner Serie zum Laravel Upgrade habe ich ja schon den Upgrade Prozess für Laravel 8 beschrieben. Mit dem Release von Laravel 9 und PHP 8.1 wird dies wohl das erste Projekt im neuen Jahr sein, das mit dieser Technik umgesetzt wird. Es fehlen auch noch ein paar Anpassungen an der API sowie Sicherheitsvorkehrungen, bevor der Puplic Access wieder hergestellt werden kann. Das Kürzen von URLs ist derzeit ohne Account nicht möglich. Hintergrund ist die Häufung von Phishing URLs. Hier geht es zur Anwendung: https://ux9.de/

Projekt Sitealarm

Auch hier soll die Codebasis auf Laravel 9 und PHP 8.1 umgestellt werden. Hier habe ich auch bereits angefangen. Es gestaltet sich jedoch sehr aufwendig, da ich hier als Basis Laravel Spark verwendet hatte und dies nicht mehr verwenden möchte. Außerdem läuft die Webanwendung auf einem Hosted Server, auf dem offiziell PHP 8.1 noch nicht unterstützt wird. Ich werde das Projekt wohl auch in meinem Blog regelmäßig als Thema verwenden. Ob ich eine App dazu rausbringen werde, kann ich heute noch nicht sagen. https://sitealarm.de/

Projekt Elnu CDN

Dieses Projekt habe ich nun einige Jahre schleifen lassen und nur privat verwendet. Doch auch hier leider nicht überall. Ziel war es zwar nie, eine große Reichweite zu erhalten oder mit großen Unternehmen zu konkurrieren. Prinzipiell geht es bei dem Projekt um den Lerneffekt und was man technisch alles für ein gut funktionierendes CDN benötigt. Im nächsten Jahr möchte ich hier versuchen, eine gute Basis für eine öffentliche Nutzung des Service zu schaffen. Dann sollen ausgewählte Benutzer die Möglichkeit bekommen, wie bei anderen Anbietern auch, eigene Repositories dem Netzwerk hinzuzufügen um so auch davon profitieren zu können. https://elnu.de/

Project Management

Dieses Projekt wird mich das ganze nächste Jahr beschäftigen. Das Projekt soll den Public-Status erreichen, sodass jeder der möchte daran mitarbeiten kann (Link zu GitHub, sobald öffentlich). Einen privaten Fork, für die original Anwendung, gibt es nun auch. Hier soll es noch viele Erweiterungen geben. Unter anderem sollen die Exporte noch besser werden, eine offizielle API soll geschafft werden und die Anbindung an das von meinem Arbeitskollegen (@santwer) programmierte Tool (Kouky) soll erweitert werden. Hier haben wir auch bereits einen Fork erstellt, der hier als optimierte Schnittstelle dienen soll. Wie wir das genau umsetzen ist noch nicht ganz sicher. Vermutlich wird es auf der selben Platform laufen wie das Hauptprojekt, ohne Verbindung zur offiziellen Seite von Kouky.

Hier geht es zur Website: https://proĵect.de/

Social Media und Öffentlichkeit

Ich möchte in 2022 wieder aktiver auf Twitter werden. Außerdem regelmäßig Blog Beiträge erstellen. Ich habe hier auch schon ein paar Ideen, wie mir das einfacher fallen kann. Damit verbundenen werde ich wohl auch endlich meine Website überarbeiteten und wieder ein bis zwei Mal pro Monat einen Newsletter verschicken. Fürs erste plane ich ca. 7 Tweets pro Woche, also ca. einen Tweet pro Tag. Das sollte eigentlich machbar sein. Vor allem werde ich auch Links teilen und Empfehlungen für Packages und Tutorials veröffentlichen.

Ich habe mir hoffentlich nicht zu viel für das kommende Jahr vorgenommen. Doch sind mir diese Projekte sehr wichtig, weshalb mir ein erfolgreiches Gelingen dieser Ziele sehr am Herzen liegt. Ein paar Projekte sind aber auch stark von der Entwicklung der Corona Pandemie abhängig, da ich z.B. beim Elnu und „Projects“ im engen Kontakt mit ein paar Freunden stehe und dieser durch Corona leider eingeschränkt ist. Trotzdem sind die Ziele machbar und durch verschiedene Meilenstein auch schrittweise erreichbar.

Rückblick auf ein ereignisreiches Jahr 2021

Es ist eigentlich jedes Jahr das gleiche. Der Dezember beginnt, mein Geburtstag naht und ich wundere mich jedes Mal darüber, wie schnell das Jahr wieder vergangen ist. In diesem Jahr habe ich die letzten Wochen etwas mehr Urlaub als sonst und kann das Jahr ganz in Ruhe mit der Familie ausklingen lassen. Zeit auch dafür, das Jahr noch einmal rückblickend zu bewerten und Ziele für das nächste Jahr zu setzen (könnt ihr hier nachlesen).

Auch dieses Jahr war wieder geprägt durch die noch anhaltende Corona Pandemie. Das habe ich selbst vor allem dadurch gespürt, dass sich meine privaten Projekte deutlich langsamer entwickelt haben, als ich ursprünglich wollte. Nicht nur durch die fehlenden engen Gespräche mit Freunden, auch das erhöhte Home-Office und mehr Zeit mit der Familie hatten darauf Auswirkungen. Nun muss ich aber sagen, dass dies ja nichts schlechtes ist. Mehr Zeit mit der Familie verbringen zu können ist wahrlich etwas schönes und ich genieße jede Minute, die ich mit ihnen verbringen kann. Auch das Home-Office bringt viele Vorteile mit sich. Es fallen gut zwei Stunden Fahrtzeit weg und auch die Spritkosten wirken sich positiv auf die Umwelt und den Geldbeutel aus.

Ich sehe es ein wenig wie eine inspirierende Auszeit an, um neue Ideen für neue und bestehende Projekte zu sammeln. Davon war das Jahr auch geprägt. Ich habe über 200 Stunden Tutorials bei Laracasts und auf YouTube angesehen. Viele neue Technologien ausprobiert, z.B. PHP 8.0 und 8.1, Tailwind CSS oder Laravel Livewire. Ich habe viel mit GitHub Actions experimentiert und meine DevOps Skills erweitert. Kurzum, ich habe viel Erfahrung gesammelt aber relativ wenig Projekte umgesetzt.

Projekt UX9 URL Shortener

Hier gab es wohl die größten Veränderungen. Gegen Ende des Jahres habe ich die Anwendung überarbeitet und auf Laravel 8 umgebaut. Außerdem für PHP 8.0 bzw. PHP 8.1 vorbereitet. Zudem gibt es nun für alle Klassen Unit Tests wodurch ich eine Code Coverage von über 90% erreichen konnte. https://ux9.de/

Projekt Zhylon und Deployer

Danke vor allem an meinen guten Freund Norbert, der hier nun viel Entwicklungsarbeit leistet. Zusammen konnten wir einige Updates einspielen was das Server Deployment nun deutlich erleichtert. Es gibt nun auch eine Version für kleine Teams und einen besseren Server Monitor. Zuletzt habe ich noch den OAuth2 Server aktiviert, wodurch ich neben MX-Codes nun auch Zhylon als Login verwenden kann. Gerne kann jeder sich beteiligen oder Beta Tester werden. Das Projekt wird noch einige Zeit brauchen, bis es komplett öffentlich werden kann. https://zhylon.de/

Projekt Management

Dieses Projekt hat vor etwa einem Jahr begonnen, da ich mit der Umstellung auf MacOS das von meinem Betrieb bereitgestellte Zeit-Buchungs-Tool nicht mehr nutzen konnte. Um mir das Buchen meiner Arbeitszeit etwas einfacher zu machen, habe ich ein altes Projekt wieder zum Leben erweckt und um einige neue Features erweitert. Norbert und Heiko konnte ich auch davon begeistern, sodass es nun regelmäßig mit großen und kleinen Updates ausgeschmückt wird. Nachdem wir bisher kein Namen für das Projekt finden konnten, haben wir nun endlich eine Domain gefunden und bestellt. Somit ist das Projekt nun ganz offiziell nutzbar https://proĵect.de/. Der Basiscode soll demnächst Open Source werden, sodass vielleicht eine Community entstehen könnte um noch mehr Features zu bekommen.

Wie ihr gelesen habt, bin ich mit dem ganzen Jahr eigentlich sehr zufrieden. Ich bin auch sehr froh darüber, dass mich die Pandemie nur am Rande betroffen hat und ich kaum größere Einschnitte dadurch gespürt habe. Ich hoffe auch das kommende Jahr wird wieder ein gutes und erfolgreiches Jahr.

Euch allen wünsche ich auf jeden Fall ein erfolgreiches, glückliches und gesundes neues Jahr.

UX9 URL Shortener: Upgrade auf Laravel 8 – Teil 2

Bevor ich mit der eigentlichen Umstellung begonnen haben, hatte ich mir ausführlich überlegt, was ich alles umstellen muss, und wie ich die Umstellung gestalten möchte. Relativ schnell ist mir aufgefallen, dass das Projekt zwar über die letzten 10 Jahre sehr gewachsen ist, der wesentliche Kern hingegen beschränkt sich auf wenige Klassen. Ich habe mich daher für eine Upgrade Strategie entschieden, die in der Regel für kleinere Projekte sehr gut funktionieren kann, hingegen für größere Projekte viel zu Aufwändig ist.

Hast du den ersten Teil bereits gelesen? Noch nicht, kein Problem. Hier geht es zum ersten Teil: UX9 URL Shortener: Upgrade auf Laravel 8 – Teil 1

Ich nenne die Strategie „Copy-To-New“, mit der ich in den letzten Jahre sehr gut bei kleine Projekten gefahren bin. Dabei ist die eigentliche Umstellung recht schnell beschrieben:

1. Alle Projekt-Dateien in ein „Backup“-Verzeichnis verschieben
2. Neue Laravel Installation bereit stellen
3. „Alten“-Code Schritt für Schritt wieder in die neue Installation verschieben
4. Alle Änderungen Testen (Unit Tests)

Bei dieser Methode ist der 4. Punkt äußerst essentiell. Ich habe die Erfahrung gemacht, dass das Testen der Anwendung am Ende doch schwieriger ist, als man sich das zuvor überlegt hatte. Darum empfehle ich, je nach Größe und Umfang des Projekts, immer PHP-Unit Tests zu verwenden, mit welchen man die Funktion des Programmes auch nach dem Upgrade sicherstellen kann.

Leider hatte ich bis dato noch keinen (nicht einen einzigen) PHP-Unit Test für meinen URL Shortener geschrieben. Da ich aber seit einige Jahren auf das Test-Drive-Development setze, wollte ich das nun auch in diesem Projekt einführen. Also der ideale Zeitpunkt, um nun damit zu beginnen. Mein erster Schritt war also, für das gesamte Programm PHP-Unit Tests zu schreiben. Hier mal ein Beispiel, wie eine Test-Klasse bei mir aussieht. Der Test prüft einige Prozesse vom User-Dashboard:

UX9 Test Cases: URL Shortener

Für diese Phase habe ich etwa 200 Test geschrieben. Ich konnte damit eine Test-Abdeckung von ca. 73% erreichen. Bis zum Ende der Umstellung und weiterem Refactoring, möchte ich eine Test-Abdeckung von über 90% erreichen. Es werden also im Laufe und vermutlich auch direkt nach dem Upgrade noch einige weitere Tests folgen.

Im nächsten Teil dieser Serie, werde ich die ersten beiden Punkte näher beschreiben. Damit ist dann die Grundlage für jede weitere Umstellung gesetzt.

UX9 URL Shortener: Upgrade auf Laravel 8 – Teil 1

Ich habe wieder einmal meinen Urlaub genutzt, um einige meiner privaten Projekte weiter zu entwickeln. Eines meiner derzeit größten Projekten ist mein eigener URL Shortener: https://ux9.de

Das ist neben meiner eigenen Homepage mittlerweile auch das Projekt, welches am längsten läuft. Bereits Ende 2009 habe ich mit den ersten Ideen dazu angefangen und diese noch auf meinem derzeitigen Blog (kein WordPress) genutzt, um externe Verlinkungen zu analysieren und durch eine einfache Verkürzung besser darstellen zu können. Mit dem Erwerb von mehreren dreistelligen Domains, hat mein URL Shortener dann in den darauffolgenden Jahren auch seine eigene Seite bekommen.

Das Projekt wurde mit der Zeit stetig erweitert. Die ersten Jahre habe ich nur PHP ohne Framework verwendet. Seit 2015 habe ich dort dann mit Laravel 4.2 bzw. Laravel 5 als Framework begonnen. Dabei habe ich auch die Grundstruktur des Projektes neu organisiert. Neben stetigen Weiterentwicklungen gab es zuletzt ein Upgrade auf Laravel 6 im September 2019.

Die darauffolgenden Jahre war ich mir nicht sicher, ob ich das Projekt überhaupt noch weiter betreiben möchte oder nicht. Nach viel Überlegen habe ich mich aber dazu entschlossen, das Projekt weiter laufen zu lassen. Die Vorraussetzung dafür ist aber, dass das Projekt von Grund auf neu strukturiert wird, mit Unit-Test ergänzt wird und es eine vernünftige Möglichkeit gibt, dass Administratoren die einzelnen Module verwalten können.

Die Umstellung meiner Seite, möchte ich in dieser Serie von Beiträgen mit euch teilen. Ich hoffe ich kann damit einen kleinen Einblick geben, wie man Projekte sinnvoll umstellen kann. Die Teile werden in den nächsten 1-2 Wochen erscheinen.