Scannen von Dateianlagen in adaptiven Forms mit einem benutzerdefinierten Validator

[AEM Forms]{class="badge positive" title="Gilt für AEM Forms"}

Die Funktion „File Attachment Virus Scanner / Validator“ ist im Early-Adopter-Programm enthalten. Sie können von Ihrer offiziellen E-Mail-Adresse aus an aem-forms-ea@adobe.com schreiben, um dem Early-Adopter-Programm beizutreten und den Zugriff auf diese Funktion zu beantragen.

Adaptive Forms kann jede hochgeladene Anlage zum Zeitpunkt der Übermittlung an einen Validator Ihrer Wahl übergeben. Der Validator wird auf dem Server ausgeführt, empfängt die Datei im Speicher und entscheidet, ob die Übermittlung akzeptiert oder abgelehnt wird, sodass eine bösartige oder nicht konforme Datei nie persistent gespeichert wird. Da Sie den Validator bereitstellen, können Sie jede Antiviren-Engine, jeden Malware-Scanner oder jede benutzerdefinierte Validierungslogik verbinden, die Sie bereits verwenden.

Dieser Artikel erläutert die Funktion, dokumentiert die FileAttachmentValidator, die Sie implementieren, und führt Sie durch den Aufbau eines Antiviren-agnostischen Validators. Ein vollständiges, Engine-spezifisches Beispiel finden Sie im begleitenden Tutorial Scannen von Dateianlagen mit ClamAV.

Funktionsweise how-it-works

Wenn ein(e) Benutzende® ein adaptives Formular sendet, für das ein Validator ausgewählt wurde, ruft AEM den Validator für den hochgeladenen Anhang auf, bevor die Übermittlung verarbeitet wird:

Zwei Eigenschaften dieses Modells sind für die Sicherheit von Bedeutung:

Verfügbarkeit und Voraussetzungen prerequisites

Die FileAttachmentValidator-Schnittstelle interface-reference

Sie können einen Validator hinzufügen, indem Sie com.adobe.forms.common.service.FileAttachmentValidator implementieren und als OSGi-Dienst registrieren. Die Schnittstelle definiert zwei Methoden.

FileAnhangValidator fileattachmentvalidator

FileAttachmentWrapper fileattachmentwrapper

Der -Wrapper gewährt dem Code Zugriff auf die hochgeladene Datei und deren Metadaten. Die in einem typischen Validator verwendeten Accessoren sind:

FileAttachmentValidationResult fileattachmentvalidationresult

Ihr Validator gibt eine FileAttachmentValidationResult zurück, die dem Framework mitteilt, ob der Anhang akzeptiert werden soll. Erstellen Sie sie mit den folgenden Parametern:

Beispiel: new FileAttachmentValidationResult(false, "The attached file failed the security scan.", wrapper).

FileAttachmentValidatorManager fileattachmentvalidatormanager

AEM registriert einen einzelnen FileAttachmentValidatorManager-Service, der sich zwischen dem Framework und jedem von Ihnen bereitgestellten Validator befindet. Normalerweise müssen Sie es nicht selbst aufrufen: AEM verwendet es, um den für ein Formular ausgewählten Validator zu suchen und aufzurufen. Es ist nützlich, zu wissen, wann eine Fehlerbehebung erfolgt, da beides vom Dropdown-Menü der Registerkarte „Übermittlung“ und der Pipeline für die Kernübermittlung durchlaufen wird.

Registrieren des OSGi-Dienstes register-service

Kommentieren Sie die Implementierung, damit sie unter der FileAttachmentValidator registriert wird. Nach der Bereitstellung kann der Validator auf den Formularen ausgewählt werden.

Erstellen eines Antiviren-agnostischen Validators build-validator

Die folgende Implementierung zeigt die Struktur eines Validators, ohne ihn an eine bestimmte Engine zu binden. Ersetzen Sie die scanWithYourEngine Methode durch einen Aufruf an Ihre Antiviren-, Scan-API oder Ihren Validierungs-Service.

package com.example.forms.security;

import com.adobe.forms.common.service.FileAttachmentValidator;
import com.adobe.forms.common.service.FileAttachmentValidationResult;
import com.adobe.forms.common.service.FileAttachmentWrapper;
import org.osgi.service.component.annotations.Component;

@Component(service = FileAttachmentValidator.class)
public class CustomFileAttachmentValidator implements FileAttachmentValidator {

    private static final String VALIDATOR_NAME = "Custom Antivirus Scanner";

