Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Active Directory Query v2 - global catalog reference #37816

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

adi88d
Copy link
Contributor

@adi88d adi88d commented Dec 23, 2024

Contributing to Cortex XSOAR Content

Make sure to register your contribution by filling the contribution registration form

The Pull Request will be reviewed only after the contribution registration form is filled.

Status

  • In Progress
  • Ready
  • In Hold - (Reason for hold)

Related Issues

https://jira-dc.paloaltonetworks.com/browse/XSUP-44308

Description

Added documentation on global catalog for queries and operations across multiple domains by using port 3268

Must have

  • Tests
  • Documentation

@adi88d adi88d marked this pull request as ready for review December 23, 2024 10:44
@adi88d adi88d requested a review from ShacharKidor December 23, 2024 10:44
Copy link

github-actions bot commented Dec 23, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
Packs/Active_Directory_Query/Integrations/Active_Directory_Query
   Active_Directory_Query.py97359538%135–136, 138, 140–143, 152, 154–155, 200, 224–230, 232, 253–259, 261, 284–288, 290, 297–298, 303–306, 313–316, 330–331, 334, 349–350, 357–359, 368–370, 378–381, 383, 392–395, 403–405, 407, 423–431, 449–450, 458–460, 482, 528–529, 533–536, 540–541, 545–548, 559, 566, 573–574, 576, 580, 582–587, 589, 592–593, 595–598, 600, 609, 613, 621, 636, 647–648, 652–653, 657–658, 662–663, 667–671, 675, 699, 735–738, 740, 745, 748, 751–752, 754–755, 763–765, 770–773, 780, 782–784, 789, 795–797, 800, 803–804, 807–808, 811–814, 817–821, 823–826, 835–836, 838–839, 850, 854, 876, 884, 890–891, 919–920, 923–924, 940–941, 943–948, 953–962, 965–970, 973, 975, 978–980, 983–985, 988, 994, 996, 1001, 1035, 1044–1045, 1056, 1058, 1106, 1109, 1118–1119, 1121–1122, 1129, 1139–1141, 1147, 1151, 1154–1156, 1168–1170, 1175, 1179–1180, 1182–1183, 1186–1192, 1197–1206, 1210–1212, 1214, 1219, 1223–1224, 1226–1233, 1239, 1245–1247, 1249, 1254, 1264–1267, 1272, 1275–1279, 1281–1282, 1285, 1287, 1292, 1296, 1298–1302, 1304–1305, 1307, 1312, 1316, 1318–1320, 1323, 1325, 1330, 1334–1335, 1337–1338, 1340–1342, 1344, 1349, 1353–1354, 1356–1360, 1362, 1366, 1369–1371, 1373, 1379, 1381, 1386, 1390–1391, 1393–1394, 1397–1400, 1403–1405, 1407, 1412, 1445, 1486, 1489–1492, 1495, 1498, 1500, 1505, 1514, 1517–1522, 1533–1536, 1538, 1540–1542, 1545–1547, 1549, 1551, 1554, 1558–1561, 1564, 1566, 1568–1571, 1573, 1580, 1582–1584, 1589, 1593, 1595, 1598–1599, 1601, 1603–1617, 1619–1621, 1624, 1626, 1641, 1643–1645, 1647, 1652, 1656, 1658, 1661–1662, 1664, 1666–1670, 1673, 1675, 1677–1679, 1684, 1689, 1693, 1696–1698, 1700–1702, 1704, 1709, 1717–1720, 1722, 1727, 1731–1732, 1734, 1737–1739, 1741, 1746, 1750, 1752, 1754, 1756–1757, 1759, 1778–1780, 1782–1783, 1785–1788, 1791, 1793–1794, 1798–1799, 1802–1805, 1808–1809, 1814, 1817, 1833–1834, 1909–1911, 1932, 1944, 1946–1947, 1950–1951, 1953, 1957–1958, 1960–1961, 1963–1964, 1966–1967, 1969–1970, 1972–1973, 1975–1976, 1978–1979, 1981–1982, 1984–1985, 1987–1988, 1990–1991, 1993–1994, 1996–1997, 1999–2000, 2002–2003, 2005–2006, 2008–2009, 2011–2012, 2014–2015, 2017–2018, 2020–2021, 2023–2024, 2026–2027, 2029–2030, 2033–2035, 2037–2039, 2041–2042, 2044, 2046–2048, 2050–2052, 2055, 2057–2060, 2062–2063, 2068, 2070
TOTAL97359538% 

Tests Skipped Failures Errors Time
44 0 💤 0 ❌ 0 🔥 10.891s ⏱️

Copy link
Contributor

@ShacharKidor ShacharKidor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adi88d Nice work,
Please add a tech writer for a docs review.

@@ -14,7 +14,7 @@ configuration:
type: 0
required: true
section: Connect
- display: Port. If not specified, the default port is 389, or 636 for LDAPS.
- display: Server port. If not specified, the default port is 389, 636 for LDAPS, or 3268 for global catalog servers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- display: Server port. If not specified, the default port is 389, 636 for LDAPS, or 3268 for global catalog servers.
- display: Server port. If not specified, the default port is 389 for LDAP, 636 for LDAPS, or 3268 for global catalog servers.

@@ -45,7 +45,7 @@ Use Cases
| **Parameter** | **Description** | **Required** |
|--------------------------------------------------------------------------------------------------| --- | --- |
| Server IP address (for example, 192.168.0.1) | The Server IP that should be used to access Active Directory. | True |
| Port | Server port. If not specified, the default port is 389, or 636 for LDAPS. | False |
| Port | Server port. If not specified, the default port is 389, 636 for LDAPS, or 3268 for global catalog servers. | False |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Port | Server port. If not specified, the default port is 389, 636 for LDAPS, or 3268 for global catalog servers. | False |
| Port | Server port. If not specified, the default port is 389 for LDAP, 636 for LDAPS, or 3268 for global catalog servers. | False |

Comment on lines 62 to 63
> <i>Note:</i> For queries and operations across multiple domains within a forest the server port should be 3268. This port is used for queries specifically targeted for the global catalog. LDAP requests sent to port 3268 can be used to search for objects in the entire forest.
For more information on global catalog see the [Microsoft documentation](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/plan/planning-global-catalog-server-placement).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> <i>Note:</i> For queries and operations across multiple domains within a forest the server port should be 3268. This port is used for queries specifically targeted for the global catalog. LDAP requests sent to port 3268 can be used to search for objects in the entire forest.
For more information on global catalog see the [Microsoft documentation](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/plan/planning-global-catalog-server-placement).
> <i>Note:</i> For queries and operations across multiple domains within an Active Directory forest the server port should be 3268. This port is used for queries specifically targeted for the global catalog. LDAP requests sent to port 3268 can be used to search for objects in the entire Active Directory forest.
For more information on global catalog see the [Microsoft documentation](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/plan/planning-global-catalog-server-placement).

@ShirleyDenkberg
Copy link
Contributor

@ShacharKidor Doc review completed.

@adi88d adi88d requested a review from ShacharKidor December 24, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants