Active Directory Federation Service (AD FS)
  • 26 Jun 2024
  • 4 Minutes to read
  • Dark
    Light
  • PDF

Active Directory Federation Service (AD FS)

  • Dark
    Light
  • PDF

Article summary

Active Directory Federation Service (AD FS) is a software component developed by Microsoft that provides users with single sign-on and identity access.

Types of Assets Fetched

This adapter fetches the following types of assets:

  • Application Extensions
  • Groups
  • User Extensions
  • SaaS Applications

Parameters

  1. Authentication - Select Authentication method, either NTLM (default) or Kerberos. If you select Kerberos, the following optional fields for authentication may be configured:

    • Kerberos AES Key (optional) - A cryptographic key, either 128 or 256 bits in length, used to secure communication by encrypting and decrypting messages exchanged between the client and the server.
    • Kerberos Host (KDC) (optional) - The Kerberos Key Distribution Center (KDC) that will be used to authenticate. If this parameter is not specified, the domain will be used.
  2. ADFS Server (required) - The hostname of the domain controller with the ADFS service.

  3. User Name and Password (required) - The credentials for a user account that has the Required Permissions to execute PowerShell code which queries the ADFS server for information on the systems managed by that server.

  4. Custom Share Name (optional) - If you do not have local Admin access, specify the name of a share to use instead of 'ADMIN$' for SMB operations. For more information, see Creating a Custom Share.

  5. Custom Files Directory (optional) - Specify the name of a file directory to use instead of 'axonius'.

  6. Custom Working Directory (optional) - If file sharing is restricted in the domain, specify the physical path of the share specified in Custom Share Name.

To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

Active Directory Federation Service AD FS

APIs

Axonius uses the ADFS Module.

Required Ports

Axonius must be able to communicate with the value supplied in Host Name or IP Address via the following ports:

  • 135 (RPC)
  • 445 (SMB)
  • Random port in the range 1024-65535

Setting up a fixed port for WMI

The Active Directory Federation Service (AD FS) adapter uses WMI.
You need to set up a fixed port to work with WMI.
WMI runs as part of a shared service host with ports assigned through DCOM by default. However, you can set up the WMI service to run as the only process in a separate host and specify a fixed port. For more details, see Microsoft Documentation - Setting Up a Fixed Port for WMI.



To set up a fixed port for WMI:

  1. At the command prompt, type:
winmgmt -standalonehost
  1. Stop the WMI service by typing:
net stop "Windows Management Instrumentation"

or:

 net stop winmgmt
  1. Restart the WMI service again in a new service host by typing:
net start "Windows Management Instrumentation" 

or:

net start winmgmt
  1. Establish a new port number for the WMI service by typing (e.g. the following example will establish port TCP 24158):
netsh firewall add portopening TCP 24158 WMIFixedPort



To undo any changes you make to WMI, type:

winmgmt /sharedhost

Then stop and start the winmgmt service again.

Creating a Custom Share

You can create a custom share and directory instead of ADMIN$ \ axonius. A custom share that is properly configured enables you to not require full local admin permissions to fetch data.

To create a custom share:

  1. Create a local user, such as ‘axonius-usr’.

  2. Add the user to the following groups:

    • Distributed COM Users
    • Remote Management Users
  3. Create a directory for Axonius to use to store temporary files and to serve as a working directory, for example: C:\axonius
    The name of this directory may be used later in the adapter configuration for AD FS in Axonius.

  4. Grant the following permissions to the local user:

    • Read
    • Write
    • Modify
    • Execute (or full control) permissions on the custom directory, subdirectories, and files
  5. Share the directory that you created by using Sharing or Advanced Sharing. Verify that the local user has full permissions for this share. Specify a descriptive name for the shared directory, preferably a name which ends with a dollar-sign, such as: AxoniusShare$
    The name of this share will be used later in the adapter configuration for AD FS in Axonius.

  6. Open WMI Management (wmimgmt.msc). Under Security, select Root (minimal: root/cimv2) namespace.

  7. Click Security. Add the local user.

  8. Click Advanced.

  9. From the Applies to dropdown, select This namespace and subnamespaces.

  10. Under the Allow column for the local user, select the Execute Methods, Enable Account, and Remote Enable options, and then click OK.

  11. In Axonius, verify that the Custom Share Name and Custom Files Directory parameters are configured. The adapter will attempt to create the specified directory under the share.

  12. If the above step fails, it means some sharing options are not enabled on the server. In such a case, add the full path to the share under Custom Working Directory.

Note: When using Custom Working Directory, this directory must be identical to all Active Directory Federation Service (AD FS) adapter connections, and needs to be specified in all adapter connections, even if using a local admin. Only use this option as a last resort.

Required Permissions

The value supplied in User Name and Password must be able to execute PowerShell code which queries the ADFS server for information on the systems managed by that server. The configured user must have permission to run the following PowerShell commands:

  • Get-Service
  • Get-AdfsRelyingPartyTrust
  • Get-AdfsApplicationGroup

The value supplied in User Name and Password must have the following permissions in order to fetch assets:

  • Local admin permissions.
  • Access RPC on the ADFS server.
  • Execute PowerShell on the ADFS server and access the IPC$ share on the ADFS server.
  • Read and Write Access to ADMIN$ share on the ADFS server. Alternatively, create an 'axonius' folder inside the \localhost\ADMIN$\ directory and ensure the Axonius account has Full Permissions to read and write to this newly created folder.

Supported From Version

Supported from Axonius version 6.1



Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.