In nur 3 Schritten HTTP Basic Authentication in Symfony integrieren – ohne User Entity

Basic Auth Login Dialog

Manchmal ist es von Nöten, dass man eine bestimmte Route in einer Symfony Anwendung mit einem Passwort schützen möchte. Symfony bietet von Haus aus sehr viele Möglichkeiten ein User Management einzubinden.

Bei mir gab es jedoch den Fall, dass ich nur eine bestimmte Route mit einem Passwort schützen wollte. Und dieses auch nur für einen kurzen Zeitraum. Meine restliche Anwendung benötigte bisher keine Rechte und ich wollte für diesen temporären Einsatz den Aufwand so gering wie möglich halten.

Zum Glück bietet Symfony auch für diesen Fall eine Lösung. Die Antwort lautet Memory User Provider. Dieser Provider gehört zu den Standard Authentifizierungs-Providern, die Symfony bereitstellt.

In der Regel sollte der Memory User Provider eher sparsam eingesetzt werden, da er nicht flexibel genug ist, um ein User Management zu integrieren. Aber bei meinem Sonderfall war es genau passend.

Du benötigst nur 3 Schritte, um eine statische Route mit einem Login und einem Passwort zu schützen. Los geht’s !

Schritt 1: Symfony Security Bundle installieren

Falls du das Security Bundle nicht bereits in deiner Anwendung nutzt, musst du es zunächst installieren.

Falls du Symfony Flex nutzt, muss du nichts weiter tun, als das Bundle über Composer zu laden.

Security Bundle über Composer laden

Schritt 2: Password kodieren

Als nächstes musst du das spätere Password für deinen User kodieren. Dazu bietet dir Symfony bereits einen Command.
Gehe in die Console und führe folgenden Task aus

Passwort kodieren

Den Wert, den du nach Ausführen des Commands erhälst, benötigst du für den nächsten Schritt.

Schritt 3: security.yaml anpassen

Im letzten Schritt muss die Konfigurationsdatei unter config/packages/security.yaml angepasst werden.

Hier trägst du nun den Encoder, die zu verschlüsselne Route und deine User mit dem in Schritt 2 gewählten Passwort ein.

Der Encoder wird zwingend benötigt. Andernfalls wird ein Fehler geworfen. Hier reicht der Standard Encoder mit dem Wert auto.

Unter dem Attribut providers gibst du dein generiertes Passwort ein und teilst es dem User zu.

Zuletzt musst du noch deine Route in der Firewall definieren. Hier ist es /my-protected-route. Als Provider bekommt die deinen oberhalb definierten Provider zugewiesen

Das war es schon. Wenn du nun deine Seite aufrufst, solltest du einen Login-Dialog erhalten. Nur dein oben definierter User mit dem entsprechenden Password kann zugreifen.

Login Dialog erscheint beim Aufrufen der Route

So das war es auch schon. Ich denke nicht mal 5 Minuten oder?

Schnelles Pimcore Setup mit Docker

Ich experimentiere momentan mit dem Open-Source PIM/MDM Pimcore und die Erstellung und Integration von selbstgeschriebenen Plugins. Damit nicht unnötig Zeit für das Setup verschwendet wird, habe ich mir eine Dockerkonfiguration für die lokale Entwicklung angelegt, die mittels docker-compose gestartet werden kann.

Doch zunächst – Was ist Pimcore?

Pimcore ist eine Kombination aus Product-Information-Management (PIM) und Master-Data-Management (MDM). Auf deutsch bedeutet das soviel, dass Produkte zentral in einem System verwaltet werden können. Ebenfalls Stammdaten wie Mitarbeiter, Kunden, Hersteller oder Lieferanten können über Pimcore gepflegt werden.

Wer einen Online-Shop betreiben möchte, kann dieses ebenfalls mit Pimcore erledigen. Dazu gibt es die Erweiterung CoreShop, die viele Funktionalitäten abdeckt.

Was Pimcore unter anderem auszeichnet, ist die benutzerdefinierte Modellierung von Inhalten. Neben bereits vorgefertigten Inhaltstypen können eigene Datenstrukturen angelegt und definiert werden – ganz einfach in der grafischen Adminoberfläche.

Genug Intro – los geht’s mit Docker

Die zentrale Einstiegsstelle ist die docker-compose.yml Datei. Diese liegt direkt im Hauptprojektverzeichnis. Hier werden die Services defniert, die für Pimcore benötigt werden. Das sind ein Webserver (hier Nginx), eine Datenbank (hier MySQL) und PHP.

version: '3.3'

services:
    nginx:
        image: nginx:latest
        ports:
            - "8080:80"
        volumes:
            - .:/var/www/html
            - ./docker/nginx/config/site.conf:/etc/nginx/conf.d/default.conf
        links:
            - php
        networks:
            - pimcorenet

    mysql:
        image: mysql:5.7
        restart: always
        ports:
            - "3306:3306"
        command: --init-file /data/application/init.sql
        volumes:
            - ./docker/mysql_init.sql:/data/application/init.sql
            - ./data/mysql:/var/lib/mysql
            - .:/var/www/html
        environment:
            MYSQL_ROOT_PASSWORD: pimcore
            MYSQL_DATABASE: pimcore
            MYSQL_USER: pimcore
            MYSQL_PASSWORD: pimcore
        networks:
            - pimcorenet

    php:
        build: ./docker/php
        volumes:
            - .:/var/www/html
        links:
            - mysql:mysql
        depends_on:
            - mysql
        networks:
          - pimcorenet