    @Override
    public FileAttachmentValidationResult validateFileAttachment(FileAttachmentWrapper wrapper) {

        if (wrapper == null) {
            return new FileAttachmentValidationResult(false, "No attachment was received.", wrapper);
        }

        byte[] content = wrapper.getValue();
        if (content == null || content.length == 0) {
            return new FileAttachmentValidationResult(false, "The attached file is empty.", wrapper);
        }

        try {
            boolean clean = scanWithYourEngine(content);
            if (clean) {
                return new FileAttachmentValidationResult(true, "File passed the security scan.", wrapper);
            }
            return new FileAttachmentValidationResult(false,
                    "The attached file failed the security scan and was rejected.", wrapper);

        } catch (Exception e) {
            // Fail closed: if the scanner cannot be reached, reject rather than let an
            // unscanned file through. See Best practices for the fail-open alternative.
            return new FileAttachmentValidationResult(false,
                    "The file could not be scanned at this time. Please try again later.", wrapper);
        }
    }

    @Override
    public String getFileAttachmentValidatorName() {
        return VALIDATOR_NAME;
    }

    /**
     * Integrate your antivirus or validation engine here.
     * Return true if the file is safe to accept, false if it should be rejected.
     */
    private boolean scanWithYourEngine(byte[] content) {
        // TODO: call a local scanning daemon (for example over a socket)
        // or a remote scanning API, and interpret its verdict.
        return true;
    }
}

Bundle erstellen und bereitstellen build-deploy

Kompilieren Sie Ihr Projekt und installieren Sie das Bundle, damit der Validator auf der AEM-Instanz registriert ist.

Bereitstellung in einer lokalen Instanz während der Entwicklung. Erstellen Sie im Projektstammverzeichnis das Bundle und installieren Sie es in der laufenden Autoreninstanz:

mvn clean install -PautoInstallBundle

Das autoInstallBundle überträgt das kompilierte Bundle an eine lokale AEM-Instanz (standardmäßig http://localhost:4502). Wenn Ihre Instanz auf einem anderen Host, Port oder mit anderen Anmeldeinformationen ausgeführt wird, übergeben Sie diese an den Build, z. B.:

mvn clean install -PautoInstallBundle -Daem.host=localhost -Daem.port=4502 -Dvault.user=admin -Dvault.password=admin

Bereitstellung in höheren Umgebungen. Installieren Sie für die Staging- und Produktionsumgebung das Paket nicht von Hand. Stellen Sie sie als Teil des all Inhaltspakets Ihres Projekts über Ihre CI/CD-Pipeline bereit. Eine vollständige Anleitung finden Sie unter Bereitstellen in AEM as a Cloud Service.

Bestätigen Sie, dass der Dienst registriert ist. Öffnen Sie die Komponentenkonsole und suchen Sie nach der Validator-Klasse:

http://localhost:4502/system/console/components

Die Komponente sollte mit ihrem Status als aktiv (oder zufrieden) aufgelistet und unter dem FileAttachmentValidator-Service registriert werden. Wenn er nicht zufrieden ist, lesen Sie Überprüfen Sie, ob der Validator geladen und ausgeführt wird.

Hinzufügen des Validierungsfelds zum Dialogfeld „Formular“ add-dialog-field

Dieser Abschnitt gilt für adaptive Forms, die auf Kernkomponenten“. Das Feld Dateianhang-Virenscanner/) ist im vorkonfigurierten Dialogfeld Container für adaptive Formulare nicht vorhanden. Sie fügen sie einmal in Ihrem eigenen Projekt als kleine Erweiterung hinzu. Jeder Validator, den Sie anschließend bereitstellen (siehe Erstellen eines Antiviren-agnostischen Validators), wird dann automatisch als Option angezeigt. Sie wiederholen diesen Schritt nicht pro Validator.

Der Container für das adaptive Formular Ihres Projekts ist eine Proxy-Komponente eine Komponente unter /apps, die auf die echte Kernkomponente zeigt, indem sling:resourceSuperType verwendet wird, z. B.:

<!-- /apps/<project>/components/adaptiveForm/formcontainer/.content.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:jcr="http://www.jcp.org/jcr/1.0"
    jcr:primaryType="cq:Component"
    jcr:title="Form Container"
    sling:resourceSuperType="core/fd/components/form/container/v2/container"
    xmlns:sling="http://sling.apache.org/jcr/sling/1.0"/>

