Deaktivieren des Dokumentationsprotokolls für ASP.NET Webdienste

  • Artikel
  • 2 Minuten Lesedauer

In diesem Artikel wird beschrieben, wie Sie das Dokumentationsprotokoll für ASP.NET Webdienste deaktivieren.

Ursprüngliche Produktversion:   ASP.NET
Ursprüngliche KB-Nummer:   815149

Zusammenfassung

ASP.NET Webdienste erleichtern die Entwicklung von Webdienstclients, indem automatisch Dokumentation generiert wird, die beschreibt, wie mit dem Webdienst kommuniziert wird. Webdienste, für die das Dokumentationsprotokoll aktiviert ist, generieren eine HTML-formatierte Seite, wenn eine Browseranforderung empfangen wird. Diese HTML-formatierte Seite beschreibt die folgenden Informationen:

  • Die unterstützten Vorgänge
  • Die Parameter, die jeder Vorgang akzeptiert
  • Der Typ der Daten, die in diesen Parametern übergeben werden sollen

Das Dokumentationsprotokoll generiert auch eine WSDL-Datei (Web Services Description Language) im XML-Format. Diese Datei soll Es Anwendungen ermöglichen, zu verstehen, wie Anforderungen an den Webdienst strukturiert werden.

Diese Informationen können für Entwickler nützlich sein, insbesondere für Entwickler, die Clients für öffentliche Webdienste erstellen. Das Offenlegen detaillierter Informationen über die Funktionalität privater Webdienste erhöht jedoch das Risiko, dass der Webdienst von einem böswilligen Angreifer missbraucht wird. Das Dokumentationsprotokoll beschreibt immer alle Funktionen und Parameter eines Webdiensts, auch wenn nur eine Teilmenge dieser Funktionen öffentlich zugänglich sein soll.

Entfernen des Dokumentationsprotokolls

Führen Sie die folgenden Schritte aus, um das Dokumentationswebdienstprotokoll für eine ASP.NET-Anwendung zu deaktivieren:

  1. Öffnen Sie die web.config Datei aus dem Stammverzeichnis der Webanwendung in einem Text-Editor (z. B. Editor). Wenn die web.config Datei nicht vorhanden ist, erstellen Sie eine web.config Datei für die ASP.NET-Anwendung.

  2. Fügen Sie das <webServices> Konfigurationselement dem system.web Element in der datei web.config hinzu.

  3. Fügen Sie im <webServices> Element das <protocols> Konfigurationselement hinzu.

  4. Fügen <protocols> Sie das Element in das remove name="Documentation" Element ein.

    Das folgende Beispiel zeigt das <webServices> Konfigurationselement, das einer web.config Datei hinzugefügt wurde, um die automatische Generierung browserfreundlicher Dokumentation zu deaktivieren:

    <webServices>
    <protocols>
        <remove name="Documentation"/>
    </protocols>
</webServices>

  5. Speichern Sie die dateiweb.config.

References