networks:
    pimcorenet:

Für die Container Nginx und MySQL benutze ich fertige Docker Images. Diese können dann von außen über Parameter konfiguriert werden. Bei dem MySQL Image wird in dem Command eine SQL Datei aufgerufen, welche dafür sorgt, dass der User pimcore existiert.
Den kompletten Source Code findest du in meinem Repository unter: https://github.com/StefanieD/pimcore-docker-setup

Für den PHP Container nutze ich ein angepasstes Dockerfile. Dieses liegt unter ./docker/php und wird über den build Parameter in der Servicekonfiguration referenziert.

Oft reichen fertige PHP Docker Images nicht aus, da bestimmte Erweiterungen nachinstalliert werden müssen. Aus diesem Grund erweitert das Dockerfile ein existierendes Image für php7.2-fpm

FROM php:7.2-fpm

# install git
RUN apt-get update && \
    apt-get install -y --no-install-recommends git

#install some base extensions
RUN apt-get install -y \
    zlib1g-dev \
    zip \
    libpng-dev \
    exiftool \
    libfreetype6-dev \
    libjpeg62-turbo-dev \
    libmcrypt-dev \
    libicu-dev \
    libpq-dev \
    libxpm-dev \
    libvpx-dev \
    mariadb-client \
    libxml2-dev

RUN docker-php-ext-install -j$(nproc) \
    zip \
    exif \
    bcmath \
    intl \
    pcntl \
    mysqli \
    pdo \
    pdo_mysql \
    pdo_pgsql \
    mbstring \
    soap \
    opcache \
    iconv

# Install Imagick
RUN apt-get update && apt-get install -y \
    libmagickwand-dev --no-install-recommends \
    && pecl install imagick \
    && docker-php-ext-enable imagick

# Install Composer
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
RUN composer --version

Und zu guter Letzt – Docker starten

Um die Anwendung nun zu starten, braucht man nichts anderes tun als im Terminal zu seinem Projektordner zu wechseln und folgende Befehle auszuführen

docker-compose build 

zum Bauen der Images und

docker-compose up -d

Beim ersten Aufruf werden die Images vom Docker Repository heruntergeladen und es kann etwas länger dauern. Später sind diese jedoch im Cache und müssen nicht erneut geladen werden.

Nachdem die Container gestartet sind, müssen noch einige Befehle manuell durchgeführt werden.
Pimcore muss installiert, ein initialer Admin User angelegt und die Datenbank konfiguriert werden.
Die Anleitung dazu findest du hier https://github.com/StefanieD/pimcore-docker-setup

Nachdem diese Schritte erfolgreich durchgeführt wurden, ist die Anwendung nun unter http://localhost:8080 erreichbar.
Den Adminbereich erreicht man unter http://localhost:8080/admin.

Mit dem zuvor angelegten Benutzer admin – admin könnt ihr euch in Pimcore anmelden.

Viel Spaß beim Experimentieren !

Quellen

  • https://pimcore.com/de
  • https://blog.perfion.com/de/was-ist-der-unterschied-zwischen-pim-und-mdm-und-warum-sie-sich-interessieren-sollten
  • https://basilicom.de/de/pimcore
  • https://www.mds.eu/blog/pim/was-ist-pimcore
  • https://divante.co/blog/pimcore-special-agency-point-view/

Elasticsearch NumberFormatException

Some time ago I came across a really annoying error in Elasticsearch.
The error log was something like this:

SearchPhaseExecutionException[Failed to execute phase [query], all shards failed; shardFailures {[_9x6xIKhTXK7y_jqC92YIQ][index][0]: ElasticicsearchException[java.lang.NumberFormatException:Invalid shift value in prefixCoded bytes (is encoded value really an INT?)]; nested:UncheckedExecutionException[java.lang.NumberFormatException: Invalid shift value in prefixCoded bytes (is encoded value really an INT?)]; nested: NumberFormatException[Invalid shift value in prefixCoded bytes (is encoded value really an INT?)]; }

It was driving me nuts to find out what the exact problem was. I searched several hours in the internet for an answer until I found a helpful post in a forum.
The actual problem is that there is a field in your Elasticsearch index, which have different mapping settings in different types.
I.e. you have the type car and the type driver and both are types of the index company. Both tpes have an ID. But one is declare as integer value and the other is a string.
Elasticsearch doesn’t make a difference between fields in different types but with the same name in the same index. So check your mappings to solve the problem.

But be aware. After I changed my mappings I still got the error message. After changing the values I also needed to clear my index to delete all old documents.
For deleting all old cached documents I made an optimize POST request to elasticsearch:

http://elasticsearch:9200/[index]/_optimize?max_num_segments=1&wait_for_merge=false/

The params are really important otherwise the documents will not be deleted. After that everything worked fine again.

I hope I could help you with my post and save you some valuable time of research:)

Starting my first blog

Hey out there. My name is Stefanie and I’ve been working as a PHP / fullstack developer for more than 3 years now.

Recently I read an article about best practices for improving my developing skills.

One of the recommendations was to write a blog about developing problems which comes up in the daily business. So I decided to follow this approach and startet to write a blog. In this blog I want to give you some practical helps and share my knowledge I’ve gained the last years as fullstack developer.

Have fun and don’t hesitate to leave me a comment.

Regards Stefanie

© 2020 Stefanie Drost

Theme von Anders Norén↑ ↑