IFtpAuthenticationProvider::AuthenticateUser Method

Checks to see whether a user name and password are valid.

Syntax

AuthenticateUser( 
   LPWSTR pszSessionId, 
   LPWSTR pszSiteName, 
   LPWSTR pszUserName, 
   LPWSTR pszPassword, 
   LPWSTR * ppszCanonicalUserName, 
   long * pfAuthenticated 
) 

Parameters

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Remarks

The ppszCanonicalUserName parameter can be used to canonicalize user names; the suggested canonical form is domain\user because previous versions of IIS FTP servers required the user name to be in the domain\user form.

A Windows authentication-based provider cannot be implemented with this method because that form of authentication does not allow user tokens to be returned.

Example

The following code example illustrates how to use the IFtpAuthenticationProvider interface to create a custom authentication module for the FTP service that implements user name checks.

public: 
   STDMETHOD(AuthenticateUser)(LPWSTR pszSessionId, 
      LPWSTR pszSiteName, 
      LPWSTR pszUserName, 
      LPWSTR pszPassword, 
      LPWSTR * ppszCanonicalUserName, 
      long * pfAuthenticated) 
      { 
      // Note: You would add your own custom logic here. 
      *ppszCanonicalUserName = pszUserName; 
 
      CString strUserName = L"MyUser"; 
      CString strPassword = L"MyPassword"; 
 
      // Verify that the user name and password are valid. 
      // In this example, the user name is case-insensitive 
      // and the password is case-sensitive. 
      if ((strUserName.CompareNoCase(pszUserName)==0) && 
          (strPassword.Compare(pszPassword)==0)) 
      { 
         *pfAuthenticated = TRUE; 
      } 
      else 
      { 
         *pfAuthenticated = FALSE; 
   } 
      return S_OK; 
   } 

Requirements

See Also

IFtpAuthenticationProvider Interface