Aus sling:resourceSuperType Grund können Sie der Registerkarte Übermittlungseinstellungen“ ein neues Feld hinzufügen, ohne das gesamte Dialogfeld zu kopieren. Der Sling Resource Merger benötigt nur den Knotennamenpfad, der bis zur Einfügemarke neu erstellt wird. Siehe Erweitern von Komponentendialogfeldern für den allgemeinen Mechanismus. Die echte Registerkarte OOTB-Übermittlung behält ihre Felder unter content/items/tabs/items/submitActions/items/columns/items/, das ist der Weg zur Spiegelung:

<!-- /apps/<project>/components/adaptiveForm/formcontainer/_cq_dialog/.content.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:sling="http://sling.apache.org/jcr/sling/1.0"
    jcr:primaryType="nt:unstructured">
  <content jcr:primaryType="nt:unstructured">
    <items jcr:primaryType="nt:unstructured">
      <tabs jcr:primaryType="nt:unstructured">
        <items jcr:primaryType="nt:unstructured">
          <submitActions jcr:primaryType="nt:unstructured">
            <items jcr:primaryType="nt:unstructured">
              <columns jcr:primaryType="nt:unstructured">
                <items jcr:primaryType="nt:unstructured">
                  <fileAttachmentValidator
                      jcr:primaryType="nt:unstructured"
                      sling:resourceType="granite/ui/components/coral/foundation/form/select"
                      fieldLabel="File Attachment Virus Scanner/Validator"
                      fieldDescription="Select a registered validator configuration to scan submitted file attachments. Select None to disable validation for this form."
                      emptyText="None"
                      name="./fileAttachmentValidator">
                    <datasource
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="<project>/datasources/fileattachmentvalidators"/>
                  </fileAttachmentValidator>
                </items>
              </columns>
            </items>
          </submitActions>
        </items>
      </tabs>
    </items>
  </content>
</jcr:root>

Zwei Details sind erwähnenswert:

Der datasource untergeordnete Knoten verweist auf ein kleines Sling-Servlet, das Sie auch schreiben. Er hat nur eine Aufgabe: FileAttachmentValidatorManager nach getValidators() fragen und die getFileAttachmentValidatorName() jedes Validators in eine Dropdown-Option umwandeln. Die vollständige, einsatzbereite Implementierung finden Sie unter Schritt 7 des ClamAV-Tutorials: Das Servlet ist unabhängig von der verwendeten Validator-Engine identisch, sodass Sie es unverändert in Ihr Projekt kopieren können.

Stellen Sie beide Dateien als Teil des ui.apps Inhaltspakets Ihres Projekts und core Bundle bereit (siehe Erstellen und Bereitstellen des Bundles). Nach der Bereitstellung ist die Funktionsfähigkeit dieser Dialogfelderweiterung überprüft: Das Feld wird auf der Registerkarte Übermittlung neben den vorhandenen vorkonfigurierten Feldern angezeigt (ersetzt sie nicht), und wenn Sie darauf festlegen, bleibt eine reine fileAttachmentValidator-Eigenschaft auf dem Guide-Container-Knoten erhalten, die von der AEM-Übermittlungs-Pipeline über FileAttachmentValidatorManager.getFileAttachmentValidator(name) gelesen wird.

Wählen Sie den Validator auf Ihrem Formular aus select-validator

Laufzeitverhalten und Benutzererlebnis runtime-behavior

Laden und Ausführen des Validators überprüfen verify

Wenn das Virenscanner/Validator für Dateianhänge nicht auf der Registerkarte „Übermittlung“ angezeigt wird:

Wenn das Feld angezeigt wird, Ihr Validator jedoch nicht in der Dropdown-Liste aufgeführt ist:

Best Practices und Hinweise best-practices

Bestimmen, wo gescannt wird. Ihr Validator kann eine Scan-Engine aufrufen, die lokal (oder zusammen mit AEM) oder über eine Remote-Scan-API ausgeführt wird. Eine lokale oder am selben Standort befindliche Engine speichert Dateiinhalte in Ihrer Umgebung, wodurch die Anforderungen an die Datenresidenz und die Compliance erfüllt werden können. Eine Remote-API sendet Datei-Bytes außerhalb der Umgebung. Überprüfen Sie daher vor der Auswahl, ob dies für Ihre Daten akzeptabel ist.

Wählen Sie bewusst einen Fehlermodus. Wenn das Scan-Modul nicht erreichbar ist oder Fehler auftreten, können Sie beim Schließen (wie im Beispiel oben) oder beim Öffnen (Akzeptieren) einen Fehler verursachen. „Fehlgeschlagen“ ist der sicherere Standard für sicherheitsempfindliche Formulare. Öffnen Sie die Favoriten für die Verfügbarkeit nicht. Treffen Sie die Auswahl explizit, anstatt zufällig.

