Skip to content

Commit 148b79d

Browse files
jpipkin1kimsauce
andauthored
CSOAR-2927 - Active Directory V2 setup (#5258)
* Rough draft * Tweaks * Proposed changes to PR #5258 (#5259) --------- Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent 0d89ee6 commit 148b79d

File tree

11 files changed

+93
-0
lines changed

11 files changed

+93
-0
lines changed

docs/platform-services/automation-service/app-central/integrations/active-directory-v2.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,99 @@ Compatibility notice:
4141

4242
* [LDAP3](https://github.com/cannatag/ldap3/blob/master/LICENSE.txt)
4343

44+
## Active Directory V2 configuration
45+
46+
### Prerequisites
47+
48+
* An [Automation Bridge](/docs/platform-services/automation-service/automation-service-bridge/) installation.
49+
* A Microsoft Windows Server with Active Directory Domain Services (AD DS) configured.
50+
51+
### Setting up Microsoft Windows Server (optional)
52+
53+
If an existing Windows Server is not available, follow these steps to set up a new one in AWS:
54+
1. Create a Microsoft Windows Server 2019 Instance on AWS.
55+
1. Launch a new AWS EC2 instance.
56+
1. Choose **Microsoft Windows Server 2019 Base** as the AMI.
57+
1. Configure instance settings (for example, instance type, storage, security groups).
58+
1. Assign a key pair for secure access.
59+
1. Deploy the instance and wait for it to be fully initialized.
60+
1. Configure the Windows Server.
61+
1. Connect to the instance using Remote Desktop Protocol (RDP).
62+
1. Once logged in, open **Server Manager**.
63+
1. Install Active Directory Domain Services (AD DS).
64+
1. In **Server Manager**, select **Add roles and features**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-add-roles-and-features.png')} style={{border:'1px solid gray'}} alt="Add roles and features" width="600"/>
65+
1. Choose **Role-based or feature-based installation**.
66+
1. Select the **Active Directory Domain Services** (AD DS) role.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-add-roles.png')} style={{border:'1px solid gray'}} alt="Add roles" width="600"/>
67+
1. Proceed with the installation and wait for it to complete.
68+
1. Promote the server to a domain controller.
69+
1. After installation, navigate to **Server Manager > AD DS**.
70+
1. Click on **Promote this server to a domain controller**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-promote-server.png')} style={{border:'1px solid gray'}} alt="Promote server" width="600"/>
71+
1. Choose **Add a new forest** and provide a root domain name (for example, `csoar.com`).<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-root-domain-name.png')} style={{border:'1px solid gray'}} alt="Root domain name" width="600"/>
72+
1. Configure **Domain Controller Options**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-domain-controller-options.png')} style={{border:'1px solid gray'}} alt="Domain controller options" width="600"/>
73+
1. Set a **Directory Services Restore Mode (DSRM) password**.
74+
1. Complete the installation and restart the server.
75+
1. Verify Active Directory setup.
76+
1. After rebooting, log back in and open **Active Directory Users and Computers**.
77+
1. Verify that the domain is properly configured.
78+
79+
## Active Directory V2 in Automation Service and Cloud SOAR
80+
81+
### Required resources from an existing Active Directory installation
82+
83+
To configure the Automation Service or Cloud SOAR to connect to an existing Active Directory installation, enter details about the Active Directory instance in the new resource configuration dialog:
84+
1. Access integrations in the [Automation Service](/docs/platform-services/automation-service/automation-service-integrations/#view-integrations) or [Cloud SOAR](/docs/cloud-soar/automation).
85+
1. After the list of the integrations appears, search for the **Active Directory V2** integration and click on the row.
86+
1. The integration details will appear. Click on the **+** button to add a new resource.
87+
1. Populate all the required fields (\*), including:
88+
* **Host**. The hostname or IP address of the AD server.
89+
* **Login Port**. The port used for LDAP authentication (the default is `389` for LDAP and `636` for LDAPS).
90+
* **Login DN (Distinguished Name)**. Enter the distinguished name format (for example, `CN=Administrator,CN=Users,DC=csoar,DC=com`). See the following sections for information about how to get the login DN.
91+
* **Password**. The corresponding password for the provided username.
92+
1. Click **SAVE**.
93+
94+
### How to get login DN with a local account
95+
96+
#### Method 1: Using PowerShell (Get-ADUser)
97+
98+
1. Open PowerShell as an administrator.
99+
1. Run the following command:
100+
```
101+
Get-ADUser -Identity Administrator | Select-Object DistinguishedName
102+
```
103+
1. Example output:
104+
```
105+
DistinguishedName
106+
-----------------
107+
CN=Administrator,CN=Users,DC=csoar,DC=com
108+
```
109+
110+
The `DistinguishedName` field contains the full LDAP path.
111+
112+
#### Method 2: Using Active Directory Users and Computers (GUI)
113+
114+
1. Open **Active Directory Users and Computers (ADUC) (dsa.msc)**.
115+
1. Enable "Advanced Features" by selecting **View > Advanced Features**.
116+
1. Navigate to the user account (for example, **Administrator**).
117+
1. Right-click the user and select **Properties**.
118+
1. Go to the **Attribute Editor** tab.
119+
1. Find the `distinguishedName` attribute. The value will be like: `CN=Administrator,CN=Users,DC=csoar,DC=com`. This is your **Login DN**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-login-dn.png')} style={{border:'1px solid gray'}} alt="Login DN" width="600"/>
120+
121+
### How to get login DN with a service account
122+
123+
Once the service account is created in the Organization Unit:
124+
1. Open PowerShell as an administrator.
125+
1. Run the following command:
126+
```
127+
Get-ADUser -Identity <service-account-name>
128+
```
129+
1. To view all the service accounts inside AD:
130+
```
131+
Get-ADUser -Filter * | Select-Object Name, SamAccountName, DistinguishedName
132+
```
133+
1. Example output:<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-dn-output-example.png')} style={{border:'1px solid gray'}} alt="DN example output" width="700" height="120"/>
134+
1. Below is the example path:<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-example-path.png')} style={{border:'1px solid gray'}} alt="Example path" width="700" height="400"/>
135+
1. Add the `distinguishedName` as the **Login DN** and correct the password of the service account.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-edit-resource.png')} style={{border:'1px solid gray'}} alt="Edit resource" width="400"/><br/>Below is the full form of each term:<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-full-form.png')} style={{border:'1px solid gray'}} alt="Full form of terms" width="400"/>
136+
44137
## Change Log
45138

46139
* March 25, 2021 - First upload
Loading
995 KB
Loading
Loading
Loading
Loading
331 KB
Loading
183 KB
Loading
340 KB
Loading
Loading

0 commit comments

Comments
 (0)