How to Use Native Code (C++) to Create a Simple FTP Logging Provider

By Robert McMurray

March 18, 2009

Microsoft has created a new FTP service that has been completely rewritten for Windows Server® 2008. This new FTP service incorporates many new features that enable Web authors to publish content more easily than before, and offers Web administrators more security and deployment options.

The new FTP 7.5 service supports extensibility that lets you extend the built-in functionality that is included with the FTP service. More specifically, FTP 7.5 supports the creation of your own authentication and authorization providers. You can also create providers for custom FTP logging and for determining the home directory information for your FTP users.

This walkthrough will lead you through the steps to use native code to create a simple FTP logging provider.

Prerequisites

The following items are required to complete the procedures in this article:

  1. 1. IIS 7.0 or above must be installed on your Windows Server 2008 server, and the Internet Information Services (IIS) Manager must also be installed.
  2. The new FTP 7.5 service must be installed. You can download and install the FTP 7.5 service from the http://www.iis.net/ web site using one of the following links:
  3. You must create a root folder for FTP publishing.
  4. You must use Visual Studio 2008.
    • Note: If you use an earlier version of Visual Studio, some of the steps in this walkthrough may not be correct.
    • Note: If you plan to develop custom FTP providers for computers that use a 64-bit version of Windows, you will have to install the 64-bit tools and compilers for Visual Studio. You can find additional information about 64-bit development in the Installing Visual Studio 64-bit Components topic on the Microsoft MSDN Web site.
  5. A folder for logging must be created; the code sample uses C:\logfiles\myftpsite, but you can change that if necessary.

Step 1: Set up the Project Environment

