CHttpModule::OnAuthenticateRequest-Methode

Stellt die Methode dar, die ein AuthenticateRequest Ereignis behandelt, das auftritt, wenn IIS die Identität eines Benutzers festlegt.

Syntax

virtual REQUEST_NOTIFICATION_STATUS OnAuthenticateRequest(  
   IN IHttpContext* pHttpContext,  
   IN IAuthenticationProvider* pProvider  
);  

Parameter

pHttpContext
[IN] Ein Zeiger auf eine IHttpContext-Schnittstelle .

pProvider
[IN] Ein Zeiger auf eine IAuthenticationProvider-Schnittstelle .

Rückgabewert

Ein REQUEST_NOTIFICATION_STATUS Wert.

Bemerkungen

Wenn ein Modul auf Anforderungsebene für die RQ_AUTHENTICATE_REQUEST Ereignisbenachrichtigung registriert wird, ruft IIS die Methode des Moduls OnAuthenticateRequest auf, wenn IIS die Identität eines Benutzers ermittelt.

Hinweis

Module auf Anforderungsebene können sich für die AuthenticateRequest Ereignisbenachrichtigung registrieren, indem sie sich in der RegisterModule-Funktion des Moduls registrierenRQ_AUTHENTICATE_REQUEST.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie Sie ein HTTP-Modul auf Anforderungsebene erstellen, das sich für die RQ_AUTHENTICATE_REQUEST Ereignis- und Nachereignisbenachrichtigungen registriert. Wenn IIS die Identität eines Benutzers vorbereitet, werden die Methoden des Beispielmoduls OnAuthenticateRequest und OnPostAuthenticateRequest aufgerufen. Jede Methode schreibt einen Eintrag in das Anwendungsprotokoll der Windows-Ereignisanzeige. Wenn die Verarbeitung abgeschlossen ist, wird das Modul beendet.

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:

    // Process an RQ_AUTHENTICATE_REQUEST event.
    REQUEST_NOTIFICATION_STATUS
    OnAuthenticateRequest(
        IN IHttpContext * pHttpContext,
        IN IAuthenticationProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog("OnAuthenticateRequest");
        return RQ_NOTIFICATION_CONTINUE;
    }

    // Process an RQ_AUTHENTICATE_REQUEST post-event.
    REQUEST_NOTIFICATION_STATUS
    OnPostAuthenticateRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog("OnPostAuthenticateRequest");
        return RQ_NOTIFICATION_CONTINUE;
    }

    MyHttpModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyHttpModule()
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Close the handle to the Event Viewer.
            DeregisterEventSource( m_hEventLog );
            m_hEventLog = NULL;
        }
    }

private:

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szNotification)
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Write any strings to the Event Viewer and return.
            return ReportEvent(
                m_hEventLog,
                EVENTLOG_INFORMATION_TYPE, 0, 0,
                NULL, 1, 0, &szNotification, NULL );
        }
        return FALSE;
    }
};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        // Specify the class factory.
        new MyHttpModuleFactory,
        // Specify the event notifications.
        RQ_AUTHENTICATE_REQUEST,
        // Specify the post-event notifications.
        RQ_AUTHENTICATE_REQUEST
    );
}

Ihr Modul muss die RegisterModule Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des /EXPORT:RegisterModule Switches kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) aufrufende Konvention verwenden, anstatt die aufrufende Konvention für jede Funktion explizit zu deklarieren.

Anforderungen

type	BESCHREIBUNG
Client	– IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 unter Windows 8 – IIS 10.0 auf Windows 10
Server	– IIS 7.0 unter Windows Server 2008 – IIS 7.5 unter Windows Server 2008 R2 – IIS 8.0 unter Windows Server 2012 – IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 auf Windows Server 2016
Produkt	– IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - IIS Express 7.5, IIS Express 8.0, IIS Express 10.0
Header	Httpserv.h

Weitere Informationen

CHttpModule-Klasse
CHttpModule::OnPostAuthenticateRequest-Methode