FTP Active Directory User Isolation <activeDirectory>

Overview

The <activeDirectory> element specifies the credentials and connection time-out for communicating with an Active Directory server for FTP user isolation. This option is the same as choosing Active Directory user isolation in the IIS 6.0 FTP server, where a user's account must have the msIIS-FTPRoot and msIIS-FTPDir properties configured in their Active Directory objects.

  • If the FTP service successfully accesses the path that is specified by the msIIS-FTPRoot and msIIS-FTPDir properties, it becomes the home directory for the user and the user cannot access the file system outside this directory.
  • If the FTP service cannot access the path that is specified by the msIIS-FTPRoot and msIIS-FTPDir properties, or either of the msIIS-FTPRoot or msIIS-FTPDir properties do not exist, the user is denied access.

For additional information about how to configure the Active Director properties, see the "Isolate Users Using Active Directory Mode" section in the Hosting Multiple FTP Sites with FTP User Isolation (IIS 6.0) topic.

Compatibility

Version Notes
IIS 7.5 The <activeDirectory> element of the <userIsolation> element ships as a feature of IIS 7.5.
IIS 7.0 The <activeDirectory> element of the <userIsolation> element was introduced in FTP 7.0, which was a separate download for IIS 7.0.
IIS 6.0 N/A

Note: The FTP 7.0 and FTP 7.5 services shipped out-of-band for IIS 7.0, which required downloading and installing the modules from the following URL:

http://www.iis.net/expand/FTP

With Windows 7 and Windows Server 2008 R2, the FTP 7.5 service ships as a feature for IIS 7.5, so downloading the FTP service is no longer necessary.

Setup

To support FTP publishing for your Web server, you must install the FTP service. To do so, use the following steps.

IIS 7.5 for Windows Server 2008 R2

  1. On the taskbar, click Start, point to Administrative Tools, and then click Server Manager.
  2. In the Server Manager hierarchy pane, expand Roles, and then click Web Server (IIS).
  3. In the Web Server (IIS) pane, scroll to the Role Services section, and then click Add Role Services.
  4. On the Select Role Services page of the Add Role Services Wizard, expand FTP Server.
  5. Select FTP Service.

    Note: To support ASP.Membership authentication or IIS Manager authentication for the FTP service, you will also need to select FTP Extensibility.
  6. Click Next.
  7. On the Confirm Installation Selections page, click Install.
  8. On the Results page, click Close.

IIS 7.5 for Windows 7

  1. On the taskbar, click Start, and then click Control Panel.
  2. In Control Panel, click Programs and Features, and then click Turn Windows Features on or off.
  3. Expand Internet Information Services, and then FTP Server.
  4. Select FTP Service.

    Note: To support ASP.Membership authentication or IIS Manager authentication for the FTP service, you will also need to select FTP Extensibility.
  5. Click OK.

IIS 7.0 for Windows Server 2008 and Windows Vista

  1. Download the installation package from the following URL:
  2. Follow the instructions in the following walkthrough to install the FTP service:

How To

How to isolate users using Active Directory

  1. Open Internet Information Services (IIS) Manager:
    • If you are using Windows Server 2008 or Windows Server 2008 R2:
      • On the taskbar, click Start, point to Administrative Tools, and then click Internet Information Services (IIS) Manager.
    • If you are using Windows Vista or Windows 7:
      • On the taskbar, click Start, and then click Control Panel.
      • Double-click Administrative Tools, and then double-click Internet Information Services (IIS) Manager.
  2. In the Connections pane, expand the server name, expand the Sites node, and then click the name of the site.
  3. In the site's Home pane, double-click FTP User Isolation.
  4. On the FTP User Isolation page, under Isolate users. Restrict users to the following directory:, select FTP home directory configured in Active Directory and then click Set.
  5. In the Set Credentials dialog box, enter a user name and password in the User name and Password boxes. Enter the password again in the Confirm Password box, and then click OK.
  6. In the Actions pane, click Apply.

For additional information about how to set up the Active Directory, see the "Isolate Users Using Active Directory Mode" section in the Hosting Multiple FTP Sites with FTP User Isolation (IIS 6.0) topic.

Configuration

The <activeDirectory> element is configured at the site level.

Attributes

Attribute Description
adCacheRefresh Optional timeSpan attribute.

Specifies the time span to cache active directory information.

The default value is 00:01:00.
adPassword Optional encrypted string attribute.

Specifies the user password for the connection to the active directory server.

There is no default value.
adUserName Optional string attribute.

Specifies the user name for the connection to the active directory server.

There is no default value.

Child Elements

None.

Configuration Sample

The following sample displays a <userIsolation> element for an FTP site that configures the FTP service to use Active Directory for user isolation that site, and configures the credentials for the connection to the Active Directory server.