Konto für Latenz. Die Überprüfung erfolgt synchron während der Übermittlung, sodass die Überprüfungszeit zur Sendeerfahrung des Benutzers hinzugefügt wird. Legen Sie sinnvolle Zeitüberschreitungswerte für Aufrufe an Ihre Engine fest und definieren Sie Erwartungen mit einer Service-Level-Vereinbarung, wenn Sie von einem externen Service abhängig sind.

Gebundene Payload. getValue() gibt die Datei als speicherinternen byte[] zurück, sodass große Uploads Heap verbrauchen. Begrenzen Sie Uploads an der Quelle mithilfe der maximalen Dateigröße und der unterstützten Dateitypen der Dateianhangskomponente, sodass der Validator nur Dateien verarbeitet, die eine angemessene Größe aufweisen und von denen erwartet wird.

Überlagern der Steuerelemente. Ein Validator ist am stärksten als eine von mehreren Ebenen. Beschränken Sie Dateitypen und -größen auf der Dateianhang-Komponente, scannen Sie bei der Übermittlung mit Ihrem Validator und fügen Sie Bot-Schutz wie CAPTCHA hinzu. Allein ist keine einzelne Schicht ausreichend.

Zurückweisungsnachrichten löschen. Der message im Ergebnis wird dem Benutzer angezeigt, sodass er verwertbar ist, z. B. „Dieser Dateityp ist nicht zulässig. Laden Sie eine PDF hoch.“ Erwägen Sie die Lokalisierung, wenn Ihre Formulare in mehreren Sprachen vorliegen.

Sichern und Überwachen des Scan-Kanals. Verwenden Sie den sicheren Transport zu Ihrer Scan-Engine, halten Sie sie hoch verfügbar, da sie sich im Übermittlungspfad befindet, und protokollieren Sie die Scan-Ergebnisse für Auditing und Fehlerbehebung.

Häufig gestellte Fragen faq

Was ist ein Dateianhang-Validator in AEM Forms?
Es handelt sich dabei um einen Server-seitigen Service, den Sie in AEM registrieren. Dieser überprüft jede Datei, die über ein adaptives Formular zum Zeitpunkt der Übermittlung hochgeladen wurde, und teilt AEM mit, ob die Datei akzeptiert oder abgelehnt werden soll. Sie wählen es in einem Formular über die Einstellung Dateianhang-Virenscanner / -Validator aus.

Wann ruft AEM den Validator auf?
Beim Senden, bevor die Formulardaten und der Anhang beibehalten werden. AEM ruft Ihre validateFileAttachment mit dem Anhang auf und blockiert die Übermittlung, wenn das Ergebnis ungültig ist.

Kann die Validierung vor der Übermittlung ausgeführt werden, sobald die Datei angehängt ist?
Ja, als separater Mechanismus. Verwenden Sie den Service aufrufen-Vorgang im Regeleditor für adaptive Forms, um einen Scan-Service beim Änderungsereignis des Dateifelds aufzurufen, bevor der Benutzer die Nachrichten sendet. Dies ist unabhängig von der in diesem Artikel beschriebenen FileAttachmentValidator. Stattdessen wird ein Formulardatenmodell-Service (FDM) aufgerufen. Siehe Aufrufen von Service-Verbesserungen im Regeleditor.

Läuft der Validator im Browser oder auf dem Server?
Auf dem Server. Die Prüfung kann nicht umgangen werden, indem JavaScript deaktiviert oder die Seite im Browser bearbeitet wird.

Kann ich mit dieser Schnittstelle ein Antivirenprogramm verwenden?
Ja. Die Schnittstelle hängt von keiner bestimmten Engine ab. Ihre Implementierung kann einen lokalen Scan-Daemon, ein kommerzielles Antiviren- oder Datenverlustpräventionsprodukt oder eine Remote-Scan-API aufrufen und das Ergebnis dann einem FileAttachmentValidationResult zuordnen.

Wird eine abgelehnte Datei in AEM gespeichert?
Anzahl Da die Datei vor dem Speichern ausgewertet wird, wird eine zurückgewiesene Datei nie in das Repository geschrieben.

Wie zeige ich eine benutzerdefinierte Nachricht, wenn eine Datei abgelehnt wird?
Legen Sie beim Erstellen der FileAttachmentValidationResult den message fest. AEM zeigt diese Meldung den Benutzenden an, wenn es die Datei ablehnt.

Beispielszenarien example-scenarios

Verwandte Artikel related-articles