In this step, you will create a project in Visual Studio 2008 for the demo provider.

  1. Open Microsoft Visual Studio 2008.
  2. Click the File menu, then New, then Project.
  3. In the New Project dialog box:
    • Choose Visual C++ as the project type.
    • Choose ATL Project as the template.
    • Type FtpLoggingDemo as the name of the project.
    • Click OK.
  4. When the ATL Project Wizard dialog appears:
    • Click Next.
    • Ensure that only Dynamic-link library (DLL) is checked.
    • Click Finish.
  5. When the project opens, add an ATL Class to the project:
    • Click Project, and then click Add Class.
    • Choose ATL Simple Object as the template.
    • Click Add.
  6. When the ATL Simple Object Wizard appears:
    • Enter "FtpLogDemo" for the short name and accept the defaults for the other values.
    • Click Next.
    • Choose the following options:
      • Choose Apartment for the Threading model. (Note: This can be customized depending on your application's needs.)
      • Choose No for Aggregation. (Note: This can be customized depending on your application's needs.)
      • Choose Custom for the Interface.
    • Click Finish.
  7. Add the extensibility interfaces:
    • Click View, and then click Class View.
    • In the Class View window, expand FtpLoggingDemo.
    • Right-click CFtpLogDemo, then click Add, then click Implement Interface.
    • Choose File for the interface implementation.
    • For the Location, enter the full path of the FTP extensibility type library. For example:
      C:\Windows\System32\inetsrv\ftpext.tlb
      Note: If you are developing on a 64-bit computer, you should copy the FTP extensibility type library to the following 32-bit path and use that location. For example:
      C:\Windows\SysWOW64\inetsrv\ftpext.tlb
    • Choose the following interface to implement:
      • IFtpLogProvider
    • Click Finish.
  8. Configure the project so that the DLL will not be registered automatically:
    • Click Project, and then click FtpLoggingDemo Properties.
    • Expand Configuration Properties, and then click Linker.
    • Select Register Output, and select No from the drop-down menu.
    • Click OK.
  9. Optional: If you are developing your custom provider on a 32-bit version of Windows, you can optionally add a custom build event to automatically deploy and register the DLL on your development computer. (Note: These steps will not work on a 64-bit version of Windows.) To add the custom build event, follow these steps:
    • Click Project, and then click FtpLoggingDemo Properties.
    • Expand Configuration Properties, then expand Build Events, then click Post-build Event.
    • Click the ellipsis (...) on the right side of the Command line text box.
    • Enter the following in the Command line dialog box:
      net stop ftpsvc
      copy /y "$(TargetPath)" "%WINDIR%\System32\inetsrv"
      regsvr32.exe /s "%WINDIR%\System32\inetsrv\$(TargetFileName)"
      net start ftpsvc
    • Click OK to close the Command line dialog box.
    • Click OK to close the FtpLoggingDemo Property Pages dialog box.
  10. If you are developing a provider for a 64-bit version of Windows, you will need to add a build configuration for 64-bit complilation:
    • Click Build, and then click Configuration Manger...
    • Select <New...> in the Active Solution Platform drop-down menu.
    • Select x64 in the Type or select the new platform drop-down menu.
    • Click OK.
    • Click Close.
  11. Save the project.

Step 2: Implement the Extensibility Interface

In this step, you will implement the extensibility interface for the demo provider.

  1. Implement the IFtpLogProvider interface:
    • In the Class View window, double-click the Log method.
    • Replace the existing implementation with the following code:
      // IFtpLogProvider Methods
      public:
          STDMETHOD(Log)(LOGGING_PARAMETERS * pLoggingParameters)
          {
              // Note: You would add your own custom logic here.
              HRESULT hr = S_OK;
              DWORD dwResult;
              HANDLE hFile;
              char szLogEntry[256]="";
              const DWORD FILE_WRITE_TO_END_OF_FILE = 0xffffffff;
      
              OVERLAPPED Overlapped = { 0 };
              Overlapped.Offset = FILE_WRITE_TO_END_OF_FILE;
              Overlapped.OffsetHigh = -1;
              
              // Retrieve the current date and time for the log entry.
              SYSTEMTIME CurrentTime;
              GetSystemTime(&CurrentTime);
              
              // Open the log file for output.
              hFile = CreateFile(
                  L"\\\\?\\C:\\logfiles\\myftpsite\\myftplog.log",
                  GENERIC_WRITE,
                  FILE_SHARE_READ,
                  NULL,
                  OPEN_ALWAYS,
                  FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH,
                  NULL);
              
              // Return an error if a failure occurs.
              if (hFile == INVALID_HANDLE_VALUE)
              {
                  hr = HRESULT_FROM_WIN32(GetLastError());
                  goto EXIT;
              }
              
              // Format the log entry.
              hr = StringCchPrintfA(
                  szLogEntry,256,
                  "%04d-%02d-%02d\t%02d:%02d:%02d\t%S\t%d\r\n",
                  CurrentTime.wYear,CurrentTime.wMonth,CurrentTime.wDay,
                  CurrentTime.wHour,CurrentTime.wMinute,CurrentTime.wSecond,
                  pLoggingParameters->pszCommand,
                  pLoggingParameters->FtpStatus);
      
              // Test for error.
              if (FAILED(hr))
              {
                  // Return the error if a failure occurs.
                  hr = HRESULT_FROM_WIN32(GetLastError());
                  goto EXIT;
              }
              
              // Write the log entry to the log file.
              if(!WriteFile(hFile, szLogEntry,
                  strlen(szLogEntry), &dwResult, &Overlapped))        
              {
                  // Return an error if a failure occurs.
                  hr = HRESULT_FROM_WIN32(GetLastError());
                  goto EXIT;
              }
      
      EXIT:
              // Close the log file if it is open.
              if(CloseHandle(hFile)==0)
              {
                  // Return an error if a failure occurs.
                  hr = HRESULT_FROM_WIN32(GetLastError());
              }
              return hr;
          }
  2. Add an include file reference for strsafe.h to the start of the FtpLogDemo.h file:
    #include "strsafe.h"
  3. Save and compile the project.

Step 3: Add the Logging Provider to FTP

In this step, you will add the demo provider to your FTP service and the default Web site.

  1. Add the extensibility provider to the global list of FTP authentication providers:
    • Open the Internet Information Services (IIS) Manager.
    • Click your computer name in the Connections pane.
    • Double-click FTP Authentication in the main window.
    • Click Custom Providers... in the Actions pane.
    • Click Register.
    • Enter FtpLoggingDemo for the provider Name.
    • Click Native Provider (COM).
    • Enter the class name for the extensibility provider as FtpLoggingDemo.FtpLogDemo.
    • Click OK.
    • Clear the FtpLoggingDemo check box in the providers list.
    • Click OK.
  2. Add the custom provider to a site:
    • There is no UI that enables you to add custom features to a site, so you will have to use the following command line:
      AppCmd set site "Default Web Site" /+ftpServer.customFeatures.providers.[name='FtpLoggingDemo',enabled='true'] /commit:apphost

Summary

In this walkthrough you learned how to:

  • Create a project in Visual Studio 2008 for a custom FTP logging provider.
  • Implement the extensibility interface for custom FTP logging.
  • Add a custom logging provider to your FTP service.

When users connect to your FTP site, the FTP service will create a log file in the path that you specified in the demo provider.



Discuss in IIS Forums