<site name="ftp.example.com" id="5">
  <application path="/">
  <virtualDirectory path="/" physicalPath="c:\inetpub\www.example.com" />
  </application>
  <bindings>
  <binding protocol="ftp" bindingInformation="*:21:" />
  </bindings>
  <ftpServer>
<userIsolation mode="ActiveDirectory">
<activeDirectory adUserName="MyUser"
adPassword="[enc:RsaProtectedConfigurationProvider:57686f6120447564652c2049495320526f636b73:enc]"
adCacheRefresh="00:02:00" />
</userIsolation>
  <security>
    <authentication>
      <basicAuthentication enabled="true" />
      <anonymousAuthentication enabled="false" />
    </authentication>
  </security>
  </ftpServer>
</site>

Sample Code

The following examples configure Active Directory user isolation for an FTP site.

AppCmd.exe

appcmd.exe set config  -section:system.applicationHost/sites /[name='ftp.example.com'].ftpServer.userIsolation.mode:"ActiveDirectory" /commit:apphost
appcmd.exe set config -section:system.applicationHost/sites /[name='ftp.example.com'].ftpServer.userIsolation.activeDirectory.adUserName:"MyUser" /[name='ftp.example.com'].ftpServer.userIsolation.activeDirectory.adPassword:"MyPassword" /[name='ftp.example.com'].ftpServer.userIsolation.activeDirectory.adCacheRefresh:"00:02:00" /commit:apphost

Note: You must be sure to set the commit parameter to apphost when you use AppCmd.exe to configure these settings. This commits the configuration settings to the appropriate location section in the ApplicationHost.config file.

C#

using System;
using System.Text;
using Microsoft.Web.Administration;
internal static class Sample {
private static void Main() {
    
     using(ServerManager serverManager = new ServerManager()) {
         Configuration config = serverManager.GetApplicationHostConfiguration();
        
         ConfigurationSection sitesSection = config.GetSection("system.applicationHost/sites");
        
         ConfigurationElementCollection sitesCollection = sitesSection.GetCollection();
        
         ConfigurationElement siteElement = FindElement(sitesCollection, "site", "name", @"ftp.example.com");
         if (siteElement == null) throw new InvalidOperationException("Element not found!");
        
        
         ConfigurationElement ftpServerElement = siteElement.GetChildElement("ftpServer");
        
         ConfigurationElement userIsolationElement = ftpServerElement.GetChildElement("userIsolation");
         userIsolationElement["mode"] = @"ActiveDirectory";
        
         ConfigurationElement activeDirectoryElement = userIsolationElement.GetChildElement("activeDirectory");
         activeDirectoryElement["adUserName"] = @"MyUser";
         activeDirectoryElement["adPassword"] = @"MyPassword";
         activeDirectoryElement["adCacheRefresh"] = TimeSpan.Parse("00:02:00");
        
         serverManager.CommitChanges();
     }
  }
 
  private static ConfigurationElement FindElement(ConfigurationElementCollection collection, string elementTagName, params string[] keyValues) {
     foreach (ConfigurationElement element in collection) {
         if (String.Equals(element.ElementTagName, elementTagName, StringComparison.OrdinalIgnoreCase)) {
             bool matches = true;
 
             for (int i = 0; i < keyValues.Length; i += 2) {
                 object o = element.GetAttributeValue(keyValues[i]);
                 string value = null;
                 if (o != null) {
                     value = o.ToString();
                 }
 
                 if (!String.Equals(value, keyValues[i + 1], StringComparison.OrdinalIgnoreCase)) {
                     matches = false;
                     break;
                 }
             }
             if (matches) {
                 return element;
             }
         }
     }
     return null;
  }
}

VB.NET

Imports System
Imports System.Text
Imports Microsoft.Web.Administration

Module Sample
   Sub Main()
      Dim serverManager As ServerManager = New ServerManager
      Dim config As Configuration = serverManager.GetApplicationHostConfiguration
      Dim sitesSection As ConfigurationSection = config.GetSection("system.applicationHost/sites")
      Dim sitesCollection As ConfigurationElementCollection = sitesSection.GetCollection

      Dim siteElement As ConfigurationElement = FindElement(sitesCollection, "site", "name", "ftp.example.com")
      If (siteElement Is Nothing) Then
         Throw New InvalidOperationException("Element not found!")
      End If

      Dim ftpServerElement As ConfigurationElement = siteElement.GetChildElement("ftpServer")

      Dim userIsolationElement As ConfigurationElement = ftpServerElement.GetChildElement("userIsolation")
      userIsolationElement("mode") = "ActiveDirectory"

      Dim activeDirectoryElement As ConfigurationElement = userIsolationElement.GetChildElement("activeDirectory")
      activeDirectoryElement("adUserName") = "MyUser"
      activeDirectoryElement("adPassword") = "MyPassword"
      activeDirectoryElement("adCacheRefresh") = TimeSpan.Parse("00:02:00")

      serverManager.CommitChanges()
   End Sub

   Private Function FindElement(ByVal collection As ConfigurationElementCollection, ByVal elementTagName As String, ByVal ParamArray keyValues() As String) As ConfigurationElement
      For Each element As ConfigurationElement In collection
         If String.Equals(element.ElementTagName, elementTagName, StringComparison.OrdinalIgnoreCase) Then
            Dim matches As Boolean = True
            Dim i As Integer
            For i = 0 To keyValues.Length - 1 Step 2
               Dim o As Object = element.GetAttributeValue(keyValues(i))
               Dim value As String = Nothing
               If (Not (o) Is Nothing) Then
                  value = o.ToString
               End If
               If Not String.Equals(value, keyValues((i + 1)), StringComparison.OrdinalIgnoreCase) Then
                  matches = False
                  Exit For
               End If
            Next
            If matches Then
               Return element
            End If
         End If
      Next
      Return Nothing
   End Function

End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST"; var sitesSection = adminManager.GetAdminSection("system.applicationHost/sites", "MACHINE/WEBROOT/APPHOST"); var sitesCollection = sitesSection.Collection; var siteElementPos = FindElement(sitesCollection, "site", ["name", "ftp.example.com"]);
if (siteElementPos == -1) throw "Element not found!";
var siteElement = sitesCollection.Item[siteElementPos]); var ftpServerElement = siteElement.ChildElements.Item("ftpServer");
var userIsolationElement = ftpServerElement.ChildElements.Item("userIsolation");
userIsolationElement.Properties.Item("mode").Value = "ActiveDirectory";
var activeDirectoryElement = userIsolationElement.ChildElements.Item("activeDirectory");
activeDirectoryElement.Properties.Item("adUserName").Value = "MyUser";
activeDirectoryElement.Properties.Item("adPassword").Value = "MyPassword";
activeDirectoryElement.Properties.Item("adCacheRefresh").Value = "00:02:00"; adminManager.CommitChanges(); function FindElement(collection, elementTagName, valuesToMatch) {
  for (var i = 0; i < collection.Count; i++) {
     var element = collection.Item(i);
    
     if (element.Name == elementTagName) {
         var matches = true;
         for (var iVal = 0; iVal < valuesToMatch.length; iVal += 2) {
             var property = element.GetPropertyByName(valuesToMatch[iVal]);
             var value = property.Value;
             if (value != null) {
                 value = value.toString();
             }
             if (value != valuesToMatch[iVal + 1]) {
                 matches = false;
                 break;
             }
         }
         if (matches) {
             return i;
         }
     }
  }
 
  return -1;
}

VBScript

Set adminManager = createObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST"
Set sitesSection = adminManager.GetAdminSection("system.applicationHost/sites", "MACHINE/WEBROOT/APPHOST")
Set sitesCollection = sitesSection.Collection

siteElementPos = FindElement(sitesCollection, "site", Array("name", "ftp.example.com"))
If siteElementPos = -1 Then
   WScript.Echo "Element not found!"
   WScript.Quit
End If

Set siteElement = sitesCollection.Item(siteElementPos)
Set ftpServerElement = siteElement.ChildElements.Item("ftpServer")
Set userIsolationElement = ftpServerElement.ChildElements.Item("userIsolation")
userIsolationElement.Properties.Item("mode").Value = "ActiveDirectory"
Set activeDirectoryElement = userIsolationElement.ChildElements.Item("activeDirectory")

activeDirectoryElement.Properties.Item("adUserName").Value = "MyUser"
activeDirectoryElement.Properties.Item("adPassword").Value = "MyPassword"
activeDirectoryElement.Properties.Item("adCacheRefresh").Value = "00:02:00"

adminManager.CommitChanges()

Function FindElement(collection, elementTagName, valuesToMatch)
   For i = 0 To CInt(collection.Count) - 1
      Set element = collection.Item(i)
      If element.Name = elementTagName Then
         matches = True
         For iVal = 0 To UBound(valuesToMatch) Step 2
            Set property = element.GetPropertyByName(valuesToMatch(iVal))
            value = property.Value
            If Not IsNull(value) Then
               value = CStr(value)
            End If
            If Not value = CStr(valuesToMatch(iVal + 1)) Then
               matches = False
               Exit For
            End If
         Next
         If matches Then
            Exit For
         End If
      End If
   Next
   If matches Then
      FindElement = i
   Else
      FindElement = -1
   End If
End Function
Deprecated Elements