diff --git a/.gitignore b/.gitignore index 12e977f514..4895a29931 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,9 @@ docs/*/*/kb/** docs/changetracker/api/reference/* !docs/changetracker/api/reference/_category_.json !docs/changetracker/api/reference/index.md +docs/privilegesecure/26.07/api/reference/* +!docs/privilegesecure/26.07/api/reference/_category_.json +!docs/privilegesecure/26.07/api/reference/index.md docs/privilegesecurediscovery/integrations/api/reference/* !docs/privilegesecurediscovery/integrations/api/reference/_category_.json !docs/privilegesecurediscovery/integrations/api/reference/index.md @@ -67,3 +70,6 @@ touch_files.py # local caches (quality-check verdicts, pilot runs) .cache/ + +# Prepared OpenAPI specs (scripts/prepare-privilegesecure-spec.mjs) +.generated/ diff --git a/docs/kb/auditor/event-id-reference/health-log-events/event-id-5801-in-health-log.md b/docs/kb/auditor/event-id-reference/health-log-events/event-id-5801-in-health-log.md index ec0b140135..2c715026cb 100644 --- a/docs/kb/auditor/event-id-reference/health-log-events/event-id-5801-in-health-log.md +++ b/docs/kb/auditor/event-id-reference/health-log-events/event-id-5801-in-health-log.md @@ -48,10 +48,10 @@ Refer to the following possible causes for the error in your environment: Refer to the respective resolution for the cause in your environment: -1. Increase the session timeout to allow the data collection to complete. Refer to the following article for additional information on connection profile setup in Netwrix Privilege Secure: https://docs.netwrix.com/docs/privilegesecure/26_03/admin/accesspolicy/connectionprofiles/connectionprofile (Connection Profiles Page — Add COnnection Profile · v26.03). +1. Increase the session timeout to allow the data collection to complete. Refer to the following article for additional information on connection profile setup in Netwrix Privilege Secure: https://docs.netwrix.com/docs/privilegesecure/26_07/configuration/access-policies/connection-profiles (Connection Profiles Page — Add COnnection Profile · v26.03). 2. Specify different credentials in the monitoring plans and data sources using Netwrix Privilege Secure accounts. Refer to the following article for the list of supported data sources: https://docs.netwrix.com/docs/auditor/10_8 Auditor Settings — Netwrix Privilege Secure · v10.7). ## Related Articles -- https://docs.netwrix.com/docs/privilegesecure/26_03/admin/accesspolicy/connectionprofiles/connectionprofile (Connection Profiles Page — Add COnnection Profile · v26.03) +- https://docs.netwrix.com/docs/privilegesecure/26_07/configuration/access-policies/connection-profiles (Connection Profiles Page — Add COnnection Profile · v26.03) - https://docs.netwrix.com/docs/auditor/10_8 Auditor Settings — Netwrix Privilege Secure · v10.7) diff --git a/docs/kb/privilegesecure/active-directory-configuration/active-directory-ad-users-groups-or-computers-not-available-to-add-to-sbpam.md b/docs/kb/privilegesecure/active-directory-configuration/active-directory-ad-users-groups-or-computers-not-available-to-add-to-sbpam.md index 382e705d37..cbb4e68ee7 100644 --- a/docs/kb/privilegesecure/active-directory-configuration/active-directory-ad-users-groups-or-computers-not-available-to-add-to-sbpam.md +++ b/docs/kb/privilegesecure/active-directory-configuration/active-directory-ad-users-groups-or-computers-not-available-to-add-to-sbpam.md @@ -1,43 +1,41 @@ --- description: >- - Recently created Active Directory objects may not appear in Netwrix Privilege - Secure until a domain synchronization runs. This article explains how to - verify the domain sync status and run a manual synchronization so users, - groups, and computers become available. + Recently created Active Directory objects may not appear in Privilege Secure + until a domain sync runs. Verify the sync status and run a manual sync. keywords: - Active Directory - AD sync - Netwrix Privilege Secure + - SbPAM - domain synchronization - Last Synchronized - Resources - Synchronize Now - - users - - groups - - computers products: - - privilege-secure-access-management -sidebar_label: 'Active Directory (AD) Users, Groups, or Computers ' -tags: [] + - privilegesecure +sidebar_label: "Active Directory (AD) Users, Groups, or Computers Not Available to Add to SbPAM" +tags: + - kb + - active-directory-configuration title: "Active Directory (AD) Users, Groups, or Computers Not Available to Add to SbPAM" knowledge_article_id: kA04u000000PdKUCA0 --- # Active Directory (AD) Users, Groups, or Computers Not Available to Add to SbPAM -## Summary +## Overview -Recently created Active Directory (AD) users, groups, or computers may not be immediately available to be added to the Netwrix Privilege Secure console, due to the last time Active Directory was synced with Netwrix Privilege Secure. +This article describes how to make recently created Active Directory (AD) users, groups, or computers available to add to the Netwrix Privilege Secure for Access Management console. These objects may not be immediately available, depending on the last time Active Directory was synced with Privilege Secure. ## Instructions -1. Log in to Netwrix Privilege Secure as an admin user, and navigate to **Resources**. -2. Confirm the domain the desired users and/or groups are members of has already been added (synced) to Netwrix Privilege Secure. - - If the domain doesn't appear in the Resources table, add it using the **+ New Domain** button above the Resources table. -3. After confirming the domain is a resource in Netwrix Privilege Secure, click the domain's name in the Resources table. -4. Confirm the **Last Synchronized** date and time. +1. Log in to Privilege Secure as an admin user, and go to **Resources**. +2. Confirm the domain that the users and/or groups you want belong to has already been added (synced) to Privilege Secure. + - If the domain does not appear in the Resources table, add it using the **+ New Domain** button above the Resources table. +3. After confirming the domain is a resource in Privilege Secure, click the domain's name in the Resources table. +4. Confirm the **Last Synchronized** date and time. - If it is not recent, click **Synchronize Now** to immediately run a domain sync. -![A domain resource as displayed in Netwrix Privilege Secure's web application.](./../0-images/ka04u000000HdF1_00N0g000004CA0p_0EM4u000004biML.png) + ![A domain resource as displayed in Netwrix Privilege Secure's web application.](./../0-images/ka04u000000HdF1_00N0g000004CA0p_0EM4u000004biML.png) -Upon successful domain sync, the **Last Synchronized** field for the domain will update. All users, groups, and computers in the domain will now be available to be onboarded to Netwrix Privilege Secure. +After a successful domain sync, the **Last Synchronized** field for the domain updates. All users, groups, and computers in the domain are now available to be onboarded to Privilege Secure. diff --git a/docs/kb/privilegesecure/active-directory-configuration/changing-the-active-directory-ou-where-users-get-created.md b/docs/kb/privilegesecure/active-directory-configuration/changing-the-active-directory-ou-where-users-get-created.md index f2c6031a00..fee56dfac0 100644 --- a/docs/kb/privilegesecure/active-directory-configuration/changing-the-active-directory-ou-where-users-get-created.md +++ b/docs/kb/privilegesecure/active-directory-configuration/changing-the-active-directory-ou-where-users-get-created.md @@ -14,18 +14,20 @@ keywords: - Login Account Template - Postgres products: - - privilege-secure-access-management -sidebar_label: Changing the Active Directory OU Where Users Get C -tags: [] + - privilegesecure +sidebar_label: Changing the Active Directory OU Where Users Get Created +tags: + - kb + - active-directory-configuration title: "Changing the Active Directory OU Where Users Get Created" knowledge_article_id: kA04u0000000HQsCAM --- # Changing the Active Directory OU Where Users Get Created -## Summary +## Overview -The Active Directory OU where Netwrix Privilege Secure users get created can be customized by modifying the `appsettings.json` file in the product's ProgramData directory. +This article describes how to change the Active Directory organizational unit (OU) where Netwrix Privilege Secure for Access Management users get created by modifying the `appsettings.json` file in the product's ProgramData directory. ## Instructions @@ -35,7 +37,7 @@ The Active Directory OU where Netwrix Privilege Secure users get created can be C:\ProgramData\Stealthbits\PAM\WebService\appsettings.json ``` -2. Locate and change the following value. If a `ManagedOUs` setting does not exist, add it prior to the final closing brace and append a comma to the preceding line: +2. Locate and change the following value. If a `ManagedOUs` setting does not exist, add it before the final closing brace and append a comma to the preceding line: ```json "ManagedOUs": { @@ -43,11 +45,11 @@ The Active Directory OU where Netwrix Privilege Secure users get created can be } ``` -3. Example: if the desired OU's Distinguished Name (DN) is “OU=Prod,OU=PAM,OU=SbPAM Users,DC=lab,DC=local”, change `"SbPAM Users"` in the preceding example to `"Prod,OU=PAM,OU=SbPAM Users"`. +3. Example: if the Distinguished Name (DN) of the OU you want is “OU=Prod,OU=PAM,OU=SbPAM Users,DC=lab,DC=local”, change `"SbPAM Users"` in the preceding example to `"Prod,OU=PAM,OU=SbPAM Users"`. - NOTE: The leading `OU=` and trailing `DC=` segments are dropped. + > **NOTE:** The leading `OU=` and trailing `DC=` segments are dropped. - After the change, the setting will look like this: + After the change, the setting looks like this: ```json "ManagedOUs": { @@ -57,6 +59,6 @@ The Active Directory OU where Netwrix Privilege Secure users get created can be 4. Save the `appsettings.json` file. -After this change, users created or managed by Netwrix Privilege Secure are created or managed in the newly specified Active Directory OU. +After this change, users created or managed by Privilege Secure are created or managed in the newly specified Active Directory OU. -NOTE: Activities that are run with Managed login accounts, and were run before this configuration change was made, may still create user account objects in the SbPAM Users OU. To circumvent this behavior, change the **Login Account Template** on the activity. This will prevent the activity from referencing any historical Postgres data referring to the SbPAM Users OU. +> **NOTE:** Activities that are run with Managed login accounts, and were run before this configuration change was made, may still create user account objects in the SbPAM Users OU. To circumvent this behavior, change the **Login Account Template** on the activity. This prevents the activity from referencing any historical Postgres data referring to the SbPAM Users OU. diff --git a/docs/kb/privilegesecure/active-directory-configuration/how-to-import-a-custom-action-step-for-single-object-replication.md b/docs/kb/privilegesecure/active-directory-configuration/how-to-import-a-custom-action-step-for-single-object-replication.md index 3e607ded18..7fb54a5361 100644 --- a/docs/kb/privilegesecure/active-directory-configuration/how-to-import-a-custom-action-step-for-single-object-replication.md +++ b/docs/kb/privilegesecure/active-directory-configuration/how-to-import-a-custom-action-step-for-single-object-replication.md @@ -1,9 +1,5 @@ --- -description: >- - Use this procedure to import a custom single-object replication action step - into Netwrix Privilege Secure to force faster Active Directory replication - when provisioning sessions. Applies to releases prior to 3.7CU1 (3.7.1250); in - 3.7.1250 and later the step is included by default. +description: "Import a single-object replication action step into Privilege Secure to speed up AD replication. Applies to releases before 3.7CU1 (3.7.1250)." keywords: - single-object replication - Active Directory replication @@ -14,35 +10,43 @@ keywords: - addon - provisioning products: - - privilege-secure-access-management -sidebar_label: How to Import a Custom Action Step for Single-obje -tags: [] -title: "How to Import a Custom Action Step for Single-object Replication" + - privilegesecure +sidebar_label: Importing a Custom Action Step for Single-Object Replication +tags: + - kb + - active-directory-configuration +title: "Importing a Custom Action Step for Single-Object Replication" knowledge_article_id: kA04u000000LLNTCA4 --- -# How to Import a Custom Action Step for Single-object Replication +# Importing a Custom Action Step for Single-Object Replication -## Summary +## Overview -It can be necessary in certain Active Directory environments to force replication when provisioning sessions. Netwrix Privilege Secure offers an out-of-the-box "Run Replication" step, but in certain Active Directory environments — often those geographically dispersed across multiple sites — this full replication step can be time consuming. In these instances, you can use a single-object replication step, which runs more quickly. +This article describes how to import a custom single-object replication action step into Netwrix Privilege Secure for Access Management. -* **Note:** these instructions apply only to releases of Netwrix Privilege Secure prior to 3.7CU1 (3.7.1250). In Netwrix Privilege Secure 3.7.1250 and all subsequent releases, the **Run AD Replication for User** step is included by default. +It can be necessary in certain Active Directory environments to force replication when provisioning sessions. Privilege Secure offers a default "Run Replication" step, but in certain Active Directory environments, often those geographically dispersed across multiple sites, this full replication step can be time consuming. In these instances, you can use a single-object replication step, which runs more quickly. + +> **NOTE:** These instructions apply only to releases of Privilege Secure before 3.7CU1 (3.7.1250). In Privilege Secure 3.7.1250 and all subsequent releases, the **Run AD Replication for User** step is included by default. ## Instructions -1. First, download the `SingleObjReplication.Addon.zip` zip archive to the Netwrix Privilege Secure server: +1. Download the `SingleObjReplication.Addon.zip` zip archive to the Privilege Secure server: + https://www.netwrix.com/download/SingleObjReplication.Addon.zip -2. Extract the archive, which contains a README file, an ActionTemplates directory, and an `Install-Addon.ps1` script file. Right-click `Install-Addon.ps1` and select **Run with PowerShell**. - ![Untitled.png](./../0-images/ka04u000000HdDb_0EM4u000005f3zs.png) +2. Extract the archive, which contains a README file, an ActionTemplates directory, and an `Install-Addon.ps1` script file. Right-click `Install-Addon.ps1` and select **Run with PowerShell**. + + ![Context menu for the add-on install script with the Run with PowerShell option](./../0-images/ka04u000000HdDb_0EM4u000005f3zs.png) -3. When prompted, select "Y" to proceed. - ![Untitled2.png](./../0-images/ka04u000000HdDb_0EM4u000005f3zZ.png) +3. When prompted, select "Y" to proceed. + + ![PowerShell prompt asking whether to proceed with the add-on installation](./../0-images/ka04u000000HdDb_0EM4u000005f3zZ.png) 4. The PowerShell window should quickly execute the script and close. -5. Log in to the Netwrix Privilege Secure console. (If Netwrix Privilege Secure was already open, be sure to refresh the console.) +5. Log in to the Privilege Secure console. If Privilege Secure was already open, refresh the console. + +6. In Privilege Secure, go to **Activities**, select an Activity, and click the green plus sign in either the **Pre-Session** or **Post-Session**. The **Run AD Replication for User** activity step is now available. -6. In Netwrix Privilege Secure, navigate to **Activities**, select an Activity, and click the green plus sign in either the **Pre-Session** or **Post-Session**. Note that the **Run AD Replication for User** activity step is now available. - ![Untitled3.png](./../0-images/ka04u000000HdDb_0EM4u000005f40R.png) + ![Pre-Session or Post-Session activity step list with the Run AD Replication for User step available](./../0-images/ka04u000000HdDb_0EM4u000005f40R.png) diff --git a/docs/kb/privilegesecure/active-directory-configuration/resolving-failed-ad-domain-syncs-after-upgrade.md b/docs/kb/privilegesecure/active-directory-configuration/resolving-failed-ad-domain-syncs-after-upgrade.md index ba5711af81..e79ca94ce1 100644 --- a/docs/kb/privilegesecure/active-directory-configuration/resolving-failed-ad-domain-syncs-after-upgrade.md +++ b/docs/kb/privilegesecure/active-directory-configuration/resolving-failed-ad-domain-syncs-after-upgrade.md @@ -1,8 +1,7 @@ --- description: >- - Learn how to resolve failed "Sync AD Domain" actions after upgrading to - Netwrix Privilege Secure 3.6+ by reconfiguring the Active Directory service - account. + Resolve failed "Sync AD Domain" actions after upgrading from Privilege Secure + 3.5 or earlier to 3.6 or later by re-entering the service account password. keywords: - Active Directory - AD sync @@ -15,22 +14,25 @@ keywords: - Resources - Service Accounts products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Resolving Failed AD Domain Syncs after Upgrade -tags: [] +tags: + - kb + - active-directory-configuration title: "Resolving Failed AD Domain Syncs after Upgrade" knowledge_article_id: kA04u000000LLlaCAG --- # Resolving Failed AD Domain Syncs after Upgrade -## Summary -This article discusses how to resolve failed "Sync AD Domain" actions following an upgrade from Netwrix Privilege Secure 3.5 or earlier, to Netwrix Privilege Secure 3.6 or later. +## Overview + +This article describes how to resolve failed "Sync AD Domain" actions after an upgrade from Netwrix Privilege Secure for Access Management 3.5 or earlier to Privilege Secure 3.6 or later. ## Instructions -To resolve failed Active Directory syncs after an upgrade, reconfigure your Active Directory service account. -1. In the Netwrix Privilege Secure console, navigate to **Configuration > Service Accounts**. Select your Active Directory service account. -2. Click inside the password field, and retype the account's password. This will ensure that the stored password in the Netwrix Privilege Secure database is correct. -3. To verify, navigate to your AD domain under the **Resources** menu, and use the **Test** button. The reconfigured service account should now be functioning. -4. You should now be able to run manual or scheduled Active Directory syncs as normal. +To resolve failed Active Directory (AD) syncs after an upgrade, reconfigure your Active Directory service account. + +1. In the Privilege Secure console, go to **Configuration > Service Accounts**. Select your Active Directory service account. +2. Click inside the password field and retype the account's password. This ensures that the stored password in the Privilege Secure database is correct. +3. To verify, go to your AD domain under the **Resources** menu and use the **Test** button. The reconfigured service account should now be functioning, and you should now be able to run manual or scheduled Active Directory syncs as normal. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-openid-connect.md b/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-openid-connect.md index e7bfffdb19..04a79f89f0 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-openid-connect.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-openid-connect.md @@ -1,33 +1,34 @@ --- description: >- - This article shows how to add Active Directory Federation Services (AD FS) as - an OpenID Connect (OIDC) authentication connector for Netwrix Privilege - Secure. It covers all AD FS configuration steps and the Netwrix Privilege - Secure connector configuration, including CORS and claim rules. + Add AD FS as an OpenID Connect authentication connector in Privilege Secure, + including the AD FS setup, CORS, and claim rules. keywords: - Active Directory Federation Services - AD FS - OpenID Connect - OIDC - Netwrix Privilege Secure + - SbPAM - Authentication Connector - CORS - Client ID - Redirect URI products: - - privilege-secure-access-management + - privilegesecure visibility: public -sidebar_label: Add Active Directory Federation Services (AD FS) a -tags: [] -title: "Add Active Directory Federation Services (AD FS) as an Authentication Connector (OpenID Connect)" +sidebar_label: "Adding Active Directory Federation Services (AD FS) as an Authentication Connector (OpenID Connect)" +tags: + - kb + - authentication-and-mfa +title: "Adding Active Directory Federation Services (AD FS) as an Authentication Connector (OpenID Connect)" knowledge_article_id: kA04u0000000HR2CAM --- -# Add Active Directory Federation Services (AD FS) as an Authentication Connector (OpenID Connect) +# Adding Active Directory Federation Services (AD FS) as an Authentication Connector (OpenID Connect) -## Summary +## Overview -This article outlines the process of adding Active Directory Federation Services (AD FS) to Netwrix Privilege Secure as an Authentication Connector via OpenID Connect (OIDC). The article is split into two sections, *Steps for AD FS* and *Steps for Netwrix Privilege Secure*. The AD FS section must be completed first. +This article describes how to add Active Directory Federation Services (AD FS) to Netwrix Privilege Secure for Access Management as an Authentication Connector via OpenID Connect (OIDC). The article is split into two sections, *Steps for AD FS* and *Steps for Privilege Secure*. The AD FS section must be completed first. ## Instructions @@ -35,31 +36,31 @@ This article outlines the process of adding Active Directory Federation Services 1. Launch **AD FS Management** on the AD FS server: - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUfU.png) + ![AD FS Management launched on the AD FS server.](./../0-images/ka04u000000HcZn_0EM4u000004bUfU.png) -2. Right-click on **Application Groups** and select **Add Application Group…** +2. Right-click **Application Groups** and select **Add Application Group…** - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUfd.png) + ![Application Groups context menu with Add Application Group selected.](./../0-images/ka04u000000HcZn_0EM4u000004bUfd.png) 3. Select **Native application accessing a web API** and enter "SbPAM (OIDC)" as the **Name**, then click **Next**. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUfn.png) + ![Add Application Group wizard with Native application accessing a web API selected and SbPAM (OIDC) entered as the Name.](./../0-images/ka04u000000HcZn_0EM4u000004bUfn.png) -4. Copy the **Client Identifier** value; you will need that when configuring Netwrix Privilege Secure. +4. Copy the **Client Identifier** value; you need it when configuring Privilege Secure. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUfi.png) + ![Client Identifier value displayed for the new application group.](./../0-images/ka04u000000HcZn_0EM4u000004bUfi.png) -5. For the **Redirect URI**, use the Netwrix Privilege Secure server's URL followed by `/callback`. For example: `https://:6500/callback`. Click **Add**, then **Next**. +5. For the **Redirect URI**, use the Privilege Secure server's URL followed by `/callback`. For example: `https://:6500/callback`. Click **Add**, then **Next**. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUfs.png) + ![Redirect URI field with the Privilege Secure callback URL added.](./../0-images/ka04u000000HcZn_0EM4u000004bUfs.png) -6. For the **Identifier** of the Web API, use the Netwrix Privilege Secure server's URL. Click **Add**, then click **Next**. +6. For the **Identifier** of the Web API, use the Privilege Secure server's URL. Click **Add**, then click **Next**. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUfx.png) + ![Identifier field for the Web API with the Privilege Secure server URL added.](./../0-images/ka04u000000HcZn_0EM4u000004bUfx.png) 7. For **Apply Access Control Policy**, leave all defaults and then click **Next**. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUg2.png) + ![Apply Access Control Policy page with the default settings.](./../0-images/ka04u000000HcZn_0EM4u000004bUg2.png) 8. For **Configure Application Permissions**, enable the following and then click **Next**: @@ -67,17 +68,17 @@ This article outlines the process of adding Active Directory Federation Services - `openid` - `profile` - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgC.png) + ![Configure Application Permissions page with allatclaims, openid, and profile enabled.](./../0-images/ka04u000000HcZn_0EM4u000004bUgC.png) 9. Review the Summary, then click **Finish**. -10. Double-click on the newly created Application Group, then double-click on the Web API application, then navigate to the **Issuance Transform Rules** tab. Click **Add Rule...** +10. Double-click the newly created Application Group, then double-click the Web API application, then go to the **Issuance Transform Rules** tab. Click **Add Rule...** - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgH.png) + ![Issuance Transform Rules tab with the Add Rule button.](./../0-images/ka04u000000HcZn_0EM4u000004bUgH.png) 11. From the dropdown, select **Send Claims Using a Custom Rule** and click **Next**. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgM.png) + ![Add Transform Claim Rule wizard with Send Claims Using a Custom Rule selected.](./../0-images/ka04u000000HcZn_0EM4u000004bUgM.png) 12. Name the rule "Send attributes", and add the following custom rule: @@ -86,32 +87,30 @@ This article outlines the process of adding Active Directory Federation Services => issue(claim = x); ``` - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgR.png) + ![Custom rule named Send attributes with the claim rule text entered.](./../0-images/ka04u000000HcZn_0EM4u000004bUgR.png) Click **Finish**, **Apply**, **OK**, then **OK** again. You can now close **AD FS**. -13. Open **PowerShell** as an administrator, and run the following commands to enable CORS for communication between the Netwrix Privilege Secure server and AD FS: - - Before running the commands, make sure you capture any existing CORS settings since the `Set-AdfsResponseHeaders` command will replace the existing values with the provided value. +13. Open **PowerShell** as an administrator. Before running the commands, ensure you capture any existing Cross-Origin Resource Sharing (CORS) settings, because the `Set-AdfsResponseHeaders` command replaces the existing values with the provided value. Then run the following commands to enable CORS for communication between the Privilege Secure server and AD FS: ```powershell Set-AdfsResponseHeaders -EnableCORS $true Set-AdfsResponseHeaders -CORSTrustedOrigins https://:6500 ``` -14. This completes the AD FS configuration portion of the guide. +This completes the AD FS configuration portion of the guide. -### Steps for Netwrix Privilege Secure +### Steps for Privilege Secure -Once the *Steps for AD FS* have been completed, take the following steps in Netwrix Privilege Secure to add AD FS as an Authentication Connector via OIDC. +After the *Steps for AD FS* are complete, take the following steps in Privilege Secure to add AD FS as an Authentication Connector via OIDC. -1. As a Netwrix Privilege Secure administrator, navigate in Netwrix Privilege Secure to **Configuration > Authentication**, and click the green **"+"** button to add a new Authentication Connector. +1. As a Privilege Secure administrator, go to **Configuration > Authentication** and click the green **"+"** button to add a new Authentication Connector. 2. Give the new connector a name, description (optional), and a Connector Type of "OpenID Connect". - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgW.png) + ![New Authentication Connector form with the name, description, and OpenID Connect connector type entered.](./../0-images/ka04u000000HcZn_0EM4u000004bUgW.png) -3. Click on **Configuration Wizard**. +3. Click **Configuration Wizard**. 4. On the wizard's **Configure Client** page, enter the following values: @@ -120,22 +119,22 @@ Once the *Steps for AD FS* have been completed, take the following steps in Netw - **Callback Address:** `https://:6500/callback` - **CORS:** `https://:6500` - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgb.png) + ![Configure Client page of the wizard with the Issue URI, Client Id, Callback Address, and CORS values entered.](./../0-images/ka04u000000HcZn_0EM4u000004bUgb.png) -5. Click **Test Connection**. If brought to a log-in page, click **Back** in your web browser and then **Next** in the Netwrix Privilege Secure wizard. If the page refreshes and brings you back to the Netwrix Privilege Secure wizard, you should also click **Next** to proceed. +5. Click **Test Connection**. If brought to a log-in page, click **Back** in your web browser and then **Next** in the Privilege Secure wizard. If the page refreshes and brings you back to the Privilege Secure wizard, you should also click **Next** to proceed. -6. On the **Test Login** page, click **Login**. You'll be brought to an AD FS log-in page. Log in with Active Directory credentials, and you'll be brought back to the same page of the Netwrix Privilege Secure wizard. Click **Next**. +6. On the **Test Login** page, click **Login**. You are brought to an AD FS log-in page. Log in with Active Directory credentials, and you are brought back to the same page of the Privilege Secure wizard. Click **Next**. -7. Click **Get User Data**. Locate a mapping you would like to use when users sign in to Netwrix Privilege Secure using AD FS, such as an email address or UPN. +7. Click **Get User Data**. Locate a mapping you would like to use when users sign in to Privilege Secure using AD FS, such as an email address or User Principal Name (UPN). - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgq.png) + ![Get User Data results listing the available user mappings, such as email address and UPN.](./../0-images/ka04u000000HcZn_0EM4u000004bUgq.png) - Click on the mapping, click **Select**, select the matching Active Directory mapping from the displayed dropdown, then click **Finish**. + Click the mapping, click **Select**, select the matching Active Directory mapping from the displayed dropdown, then click **Finish**. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgg.png) + ![Mapping selection with the matching Active Directory mapping chosen from the dropdown before clicking Finish.](./../0-images/ka04u000000HcZn_0EM4u000004bUgg.png) -8. The last step is to navigate to specific users in Netwrix Privilege Secure's **Users & Groups** menu, and assign the AD FS OIDC authenticator. +8. In the Privilege Secure **Users & Groups** menu, go to specific users and assign the AD FS OIDC authenticator. - ![User-added image](./../0-images/ka04u000000HcZn_0EM4u000004bUgl.png) + ![Users & Groups menu showing the AD FS OIDC authenticator assigned to a user.](./../0-images/ka04u000000HcZn_0EM4u000004bUgl.png) -When using the OIDC log-in option, the user is redirected to log in to AD FS. Upon successful authentication, the user is redirected to the Netwrix Privilege Secure UI as their now logged-in user. +When using the OIDC log-in option, the user is redirected to log in to AD FS. Upon successful authentication, the user is redirected to the Privilege Secure UI as their now logged-in user. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-saml.md b/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-saml.md index 37bc54cd3e..9ffb52c422 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-saml.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-saml.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to add Active Directory Federation Services (AD FS) as a SAML - authentication connector for Netwrix Privilege Secure. Contains step-by-step - AD FS configuration and the corresponding setup in Netwrix Privilege Secure. + Add Active Directory Federation Services (AD FS) as a SAML authentication + connector by configuring AD FS first, then adding the connector in Privilege Secure. keywords: - AD FS - SAML @@ -11,59 +10,75 @@ keywords: - Relying Party Trust - sbpamsaml.stealthbits.com - Assertion Consumer + - SbPAM + - Issuance Transform Rules + - Claims aware + - Name ID Policy products: - - privilege-secure-access-management -sidebar_label: Add AD FS as a SAML Authentication Connector -tags: [] -title: "Add Active Directory Federation Services (AD FS) as an Authentication Connector (SAML)" + - privilegesecure +sidebar_label: Adding Active Directory Federation Services (AD FS) as an Authentication Connector (SAML) +tags: + - kb + - authentication-and-mfa +title: "Adding Active Directory Federation Services (AD FS) as an Authentication Connector (SAML)" knowledge_article_id: kA04u0000000HR7CAM --- -# Add Active Directory Federation Services (AD FS) as an Authentication Connector (SAML) +# Adding Active Directory Federation Services (AD FS) as an Authentication Connector (SAML) -## Summary +## Overview -This article explains how to add Active Directory Federation Services (AD FS) to Netwrix Privilege Secure as an Authentication Connector via SAML. This article covers two sections: *Steps for AD FS* and *Steps for Netwrix Privilege Secure*. Complete the AD FS section first. +This article describes how to add Active Directory Federation Services (AD FS) to Netwrix Privilege Secure for Access Management as an Authentication Connector via SAML. This article covers two sections: *Steps for Active Directory Federation Services (AD FS)* and *Steps for Privilege Secure*. Complete the AD FS section first. ## Instructions ### Steps for Active Directory Federation Services (AD FS) 1. Launch **AD FS Management** on the AD FS server: - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUhA.png) -2. Right-click on **Application Groups** and select **Add Application Group…** - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUhK.png) + ![Launching AD FS Management on the AD FS server](./../0-images/ka04u000000wwIE_0EM4u000004bUhA.png) -3. Select **Native application accessing a web API** and enter "SbPAM (SAML)" as the **Name**, then click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUhP.png) +2. Right-click **Application Groups** and select **Add Application Group…** -4. Copy the **Client Identifier** value; you will need that when configuring Netwrix Privilege Secure. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUhU.png) + ![Add Application Group option in the Application Groups context menu](./../0-images/ka04u000000wwIE_0EM4u000004bUhK.png) -5. For the **Redirect URI**, use the following URI with the hostname of the SbPAM server customized to match your environment. For example: `https://:6500/samlSigninCallback`. Click **Add**, then **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUhZ.png) +3. Select **Native application accessing a web API** and enter "SbPAM (SAML)" as the **Name**, then click **Next**. -6. For the **Identifier** of the Web API, enter `sbpamsaml.stealthbits.com`, click **Add**, then click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUiD.png) + ![Native application accessing a web API template with SbPAM (SAML) entered as the name](./../0-images/ka04u000000wwIE_0EM4u000004bUhP.png) -7. For **Apply Access Control Policy**, leave all defaults and then click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUiI.png) +4. Copy the **Client Identifier** value; you need that value when configuring Privilege Secure. + + ![Client Identifier value on the Native application page](./../0-images/ka04u000000wwIE_0EM4u000004bUhU.png) + +5. For the **Redirect URI**, use the following URI with the hostname of the Privilege Secure server customized to match your environment. For example: `https://:6500/samlSigninCallback`. Click **Add**, then **Next**. + + ![Redirect URI entry with the Add button](./../0-images/ka04u000000wwIE_0EM4u000004bUhZ.png) + +6. For the **Identifier** of the Web API, enter `sbpamsaml.stealthbits.com`, click **Add**, then click **Next**. + + ![Web API Identifier entry with the Add button](./../0-images/ka04u000000wwIE_0EM4u000004bUiD.png) + +7. For **Apply Access Control Policy**, leave all defaults and then click **Next**. + + ![Apply Access Control Policy page with the default settings](./../0-images/ka04u000000wwIE_0EM4u000004bUiI.png) 8. For **Configure Application Permissions**, enable the following and then click **Next**: - `allatclaims` - `email` - `openid` - - `profile` - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUi8.png) + - `profile` + + ![Configure Application Permissions page with allatclaims, email, openid, and profile enabled](./../0-images/ka04u000000wwIE_0EM4u000004bUi8.png) 9. Click **Next** on the remaining pages until the wizard completes. -10. In the left sidebar of **AD FS**, click on the **Relying Party Trusts** folder. In the right sidebar, click **Add Relying Party Trust...** - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUho.png) +10. In the left sidebar of **AD FS**, click the **Relying Party Trusts** folder. In the right sidebar, click **Add Relying Party Trust...** + + ![Relying Party Trusts folder with the Add Relying Party Trust action](./../0-images/ka04u000000wwIE_0EM4u000004bUho.png) -11. Select **Claims aware** and click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUhy.png) +11. Select **Claims aware** and click **Next**. + + ![Claims aware option in the Add Relying Party Trust wizard](./../0-images/ka04u000000wwIE_0EM4u000004bUhy.png) 12. For **Select Data Source**, select **Enter data about the relying party manually** and click **Next**. @@ -71,85 +86,97 @@ This article explains how to add Active Directory Federation Services (AD FS) to 14. For **Configure Certificate**, leave the default values and click **Next**. -15. For **Configure URL**, check **Enable support for the SAML 2.0 WebSSO protocol** and enter your AD FS server's FQDN followed by `/adfs/ls`. For example: `https://adfs-server.domain.com/adfs/ls`. Click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUiN.png) +15. For **Configure URL**, check **Enable support for the SAML 2.0 WebSSO protocol** and enter your AD FS server's FQDN followed by `/adfs/ls`. For example: `https://adfs-server.domain.com/adfs/ls`. Click **Next**. + + ![Configure URL page with SAML WebSSO support enabled and the AD FS URL entered](./../0-images/ka04u000000wwIE_0EM4u000004bUiN.png) + +16. For **Configure Identifiers**, use the value `sbpamsaml.stealthbits.com`, click **Add**, then click **Next**. -16. For **Configure Identifiers**, use the value `sbpamsaml.stealthbits.com`, click **Add**, then click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUiS.png) + ![Configure Identifiers page with the identifier added](./../0-images/ka04u000000wwIE_0EM4u000004bUiS.png) 17. Leave **Choose Access Control Policy** as default values and click **Next**, then click **Next** through the remaining pages to finish the wizard. -18. When the wizard closes, a window for **Issuance Transform Rules** will automatically open. Click **Add Rule...**. +18. When the wizard closes, a window for **Issuance Transform Rules** automatically opens. Click **Add Rule...**. -19. Select **Send LDAP Attributes as Claims**, and click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUiX.png) +19. Select **Send LDAP Attributes as Claims**, and click **Next**. + + ![Send LDAP Attributes as Claims rule template selected](./../0-images/ka04u000000wwIE_0EM4u000004bUiX.png) 20. Name the rule "Send attributes", select "Active Directory" as the **Attribute store**, map the following **LDAP Attributes** to **Outgoing Claim Types**, click **Finish**, then click **Apply** and **OK**: - `SAM-Account-Name` → `Name` - `User-Principal-Name` → `UPN` - - `E-Mail-Addresses` → `E-Mail Address` - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUic.png) + - `E-Mail-Addresses` → `E-Mail Address` + + ![Send attributes rule with the LDAP attribute to outgoing claim type mappings](./../0-images/ka04u000000wwIE_0EM4u000004bUic.png) + +21. Double-click the **Relying Party Trust** created in the previous steps (named "SbPAM (SAML)"), and go to the **Endpoints** tab. -21. Double-click on the **Relying Party Trust** created in the previous steps (named "SbPAM (SAML)"), and navigate to the **Endpoints** tab. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUih.png) + ![Endpoints tab of the Relying Party Trust properties](./../0-images/ka04u000000wwIE_0EM4u000004bUih.png) Add the following endpoints (click **Add SAML...**): - - Endpoint type: SAML Assertion Consumer - Binding: POST - Index: 0 - Trusted URL: `https://:6500/samlSigninCallback` - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUim.png) + - Endpoint type: SAML Assertion Consumer + - Binding: POST + - Index: 0 + - Trusted URL: `https://:6500/samlSigninCallback` - - Endpoint type: SAML Logout - Binding: POST - Index: 0 - Trusted URL: `https://.domain.com/adfs/ls/?wa=wsignout1.0&wreply=https://:6500` - Response URL: `https://:6500/login` - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUir.png) + ![SAML Assertion Consumer endpoint settings](./../0-images/ka04u000000wwIE_0EM4u000004bUim.png) - Click **OK**, **Apply**, then **OK**. + - Endpoint type: SAML Logout + - Binding: POST + - Index: 0 + - Trusted URL: `https://.domain.com/adfs/ls/?wa=wsignout1.0&wreply=https://:6500` + - Response URL: `https://:6500/login` -22. This completes the AD FS configuration portion of the guide. + ![SAML Logout endpoint settings](./../0-images/ka04u000000wwIE_0EM4u000004bUir.png) -### Steps for Netwrix Privilege Secure + Click **OK**, **Apply**, then **OK**. This completes the AD FS configuration portion of the guide. -After completing the *Steps for AD FS*, take the following steps in Netwrix Privilege Secure to add AD FS as an Authentication Connector via SAML. +### Steps for Privilege Secure -1. As a Netwrix Privilege Secure admin, navigate in Netwrix Privilege Secure to **Configuration > Authentication**, and click the green **"+"** button to add a new Authentication Connector. +After completing the *Steps for Active Directory Federation Services (AD FS)*, take the following steps in Privilege Secure to add AD FS as an Authentication Connector via SAML. -2. Give the new connector a name, description (optional), and a Connector Type of "SAML". - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUiw.png) +1. As a Privilege Secure admin, go to **Configuration > Authentication** in Privilege Secure, and click the green **"+"** button to add a new Authentication Connector. -3. Click on **Configuration Wizard**. +2. Give the new connector a name, description (optional), and a Connector Type of "SAML". + + ![New Authentication Connector with the SAML connector type](./../0-images/ka04u000000wwIE_0EM4u000004bUiw.png) + +3. Click **Configuration Wizard**. 4. On the wizard's **Configure Client** page, enter the following values: - Signin URI: `https://.domain.com/adfs/ls` - Callback Address: `https://:6500/samlSigninCallback` - - CORS (Cross-Origin Resource Sharing): `https://:6500` - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUj1.png) + - CORS (Cross-Origin Resource Sharing): `https://:6500` + + ![Configure Client page with the sign-in URI, callback address, and CORS values](./../0-images/ka04u000000wwIE_0EM4u000004bUj1.png) - Click **Test Connection**. If you are redirected to a log-in page, click **Back** in your web browser, then click **Next** in the Netwrix Privilege Secure wizard. If the page refreshes and brings you back to the Netwrix Privilege Secure wizard, click **Next** to proceed. + Click **Test Connection**. If you are redirected to a log-in page, click **Back** in your web browser, then click **Next** in the Privilege Secure wizard. If the page refreshes and brings you back to the Privilege Secure wizard, click **Next** to proceed. -5. Select "Unspecified" for the **Name ID Policy**, and add a certificate if required. Then, click **Login** and sign in to AD FS using Active Directory credentials. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUj6.png) +5. Select "Unspecified" for the **Name ID Policy**, and add a certificate if required. Then, click **Login** and sign in to AD FS using Active Directory credentials. + + ![Name ID Policy set to Unspecified with the Login button](./../0-images/ka04u000000wwIE_0EM4u000004bUj6.png) When AD FS redirects you back to this page after signing in, if the message reads "Login was successful", click **Next**. -6. Locate a mapping you would like to use when users sign in to Netwrix Privilege Secure using AD FS, such as an email address or UPN. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUjB.png) +6. Locate a mapping you want to use when users sign in to Privilege Secure using AD FS, such as an email address or UPN. + + ![List of available mappings](./../0-images/ka04u000000wwIE_0EM4u000004bUjB.png) + + Click the mapping, click **Select**, select the matching Active Directory mapping from the displayed dropdown, then click **Next**. - Click on the mapping, click **Select**, select the matching Active Directory mapping from the displayed dropdown, then click **Next**. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUjG.png) + ![Selected mapping matched to an Active Directory mapping](./../0-images/ka04u000000wwIE_0EM4u000004bUjG.png) 7. For the **Signout URI** and **Signout Callback URI**, use the following values: - Signout URI: `https://.domain.com/adfs/ls/?wa=wsignout1.0&wreply=` - - Signout Callback URI: `https://:6500` - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUjL.png) + - Signout Callback URI: `https://:6500` + + ![Signout URI and Signout Callback URI values](./../0-images/ka04u000000wwIE_0EM4u000004bUjL.png) + + Click **Test Log Out**, then **Finish** to complete the wizard. Privilege Secure now uses AD FS (via SAML) as an Authentication Connector. - Click **Test Log Out**, then **Finish** to complete the wizard. Netwrix Privilege Secure now uses AD FS (via SAML) as an Authentication Connector. +8. In the **Users & Groups** menu in Privilege Secure, go to specific users and assign the AD FS SAML authenticator. -8. Navigate to specific users in Netwrix Privilege Secure's **Users & Groups** menu and assign the AD FS SAML authenticator. - ![User-added image](./../0-images/ka04u000000wwIE_0EM4u000004bUjQ.png) + ![AD FS SAML authenticator assigned to a user in Users & Groups](./../0-images/ka04u000000wwIE_0EM4u000004bUjQ.png) -When using the SAML log-in option, the user signs in to AD FS. Upon successful authentication, Netwrix Privilege Secure redirects the user to the UI as their signed-in account. +When using the SAML log-in option, the user signs in to AD FS. Upon successful authentication, Privilege Secure redirects the user to the UI as their signed-in account. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-openid-connect.md b/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-openid-connect.md index 644b736077..7c2d1fcad1 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-openid-connect.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-openid-connect.md @@ -1,9 +1,7 @@ --- description: >- - Shows how to add Microsoft Entra ID as an OpenID Connect (OIDC) Authentication - Connector for Netwrix Privilege Secure, including required app registration - steps in Microsoft Entra ID and configuration steps in Netwrix Privilege - Secure. + Add Microsoft Entra ID as an OpenID Connect (OIDC) Authentication Connector by + registering an app in Entra ID and configuring Privilege Secure. keywords: - Microsoft Entra ID - OpenID Connect @@ -15,28 +13,30 @@ keywords: - Client ID - Redirect URI products: - - privilege-secure-access-management -sidebar_label: Add Microsoft Entra ID as an Authentication Connec -tags: [] -title: "Add Microsoft Entra ID as an Authentication Connector (OpenID Connect)" + - privilegesecure +sidebar_label: "Adding Microsoft Entra ID as an Authentication Connector (OpenID Connect)" +tags: + - kb + - authentication-and-mfa +title: "Adding Microsoft Entra ID as an Authentication Connector (OpenID Connect)" knowledge_article_id: kA04u0000000HRCCA2 --- -# Add Microsoft Entra ID as an Authentication Connector (OpenID Connect) +# Adding Microsoft Entra ID as an Authentication Connector (OpenID Connect) ## Overview -This article outlines the process of adding Microsoft Entra ID (formerly Azure AD) to Netwrix Privilege Secure as an Authentication Connector via OpenID Connect (OIDC). The article is divided into two sections: **Steps for Microsoft Entra ID** and **Steps for Netwrix Privilege Secure**. Complete the Microsoft Entra ID section first. +This article describes how to add Microsoft Entra ID (formerly Azure AD) to Netwrix Privilege Secure for Access Management as an Authentication Connector via OpenID Connect (OIDC). The article is divided into two sections: **Steps for Microsoft Entra ID** and **Steps for Netwrix Privilege Secure**. Complete the Microsoft Entra ID section first. ## Instructions ### Steps for Microsoft Entra ID -Perform the following steps in Microsoft Entra ID as an administrator to prepare an app registration for use with Netwrix Privilege Secure. +Perform the following steps in Microsoft Entra ID as an administrator to prepare an app registration for use with Privilege Secure. -1. Navigate to `https://portal.azure.com/` and sign in to Microsoft Entra ID as an administrator. Create an Enterprise Application. +1. Go to `https://portal.azure.com/` and sign in to Microsoft Entra ID as an administrator. Create an Enterprise Application. 2. Click **Azure Active Directory** from the left sidebar, then click **App Registrations**. Next, click **New Registration** near the top of the page. -3. Enter a name for the app. For **Redirect URI**, enter the following, replacing `your-sbpam-server-hostname` with the hostname of your Netwrix Privilege Secure server: +3. Enter a name for the app. For **Redirect URI**, enter the following, replacing `your-sbpam-server-hostname` with the hostname of your Privilege Secure server: ``` https://your-sbpam-server-hostname:6500/callback @@ -45,18 +45,15 @@ Perform the following steps in Microsoft Entra ID as an administrator to prepare ![App registration page with Redirect URI field highlighted](./../0-images/ka0Qk000000DtGP_0EM4u000004bUjf.png) 4. Click **Register**. After registration completes, you are redirected to the new app's **Overview** page. -5. In the left sidebar, click **Authentication**. Scroll down and enter the same **Callback Address** from Step 3 in the **Front-channel logout URL** field. - Enable the following checkboxes: +5. In the left sidebar, click **Authentication**. Scroll down and enter the same **Callback Address** from Step 3 in the **Front-channel logout URL** field. Enable the following checkboxes: - **Access tokens (used for implicit flows)** - **ID tokens (used for implicit and hybrid flows)** ![Authentication settings with token options enabled](./../0-images/ka0Qk000000DtGP_0EM4u000004bUjk.png) 6. Click **Save** at the top of the page, then return to the app's **Overview** page. -7. Click **Endpoints** near the top of the page. Copy the **OpenID Connect metadata document** URL and open it in a new browser tab. - This displays JSON data. To make it easier to read, consider using a JSON browser extension such as **JSON Formatter** for Chromium-based browsers. -8. While viewing the JSON data, find the **Issuer** key. **Copy only the value between the forward slashes**, not the entire line. In this case, it is a URL. - For example: +7. Click **Endpoints** near the top of the page. Copy the **OpenID Connect metadata document** URL and open it in a new browser tab. This displays JSON data. To make it easier to read, consider using a JSON browser extension such as **JSON Formatter** for Chromium-based browsers. +8. While viewing the JSON data, find the **Issuer** key. **Copy only the value between the forward slashes**, not the entire line. In this case, it is a URL. For example: ```text https://login.microsoftonline.com//v2.0 @@ -66,9 +63,9 @@ Perform the following steps in Microsoft Entra ID as an administrator to prepare ### Steps for Netwrix Privilege Secure -After completing the **Steps for Microsoft Entra ID**, perform the following steps in Netwrix Privilege Secure to add Microsoft Entra ID as an Authentication Connector via OpenID Connect (OIDC). +After completing the **Steps for Microsoft Entra ID**, perform the following steps in Privilege Secure to add Microsoft Entra ID as an Authentication Connector via OpenID Connect (OIDC). -1. As a Netwrix Privilege Secure administrator, navigate to **Configuration > Authentication** and click the green **+** button to add a new Authentication Connector. +1. As a Privilege Secure administrator, go to **Configuration > Authentication** and click the green **+** button to add a new Authentication Connector. 2. Enter a name and (optionally) a description for the new connector. Set the **Connector Type** to **OpenID Connect**. ![Authentication Connector creation dialog with OpenID Connect selected](./../0-images/ka0Qk000000DtGP_0EM4u000004bUjp.png) @@ -78,38 +75,41 @@ After completing the **Steps for Microsoft Entra ID**, perform the following ste ![Configure Client page with Issuer and Client ID fields](./../0-images/ka0Qk000000DtGP_0EM4u000004bUju.png) -5. Click **Test Connection**. - On the Microsoft Entra ID sign-in page that loads, **do not sign in**. Once you have verified that the sign-in page loaded properly, click the back button in your browser to return to Netwrix Privilege Secure. The connection test is successful if Microsoft Entra ID did not display an error. -6. Click **Next** to advance in the Authentication Connector Configuration Wizard. You will now be on the **Test Login** page. +5. Click **Test Connection**. On the Microsoft Entra ID sign-in page that loads, **do not sign in**. After you verify that the sign-in page loaded properly, click the back button in your browser to return to Privilege Secure. The connection test is successful if Microsoft Entra ID did not display an error. +6. Click **Next** to advance in the Authentication Connector Configuration Wizard. You are now on the **Test Login** page. 7. Click **Login** and sign in as any Microsoft Entra ID user (this does not need to be an administrator). You are prompted to accept the app's requested permissions. Check **Consent on behalf of your organization** and click **Accept**. ![Microsoft Entra ID permissions consent dialog](./../0-images/ka0Qk000000DtGP_0EM4u000004bUjz.png) -8. Click **Next** in the wizard. You will now be on the **Configure Id Mapping** page. -9. Click **Get User Data**. - Netwrix Privilege Secure will use the access token to retrieve user data from the OpenID Connect provider. The OpenID Connect provider requires a User Id Field for sign-in. - Specify which field in Active Directory should map to that User Id Field, so that Netwrix Privilege Secure can automatically fill in the required credentials at login. The value provided is used to sign in to the multi-factor authenticator (MFA) when a user logs in to the Netwrix Privilege Secure Console. - To connect a user from the OpenID Connect provider to a user in the Netwrix Privilege Secure copy of the AD data, map a field in the provider list to a field in the Netwrix Privilege Secure host user table. The exact fields to map will vary between providers and according to the user’s AD configuration. - The table displays the retrieved data that can be used for the host user lookup. Select from the displayed records a field that corresponds to a value in your AD configuration. For example, if the AD data contains email addresses, select any of the fields that contain email addresses. +8. Click **Next** in the wizard. You are now on the **Configure Id Mapping** page. +9. Click **Get User Data**. + + Privilege Secure uses the access token to retrieve user data from the OpenID Connect provider. The OpenID Connect provider requires a User Id Field for sign-in. + + Specify which field in Active Directory should map to that User Id Field, so that Privilege Secure can automatically fill in the required credentials at login. The value provided is used to sign in to the multi-factor authenticator (MFA) when a user logs in to the Privilege Secure Console. + + To connect a user from the OpenID Connect provider to a user in the Privilege Secure copy of the AD data, map a field in the provider list to a field in the Privilege Secure host user table. The exact fields to map vary between providers and according to the user’s AD configuration. + + The table displays the retrieved data that you can use for the host user lookup. Select from the displayed records a field that corresponds to a value in your AD configuration. For example, if the AD data contains email addresses, select any of the fields that contain email addresses. + **There must be a property for each user in on-premises Active Directory and Microsoft Entra ID that matches. Often, this is an email address.** - > **IMPORTANT:** Make sure to use a field that has an `ID TOKEN` source, rather than `ACCESS TOKEN`. + > **IMPORTANT:** Ensure that you use a field that has an `ID TOKEN` source, rather than `ACCESS TOKEN`. ![User data mapping table with ID Token source highlighted](./../0-images/ka0Qk000000DtGP_0EM4u000004bUk9.png) - Once the desired field has been found, click on it and then click **Select**. -10. You will now be back in the Authentication Connector Configuration Wizard, on the **Configure Id Mapping** page. Make sure the **Login Format** dropdown matches the ID Token field selected from Microsoft Entra ID in the previous step. - For example, if you chose **Email** for the field in the previous step, then this dropdown should also be **Email Address**. + After you find the field you want, click it and then click **Select**. +10. You are now back in the Authentication Connector Configuration Wizard, on the **Configure Id Mapping** page. Ensure the **Login Format** dropdown matches the ID Token field selected from Microsoft Entra ID in the previous step. For example, if you chose **Email** for the field in the previous step, then this dropdown should also be **Email Address**. ![Login Format dropdown with Email Address selected](./../0-images/ka0Qk000000DtGP_0EM4u000004bUkE.png) 11. Click **Finish** on the summary modal, and then **Save** for the authentication connector. -12. You can now assign this authentication connector to a user via the **Authentication Connector** tab for a user accessed in Netwrix Privilege Secure's **Users & Groups** page. +12. You can now assign this authentication connector to a user via the **Authentication Connector** tab for a user accessed in the Privilege Secure **Users & Groups** page. ![Authentication Connector assignment in Users & Groups page](./../0-images/ka0Qk000000DtGP_0EM4u000004bUkJ.png) - Users with this authentication connector assignment can now use this authentication connector option on the Netwrix Privilege Secure log-in screen. + Users with this authentication connector assignment can now use this authentication connector option on the Privilege Secure log-in screen. ![Netwrix Privilege Secure login screen with OpenID Connect option](./../0-images/ka0Qk000000DtGP_0EM4u000004bUkO.png) - When using the OpenID Connect log-in option, the user is redirected to sign in to Microsoft Entra ID. Upon successful authentication, the user is redirected to the Netwrix Privilege Secure UI as their signed-in user. + When using the OpenID Connect log-in option, the user is redirected to sign in to Microsoft Entra ID. Upon successful authentication, the user is redirected to the Privilege Secure UI as their signed-in user. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-saml.md b/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-saml.md index c5702750d8..1c934f64a9 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-saml.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/add-microsoft-entra-id-as-an-authentication-connector-saml.md @@ -1,9 +1,6 @@ --- description: >- - Shows how to add Microsoft Entra ID as a SAML Authentication Connector in - Netwrix Privilege Secure, including steps to configure the Microsoft Entra ID - Enterprise Application and complete the Authentication Connector Configuration - Wizard in Netwrix Privilege Secure. + Add Microsoft Entra ID as a SAML Authentication Connector by configuring the Enterprise Application and completing the Configuration Wizard. keywords: - Microsoft Entra ID - SAML @@ -15,112 +12,112 @@ keywords: - reply URL - login URL products: - - privilege-secure-access-management -sidebar_label: Add Microsoft Entra ID as an Authentication Conne -tags: [] -title: "Add Microsoft Entra ID as an Authentication Connector (SAML)" + - privilegesecure +sidebar_label: "Adding Microsoft Entra ID as an Authentication Connector (SAML)" +tags: + - kb + - authentication-and-mfa +title: "Adding Microsoft Entra ID as an Authentication Connector (SAML)" knowledge_article_id: kA04u0000000HRHCA2 --- -# Add Microsoft Entra ID as an Authentication Connector (SAML) +# Adding Microsoft Entra ID as an Authentication Connector (SAML) -## Summary +## Overview -This article outlines the process of adding Microsoft Entra ID (formerly Azure AD) to Netwrix Privilege Secure as an Authentication Connector via SAML. The article is split into two sections, Steps for Microsoft Entra ID and Steps for Netwrix Privilege Secure. The Microsoft Entra ID section must be completed first. +This article describes how to add Microsoft Entra ID (formerly Azure AD) to Netwrix Privilege Secure for Access Management as an Authentication Connector via Security Assertion Markup Language (SAML). The article is split into two sections, Steps for Microsoft Entra ID and Steps for Privilege Secure. The Microsoft Entra ID section must be completed first. ## Instructions ### Steps for Microsoft Entra ID -1. In a web browser, navigate to https://portal.azure.com/ and sign-in as an admin. You’ll need to create an Enterprise Application and gather several pieces of information to complete the Netwrix Privilege Secure **Configuration Wizard** steps later in this article. +1. In a web browser, go to https://portal.azure.com/ and sign in as an admin. You need to create an Enterprise Application and gather several pieces of information to complete the Privilege Secure **Configuration Wizard** steps later in this article. 2. In Azure, click **Azure Active Directory** from the left sidebar. Then, click **Enterprise Applications** from the left sidebar. 3. Click **New Application** near the top of the **Enterprise Applications** page, followed by **Create Your Own Application** on the page that follows. Give the app any name, and set the radio button to **Integrate any other application you don't find in the gallery (Non-gallery)**. Click **Create**. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkT.png) + ![The Create Your Own Application pane with the Non-gallery option selected.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkT.png) -4. You’ll be redirected to the new app’s **Overview** page. +4. You are redirected to the new app's **Overview** page. In the left sidebar, select **Single sign-on**, then select **SAML**. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkY.png) + ![The Single sign-on page of the new app with the SAML option.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkY.png) 5. For Step 1 in this wizard (**Basic SAML Configuration**), click **Edit**. Change the **Identifier (Entity ID)** to `sbpamsaml.stealthbits.com`, and set it to be the default. - For the **Reply URL (Assertion Consumer Service URL)**, use the following URL (changing the hostname to the hostname used to access Netwrix Privilege Secure via a web browser): + For the **Reply URL (Assertion Consumer Service URL)**, use the following URL (changing the hostname to the hostname used to access Privilege Secure via a web browser): ``` https://:6500/samlSigninCallback ``` - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUh1.png) + ![The Basic SAML Configuration editor with the Identifier and Reply URL fields filled in.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUh1.png) Click **Save** after making changes, and then close the editor for **Basic SAML Configuration**. 6. Scroll down to section 3, and download the **Certificate (Base64)**. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkd.png) + ![The SAML Certificates section with the certificate download link.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkd.png) 7. Scroll down to section 4, and copy the **Login URL** for later use. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUki.png) + ![The Login URL value in the app's SAML setup section.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUki.png) -8. In the left sidebar, click on **Users and Groups**. Add a Microsoft Entra ID user to this page (**Add user/group** button near the top). +8. In the left sidebar, click **Users and Groups**. Add a Microsoft Entra ID user to this page (**Add user/group** button near the top). - This user should be accessible to whoever will complete the Steps for Netwrix Privilege Secure, as they need to be able to log in to this user to complete the Authentication Connector Configuration Wizard for SAML in Netwrix Privilege Secure. + Ensure this user is accessible to whoever will complete the Steps for Privilege Secure, as they need to be able to log in to this user to complete the Authentication Connector Configuration Wizard for SAML in Privilege Secure. -9. Sign-out of Microsoft Entra ID. +9. Sign out of Microsoft Entra ID. -10. At this point, you should have the following pieces of information for use in the Steps for Netwrix Privilege Secure: +10. At this point, you should have the following pieces of information for use in the Steps for Privilege Secure: - - **Certificate (Base64)** - - **Login URL** - - **Microsoft Entra ID user** (associated with the Enterprise Application and can be logged-in to by whoever will complete the Netwrix Privilege Secure portion of this article) + - **Certificate (Base64)** + - **Login URL** + - **Microsoft Entra ID user** (associated with the Enterprise Application and can be logged-in to by whoever will complete the Privilege Secure portion of this article) ---- - -### Steps for Netwrix Privilege Secure +### Steps for Privilege Secure -1. As a Netwrix Privilege Secure admin, navigate in Netwrix Privilege Secure to **Configuration > Authentication**, and click the green **"+"** button to add a new Authentication Connector. +1. As a Privilege Secure admin, go to **Configuration > Authentication** in Privilege Secure, and click the green **"+"** button to add a new Authentication Connector. 2. Give the new connector a name, description (optional), and a Connector Type of "SAML". - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkn.png) + ![The new authentication connector with a name and the SAML connector type.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkn.png) -3. Click on **Configuration Wizard**. +3. Click **Configuration Wizard**. 4. On the **Configure Client** page of that wizard, use the **Login URL** in the **Signin URI** field (the **Login URL** was obtained in the Steps for Microsoft Entra ID). All fields should now be filled in. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUks.png) + ![The Configure Client page with the Signin URI field filled in.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUks.png) 5. Click **Test Connection**. - On the page that loads (Microsoft Entra ID sign-in page), **DO NOT SIGN-IN**. Instead, once you've verified that the sign-in page loaded properly, click the back button in the browser to return to Netwrix Privilege Secure (the connection test was successful if Microsoft Entra ID didn't display an error). + On the page that loads (Microsoft Entra ID sign-in page), **DO NOT SIGN-IN**. Instead, after you have verified that the sign-in page loaded properly, click the back button in the browser to return to Privilege Secure (the connection test was successful if Microsoft Entra ID did not display an error). -6. Click **Next** to advance in the Authentication Connector Configuration Wizard. You’ll now be on the wizard's **Test Login** page. +6. Click **Next** to advance in the Authentication Connector Configuration Wizard. You are now on the wizard's **Test Login** page. 7. Open the certificate obtained during the Steps for Microsoft Entra ID. Copy the text between `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` into the **Certificate** field in the Authentication Connector Configuration Wizard. -8. Click **Login**, and log in as the Microsoft Entra ID user associated with the Enterprise Application from Step 8 in the Steps for Microsoft Entra ID. Upon successful sign-in, you’ll be redirected back to the wizard in Netwrix Privilege Secure. +8. Click **Login**, and log in as the Microsoft Entra ID user associated with the Enterprise Application from Step 8 in the Steps for Microsoft Entra ID. Upon successful sign-in, you are redirected back to the wizard in Privilege Secure. If the sign-in was successful, the Provider User Name/Id displays. This is passed to the UserTokenController so that the user information can be extracted. Click **Next**. -9. You will now be on the **Configure Id Mapping** page. +9. You are now on the **Configure Id Mapping** page. - Netwrix Privilege Secure will use the access token to retrieve user data from the SAML provider. The SAML provider requires a User Id Field for sign-in. It is necessary to specify which field in Active Directory should map to that User Id Field, so that Netwrix Privilege Secure can automatically fill in the required credentials at log-in. The value provided is used to sign in to the multi-factor authenticator (MFA) when a user logs in to the Netwrix Privilege Secure Console. + Privilege Secure uses the access token to retrieve user data from the SAML provider. The SAML provider requires a User Id Field for sign-in. Specify which field in Active Directory (AD) should map to that User Id Field, so that Privilege Secure can automatically fill in the required credentials at log-in. The value provided is used to sign in to the multi-factor authenticator (MFA) when a user logs in to the Privilege Secure Console. - The table displays the retrieved data that can be used for the host user lookup. You must select from the displayed records a field that corresponds to a value in your AD configuration. For example, if the AD data contains email addresses, you can select any of the fields which contain email addresses. + The table displays the retrieved data for the host user lookup. You must select from the displayed records a field that corresponds to a value in your AD configuration. For example, if the AD data contains email addresses, you can select any of the fields which contain email addresses. - In simple terms, there needs to be a property for each user in on-prem Active Directory and Microsoft Entra ID that matches. Often, this is an email address. + In simple terms, there needs to be a property for each user in on-prem AD and Microsoft Entra ID that matches. Often, this is an email address. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkx.png) + ![The table of retrieved SAML provider data for selecting the Id mapping field.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUkx.png) - Once the desired field has been found, click on it and then click **Select** (you may need to scroll down in the modal to see this button). + After you find the field you want, click it and then click **Select** (you may need to scroll down in the modal to see this button). -10. You will now be back in the Authentication Connector Configuration Wizard, on the **Configure Id Mapping** page. Make sure the **Login Format** dropdown is for a format that will match the ID Token field selected from Microsoft Entra ID in the previous step. +10. You are now back in the Authentication Connector Configuration Wizard, on the **Configure Id Mapping** page. Ensure the **Login Format** dropdown is set to a format that matches the ID Token field selected from Microsoft Entra ID in the previous step. For example, if you chose **Email** for the field in the previous step then this dropdown should also be **Email Address**. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUl2.png) + ![The Login Format dropdown on the Configure Id Mapping page.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUl2.png) 11. Click **Next**. On the next page, enter the following for the **Signout URI**: @@ -130,14 +127,14 @@ This article outlines the process of adding Microsoft Entra ID (formerly Azure A Click **Test Log Out** to sign out of the SAML provider. If the log out was performed correctly, click **Finish** then **Okay**, otherwise confirm the settings and try again. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUl7.png) + ![The Signout URI field and the Test Log Out button.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUl7.png) -12. You can now assign this authentication connector to a user via the **Authentication Connector** tab for a user accessed in Netwrix Privilege Secure's **Users & Groups** page. +12. You can now assign this authentication connector to a user via the **Authentication Connector** tab for a user accessed in the Privilege Secure **Users & Groups** page. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUlC.png) + ![The Authentication Connector tab for a user on the Users & Groups page.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUlC.png) - Users with this authentication connector assignment can now use this authentication connector option on the Netwrix Privilege Secure log-in screen. + Users with this authentication connector assignment can now use this authentication connector option on the Privilege Secure log-in screen. - ![User-added image](./../0-images/ka0Qk0000003IQD_0EM4u000004bUlH.png) + ![The Privilege Secure log-in screen with the SAML authentication connector option.](./../0-images/ka0Qk0000003IQD_0EM4u000004bUlH.png) - When using the SAML log-in option, the user is redirected to sign in to Microsoft Entra ID. Upon successful authentication, the user is redirected to the Netwrix Privilege Secure UI as their now signed-in user. + When using the SAML log-in option, the user is redirected to sign in to Microsoft Entra ID. Upon successful authentication, the user is redirected to the Privilege Secure user interface (UI) as their now signed-in user. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/configuring-a-custom-radius-authentication-connector.md b/docs/kb/privilegesecure/authentication-and-mfa/configuring-a-custom-radius-authentication-connector.md index a041e4c00d..c760770566 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/configuring-a-custom-radius-authentication-connector.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/configuring-a-custom-radius-authentication-connector.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to configure a custom RADIUS Authentication Connector in Netwrix - Privilege Secure, including updating the appsettings.json to enable external - RADIUS authentication and assigning the connector to users and groups. + Configure a custom RADIUS Authentication Connector, enable external RADIUS + authentication in appsettings.json, and assign the connector to users and groups. keywords: - RADIUS - Authentication Connector @@ -13,9 +12,11 @@ keywords: - SbPAM - NPS extension products: - - privilege-secure-access-management -sidebar_label: Configuring a Custom RADIUS Authentication Connect -tags: [] + - privilegesecure +sidebar_label: Configuring a Custom RADIUS Authentication Connector +tags: + - kb + - authentication-and-mfa title: "Configuring a Custom RADIUS Authentication Connector" knowledge_article_id: kA04u000000Tt8tCAC --- @@ -23,20 +24,29 @@ knowledge_article_id: kA04u000000Tt8tCAC # Configuring a Custom RADIUS Authentication Connector ## Overview -Netwrix Privilege Secure (NPS) supports the configuration of Authentication Connectors for any RADIUS server. -> NOTE: In this article, the screenshots will illustrate how to configure an Authentication Connector for Azure MFA, but the same process generally applies. +This article describes how to configure an Authentication Connector for any RADIUS server in Netwrix Privilege Secure for Access Management. -## Before You Begin -Ensure that you have a RADIUS server installed and configured in your environment. For Azure MFA, refer to the relevant Microsoft documentation on configuring the NPS extension: https://docs.microsoft.com/en-us/azure/active-directory/authentication/howto-mfa-nps-extension. In general, refer to the appropriate product-specific documentation for your RADIUS server. +> **NOTE:** The screenshots in this article show how to configure an Authentication Connector for Azure MFA, but the same process generally applies. ## Instructions -1. In Netwrix Privilege Secure (NPS), navigate to **Configuration > Authentication**. Select the **green plus sign** to create a new Authentication Connector. -2. Provide a name for the Connector and select the **MFA** Connector Type. - ![rtaImage.jpg](./../0-images/ka0Qk000000B1aH_0EMQk000008j38P.png) -3. Click **Save**, and then configure the connector with the appropriate values for your RADIUS server. - ![rtaImage 2.jpg](./../0-images/ka0Qk000000B1aH_0EMQk000008j3Bd.png) -4. Open the **appsettings.json** file. On a default installation, it will be located in the following path: + +### Before You Begin + +Ensure that you have a RADIUS server installed and configured in your environment. For Azure MFA, see the relevant Microsoft documentation on configuring the NPS extension: https://docs.microsoft.com/en-us/azure/active-directory/authentication/howto-mfa-nps-extension. In general, see the appropriate product-specific documentation for your RADIUS server. + +### Configure the Connector + +1. In Privilege Secure, go to **Configuration > Authentication**. Select the **green plus sign** to create a new Authentication Connector. +2. Provide a name for the Connector and select the **MFA** Connector Type. + + ![Create Authentication Connector dialog with a connector name entered and the MFA Connector Type selected.](./../0-images/ka0Qk000000B1aH_0EMQk000008j38P.png) + +3. Click **Save**, and then configure the connector with the appropriate values for your RADIUS server. + + ![Authentication Connector configuration page with the RADIUS server values entered.](./../0-images/ka0Qk000000B1aH_0EMQk000008j3Bd.png) + +4. Open the **appsettings.json** file. On a default installation, the file is in the following path: ``` C:\ProgramData\Stealthbits\PAM\WebService\appsettings.json @@ -48,6 +58,6 @@ Ensure that you have a RADIUS server installed and configured in your environmen "StrictExternalAuth": "False" ``` - > NOTE: If there are other properties before the **closing }**, ensure that they are all separated by a single comma. + > **NOTE:** If there are other properties before the **closing }**, ensure that they are all separated by a single comma. -6. You may now assign the new RADIUS authentication connector to users and groups in SbPAM. +6. You can now assign the new RADIUS authentication connector to users and groups in Privilege Secure. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/disable-mfa-for-users-or-groups.md b/docs/kb/privilegesecure/authentication-and-mfa/disable-mfa-for-users-or-groups.md index 1cd7f2f23a..8263c26854 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/disable-mfa-for-users-or-groups.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/disable-mfa-for-users-or-groups.md @@ -1,40 +1,42 @@ --- description: >- - Shows how to disable Multi-factor Authentication (MFA) for individual users or - groups in Netwrix Privilege Secure. Disabling MFA is not recommended per - security best practices. + Disable Multi-factor Authentication (MFA) for individual users or groups in + Privilege Secure. Disabling MFA is not recommended per security best practices. keywords: - MFA - multi-factor authentication - disable MFA - - users - - groups - Privileged Access Management - Netwrix Privilege Secure + - Authentication Connector + - Users & Groups + - Not Required products: - - privilege-secure-access-management -sidebar_label: Disable MFA for Users or Groups -tags: [] -title: "Disable MFA for Users or Groups" + - privilegesecure +sidebar_label: Disabling MFA for Users or Groups +tags: + - kb + - authentication-and-mfa +title: "Disabling MFA for Users or Groups" knowledge_article_id: kA04u000000Pd84CAC --- -# Disable MFA for Users or Groups +# Disabling MFA for Users or Groups -## Summary +## Overview -This article outlines how to disable Multi-factor Authentication (MFA) for individual users or groups of users in Netwrix Privilege Secure. +This article describes how to disable Multi-factor Authentication (MFA) for individual users or groups of users in Netwrix Privilege Secure for Access Management. -**IMPORTANT:** *Disabling MFA is not recommended per security best practices.* +> **IMPORTANT:** Disabling MFA is not recommended per security best practices. ## Instructions -1. Log in to Netwrix Privilege Secure as an Administrator, then navigate to **Users & Groups** in the sidebar navigation. +1. Log in to Privilege Secure as an Administrator, then go to **Users & Groups** in the sidebar navigation. - ![User-added image](./../0-images/ka04u000000HdEsAAK_1.png) + ![Users & Groups selected in the Privilege Secure sidebar navigation](./../0-images/ka04u000000HdEsAAK_1.png) -2. Click on a user or a group, then navigate to that principal's **Authentication Connector** tab. +2. Click a user or a group, then go to that principal's **Authentication Connector** tab. - ![User-added image](./../0-images/ka04u000000HdEsAAK_2.png) + ![Authentication Connector tab for the selected user or group](./../0-images/ka04u000000HdEsAAK_2.png) -3. Click **Not Required**, which will immediately disable the MFA requirement for the user or all users that are a member of the group. +3. Click **Not Required**. The MFA requirement is immediately disabled for the user or for all users that are members of the group. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/how-to-configure-a-duo-radius-proxy-for-multi-factor-authentication.md b/docs/kb/privilegesecure/authentication-and-mfa/how-to-configure-a-duo-radius-proxy-for-multi-factor-authentication.md index 8f56046dc3..d367f4dfa0 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/how-to-configure-a-duo-radius-proxy-for-multi-factor-authentication.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/how-to-configure-a-duo-radius-proxy-for-multi-factor-authentication.md @@ -1,8 +1,7 @@ --- description: >- - Lists the steps to configure a Duo RADIUS proxy server as a multi-factor - authentication (MFA) provider for Netwrix Privilege Secure (NPS). Includes - required authproxy.cfg changes and the NPS configuration checks. + Configure a Duo RADIUS proxy server as an MFA provider for Privilege Secure by + editing authproxy.cfg and verifying the authentication settings. keywords: - Duo - RADIUS @@ -12,58 +11,63 @@ keywords: - authproxy.cfg - RADIUS server - multi-factor authentication + - duo_only_client + - radius_server_auto + - Duo Authentication Proxy products: - - privilege-secure-access-management -sidebar_label: How to Configure a Duo RADIUS Proxy for Multi-Fact -tags: [] -title: "How to Configure a Duo RADIUS Proxy for Multi-Factor Authentication" + - privilegesecure +sidebar_label: Configuring a Duo RADIUS Proxy for Multi-Factor Authentication +tags: + - kb + - authentication-and-mfa +title: "Configuring a Duo RADIUS Proxy for Multi-Factor Authentication" knowledge_article_id: kA04u000000LLOHCA4 --- -# How to Configure a Duo RADIUS Proxy for Multi-Factor Authentication +# Configuring a Duo RADIUS Proxy for Multi-Factor Authentication ## Overview -This article lists the steps to configure a Duo RADIUS proxy server as a multi-factor authentication (MFA) provider for Netwrix Privilege Secure (NPS). +This article describes how to configure a Duo RADIUS proxy server as a multi-factor authentication (MFA) provider for Netwrix Privilege Secure for Access Management. -> **IMPORTANT:** Privilege Secure only supports Duo as a secondary authentication provider. Password authentication is still handled by Netwrix Privilege Secure. +> **IMPORTANT:** Privilege Secure only supports Duo as a secondary authentication provider. Password authentication is still handled by Privilege Secure. ## Instructions -1. On your RADIUS server, follow the following path to open the `authproxy.cfg` file. +1. On your RADIUS server, open the `authproxy.cfg` file at the following path: -``` -%ProgramFiles%\Duo Security Authentication Proxy\conf\authproxy.cfg -``` + ``` + %ProgramFiles%\Duo Security Authentication Proxy\conf\authproxy.cfg + ``` -2. Add a `[duo_only_client]` section heading to the file and save the file. The new heading should precede the `[radius_server_auto]` section heading. See the following code block for a reference: +2. Add a `[duo_only_client]` section heading to the file and save the file. The new heading should precede the `[radius_server_auto]` section heading. See the following code block for reference: -``` -[duo_only_client] + ``` + [duo_only_client] -[radius_server_auto] -ikey=%value% -skey=%value% -api_host=%value% -radius_secret_1=testing123 -radius_ip_1=192.168.77.20 -failmode=safe -client=duo_only_client -port=1812 -``` + [radius_server_auto] + ikey=%value% + skey=%value% + api_host=%value% + radius_secret_1=testing123 + radius_ip_1=192.168.77.20 + failmode=safe + client=duo_only_client + port=1812 + ``` -> **NOTE:** Take note of values in the `[radius_server_auto]` section—these are used to configure NPS for Duo authentication. If you maintain multiple Duo configurations for applications, take note of values in `[radius_server_auto1]`, `[radius_server_auto2]`, etc. + > **NOTE:** Take note of values in the `[radius_server_auto]` section—these are used to configure Privilege Secure for Duo authentication. If you maintain multiple Duo configurations for applications, take note of values in `[radius_server_auto1]`, `[radius_server_auto2]`, etc. -3. Log in to the NPS console as a user with the Administrator role. Navigate to **Configuration** > **Authentication**. +3. Log in to the Privilege Secure console as a user with the Administrator role. Go to **Configuration** > **Authentication**. 4. Verify the following points: -- **IP**, **Remote Port**, and **Shared Secret** match the corresponding values in the `authproxy.cfg` file. -- The **Prefix for Response Text** field contains a comma. In case the PAP protocol is used, no prefix is needed. -- Both **Initial Auto-Response Text** and **Send Initial Text** features are optional. If you specify the `push` auto-response text and enable the **Send Initial Text** feature, a Duo push is automatically initiated. + - **IP**, **Remote Port**, and **Shared Secret** match the corresponding values in the `authproxy.cfg` file. + - The **Prefix for Response Text** field contains a comma. If the PAP protocol is used, no prefix is needed. + - Both **Initial Auto-Response Text** and **Send Initial Text** features are optional. If you specify the `push` auto-response text and enable the **Send Initial Text** feature, a Duo push is automatically initiated. 5. Save the changes to the configuration. -> **NOTE:** You can assign Duo as an authenticator connector for any NPS user. In the main NPS screen, click **Policy** > **Users & Groups**. Select any user and proceed to the **Authenticator Connector** tab. Select the **Duo** option. + > **NOTE:** You can assign Duo as an authenticator connector for any Privilege Secure user. In the main Privilege Secure screen, click **Policy** > **Users & Groups**. Select any user and proceed to the **Authenticator Connector** tab. Select the **Duo** option. -On their login to NPS, the configured user should both enter their password and see the multi-factor authentication prompt from Duo. During the initial login, they are asked to perform the initial Duo enrollment. +When the configured user logs in to Privilege Secure, they should both enter their password and see the multi-factor authentication prompt from Duo. During the initial login, they are asked to perform the initial Duo enrollment. diff --git a/docs/kb/privilegesecure/authentication-and-mfa/invalid-multi-factor-authentication-code-error.md b/docs/kb/privilegesecure/authentication-and-mfa/invalid-multi-factor-authentication-code-error.md index 3cc1eb0a4c..55ebd17060 100644 --- a/docs/kb/privilegesecure/authentication-and-mfa/invalid-multi-factor-authentication-code-error.md +++ b/docs/kb/privilegesecure/authentication-and-mfa/invalid-multi-factor-authentication-code-error.md @@ -1,9 +1,7 @@ --- description: >- - Users see an "Invalid MFA code" error when multi-factor authentication fails - due to a system time discrepancy between the Privilege Secure server and - clients. This article explains the symptoms, cause, and how to resolve the - issue by syncing system time. + Fix the "Invalid MFA code" login error by syncing the system time between the + Privilege Secure server and clients. keywords: - MFA - multi-factor authentication @@ -14,34 +12,34 @@ keywords: - system time - authentication error products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Invalid Multi-Factor Authentication Code Error -tags: [] +tags: + - kb + - authentication-and-mfa title: "Invalid Multi-Factor Authentication Code Error" knowledge_article_id: kA04u000000wnj6CAA --- # Invalid Multi-Factor Authentication Code Error -## Symptoms +## Symptom -- When a user attempts to log in the **Netwrix Privilege Secure** console using the multi-factor authentication code, the page refreshes. The user is prompted to provide credentials again. -- A multi-factor authentication (MFA) code is deemed invalid. Login fails with the following error prompted: +- When a user attempts to log in to the **Netwrix Privilege Secure** console using the multi-factor authentication code, the page refreshes. The user is prompted to provide credentials again. +- A multi-factor authentication (MFA) code is deemed invalid. Login fails with the following error: ``` Invalid MFA code ``` -## Causes +![Authenticator code login page showing the Invalid MFA code error](./../0-images/ka04u000000wvuC_0EM4u000008pS5A.png) + +## Cause The **Netwrix Privilege Secure** server and client have a system time discrepancy. ## Resolution -Review the system time in both NPS server and clients in your environment. +Review the system time on both the Privilege Secure server and clients in your environment. > **NOTE:** You can set the system time to sync with the OS time server automatically − in your server settings, select **Time & Language** > **Date & Time** > switch the **Set time automatically** switch on. - -## Reference - -![Capture.png](./../0-images/ka04u000000wvuC_0EM4u000008pS5A.png) diff --git a/docs/kb/privilegesecure/certificates-and-security/installing-an-iis-certificate.md b/docs/kb/privilegesecure/certificates-and-security/installing-an-iis-certificate.md index ff6366c87b..d5c5b33ef6 100644 --- a/docs/kb/privilegesecure/certificates-and-security/installing-an-iis-certificate.md +++ b/docs/kb/privilegesecure/certificates-and-security/installing-an-iis-certificate.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to install a valid certificate to the Netwrix Privilege Secure IIS - website and update related service configuration files so services use the - certificate DNS name. + Install a valid certificate on the Privilege Secure IIS website and update + service configuration files to use the certificate DNS name. keywords: - SSL certificate - IIS @@ -13,9 +12,11 @@ keywords: - FQDN - SAN products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Installing an IIS Certificate -tags: [] +tags: + - kb + - certificates-and-security title: "Installing an IIS Certificate" knowledge_article_id: kA04u000000Pd7zCAC --- @@ -23,55 +24,66 @@ knowledge_article_id: kA04u000000Pd7zCAC # Installing an IIS Certificate ## Overview -This article outlines the process of installing a valid certificate to the Netwrix Privilege Secure IIS website. -## Requirements -- The certificate should be for Client and Server Authentication and be from a trusted Certificate Authority (CA). -- The certificate needs to be in the Trusted Root on the Netwrix Privilege Secure server (with the private key), and in the Trusted Root on all clients accessing the Netwrix Privilege Secure website (without the private key). -- For High Availability (HA) deployments the certificate should have both server FQDN names in either Common Name (CN) or Subject Alternative Name (SAN) fields. +This article describes how to install a valid certificate on the Netwrix Privilege Secure for Access Management Internet Information Services (IIS) website. ## Instructions -After receiving the certificate from a CA, the bindings for the Netwrix Privilege Secure website need to be updated in **Internet Information Services (IIS) Manager** on the Netwrix Privilege Secure server. -1. Open the **IIS Manager** on the Netwrix Privilege Secure server. -2. In the left sidebar, navigate to the **Netwrix Privilege Secure Web Service** website, right-click, and click **Edit Bindings...** +### Requirements + +- The certificate should be for Client and Server Authentication and be from a trusted Certificate Authority (CA). +- The certificate must be in the Trusted Root on the Privilege Secure server (with the private key), and in the Trusted Root on all clients accessing the Privilege Secure website (without the private key). +- For High Availability (HA) deployments the certificate should have both server fully qualified domain names (FQDNs) in either Common Name (CN) or Subject Alternative Name (SAN) fields. + +### Updating the IIS Bindings + +After receiving the certificate from a CA, update the bindings for the Privilege Secure website in **Internet Information Services (IIS) Manager** on the Privilege Secure server. + +1. Open the **IIS Manager** on the Privilege Secure server. +2. In the left sidebar, go to the **Netwrix Privilege Secure Web Service** website, right-click, and click **Edit Bindings...** + + ![IIS Manager with the right-click menu on the Privilege Secure Web Service website showing Edit Bindings](./../0-images/ka04u000001172V_0EM4u000004baX1.png) + +3. Double-click **https**. +4. Select the **SSL certificate** for the DNS hostname of your Privilege Secure server (the DNS name used as the SAN in the certificate). + + ![Binding settings for https with the SSL certificate selection for the Privilege Secure server](./../0-images/ka04u000001172V_0EM4u000004baX6.png) + +After making these changes, restart the Privilege Secure website by running the `iisreset` command in an elevated Command Prompt. -![User-added image](./../0-images/ka04u000001172V_0EM4u000004baX1.png) +### Updating Service Configuration Files (Privilege Secure 3.6 or Later) -1. Double-click **https**. -2. Select the **SSL certificate** for the DNS hostname of your Netwrix Privilege Secure server (the DNS name used as the Subject Alternative Name (SAN) in the cert). +The Privilege Secure service configuration files must be updated to use the same DNS name as the certificate. You can trigger these updates from the Privilege Secure UI. -![User-added image](./../0-images/ka04u000001172V_0EM4u000004baX6.png) +1. Go to the **System Settings** menu, and then the **Services** node. -After making these changes, restart the Netwrix Privilege Secure website by running the `iisreset` command in an elevated Command Prompt. + ![System Settings Services node with the Register Services button](./../0-images/ka04u000001172V_0EM4u000004dDEz.png) -### Updating Service Configuration Files (Netwrix Privilege Secure 3.6 or later) -Netwrix Privilege Secure service configuration files will need to be updated to use the same DNS name as the certificate. These updates can be triggered via the Netwrix Privilege Secure UI. Navigate to the **System Settings** menu, and the **Services** node. +2. Enter the FQDN that matches the name of your certificate (for example, `https://yourcert.company.com:6500`). Leave **Ignore HTTPS Certificate Errors** unchecked. +3. Click the **Register Services** button. A "Services registered" pop-up appears when the necessary changes have been made. -![User-added image](./../0-images/ka04u000001172V_0EM4u000004dDEz.png) +### Updating Service Configuration Files (Privilege Secure 3.5 or Earlier) -Enter the FQDN that matches the name of your cert (e.g. `https://yourcert.company.com:6500`). Leave **Ignore HTTPS Certificate Errors** unchecked. -Click the **Register Services** button. A "Services registered" pop-up appears when the necessary changes have been made. +The Privilege Secure service configuration files must be updated to use the same DNS name as the certificate. -### Updating Service Configuration Files (Netwrix Privilege Secure 3.5 or earlier) -Netwrix Privilege Secure service configuration files will need to be updated to use the same DNS name as the certificate. The following files will need to be edited: +1. Edit the following files: -``` -C:\ProgramData\Stealthbits\PAM\ActionService\appsettings.user.json -C:\ProgramData\Stealthbits\PAM\EmailService\appsettings.user.json -C:\ProgramData\Stealthbits\PAM\ProxyService\appsettings.user.json -C:\ProgramData\Stealthbits\PAM\SchedulerService\appsettings.user.json -C:\ProgramData\Stealthbits\PAM\SIEMService\appsettings.user.json -``` + ``` + C:\ProgramData\Stealthbits\PAM\ActionService\appsettings.user.json + C:\ProgramData\Stealthbits\PAM\EmailService\appsettings.user.json + C:\ProgramData\Stealthbits\PAM\ProxyService\appsettings.user.json + C:\ProgramData\Stealthbits\PAM\SchedulerService\appsettings.user.json + C:\ProgramData\Stealthbits\PAM\SIEMService\appsettings.user.json + ``` -In each file, locate the `Url` key and change its value so it matches the DNS name used in the certificate. In the following example, `localhost` should be changed to match the aforementioned DNS name (leaving the port specification unchanged): +2. In each file, locate the `Url` key and change its value so it matches the DNS name used in the certificate. In the following example, change `localhost` to match that DNS name (leaving the port specification unchanged): -```json -"Url":"https://localhost:6500" -``` + ```json + "Url":"https://localhost:6500" + ``` -After updating each config file, verify Netwrix Privilege Secure services are running properly by navigating to the **Service Nodes** page in the Netwrix Privilege Secure Web UI. The services should be all green: +3. After updating each config file, verify the Privilege Secure services are running properly by going to the **Service Nodes** page in the Privilege Secure Web UI. The services should be all green: -![User-added image](./../0-images/ka04u000001172V_0EM4u000004baat.png) + ![Service Nodes page in the Privilege Secure Web UI with all services shown in green](./../0-images/ka04u000001172V_0EM4u000004baat.png) -If any services are red, Register Services by selecting your **username** in the top-right of the Netwrix Privilege Secure UI, click **Settings**, then click **Register Services**. +4. If any services are red, register the services: select your **username** in the top right of the Privilege Secure UI, click **Settings**, then click **Register Services**. diff --git a/docs/kb/privilegesecure/certificates-and-security/renewing-the-jwt-signing-certificate.md b/docs/kb/privilegesecure/certificates-and-security/renewing-the-jwt-signing-certificate.md index e925549aa7..dfa77e5234 100644 --- a/docs/kb/privilegesecure/certificates-and-security/renewing-the-jwt-signing-certificate.md +++ b/docs/kb/privilegesecure/certificates-and-security/renewing-the-jwt-signing-certificate.md @@ -1,9 +1,7 @@ --- description: >- - Follow these steps when instructed by Netwrix Support to regenerate Netwrix - Privilege Secure's JWT signing certificate. The procedure stops services, - removes the existing certificate and configuration, runs the key generator, - and re-registers services. + Regenerate the JWT signing certificate for Privilege Secure when instructed by + Netwrix Support, using the key generator and re-registering services. keywords: - JWT - jwtsign.pfx @@ -12,64 +10,69 @@ keywords: - appsettings.jwt.json - register services - KeyGen + - SbPAM + - Stealthbits + - IIS products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Renewing the JWT Signing Certificate -tags: [] +tags: + - kb + - certificates-and-security title: "Renewing the JWT Signing Certificate" knowledge_article_id: kA04u000000PdKtCAK --- # Renewing the JWT Signing Certificate -## Summary +## Overview -The following steps should be taken if instructed by Netwrix Support to regenerate Netwrix Privilege Secure's JWT Signing Certificate. +This article describes how to regenerate the JSON Web Token (JWT) signing certificate for Netwrix Privilege Secure for Access Management. Complete these steps only if instructed by Netwrix Support. ## Instructions -> **IMPORTANT:** While many of these steps use drive letter `C:` in the path, this will differ for Program Files paths if Privilege Secure was installed to a different drive letter. All references to `C:\ProgramData\Stealthbits\PAM` will use drive letter `C:` in all environments. +> **IMPORTANT:** While many of these steps use drive letter `C:` in the path, this differs for Program Files paths if Privilege Secure was installed to a different drive letter. All references to `C:\ProgramData\Stealthbits\PAM` use drive letter `C:` in all environments. -1. Stop all SbPAM and IIS services by running the following in an elevated PowerShell window: +1. Stop all Privilege Secure and IIS services by running the following in an elevated PowerShell window: -```powershell -Stop-Service sbpam* -Force -Stop-Service w3svc -Force -``` + ```powershell + Stop-Service sbpam* -Force + Stop-Service w3svc -Force + ``` -2. In Windows Explorer, navigate to the Program Data directory for Privilege Secure (for example, `C:\ProgramData\Stealthbits\PAM\`). From here, open the **WebService** folder, and then open `appsettings.jwt.json` in Notepad. In `appsettings.jwt.json`, locate the `"Jwt"` section (such as the following example) and delete all of it. This is the trigger to generate a new JWT Signing Certificate: +2. In Windows Explorer, go to the Program Data directory for Privilege Secure (for example, `C:\ProgramData\Stealthbits\PAM\`). From here, open the **WebService** folder, and then open `appsettings.jwt.json` in Notepad. In `appsettings.jwt.json`, locate the `"Jwt"` section (such as the following example) and delete all of it. This is the trigger to generate a new JWT signing certificate: -```json -"Jwt": { - "CertificateFile": "C:\ProgramData\Stealthbits\PAM\Web\jwtsign.pfx", - "CertificatePassword": "...", - "CertificateThumbprint": "...", - "Encryptionkey": "..." -}, -``` + ```json + "Jwt": { + "CertificateFile": "C:\ProgramData\Stealthbits\PAM\Web\jwtsign.pfx", + "CertificatePassword": "...", + "CertificateThumbprint": "...", + "Encryptionkey": "..." + }, + ``` -3. Navigate to `C:\ProgramData\Stealthbits\PAM\Web` and delete the `jwtsign.pfx` file. +3. Go to `C:\ProgramData\Stealthbits\PAM\Web` and delete the `jwtsign.pfx` file. -4. Navigate back up one level to the PAM folder, and then to the Webservice folder. Open `appsettings.log.json` in Notepad and repeat step #2 if it also has a `"jwt"` section. +4. Go back up one level to the PAM folder, and then to the Webservice folder. Open `appsettings.log.json` in Notepad and repeat step 2 if it also has a `"jwt"` section. 5. Run the following commands in an elevated PowerShell window (changing the path to the PAM folder depending on the install path): -```powershell -cd C:\Program Files\Stealthbits\PAM\KeyGen -& .\SbPAM.KeyGen.Exe -``` + ```powershell + cd C:\Program Files\Stealthbits\PAM\KeyGen + & .\SbPAM.KeyGen.Exe + ``` -6. Open `appsettings.jwt.json` again from step #2, and verify the `"Jwt"` section has been recreated. +6. Open `appsettings.jwt.json` again from step 2, and verify the `"Jwt"` section has been recreated. 7. Start all Privilege Secure and IIS services by running the following in an elevated PowerShell window: -```powershell -Start-Service sbpam* -Start-Service w3svc -``` + ```powershell + Start-Service sbpam* + Start-Service w3svc + ``` -8. Log in to the Privilege Secure web application as an Admin, and re-register services by clicking the logged-in user's name in the upper-right, clicking **Settings**, and then clicking **Register Services**. +8. Log in to the Privilege Secure web application as an Admin, and re-register services. Click the logged-in user's name in the upper-right, click **Settings**, and then click **Register Services**. -![The SbPAM web application interface's user settings menu dropdown.](./../0-images/ka04u000000wvts_0EM4u000004bjDZ.png) + ![The Privilege Secure web application user settings menu dropdown.](./../0-images/ka04u000000wvts_0EM4u000004bjDZ.png) -![The SbPAM web application interface's settings page, displaying the Register Services button.](./../0-images/ka04u000000wvts_0EM4u000004bjDe.png) + ![The Privilege Secure web application settings page, displaying the Register Services button.](./../0-images/ka04u000000wvts_0EM4u000004bjDe.png) diff --git a/docs/kb/privilegesecure/certificates-and-security/security-considerations-non-domain-joined-netwrix-privilege-secure-server.md b/docs/kb/privilegesecure/certificates-and-security/security-considerations-non-domain-joined-netwrix-privilege-secure-server.md index fbffc480d0..4959094f1e 100644 --- a/docs/kb/privilegesecure/certificates-and-security/security-considerations-non-domain-joined-netwrix-privilege-secure-server.md +++ b/docs/kb/privilegesecure/certificates-and-security/security-considerations-non-domain-joined-netwrix-privilege-secure-server.md @@ -1,9 +1,10 @@ --- description: >- - Explains why Netwrix recommends that Netwrix Privilege Secure servers not be - joined to a managed domain and outlines the associated security risks. + Explains why Netwrix recommends not joining Privilege Secure servers to a + managed domain and lists the security risks of doing so. keywords: - Netwrix Privilege Secure + - NPS - PAM - domain-joined - non-domain-joined @@ -13,9 +14,11 @@ keywords: - audit trail - security best practices products: - - privilege-secure-access-management -sidebar_label: 'Security Considerations: Non-Domain-Joined Netwrix' -tags: [] + - privilegesecure +sidebar_label: 'Security Considerations: Non-Domain-Joined Netwrix Privilege Secure Server' +tags: + - kb + - certificates-and-security title: 'Security Considerations: Non-Domain-Joined Netwrix Privilege Secure Server' knowledge_article_id: kA04u000000wnksCAA --- @@ -24,14 +27,14 @@ knowledge_article_id: kA04u000000wnksCAA ## Question -What is the reasoning behind the recommendation in the Server Requirements that Netwrix Privilege Secure (NPS) servers not be joined to a managed domain? +What is the reasoning behind the recommendation in the Server Requirements that Netwrix Privilege Secure for Access Management servers not be joined to a managed domain? ## Answer -Netwrix recommends considering standard PAM security cogitations when deploying NPS. NPS instances should be installed on standalone servers that are hardened and have limited access rights. +Netwrix recommends considering standard privileged access management (PAM) security cogitations when deploying Privilege Secure. Install Privilege Secure instances on standalone servers that are hardened and have limited access rights. -The following risks are posed by joining NPS to a domain: +Joining Privilege Secure to a domain poses the following risks: -1. A domain-joined server can have its security compromised through group policy controls, as policy inheritance may not be blocked for the server. -2. If a privileged domain account is compromised, the NPS server is then a potential target for lateral movement attacks. -3. A key use case of NPS is to provide dynamic domain administrator access to users. If a user is provided with domain administrator privileges, the user would then have domain administrator access to the NPS server. This would allow for malicious actions that would compromise the security of the NPS Server, up to and including tampering with the audit trail after performing malicious actions. +- A domain-joined server can have its security compromised through group policy controls, as policy inheritance may not be blocked for the server. +- If a privileged domain account is compromised, the Privilege Secure server is then a potential target for lateral movement attacks. +- A key use case of Privilege Secure is to provide dynamic domain administrator access to users. If a user is provided with domain administrator privileges, the user would then have domain administrator access to the Privilege Secure server. This would allow for malicious actions that would compromise the security of the Privilege Secure server, up to and including tampering with the audit trail after performing malicious actions. diff --git a/docs/kb/privilegesecure/certificates-and-security/speeding-up-crl-checks-on-sbpam-servers-without-internet-connectivity.md b/docs/kb/privilegesecure/certificates-and-security/speeding-up-crl-checks-on-sbpam-servers-without-internet-connectivity.md index 1253f1f39f..830f65c4b7 100644 --- a/docs/kb/privilegesecure/certificates-and-security/speeding-up-crl-checks-on-sbpam-servers-without-internet-connectivity.md +++ b/docs/kb/privilegesecure/certificates-and-security/speeding-up-crl-checks-on-sbpam-servers-without-internet-connectivity.md @@ -1,9 +1,7 @@ --- description: >- - If Netwrix Privilege Secure or its proxy runs on a server without internet - connectivity, the proxy may fail SSL handshakes due to CRL checks. This - article explains how to reduce the Windows CRL retrieval timeout via Group - Policy to avoid those failures. + Reduce the Windows CRL retrieval timeout through Group Policy so proxy SSL + handshakes do not fail on servers without internet connectivity. keywords: - CRL - certificate revocation @@ -11,36 +9,50 @@ keywords: - group policy - gpedit.msc - Netwrix Privilege Secure + - SbPAM - SSL handshake + - TLS Authentication error - proxy - Certificate Path Validation products: - - privilege-secure-access-management -sidebar_label: Speeding up CRL Checks on SbPAM Servers without In -tags: [] -title: "Speeding up CRL Checks on Netwrix Privilege Secure Servers without Internet Connectivity" + - privilegesecure +sidebar_label: "Speeding Up CRL Checks on Netwrix Privilege Secure Servers without Internet Connectivity" +tags: + - kb + - certificates-and-security +title: "Speeding Up CRL Checks on Netwrix Privilege Secure Servers without Internet Connectivity" knowledge_article_id: kA04u000000Tt7vCAC --- -# Speeding up CRL Checks on Netwrix Privilege Secure Servers without Internet Connectivity +# Speeding Up CRL Checks on Netwrix Privilege Secure Servers without Internet Connectivity -## Summary -If Netwrix Privilege Secure, or a Netwrix Privilege Secure proxy service, is installed on a server without internet connectivity, the proxy may be unable to initiate SSL handshakes. The following error message when registering a proxy service is indicative of this problem: +## Overview + +This article describes how to reduce the Windows timeout setting that governs certificate revocation list (CRL) checks, using Group Policy. + +If Netwrix Privilege Secure for Access Management, or a Privilege Secure proxy service, is installed on a server without internet connectivity, the proxy may be unable to initiate SSL handshakes. The following error message when you register a proxy service indicates this problem: ```text TLS Authentication error One or more errors occurred. (Unable to read data from the transport connection: An established connection was aborted by the software in your host machine.) ``` -You can resolve this issue by reducing the timeout setting in Windows that governs CRL (certificate revocation list) checks. Because these CRL checks require internet access, set the timeout to the minimum possible value when internet connectivity is not present. +You can resolve this issue by reducing the timeout setting in Windows that governs CRL checks. Because these CRL checks require internet access, set the timeout to the minimum possible value when internet connectivity is not present. ## Instructions -This timeout setting is governed by a Group Policy. The following steps allow you to configure it: + +This timeout setting is governed by a Group Policy. Complete the following steps to configure it: 1. Open Group Policy Editor: `gpedit.msc` -2. Navigate to `Computer Configuration > Windows Settings > Security Settings > Public Key Policies` - ![User-added image](./../0-images/ka04u000000HdFp_0EM4u0000052lrQ.png) -3. Double-click on **Certificate Path Validation Settings** and go to the **Network Retrieval** tab. - ![User-added image](./../0-images/ka04u000000HdFp_0EM4u0000052lrf.png) -4. Check the **Define these policy settings** box, and reduce both **Default retrieval timeout settings** to `1`. - ![User-added image](./../0-images/ka04u000000HdFp_0EM4u0000052lrk.png) +2. Go to `Computer Configuration > Windows Settings > Security Settings > Public Key Policies` + + ![Public Key Policies folder in Group Policy Editor](./../0-images/ka04u000000HdFp_0EM4u0000052lrQ.png) + +3. Double-click **Certificate Path Validation Settings** and go to the **Network Retrieval** tab. + + ![Network Retrieval tab of the Certificate Path Validation Settings dialog](./../0-images/ka04u000000HdFp_0EM4u0000052lrf.png) + +4. Check the **Define these policy settings** box, and reduce both **Default retrieval timeout settings** to `1`. + + ![Define these policy settings checked with both Default retrieval timeout settings reduced](./../0-images/ka04u000000HdFp_0EM4u0000052lrk.png) + 5. Click **Apply** to save the configuration. diff --git a/docs/kb/privilegesecure/certificates-and-security/understanding-the-microsoft-kb5082142-rc4-to-aes-encryption-change.md b/docs/kb/privilegesecure/certificates-and-security/understanding-the-microsoft-kb5082142-rc4-to-aes-encryption-change.md index bbeac34655..87254667d2 100644 --- a/docs/kb/privilegesecure/certificates-and-security/understanding-the-microsoft-kb5082142-rc4-to-aes-encryption-change.md +++ b/docs/kb/privilegesecure/certificates-and-security/understanding-the-microsoft-kb5082142-rc4-to-aes-encryption-change.md @@ -17,7 +17,9 @@ keywords: products: - privilegesecure sidebar_label: Understanding the Microsoft KB5082142 RC4-to-AES Encryption Change -tags: [kb] +tags: + - kb + - certificates-and-security title: "Understanding the Microsoft KB5082142 RC4-to-AES Encryption Change" knowledge_article_id: --- @@ -52,4 +54,4 @@ Despite this, a subset of accounts and devices can still end up without a usable - **Legacy or third-party devices that only support RC4.** Some non-Windows Kerberos clients—older network appliances, embedded devices, older Unix/Linux Kerberos implementations, and similar hardware—were never built with AES-SHA1 support. These devices structurally cannot generate or use an AES key, regardless of password rotation, and need an explicit exception or a hardware/software upgrade path. -If you use Netwrix Privilege Secure for Access Management (NPS-AM) and are troubleshooting an authentication issue after installing this update, see [NPS-AM Authentication Failures After Microsoft KB5082142](/docs/kb/privilegesecure/troubleshooting-and-errors/netwrix-privilege-secure-authentication-failures-after-microsoft-kb5082142). +If you use Netwrix Privilege Secure for Access Management and are troubleshooting an authentication issue after installing this update, see [Error: NPS-AM Authentication Failures After Microsoft KB5082142](/docs/kb/privilegesecure/troubleshooting-and-errors/netwrix-privilege-secure-authentication-failures-after-microsoft-kb5082142). diff --git a/docs/kb/privilegesecure/client-tools-and-integrations/add-vmware-vcenter-website-to-browser-extension.md b/docs/kb/privilegesecure/client-tools-and-integrations/add-vmware-vcenter-website-to-browser-extension.md index dc105e01d9..9016e79d4a 100644 --- a/docs/kb/privilegesecure/client-tools-and-integrations/add-vmware-vcenter-website-to-browser-extension.md +++ b/docs/kb/privilegesecure/client-tools-and-integrations/add-vmware-vcenter-website-to-browser-extension.md @@ -1,9 +1,5 @@ --- -description: >- - This article outlines the process of adding a VMware vCenter web application - to Netwrix Privilege Secure's Browser Extension for quick and easy session - provisioning. It covers creating an Activity, a Website Resource, and an - Access Policy to enable vSphere session launches from the extension. +description: "Add a VMware vCenter website to the Privilege Secure Browser Extension by creating an Activity, a Website Resource, and an Access Policy." keywords: - vCenter - VMware @@ -16,31 +12,33 @@ keywords: - session provisioning - Active Directory products: - - privilege-secure-access-management -sidebar_label: Add VMware vCenter website to Browser Extension -tags: [] -title: "Add VMware vCenter website to Browser Extension" + - privilegesecure +sidebar_label: Adding a VMware vCenter Website to Browser Extension +tags: + - kb + - client-tools-and-integrations +title: "Adding a VMware vCenter Website to Browser Extension" knowledge_article_id: kA04u0000000HRMCA2 --- -# Add VMware vCenter website to Browser Extension +# Adding a VMware vCenter Website to Browser Extension -## Summary +## Overview -This article outlines the process of adding a VMware vCenter web application (website) to Netwrix Privilege Secure's Browser Extension, for quick and easy session provisioning. +This article describes how to add a VMware vCenter web application (website) to the Netwrix Privilege Secure for Access Management Browser Extension for quick and easy session provisioning. ## Instructions -1. **Create a VMware vCenter website Activity** (be sure to enter the URL normally used to log-in to vCenter, and any Active Directory (AD) group that would give the account permission to log-in). Note that this example is for an **Activity Token**, however **Managed Account** and **Requester** workflows are also supported. +1. **Create a VMware vCenter website Activity**. Enter the URL normally used to log in to vCenter and any Active Directory (AD) group that gives the account permission to log in. - ![User-added image](./../0-images/ka04u000000HcZr_0EM4u000004bUlM.png) + > **NOTE:** This example is for an **Activity Token**. **Managed Account** and **Requester** workflows are also supported. -2. **Create a Website Resource**. Enter the URL for vCenter, and also (if possible) choose a resource that is in the same AD domain as the vSphere host. This is to ensure that when an account is created and group permissions are granted to it, it will happen on a Domain Controller (DC) close to where vSphere would normally authenticate to. This prevents needing to wait for permissions to replicate when logging-in to vSphere. + ![Activity page for the VMware vCenter website with the vCenter URL and AD group](./../0-images/ka04u000000HcZr_0EM4u000004bUlM.png) - ![User-added image](./../0-images/ka04u000000HcZr_0EM4u000004bUlR.png) +2. **Create a Website Resource**. Enter the URL for vCenter and, if possible, choose a resource that is in the same AD domain as the vSphere host. This ensures that when an account is created and group permissions are granted to it, this happens on a Domain Controller (DC) close to where vSphere would normally authenticate to. This prevents needing to wait for permissions to replicate when logging in to vSphere. -3. **Create an Access Policy** that links a user to the vSphere Activity and the Website Resource. + ![Website Resource page with the vCenter URL and a resource in the same AD domain](./../0-images/ka04u000000HcZr_0EM4u000004bUlR.png) - ![User-added image](./../0-images/ka04u000000HcZr_0EM4u000004bUlW.png) +3. **Create an Access Policy** that links a user to the vSphere Activity and the Website Resource. There should now be a vSphere activity in the Privilege Secure Browser Extension, with the ability to select it to create a session (click once) and then launch vSphere (click again). -4. There should now be a vSphere activity in the Netwrix Privilege Secure Browser Extension, with the ability to select it to create a session (click once) and then launch vSphere (click again). + ![Access Policy page linking a user to the vSphere Activity and the Website Resource](./../0-images/ka04u000000HcZr_0EM4u000004bUlW.png) diff --git a/docs/kb/privilegesecure/client-tools-and-integrations/enable-session-extension-countdown-tab-display-for-sbpam-ssh-sessions-in-mobaxterm.md b/docs/kb/privilegesecure/client-tools-and-integrations/enable-session-extension-countdown-tab-display-for-sbpam-ssh-sessions-in-mobaxterm.md index 0e7bc9a17e..b33f5817b3 100644 --- a/docs/kb/privilegesecure/client-tools-and-integrations/enable-session-extension-countdown-tab-display-for-sbpam-ssh-sessions-in-mobaxterm.md +++ b/docs/kb/privilegesecure/client-tools-and-integrations/enable-session-extension-countdown-tab-display-for-sbpam-ssh-sessions-in-mobaxterm.md @@ -1,9 +1,7 @@ --- description: >- - Netwrix Privilege Secure’s SSH Session Extension countdown may not appear in - the MobaXTerm tab bar unless the session's Lock terminal title option is - disabled. This article shows how to disable the option in MobaXTerm Bookmark - Settings so the countdown displays in the session tab. + Disable the Lock terminal title option in MobaXTerm Bookmark Settings so the + SSH Session Extension countdown displays in the session tab. keywords: - Netwrix Privilege Secure - MobaXTerm @@ -15,30 +13,32 @@ keywords: - Connection Profile - Access Profile products: - - privilege-secure-access-management -sidebar_label: Enable Session Extension Countdown Tab Display for -tags: [] -title: "Enable Session Extension Countdown Tab Display for Netwrix Privilege Secure SSH Sessions in MobaXTerm" + - privilegesecure +sidebar_label: Enabling Session Extension Countdown Tab Display for Netwrix Privilege Secure SSH Sessions in MobaXTerm +tags: + - kb + - client-tools-and-integrations +title: "Enabling Session Extension Countdown Tab Display for Netwrix Privilege Secure SSH Sessions in MobaXTerm" knowledge_article_id: kA04u0000000HRbCAM --- -# Enable Session Extension Countdown Tab Display for Netwrix Privilege Secure SSH Sessions in MobaXTerm +# Enabling Session Extension Countdown Tab Display for Netwrix Privilege Secure SSH Sessions in MobaXTerm -## Summary +## Overview -Netwrix Privilege Secure’s SSH Session Extension countdown does not display in the MobaXTerm tab bar unless a specific option has been disabled in the MobaXTerm session’s **Bookmark Settings**. +This article describes how to display the Netwrix Privilege Secure for Access Management SSH Session Extension countdown in the MobaXTerm tab bar. The countdown does not display unless the **"Lock terminal title"** setting is disabled in the MobaXTerm session’s **Bookmark Settings**. ## Instructions -As shown in the following screenshot, the SSH session’s **"Lock terminal title"** setting should be disabled in the session’s **Bookmark Settings** within MobaXTerm. +Disable the SSH session’s **"Lock terminal title"** setting in the session’s **Bookmark Settings** within MobaXTerm, as shown in the following screenshot. 1. In MobaXTerm, right-click the session in the **Sessions** sidebar. 2. Click **Edit Settings**. -3. Navigate to **Bookmark Settings**. +3. Go to **Bookmark Settings**. 4. Disable the **"Lock terminal title"** setting. -![User-added image](./../0-images/ka04u000000HcZt_0EM4u000004bUnw.png) + ![MobaXTerm Bookmark Settings with the Lock terminal title setting disabled](./../0-images/ka04u000000HcZt_0EM4u000004bUnw.png) -If configured correctly, the session tab displays session expiration countdown messages per the settings in the Netwrix Privilege Secure Connection Profile assigned to the Access Profile granting the user the right to use the SSH Activity. +If configured correctly, the session tab displays session expiration countdown messages per the settings in the Privilege Secure Connection Profile assigned to the Access Profile granting the user the right to use the SSH Activity. -![User-added image](./../0-images/ka04u000000HcZt_0EM4u000004bUo1.png) +![MobaXTerm session tab displaying the session expiration countdown message](./../0-images/ka04u000000HcZt_0EM4u000004bUo1.png) diff --git a/docs/kb/privilegesecure/client-tools-and-integrations/integrating-privilege-secure-for-access-management-with-auditor.md b/docs/kb/privilegesecure/client-tools-and-integrations/integrating-privilege-secure-for-access-management-with-auditor.md index dcabfa7f82..d01e4d8cf8 100644 --- a/docs/kb/privilegesecure/client-tools-and-integrations/integrating-privilege-secure-for-access-management-with-auditor.md +++ b/docs/kb/privilegesecure/client-tools-and-integrations/integrating-privilege-secure-for-access-management-with-auditor.md @@ -1,9 +1,7 @@ --- description: >- - This article explains how to integrate Netwrix Privilege Secure for Access - Management with Netwrix Auditor, covering certificate export, connection - profile and policy configuration, and enabling the integration in monitoring - plans. + Integrate Privilege Secure with Netwrix Auditor by exporting the certificate, + creating a connection profile and policy, and enabling it in monitoring plans. keywords: - Netwrix Privilege Secure - Netwrix Auditor @@ -14,44 +12,47 @@ keywords: - resource-based - credential-based - monitoring plan + - API key products: + - privilegesecure - auditor - - privilege-secure-access-management -sidebar_label: Integrating Privilege Secure for Access Management -tags: [] +sidebar_label: "Integrating Privilege Secure for Access Management with Auditor" +tags: + - kb + - client-tools-and-integrations title: "Integrating Privilege Secure for Access Management with Auditor" knowledge_article_id: kA0Qk0000002WwfKAE --- -# Integrating Netwrix Privilege Secure for Access Management with Netwrix Auditor +# Integrating Privilege Secure for Access Management with Auditor ## Overview -This guide describes the steps to set up Netwrix Privilege Secure for Access Management integration in Netwrix Auditor. The guide is split into sections to segment the setup process. Refer to the corresponding section to learn more about the required steps. +This article describes how to set up the Netwrix Privilege Secure for Access Management integration in Netwrix Auditor. The article is split into sections to segment the setup process. See the corresponding section for the required steps. ## Instructions ### Perform the Initial Setup in Netwrix Auditor 1. In the main Netwrix Auditor menu, go to **Settings** > **Privilege Secure**. If this is the first time you are setting up the integration, click the **Set Up Integration** button. -2. Specify the Netwrix Privilege Secure for Access Management server name or the IP address with the corresponding port, and click **Next**. (E.g., with the default 6500 port: - `https://contoso-nps:6500/`) -3. If the Netwrix Privilege Secure for Access Management server certificate is untrusted on the Netwrix Auditor host, select the **I want Auditor to trust this certificate when connecting to this server** checkbox and click **Next**. +2. Specify the Privilege Secure server name or the IP address with the corresponding port, and click **Next**. For example, with the default 6500 port: + `https://contoso-nps:6500/` +3. If the Privilege Secure server certificate is untrusted on the Netwrix Auditor host, select the **I want Auditor to trust this certificate when connecting to this server** checkbox and click **Next**. 4. Take note of the application name. You can keep the default name or change it. This article uses the default **NetwrixAuditor** name. > **NOTE:** It is not recommended to use a space in the application name, as this may lead to incorrect operation when using Microsoft Entra ID. 5. In the **Specify the client certificate** section, select **Generate new certificate** and click **Next**. -6. Export the Netwrix Auditor Privilege Secure for Access Management client certificate to the Netwrix Privilege Secure for Access Management server. Refer to the steps in the **Export the Certificate to Privilege Secure for Access Management Server** section. -7. In the **Dashboard** tab of Netwrix Privilege Secure for Access Management, click **Users** > **Add** > **New Application User**. +6. Export the Netwrix Auditor Privilege Secure for Access Management client certificate to the Privilege Secure server. See the [**Export the Certificate to Privilege Secure for Access Management Server**](#export-the-certificate-to-privilege-secure-for-access-management-server) section. +7. In the **Dashboard** tab of Privilege Secure, click **Users** > **Add** > **New Application User**. 8. Specify the application name to match the application name stated in Netwrix Auditor. The default name is **NetwrixAuditor**. 9. Copy the certificate serial number value from your Netwrix Auditor server. Click **Save**. -10. Once you save the details, Netwrix Privilege Secure for Access Management generates an API key. Reveal the key, copy the value, and paste it in the **API key** field in the Privilege Secure Integration window of your Netwrix Auditor server. +10. After you save the details, Privilege Secure generates an API key. Reveal the key, copy the value, and paste it in the **API key** field in the Privilege Secure Integration window of your Netwrix Auditor server. 11. In the Netwrix Auditor server, click **Next** > **Finish** to complete the initial setup. ### Export the Certificate to Privilege Secure for Access Management Server -1. On the Netwrix Auditor server, start the Microsoft Management Console—press **Windows + R**, type **mmc**, and click **OK**. +1. On the Netwrix Auditor server, start the Microsoft Management Console—press **Windows + R**, enter **mmc**, and click **OK**. 2. Go to **File** > **Add/Remove Snap-in...** 3. In the left pane, locate the **Certificates** snap-in, highlight it, and click **Add >**. 4. In the pop-up windows, select **Computer account** > **Next** > **Local computer** > **Finish**. @@ -61,66 +62,62 @@ This guide describes the steps to set up Netwrix Privilege Secure for Access Man 8. In the Export Wizard, click **Next** > **No, do not export the private key** > **Next** > **DER encoded binary** > **Next**. 9. Specify the target location and name the certificate. Click **Next**, then click **Finish**. 10. A message to confirm the successful export should appear. Confirm the export by reviewing the target location. -11. Copy the exported certificate to the Netwrix Privilege Secure for Access Management server. -12. On the Netwrix Privilege Secure for Access Management server, right-click the certificate and select **Install**. +11. Copy the exported certificate to the Privilege Secure server. +12. On the Privilege Secure server, right-click the certificate and select **Install**. 13. Select **Local machine** > **Next** > **Place all certificates in the following store:** > **Trusted Root Certification Authorities** > **Next** > **Finish**. A message to confirm the successful import should appear. ### Create a Connection Profile > **NOTE:** Both credential-based and resource-based integrations require a connection profile. The steps to set up a connection profile are the same for both types of integration. -1. In Netwrix Privilege Secure for Access Management, select the **Policy** tab and go to **Access Policy** > **Connection Profiles** in the left pane. -2. Click the plus icon to add a new connection profile. For the generic workflow, refer to the following article: [Connection Profiles Page](https://docs.netwrix.com/docs/privilegesecure/26_03/admin/accesspolicy/connectionprofiles). +1. In Privilege Secure, select the **Policy** tab and go to **Access Policy** > **Connection Profiles** in the left pane. +2. Click the plus icon to add a new connection profile. For the generic workflow, see [Connection Profiles Page](https://docs.netwrix.com/docs/privilegesecure/26_07/configuration/access-policies/connection-profiles). 3. Name the connection profile to distinguish it from other non-integration-related connection profiles. -4. Refer to the required connection profile settings: +4. Set the following required connection profile settings: - Allow Proxy Auto-connect = True - Record Proxy Session = True - - Session Control - - Max Duration = 60 - - Session End Notification = 5 - - Enable Session Extension = False - - Monitor for Logon = False - - Leave Existing Members in Group = True - - Validate Users for SSH Sessions = False - - Require Notes for Sessions = False - - Require Ticket Number for Sessions = False - - Credential Management - - Allow User to Access Password = True - - Enable credential auto-fill in browser extension = False - - Enable `Show Password` option in user interface and browser extension = False - - View Password Timeout = 20 - - Website - - Clear Website Data Before Start = True - - Clear Website Data After Stop = True - - Record Session Audio = True - + - **Session Control** + - Max Duration = 60 + - Session End Notification = 5 + - Enable Session Extension = False + - Monitor for Logon = False + - Leave Existing Members in Group = True + - Validate Users for SSH Sessions = False + - Require Notes for Sessions = False + - Require Ticket Number for Sessions = False + - **Credential Management** + - Allow User to Access Password = True + - Enable credential auto-fill in browser extension = False + - Enable `Show Password` option in user interface and browser extension = False + - View Password Timeout = 20 + - **Website** + - Clear Website Data Before Start = True + - Clear Website Data After Stop = True + - Record Session Audio = True - Approval Workflow = Automatic 5. Click **Save** to save the profile settings. -### Setting Up the Resource-based Policy for Integration +### Setting Up the Resource-Based Policy for Integration The resource-based type of the integration requires the following items: - Activity - Resource -Refer to the following subsections for information on required steps. +See the following subsections for the required steps. #### Create an Activity -1. In Netwrix Privilege Secure for Access Management, select the **Policy** tab and go to **Activities** in the left pane. -2. Click the plus icon to add a new activity. For the generic workflow, refer to the following article: [My Activities Page](https://docs.netwrix.com/docs/privilegesecure/4_2/revieweruser/myactivities/). -3. Specify the activity name. This article uses the **Netwrix Auditor Domain Admin** name. Refer to the required activity settings: +1. In Privilege Secure, select the **Policy** tab and go to **Activities** in the left pane. +2. Click the plus icon to add a new activity. For the generic workflow, see [My Activities Page](https://docs.netwrix.com/docs/privilegesecure/26_07/user-guide/my-activities). +3. Specify the activity name. This article uses the **Netwrix Auditor Domain Admin** name. Set the following required activity settings: - Platform = Active Directory - Login Account = Activity Token - Activity Type = Interactive - Login Account Template = ` %targetDomain%\%samAccountName% ` 4. Click **Save** to save the changes. 5. Add an action to the pre-session—click the plus sign next to the **Pre-Session (Grant)** section. -6. Refer to the required pre-session action settings: +6. Set the following required pre-session action settings: - Action Type = Add User to Domain Group - Domain = `%target_domain%` - Group = Domain Admins @@ -131,29 +128,29 @@ Refer to the following subsections for information on required steps. #### Create a Resource -1. In Netwrix Privilege Secure for Access Management, select the **Policy** tab and go to **Resources** in the left pane. +1. In Privilege Secure, select the **Policy** tab and go to **Resources** in the left pane. 2. Click **Add** and select **New Server**. Select **Import from AD** and select the target domain controller. > **NOTE:** In environments with multiple domain controllers, select the primary domain controller. 3. In the bottom right corner, select the service account, and click **Add**. -#### Create a Resource-based Access Policy +#### Create a Resource-Based Access Policy -1. In Netwrix Privilege Secure for Access Management, select the **Policy** tab and go to **Access Policy** in the left pane. -2. Click the plus icon to add a new access policy. For the generic workflow, refer to the following article: [Access Policy Page](https://docs.netwrix.com/docs/privilegesecure/26_03/admin/accesspolicy). -3. Introduce a policy name. +1. In Privilege Secure, select the **Policy** tab and go to **Access Policy** in the left pane. +2. Click the plus icon to add a new access policy. For the generic workflow, see [Access Policy Page](https://docs.netwrix.com/docs/privilegesecure/26_07/configuration/access-policies/overview). +3. Enter a policy name. 4. Verify the **Type** value is **Resource Based**. Select the dedicated connection profile and click **Save**. 5. Select the **Users** tab and click **Add** to add a user. Select the application user (**NetwrixAuditor** by default) and click **Add**. 6. Select the **Activities** tab and click **Add** to add an activity. Select the **Netwrix Auditor Domain Admin** activity and click **Add**. 7. Select the **Resources** tab and click **Add** to add a resource to manage. Select the target resources and click **Add**. -### Setting Up Credential-based Policy for Integration +### Setting Up the Credential-Based Policy for Integration -1. Specify the account for Netwrix Privilege Secure for Access Management to control—in the **Dashboard** tab, select the **Credentials** section and locate the target domain account. +1. Specify the account for Privilege Secure to control—in the **Dashboard** tab, select the **Credentials** section and locate the target domain account. 2. Select the corresponding checkbox and click **Manage**. Click **Automatic**. -3. In the **Policy** tab, select the **Access Policy** menu in the left pane. Click the plus icon to add a new access policy. For the generic workflow, refer to the following article: [Access Policy Page](https://docs.netwrix.com/docs/privilegesecure/26_03/admin/accesspolicy). -4. Introduce a policy name. +3. In the **Policy** tab, select the **Access Policy** menu in the left pane. Click the plus icon to add a new access policy. For the generic workflow, see [Access Policy Page](https://docs.netwrix.com/docs/privilegesecure/26_07/configuration/access-policies/overview). +4. Enter a policy name. 5. Verify the **Type** value is **Credential Based**. Select the appropriate dedicated connection profile and click **Save**. 6. Select the **Users** tab and click **Add** to add a user. Select the application user (**NetwrixAuditor** by default) and click **Add**. 7. Select the **Credentials** tab and click **Add** to add the managed account. Select the managed account and click **Add**. @@ -166,12 +163,12 @@ Refer to the following subsections for information on required steps. 4. For a credential-based policy, specify the user name of the user account for collecting data. 5. For a resource-based policy, specify the activity name and the resource name in the corresponding fields. - > **IMPORTANT:** Specify the names as stated in Netwrix Privilege Secure for Access Management. + > **IMPORTANT:** Specify the names as stated in Privilege Secure. 6. Click **Save & Close**. ## Related Links -- [My Activities Page](https://docs.netwrix.com/docs/privilegesecure/4_2/revieweruser/myactivities/) -- [Connection Profiles Page](https://docs.netwrix.com/docs/privilegesecure/26_03/admin/accesspolicy/connectionprofiles) -- [Access Policy Page](https://docs.netwrix.com/docs/privilegesecure/26_03/admin/accesspolicy) +- [My Activities Page](https://docs.netwrix.com/docs/privilegesecure/26_07/user-guide/my-activities) +- [Connection Profiles Page](https://docs.netwrix.com/docs/privilegesecure/26_07/configuration/access-policies/connection-profiles) +- [Access Policy Page](https://docs.netwrix.com/docs/privilegesecure/26_07/configuration/access-policies/overview) diff --git a/docs/kb/privilegesecure/client-tools-and-integrations/invoking-desktop-ssh-client-automatically.md b/docs/kb/privilegesecure/client-tools-and-integrations/invoking-desktop-ssh-client-automatically.md index 43b0b5eaa8..3c69f63c42 100644 --- a/docs/kb/privilegesecure/client-tools-and-integrations/invoking-desktop-ssh-client-automatically.md +++ b/docs/kb/privilegesecure/client-tools-and-integrations/invoking-desktop-ssh-client-automatically.md @@ -10,11 +10,16 @@ keywords: - PuTTY - protocol handler - Windows + - registry + - Extras folder + - NPS-AM products: - - privilege-secure-access-management + - privilegesecure visibility: public sidebar_label: Invoking Desktop SSH Client Automatically -tags: [] +tags: + - kb + - client-tools-and-integrations title: "Invoking Desktop SSH Client Automatically" knowledge_article_id: kA04u0000004n11CAA --- @@ -23,35 +28,31 @@ knowledge_article_id: kA04u0000004n11CAA ## Overview -To automatically invoke a local SSH client for sessions, you need to register a URL handler on your desktop. This article provides step-by-step instructions to configure this handler using `sbpam-url`. +This article describes how to register a URL handler on your desktop using `sbpam-url` so that a local SSH client is invoked automatically for sessions. ## Instructions -> **IMPORTANT:** Do not move the command file after registering it. The registry entry points to the file's original location and will break if the file is moved. +> **IMPORTANT:** Do not move the command file after registering it. The registry entry points to the file's original location and breaks if the file is moved. -1. To register a URL handler on your desktop, locate `sbpam-url.exe` in the **Extras** folder of the full NPS-AM download and copy it to a permanent folder on your file system. +1. To register a URL handler on your desktop, locate `sbpam-url.exe` in the **Extras** folder of the full Netwrix Privilege Secure for Access Management download and copy it to a permanent folder on your file system. - For example, `C:\Tools\sbpam-url\`. Avoid temporary or user-managed locations such as `Desktop` or `Downloads`. ![sbpam-url.exe in the NPS-AM Extras folder](./../0-images/ka0Qk000000E5z7_extras-folder.png) - > **NOTE:** The **Extras** folder also includes batch files with known configurations for popular SSH clients. For information about the full NPS-AM package and its contents, see [Privilege Secure Components](https://docs.netwrix.com/docs/privilegesecure/25_12/install/components). + > **NOTE:** The **Extras** folder also includes batch files with known configurations for popular SSH clients. For information about the full Privilege Secure for Access Management package and its contents, see [Privilege Secure Components](https://docs.netwrix.com/docs/privilegesecure/26_07/install/components). 2. Ensure that your preferred SSH app (for example, PuTTY) is installed and note its installation location. -3. Right-click the Windows command file corresponding to the application you wish to register. Ensure that it is configured with the correct installation directory you noted in the previous step. If it is not, edit the file with the correct path and save it. +3. Right-click the Windows command file corresponding to the application you want to register. Ensure that it is configured with the correct installation directory you noted in the previous step. If it is not, edit the file with the correct path and save it. ![Editing the Windows command file to configure the correct installation directory](./../0-images/ka0Qk000000E5z7_0EM4u000005yg27.png) -4. Double-click the command file you previously opened to execute it. +4. Double-click the command file you previously opened to execute it. The command file modifies the registry and registers the application to the URL handler. Your registered SSH client is now invoked automatically when starting SSH sessions from the Privilege Secure user interface. ![Executing the command file to register the application](./../0-images/ka0Qk000000E5z7_0EM4u000005yg2C.png) -5. The command file will modify the registry and register the application to the URL handler. Your registered SSH client will now be invoked automatically when starting SSH sessions from the Netwrix Privilege Secure user interface. - -6. Ensure that your SSH handler is indicated in Windows' **Choose default apps by protocol** settings as **Netwrix Privilege Secure URL Handler**. +5. Ensure that your SSH handler is indicated in Windows' **Choose default apps by protocol** settings as **Netwrix Privilege Secure URL Handler**. ![Setting Netwrix Privilege Secure URL Handler as the default app by protocol](./../0-images/ka0Qk000000E5z7_0EM4u000008M1Gl.png) -7. If none of these built-in command files are successful, then you may refer to the following provided options: [Registering and Using the sbpam-url SSH Protocol Handler](/docs/kb/privilegesecure/client-tools-and-integrations/registering-and-using-the-sbpam-url-ssh-protocol-handler.md). - - +6. If none of these built-in command files are successful, see [Registering and Using the sbpam-url SSH Protocol Handler](/docs/kb/privilegesecure/client-tools-and-integrations/registering-and-using-the-sbpam-url-ssh-protocol-handler.md) for the provided options. diff --git a/docs/kb/privilegesecure/client-tools-and-integrations/registering-and-using-the-sbpam-url-ssh-protocol-handler.md b/docs/kb/privilegesecure/client-tools-and-integrations/registering-and-using-the-sbpam-url-ssh-protocol-handler.md index c0e1c30da9..c584ea132e 100644 --- a/docs/kb/privilegesecure/client-tools-and-integrations/registering-and-using-the-sbpam-url-ssh-protocol-handler.md +++ b/docs/kb/privilegesecure/client-tools-and-integrations/registering-and-using-the-sbpam-url-ssh-protocol-handler.md @@ -1,9 +1,7 @@ --- description: >- - Registers the sbpam-url SSH protocol handler and shows how to use it to - automatically launch external SSH clients for NPS-proxied connections. - Includes command examples, available replacement strings, registry keys - modified, and alternatives. + Register the sbpam-url SSH protocol handler to launch external SSH clients + automatically, with example commands, replacement strings, and registry keys. keywords: - sbpam-url - SSH @@ -15,9 +13,11 @@ keywords: - URL handler - ssh handler products: - - privilege-secure-access-management -sidebar_label: Registering and Using the sbpam-url SSH Protocol H -tags: [] + - privilegesecure +sidebar_label: "Registering and Using the sbpam-url SSH Protocol Handler" +tags: + - kb + - client-tools-and-integrations title: "Registering and Using the sbpam-url SSH Protocol Handler" knowledge_article_id: kA0Qk0000002VvlKAE --- @@ -26,9 +26,11 @@ knowledge_article_id: kA0Qk0000002VvlKAE ## Overview -The `sbpam-url` utility, located in the **Extras** folder of the download package, registers an SSH URL handler. This utility helps you automatically connect to an NPS-proxied SSH session. +This article describes how to register the `sbpam-url` SSH protocol handler and use it to automatically connect to an SSH session proxied by Netwrix Privilege Secure for Access Management. -For additional information, refer to the following article: [Invoking Desktop SSH Client Automatically](/docs/kb/privilegesecure/client-tools-and-integrations/invoking-desktop-ssh-client-automatically.md) +The `sbpam-url` utility, located in the **Extras** folder of the download package, registers an SSH URL handler. + +For additional information, see [Invoking Desktop SSH Client Automatically](/docs/kb/privilegesecure/client-tools-and-integrations/invoking-desktop-ssh-client-automatically.md). At the time this article was written, the referenced KB article instructed users to download the utility from a static link, which may provide an outdated version. Use the utility bundled in the **Extras** folder to ensure you have the latest version. @@ -36,7 +38,7 @@ At the time this article was written, the referenced KB article instructed users ### Where to Install or Run the Utility -The URL handler must be registered on the machine where NPS users run their browser. Ensure you run the utility on the appropriate client system. +The URL handler must be registered on the machine where Privilege Secure users run their browser. Ensure you run the utility on the appropriate client system. ### Example Commands for External SSH Clients @@ -60,10 +62,23 @@ Use the following PowerShell commands and arguments for various external SSH cli ### Remove the SSH Handler +To remove the SSH handler, run the following command: + ```powershell & .\sbpam-url handle -U -p ssh ``` +### Alternatives to `sbpam-url` + +You can use WinSCP to install an SSH handler as an alternative to `sbpam-url`. + +> **NOTE:** WinSCP requires Putty to be installed first. + +- [Download Putty ⸱ PuTTY 🐍](https://www.putty.org/) +- [Download WinSCP ⸱ WinSCP 🐘](https://winscp.net/eng/download.php) + +## Command Reference + ### General Command-Line Form Use the following syntax to register a handler: @@ -74,44 +89,37 @@ Use the following syntax to register a handler: | Command | Description | |---|---| -| `completion` | Generate the autocompletion script for the specified shell. | -| `handle` | Register a URL handler. | -| `help` | Display help about any command. | +| `completion` | Generate the autocompletion script for the specified shell | +| `handle` | Register a URL handler | +| `help` | Display help about any command | ### Command Flags | Flag | Description | |---|---| -| `-h, --help` | Display help for sbpam-url. | -| `-d, --debug` | Display debug messages. | -| `-Q, --quiet` | Do not display messages. | -| `-u, --url string` | URL to handle. | -| `-v, --version` | Display version information. | -| `handle -p ` | Handle the specified protocol. | -| `handle -u` | Unregister all protocols. | -| `handle -u -p ` | Unregister a specific protocol. | +| `-h, --help` | Display help for sbpam-url | +| `-d, --debug` | Display debug messages | +| `-Q, --quiet` | Do not display messages | +| `-u, --url string` | URL to handle | +| `-v, --version` | Display version information | +| `handle -p ` | Handle the specified protocol | +| `handle -u` | Unregister all protocols | +| `handle -u -p ` | Unregister a specific protocol | ### Available Replacement Strings | Replacement String | Description | |---|---| -| `{{scheme}}` | Protocol, for example, SSH. | -| `{{user}}` | User portion of the URL (direct connect string). | -| `{{user_esc}}` | Escaped user portion of the URL. | -| `{{host}}` | The host and port in the format `host:port`. | -| `{{hostname}}` | Just the hostname. | -| `{{port}}` | Just the port. | -| `{{path}}` | The URL path. | -| `{{query}}` | The URL query. | -| `{{fragment}}` | The URL fragment. | -| `{{password}}` | The password portion of the URL. | - -### Alternatives to sbpam-url - -You can use WinSCP to install an SSH handler as an alternative to `sbpam-url`. Note that WinSCP requires Putty to be installed first. - -- [Download Putty ⸱ PuTTY 🐍](https://www.putty.org/) -- [Download WinSCP ⸱ WinSCP 🐘](https://winscp.net/eng/download.php) +| `{{scheme}}` | Protocol, for example, SSH | +| `{{user}}` | User portion of the URL (direct connect string) | +| `{{user_esc}}` | Escaped user portion of the URL | +| `{{host}}` | The host and port in the format `host:port` | +| `{{hostname}}` | Just the hostname | +| `{{port}}` | Just the port | +| `{{path}}` | The URL path | +| `{{query}}` | The URL query | +| `{{fragment}}` | The URL fragment | +| `{{password}}` | The password portion of the URL | ### Registry Keys Modified by sbpam-url diff --git a/docs/kb/privilegesecure/client-tools-and-integrations/resolving-invalid-connection-string-for-directconnect-in-mremoteng.md b/docs/kb/privilegesecure/client-tools-and-integrations/resolving-invalid-connection-string-for-directconnect-in-mremoteng.md index a90d05690a..40597a49ef 100644 --- a/docs/kb/privilegesecure/client-tools-and-integrations/resolving-invalid-connection-string-for-directconnect-in-mremoteng.md +++ b/docs/kb/privilegesecure/client-tools-and-integrations/resolving-invalid-connection-string-for-directconnect-in-mremoteng.md @@ -1,8 +1,6 @@ --- description: >- - Netwrix Privilege Secure DirectConnect strings in mRemoteNG can appear as - empty due to saved RDP credentials on the same host. This article explains the - cause and two ways to resolve the "Invalid Connection String" error. + Fix the "Invalid Connection String" error for DirectConnect strings in mRemoteNG, caused by saved RDP credentials for the Proxy Server. keywords: - mRemoteNG - DirectConnect @@ -13,26 +11,32 @@ keywords: - Proxy Server - connection string error products: - - privilege-secure-access-management -sidebar_label: Resolving "Invalid Connection String" for DirectCo -tags: [] -title: Resolving "Invalid Connection String" for DirectConnect in mRemoteNG + - privilegesecure +sidebar_label: 'Resolving "Invalid Connection String" for DirectConnect in mRemoteNG' +tags: + - kb + - client-tools-and-integrations +title: 'Resolving "Invalid Connection String" for DirectConnect in mRemoteNG' knowledge_article_id: kA04u0000000HdXCAU --- # Resolving "Invalid Connection String" for DirectConnect in mRemoteNG -## Summary -In a specific scenario, valid Netwrix Privilege Secure `DirectConnect` strings used in mRemoteNG will result in an invalid connection string error, stating the connection string is empty. +## Symptom + +In a specific scenario, valid Netwrix Privilege Secure for Access Management `DirectConnect` strings used in mRemoteNG result in an invalid connection string error, stating the connection string is empty. ![Screenshot of Netwrix Privilege Secure DirectConnect error, stating the connection string is invalid (empty).](./../0-images/ka04u000000Hca3_0EM4u000004bv9Z.png) -## Instructions -This error is caused by having credentials saved for the Netwrix Privilege Secure server (for example, the Netwrix Privilege Secure Proxy Server) in the Windows built-in RDP client, **Remote Desktop Connection**, on the same host that is running mRemoteNG. +## Cause + +This error is caused by having credentials saved for the Privilege Secure server (for example, the Privilege Secure Proxy Server) in the Windows built-in Remote Desktop Protocol (RDP) client, **Remote Desktop Connection**, on the same host that is running mRemoteNG. ![Screenshot of a credential saved in Remote Desktop Connection, the built-in Windows RDP client, for the Netwrix Privilege Secure Proxy Server.](./../0-images/ka04u000000Hca3_0EM4u000004bv9t.png) -To resolve the issue, you have two options: +## Resolution + +To resolve the issue, choose one of the following two options: -1. Delete the credential saved in **Remote Desktop Connection**. After you delete that credential, the valid `DirectConnect` string will work as expected in mRemoteNG. -2. Fill in a password for each `DirectConnect` connection saved in mRemoteNG. This resolves the issue without deleting any credentials from **Remote Desktop Connection**. +- Delete the credential saved in **Remote Desktop Connection**. After you delete that credential, the valid `DirectConnect` string works as expected in mRemoteNG. +- Fill in a password for each `DirectConnect` connection saved in mRemoteNG. This resolves the issue without deleting any credentials from **Remote Desktop Connection**. diff --git a/docs/kb/privilegesecure/database-and-backend/exporting-and-importing-the-database-to-a-new-server.md b/docs/kb/privilegesecure/database-and-backend/exporting-and-importing-the-database-to-a-new-server.md index 2ce813f4e9..cf3e05704e 100644 --- a/docs/kb/privilegesecure/database-and-backend/exporting-and-importing-the-database-to-a-new-server.md +++ b/docs/kb/privilegesecure/database-and-backend/exporting-and-importing-the-database-to-a-new-server.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to export the Netwrix Privilege Secure PostgreSQL database, RDP/SSH - recordings, configuration files, and encryption keys from an existing server - and import them to a new Privilege Secure server. + Export the PostgreSQL database, RDP/SSH recordings, configuration files, and + encryption keys from an existing server and import them to a new server. keywords: - Privilege Secure - PostgreSQL @@ -15,9 +14,11 @@ keywords: - migration - backup products: - - privilege-secure-access-management -sidebar_label: Exporting and Importing the Database to a New Serv -tags: [] + - privilegesecure +sidebar_label: Exporting and Importing the Database to a New Server +tags: + - kb + - database-and-backend title: "Exporting and Importing the Database to a New Server" knowledge_article_id: kA0Qk0000000RBVKA2 --- @@ -25,62 +26,72 @@ knowledge_article_id: kA0Qk0000000RBVKA2 # Exporting and Importing the Database to a New Server ## Overview -This article outlines the process of exporting your Netwrix Privilege Secure database, and importing it to a new Privilege Secure server. + +This article describes how to export the Netwrix Privilege Secure for Access Management database and import it to a new Privilege Secure server. The data transferred includes: -1. PostgreSQL Database -2. RDP/SSH Recordings -3. Configuration files -4. Encryption keys +- PostgreSQL Database +- RDP/SSH Recordings +- Configuration files +- Encryption keys ## Instructions -### On the new server -1. Install Netwrix Privilege Secure on the new server. +### Install on the New Server + +1. Install Privilege Secure on the new server. + +### Export from the Existing Server -### On the existing server 1. Stop the following services on the server by running the indicated PowerShell commands: -```powershell -Stop-Service SbPAM* -Force -Stop-Service W3SVC -Stop-Service postgresql-x64-12 -``` + ```powershell + Stop-Service SbPAM* -Force + Stop-Service W3SVC + Stop-Service postgresql-x64-12 + ``` + +2. Create an archive of the PostgreSQL database by running the indicated command: + + `Compress-Archive -Path C:\ProgramData\Stealthbits\Postgres12 -DestinationPath C:\Temp\pg_data.zip -CompressionLevel Optimal` -2. Create an archive of PostgreSQL database by running the indicated command: -`Compress-Archive -Path C:\ProgramData\Stealthbits\Postgres12 -DestinationPath C:\Temp\pg_data.zip -CompressionLevel Optimal` +3. Export the Privilege Secure encryption keys, and capture the password generated by the export **(note: the keys.exp file created in this step is sensitive and should be deleted after the import is complete)**: -3. Export the NPS encryption keys, and capture the password generated by the export **(note: the keys.exp file created in this step is sensitive and should be deleted after the import is complete)**: -`"C:\Program Files\Stealthbits\PAM\KeyTools\SbPAM.RotateKey.exe" export -n c:\temp\keys.exp` + `"C:\Program Files\Stealthbits\PAM\KeyTools\SbPAM.RotateKey.exe" export -n c:\temp\keys.exp` -4. Create an archive of the NPS configuration files: -`Compress-Archive -Path C:\ProgramData\Stealthbits\PAM -DestinationPath C:\Temp\nps_config.zip -CompressionLevel Optimal` +4. Create an archive of the Privilege Secure configuration files: + + `Compress-Archive -Path C:\ProgramData\Stealthbits\PAM -DestinationPath C:\Temp\nps_config.zip -CompressionLevel Optimal` 5. Copy `pg_data.zip`, `keys.exp`, and `nps_config.zip` to the new server. -### On new server +### Import on the New Server + 1. Stop the following services on the server by running the indicated PowerShell commands: -```powershell -Stop-Service SbPAM* -Force -Stop-Service W3SVC -Stop-Service postgresql-x64-12 -``` + ```powershell + Stop-Service SbPAM* -Force + Stop-Service W3SVC + Stop-Service postgresql-x64-12 + ``` + +2. Decompress the configuration files from the original server: + + `Expand-Archive -Path c:\temp\nps_config.zip -DestinationPath c:\ProgramData\Stealthbits -Force` + +3. Decompress the PostgreSQL files from the original server: -2. Decompress the configuration files from the original server: -`Expand-Archive -Path c:\temp\nps_config.zip -DestinationPath c:\ProgramData\Stealthbits -Force` + `Expand-Archive -Path C:\temp\pg_data.zip -DestinationPath C:\ProgramData\Stealthbits -Force` -3. Decompress the PostgreSQL files from the original server: -`Expand-Archive -Path C:\temp\pg_data.zip -DestinationPath C:\ProgramData\Stealthbits -Force` +4. Import the key files from the original server **(note: the keys.exp file is sensitive and should be deleted after the import is complete)**: -4. Import the key files from the original server **(note: the keys.exp file is sensitive and should be deleted after the import is complete)**: -`"C:\Program Files\Stealthbits\PAM\KeyTools\SbPAM.RotateKey.exe" import -f -n c:\temp\keys.exp` + `"C:\Program Files\Stealthbits\PAM\KeyTools\SbPAM.RotateKey.exe" import -f -n c:\temp\keys.exp` 5. Start the following services on the server by running the indicated PowerShell commands: -```powershell -Start-Service postgresql-x64-12 -Start-Service W3SVC -Start-Service SbPAM* -Force -``` + ```powershell + Start-Service postgresql-x64-12 + Start-Service W3SVC + Start-Service SbPAM* -Force + ``` diff --git a/docs/kb/privilegesecure/database-and-backend/how-to-configure-a-multi-server-nps-environment-with-a-shared-database-server.md b/docs/kb/privilegesecure/database-and-backend/how-to-configure-a-multi-server-nps-environment-with-a-shared-database-server.md index 200e0a3126..c0804ab959 100644 --- a/docs/kb/privilegesecure/database-and-backend/how-to-configure-a-multi-server-nps-environment-with-a-shared-database-server.md +++ b/docs/kb/privilegesecure/database-and-backend/how-to-configure-a-multi-server-nps-environment-with-a-shared-database-server.md @@ -1,9 +1,7 @@ --- description: >- - This article guides you through setting up a deployment with multiple Netwrix - Privilege Secure servers that use a single PostgreSQL server, including TLS - configuration for all traffic and optional migration steps from an existing - deployment. + Set up multiple Privilege Secure servers that use a single PostgreSQL server, + with TLS configured for all network traffic to the database server. keywords: - Netwrix Privilege Secure - PostgreSQL @@ -15,96 +13,124 @@ keywords: - pg_hba.conf - postgresql.conf products: - - privilege-secure-access-management -sidebar_label: How to Configure a Multi-Server NPS Environment Wi -tags: [] -title: "How to Configure a Multi-Server NPS Environment With a Shared Database Server" + - privilegesecure +sidebar_label: Configuring a Multi-Server NPS Environment with a Shared Database Server +tags: + - kb + - database-and-backend +title: "Configuring a Multi-Server NPS Environment with a Shared Database Server" knowledge_article_id: kA04u0000000JyXCAU --- -# How to Configure a Multi-Server NPS Environment With a Shared Database Server +# Configuring a Multi-Server NPS Environment with a Shared Database Server -## Summary +## Overview -This article will guide the user through the process of setting up a deployment with multiple Netwrix Privilege Secure servers communicating with a single Postgres server. Instructions are included for configuring TLS for all network traffic to the Postgres server. Optional migration steps are included for users who wish to use a Postgres database from an existing Netwrix Privilege Secure deployment. +This article describes how to set up a deployment with multiple Netwrix Privilege Secure for Access Management servers communicating with a single Postgres server. Instructions are included for configuring TLS for all network traffic to the Postgres server. Optional migration steps are included for users who want to use a Postgres database from an existing Privilege Secure deployment. -This diagram illustrates the desired network architecture. -![nps_diagram.png](./../0-images/ka0Qk0000009L21_0EMQk000006FKxR.png) +This diagram illustrates the target network architecture. + +![Network architecture diagram showing multiple Privilege Secure servers communicating with a single Postgres server](./../0-images/ka0Qk0000009L21_0EMQk000006FKxR.png) ## Instructions ### Configuring the Postgres Server -1. On the Postgres server, open the `NPS_Setup.exe` installer, and install Postgres 12. Next, use the `NPS_Setup.exe` installer to install Netwrix Privilege Secure. (This is necessary for the Postgres database to be properly configured. There will be no need to launch Netwrix Privilege Secure on the Postgres server at any point in this process, and the Postgres database can be entirely administered from the remote Netwrix Privilege Secure servers.) -2. (Recommended) Now that the Postgres database is properly configured, you may uninstall Netwrix Privilege Secure on the Postgres server. This will conserve disk space and computing resources. -3. Open the `sbpam_node.json` file. On a default installation to the C: drive, it will be located here: -```text -C:\ProgramData\Stealthbits\PAM\ProxyService\sbpam_node.json -``` +1. On the Postgres server, open the `NPS_Setup.exe` installer, and install Postgres 12. Next, use the `NPS_Setup.exe` installer to install Privilege Secure. (This is necessary for the Postgres database to be properly configured. There is no need to launch Privilege Secure on the Postgres server at any point in this process, and the Postgres database can be entirely administered from the remote Privilege Secure servers.) +2. (Recommended) Now that the Postgres database is properly configured, you can uninstall Privilege Secure on the Postgres server. This conserves disk space and computing resources. +3. Open the `sbpam_node.json` file. On a default installation to the C: drive, the file is located here: + + ```text + C:\ProgramData\Stealthbits\PAM\ProxyService\sbpam_node.json + ``` + 4. Ensure that both `localhost` and the FQDN of your Postgres server are populated under `advertise`: -```json -{ - "advertise": ["testlab-pg01.sbpamtestlab.com", "localhost"], - "tags": [] -} -``` -5. Navigate to the TLS certificate directory. On a default installation to the C: drive, it will be located here: -```text -C:\ProgramData\Stealthbits\PAM\tls\certs\ -``` -6. Copy the `\ProgramData\Stealthbits\PAM\tls\certs\sbpam-node.crt` and `\ProgramData\Stealthbits\PAM\tls\keys\sbpam-node.pem` files into the root of the Postgres data directory. On a default installation to the C: drive, the Postgres data directory will be located here: -```text -C:\ProgramData\Stealthbits\Postgres12 -``` -(If you wish to copy the .crt and .pem files to a subdirectory of the data directory, you will have to specify their relative subpaths later on in these instructions, when configuring the postgresql.conf file.) + + ```json + { + "advertise": ["testlab-pg01.sbpamtestlab.com", "localhost"], + "tags": [] + } + ``` + +5. Go to the TLS certificate directory. On a default installation to the C: drive, the directory is located here: + + ```text + C:\ProgramData\Stealthbits\PAM\tls\certs\ + ``` + +6. Copy the `\ProgramData\Stealthbits\PAM\tls\certs\sbpam-node.crt` and `\ProgramData\Stealthbits\PAM\tls\keys\sbpam-node.pem` files into the root of the Postgres data directory. On a default installation to the C: drive, the Postgres data directory is located here: + + ```text + C:\ProgramData\Stealthbits\Postgres12 + ``` + + (If you want to copy the `.crt` and `.pem` files to a subdirectory of the data directory, you must specify their relative subpaths later in these instructions, when configuring the `postgresql.conf` file.) + 7. Open the **Certificate Manager**. Import the `\ProgramData\Stealthbits\PAM\tls\cacerts\sbpam-region.crt` certificate into the **Trusted Root**. -8. Open the `pg_hba.conf` file. On a default installation to the C: drive, it will be located here: -```text -C:\ProgramData\Stealthbits\Postgres12\pg_hba.conf -``` -Edit the file to contain one or more entries which allow connections from your Netwrix Privilege Secure application servers. For instance, to allow all IP addresses in the `10.2.0.x` range, add an entry ending in `/24`: -```text -host all all 10.2.0.0/24 md5 -``` -Or, for granular access on a per-IP basis, add a line for each IP address ending in /32: -```text -host all all 10.2.0.1/32 md5 -host all all 10.2.0.2/32 md5 -``` -9. Open the `pg_hba.conf` file. On a default installation to the C: drive, it will be located here: -```text -C:\ProgramData\Stealthbits\Postgres12\postgresql.conf -``` +8. Open the `pg_hba.conf` file. On a default installation to the C: drive, the file is located here: + + ```text + C:\ProgramData\Stealthbits\Postgres12\pg_hba.conf + ``` + + Edit the file to contain one or more entries that allow connections from your Privilege Secure application servers. For instance, to allow all IP addresses in the `10.2.0.x` range, add an entry ending in `/24`: + + ```text + host all all 10.2.0.0/24 md5 + ``` + + Or, for granular access on a per-IP basis, add a line for each IP address ending in `/32`: + + ```text + host all all 10.2.0.1/32 md5 + host all all 10.2.0.2/32 md5 + ``` + +9. Open the `pg_hba.conf` file. On a default installation to the C: drive, the file is located here: + + ```text + C:\ProgramData\Stealthbits\Postgres12\postgresql.conf + ``` + 10. Under `# - SSL -`, edit the SSL settings as follows: -```text -# - SSL - - -ssl = on -#ssl_ca_file = '' -ssl_cert_file = 'sbpam-node.crt' -#ssl_crl_file = '' -ssl_key_file = 'sbpam-node.pem' -``` + + ```text + # - SSL - + + ssl = on + #ssl_ca_file = '' + ssl_cert_file = 'sbpam-node.crt' + #ssl_crl_file = '' + ssl_key_file = 'sbpam-node.pem' + ``` + 11. Restart the Postgres service. Your Postgres server should now be ready to accept TLS-encrypted traffic. ### Configuring the NPS Servers -1. On each Netwrix Privilege Secure server, open the `SB_Setup.exe` installer, and install Postgres 12. Next, use the `SB_Setup.exe` installer to install Netwrix Privilege Secure. -2. Once Netwrix Privilege Secure is installed, open the `appsettings.json` file. On a default installation to the C: drive, it will be located here: -```text -C:\Program Files\Stealthbits\PAM\Web -``` -Edit this file so that the `Database` key references the hostname of the Postgres server: -```json -"Database": { - "Host": "testlab-pg01.sbpamtestlab.com", - "Port": 5432 - } -``` +1. On each Privilege Secure server, open the `SB_Setup.exe` installer, and install Postgres 12. Next, use the `SB_Setup.exe` installer to install Privilege Secure. +2. After Privilege Secure is installed, open the `appsettings.json` file. On a default installation to the C: drive, the file is located here: + + ```text + C:\Program Files\Stealthbits\PAM\Web + ``` + + Edit this file so that the `Database` key references the hostname of the Postgres server: + + ```json + "Database": { + "Host": "testlab-pg01.sbpamtestlab.com", + "Port": 5432 + } + ``` + 3. Obtain a copy of the `\ProgramData\Stealthbits\PAM\tls\cacerts\sbpam-region.crt` certificate from the Postgres server. Open the **Certificate Manager**. Import the `sbpam-region.crt` certificate into the **Trusted Root** of the local machine. -You should now be able to access the Netwrix Privilege Secure console at `https://[yourNPSServerIP]:6500`, and all traffic should be TLS encrypted. *Note: if you are receiving an IIS certificate warning from your browser, install an IIS certificate using [Install an IIS Certificate](https://docs.netwrix.com/docs/kb/privilegesecure/installing-an-iis-certificate) +You should now be able to access the Privilege Secure console at `https://[yourNPSServerIP]:6500`, and all traffic should be TLS encrypted. + +> **NOTE:** If you receive an IIS certificate warning from your browser, install an IIS certificate using [Installing an IIS Certificate](https://docs.netwrix.com/docs/kb/privilegesecure/installing-an-iis-certificate) ### Key Export/Import -*In order to ensure that encryption keys are in agreement between Netwrix Privilege Secure servers, please follow the instructions outlined in [How to Configure Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md).* +To ensure that encryption keys are in agreement between Privilege Secure servers, follow the instructions outlined in [Configuring Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md). diff --git a/docs/kb/privilegesecure/database-and-backend/least-privilege-model-for-sql-server-backend.md b/docs/kb/privilegesecure/database-and-backend/least-privilege-model-for-sql-server-backend.md index db7618ac2a..be1052ab2b 100644 --- a/docs/kb/privilegesecure/database-and-backend/least-privilege-model-for-sql-server-backend.md +++ b/docs/kb/privilegesecure/database-and-backend/least-privilege-model-for-sql-server-backend.md @@ -1,8 +1,7 @@ --- description: >- - Provides the least privilege model for the MS SQL Server service accounts used - by Netwrix Privilege Secure when a SQL Server backend and SQL authentication - are required. + Lists the privileges the MS SQL Server service account needs for regular + usage, installations, and upgrades of Privilege Secure with a SQL backend. keywords: - MS SQL Server - service account @@ -12,10 +11,14 @@ keywords: - db_datareader - db_datawriter - db_ddladmin + - SQL authentication + - REFERENCES permission products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Least Privilege Model for SQL Server Backend -tags: [] +tags: + - kb + - database-and-backend title: "Least Privilege Model for SQL Server Backend" knowledge_article_id: kA04u000000wnnrCAA --- @@ -24,13 +27,13 @@ knowledge_article_id: kA04u000000wnnrCAA ## Overview -This article provides the least privilege model for the MS SQL Server service accounts used by Netwrix Privilege Secure. This model applies exclusively to Privilege Secure for Access Management version 4.1 and higher, and only in environments where a SQL Server backend is being used. Further, you must use a SQL user, as Windows (Active Directory) authentication is not supported at this time. +This article describes the least privilege model for the MS SQL Server service accounts used by Netwrix Privilege Secure for Access Management. This model applies exclusively to Privilege Secure for Access Management version 4.1 and higher, and only in environments where a SQL Server backend is being used. Further, you must use a SQL user, as Windows (Active Directory) authentication is not supported at this time. ## Instructions -The service account used by Netwrix Privilege Secure requires the following privileges: +The service account used by Privilege Secure requires the following privileges: -### During regular usage +### During Regular Usage The service account requires the following roles on the PAM database: @@ -40,9 +43,9 @@ The service account requires the following roles on the PAM database: 4. ALTER permission on the dbo schema 5. CREATE TABLE -> **NOTE:** As an alternate privilege, instead of 4. and 5. in the preceding list, the `db_ddladmin` role may be granted. The purpose of the ALTER/CREATE permissions, whether granted directly or through `ddladmin`, is to allow for non-temporary tables to be created and dropped inside of the NPS database during regular operation of the software. +> **NOTE:** As an alternate privilege, instead of 4. and 5. in the preceding list, the `db_ddladmin` role may be granted. The purpose of the ALTER/CREATE permissions, whether granted directly or through `ddladmin`, is to allow for non-temporary tables to be created and dropped inside of the Privilege Secure database during regular operation of the software. -### During installations and upgrades +### During Installations and Upgrades The service account must be granted the following additional permissions: @@ -60,4 +63,4 @@ These permissions can then be revoked after installation and upgrade: - REFERENCES permission ON `scheduled_change_policy`: `REVOKE REFERENCES ON scheduled_change_policy TO [serviceaccount]` - REFERENCES permission ON `email_settings`: `REVOKE REFERENCES ON email_settings TO [serviceaccount]` -> **IMPORTANT:** It is critical that these permissions be granted to the service account during all installations and upgrades. +> **IMPORTANT:** It is critical to grant these permissions to the service account during all installations and upgrades. diff --git a/docs/kb/privilegesecure/database-and-backend/moving-the-postgresql-data-directory-pgdatadir-to-a-new-location.md b/docs/kb/privilegesecure/database-and-backend/moving-the-postgresql-data-directory-pgdatadir-to-a-new-location.md index 847d04c8fe..1bd8bdcad6 100644 --- a/docs/kb/privilegesecure/database-and-backend/moving-the-postgresql-data-directory-pgdatadir-to-a-new-location.md +++ b/docs/kb/privilegesecure/database-and-backend/moving-the-postgresql-data-directory-pgdatadir-to-a-new-location.md @@ -1,9 +1,7 @@ --- description: >- - Instructions to move the PostgreSQL 16 data directory (PgDataDir) for Netwrix - Privilege Secure to a new location, including required registry updates and - service steps. Repeat the procedure on each server in a High Availability (HA) - pair. + Move the PostgreSQL 16 data directory (PgDataDir) to a new location, including + the registry updates and service steps. Repeat on each High Availability server. keywords: - PostgreSQL - PgDataDir @@ -15,9 +13,11 @@ keywords: - Network Service - ACL products: - - privilege-secure-access-management -sidebar_label: Moving the PostgreSQL Data Directory (PgDataDir) t -tags: [] + - privilegesecure +sidebar_label: Moving the PostgreSQL Data Directory (PgDataDir) to a New Location +tags: + - kb + - database-and-backend title: "Moving the PostgreSQL Data Directory (PgDataDir) to a New Location" knowledge_article_id: kA04u0000000HjaCAE --- @@ -25,25 +25,28 @@ knowledge_article_id: kA04u0000000HjaCAE ## Overview -This article outlines the steps required to move an installed PostgreSQL data directory (**PgDataDir**) for Netwrix Privilege Secure to a new location. In a High Availability (HA) pair, you must perform this procedure on each server separately. +This article describes how to move an installed PostgreSQL data directory (**PgDataDir**) for Netwrix Privilege Secure for Access Management to a new location. In a High Availability (HA) pair, perform this procedure on each server separately. ## Instructions -> **IMPORTANT:** It is recommended to make a backup of the PostgreSQL data directory before making manual modifications or moving it. Also, this article pertains specifically to **PostgreSQL 16**. If using **PostgreSQL 12**, please contact [Netwrix Technical Support](https://www.netwrix.com/support.html) to upgrade before proceeding with the following instructions. +> **IMPORTANT:** Netwrix recommends making a backup of the PostgreSQL data directory before making manual modifications or moving it. This article applies only to **PostgreSQL 16**. If using **PostgreSQL 12**, contact [Netwrix Technical Support](https://www.netwrix.com/support.html) to upgrade before proceeding with the following instructions. + +1. While Privilege Secure is not in use, stop the **postgresql-x64-16 – PostgreSQL Server 16** service in the Windows Services menu (`services.msc`). +2. Open the Windows Registry and go to: + `Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\postgresql-x64-16` -1. While Netwrix Privilege Secure is not in use, stop the **postgresql-x64-16 – PostgreSQL Server 16** service in the Windows Services menu (`services.msc`). -2. Open the Windows Registry and navigate to: - `Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\postgresql-x64-16` Update the value of **ImagePath** to reflect the data directory's new location. Only modify the path between quotes after `-D`, as this is the path to the database. -3. In the Windows Registry, navigate to: - `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\PostgreSQL\Services\postgresql-x64-16` +3. In the Windows Registry, go to: + `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\PostgreSQL\Services\postgresql-x64-16` + Update the value of **Data Directory** to reflect the data directory's new location. -4. In the Windows Registry, navigate to: - `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\PostgreSQL\Installations\postgresql-x64-16` +4. In the Windows Registry, go to: + `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\PostgreSQL\Installations\postgresql-x64-16` + Update the value of **Data Directory** to reflect the data directory's new location. 5. Move the PostgreSQL data directory to its new location. Ensure that the new path matches the one specified in the previous steps. 6. After moving the PostgreSQL data directory, start the **postgresql-x64-16 – PostgreSQL Server 16** service in the Windows Services menu (`services.msc`). -> **IMPORTANT:** After moving the database to a new location, add the **Network Service** account to the new folder's Access Control List (ACL). + > **IMPORTANT:** After moving the database to a new location, add the **Network Service** account to the new folder's Access Control List (ACL). -7. Verify that you can log in to Netwrix Privilege Secure as usual, navigate the UI, and provision sessions. If everything functions normally, the process is complete. +7. Verify that you can log in to Privilege Secure as usual, navigate the UI, and provision sessions. If everything functions normally, the process is complete. diff --git a/docs/kb/privilegesecure/database-and-backend/netwrix-privilege-secure-performing-an-in-place-postgres-upgrade.md b/docs/kb/privilegesecure/database-and-backend/netwrix-privilege-secure-performing-an-in-place-postgres-upgrade.md index eefc3c162f..0537d7efa6 100644 --- a/docs/kb/privilegesecure/database-and-backend/netwrix-privilege-secure-performing-an-in-place-postgres-upgrade.md +++ b/docs/kb/privilegesecure/database-and-backend/netwrix-privilege-secure-performing-an-in-place-postgres-upgrade.md @@ -1,8 +1,7 @@ --- description: >- - Step-by-step guidance to perform an in-place upgrade of the Netwrix Privilege - Secure server Postgres 12 backend. This procedure applies to build updates for - Postgres 12 and should be scheduled outside regular operational hours. + Perform an in-place upgrade of the Privilege Secure Postgres 12 backend for + build updates, scheduled outside regular operational hours. keywords: - Postgres - upgrade @@ -12,10 +11,13 @@ keywords: - PowerShell - EnterpriseDB - Postgres installer + - psql products: - - privilege-secure-access-management -sidebar_label: 'Netwrix Privilege Secure: Performing an In-Place P' -tags: [] + - privilegesecure +sidebar_label: 'Netwrix Privilege Secure: Performing an In-Place Postgres Upgrade' +tags: + - kb + - database-and-backend title: 'Netwrix Privilege Secure: Performing an In-Place Postgres Upgrade' knowledge_article_id: kA04u000000LLRpCAO --- @@ -24,37 +26,37 @@ knowledge_article_id: kA04u000000LLRpCAO ## Overview -This article provides guidance on how to perform an in-place upgrade for the Netwrix Privilege Secure (NPS) server's Postgres backend. +This article describes how to perform an in-place upgrade of the Postgres backend for the Netwrix Privilege Secure for Access Management server. -> **NOTE:** This article applies exclusively to build updates for Postgres 12. As the upgrade may take considerable time and require a server reboot, it is recommended to schedule this process outside of regular operational hours. +> **NOTE:** This article applies exclusively to build updates for Postgres 12. The upgrade may take considerable time and require a server reboot, so Netwrix recommends scheduling this process outside of regular operational hours. ## Instructions 1. Determine your current Postgres version by launching a PowerShell terminal and running the following commands: -```powershell -cd 'C:\Program Files\Stealthbits\Postgres12\bin\' -.\psql.exe -V -``` + ```powershell + cd 'C:\Program Files\Stealthbits\Postgres12\bin\' + .\psql.exe -V + ``` -> **NOTE:** You may need to modify the path to the Postgres12 directory depending on your installation. + > **NOTE:** You may need to modify the path to the Postgres12 directory depending on your installation. -2. This command should return your Postgres version number. For example, if your current version is 12.8, upgrade to the latest 12.X release. + The command should return your Postgres version number. For example, if your current version is 12.8, upgrade to the latest 12.X release. -3. Visit the Postgres download page: https://www.postgresql.org/download/windows/. Click the "Download the Installer" link at the top of the page, and download an executable installer from the EnterpriseDB website. Ensure the version matches the one determined in Step 2. +2. Visit the Postgres download page: https://www.postgresql.org/download/windows/. Click the "Download the Installer" link at the top of the page, and download an executable installer from the EnterpriseDB website. Ensure the version matches the one you determined in the previous step. -4. Run the `postgresql-[versionnumber]-windows-x64.exe` file on your Netwrix Privilege Secure (NPS) server. This will launch the Postgres Setup Wizard. Click **Next** on the initial splash page. +3. Run the `postgresql-[versionnumber]-windows-x64.exe` file on your Privilege Secure server. This launches the Postgres Setup Wizard. Click **Next** on the initial splash page. -5. On the **Select Components** page, select only **PostgreSQL Server** and **Command Line Tools** to install/upgrade: +4. On the **Select Components** page, select only **PostgreSQL Server** and **Command Line Tools** to install/upgrade: -![Postgres Select Components](./../0-images/ka0Qk000000CGIj_0EM4u000005feFD.png) + ![Postgres Select Components](./../0-images/ka0Qk000000CGIj_0EM4u000005feFD.png) -6. Proceed through the prompts until you see the **Pre-Installation Summary** window and confirm that it matches your server's settings: +5. Proceed through the prompts until you see the **Pre-Installation Summary** window and confirm that it matches your server's settings: -![Postgres Pre-Installation Summary](./../0-images/ka0Qk000000CGIj_0EM4u000005feFN.png) + ![Postgres Pre-Installation Summary](./../0-images/ka0Qk000000CGIj_0EM4u000005feFN.png) -7. Once satisfied with the **Pre-Installation Summary** window, click **Next** two more times to proceed with the installation. +6. After you are satisfied with the **Pre-Installation Summary** window, click **Next** two more times to proceed with the installation. -8. Once the installation is finished, you are prompted to restart your server. Restart your server. +7. After the installation finishes, you are prompted to restart your server. Restart your server. -9. To confirm the success of your installation, use the PowerShell commands from Step 1 to verify that your version number matches the installer. +8. To confirm the success of your installation, use the PowerShell commands from the first step to verify that your version number matches the installer. diff --git a/docs/kb/privilegesecure/database-and-backend/timeout-during-reading-attempt-error.md b/docs/kb/privilegesecure/database-and-backend/timeout-during-reading-attempt-error.md index 9c040f1a7c..1f4af01e99 100644 --- a/docs/kb/privilegesecure/database-and-backend/timeout-during-reading-attempt-error.md +++ b/docs/kb/privilegesecure/database-and-backend/timeout-during-reading-attempt-error.md @@ -1,9 +1,7 @@ --- description: >- - When Netwrix Privilege Secure synchronizes with Entra ID, you may see a - "Timeout during reading attempt" error in event logs. This article explains - the cause and steps to increase the command timeout to allow synchronization - to complete. + Fix the "Timeout during reading attempt" error during Entra ID synchronization + in Privilege Secure by increasing the Command Timeout to 3600. keywords: - Entra ID - Azure Active Directory @@ -14,10 +12,13 @@ keywords: - synchronization - Stealthbits - NPS Database Configuration Tool + - Timeout during reading attempt products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Timeout During Reading Attempt Error -tags: [] +tags: + - kb + - database-and-backend title: "Timeout During Reading Attempt Error" knowledge_article_id: kA0Qk0000000XC5KAM --- @@ -26,7 +27,7 @@ knowledge_article_id: kA0Qk0000000XC5KAM ## Symptom -Netwrix Privilege Secure prompts the following error in Entra ID (formerly Azure Active Directory) event logs: +Netwrix Privilege Secure for Access Management prompts the following error in Entra ID (formerly Azure Active Directory) event logs: ``` Data processing error: Exception while reading from stream, @@ -35,13 +36,13 @@ Timeout during reading attempt ## Cause -In larger Entra ID environments (e.g., with 9000 users or more), timeouts may hinder Entra ID synchronization. +In larger Entra ID environments (for example, with 9000 users or more), timeouts may hinder Entra ID synchronization. ## Resolution Adjust the timeout setting to prevent the synchronization from being interrupted prematurely: -1. On the NPS server, locate the NPS Database Configuration Tool in ` %ProgramFiles%\Stealthbits\PAM\DatabaseConfig\DatabaseConfigUI` by default. +1. On the Privilege Secure server, locate the NPS Database Configuration Tool in ` %ProgramFiles%\Stealthbits\PAM\DatabaseConfig\DatabaseConfigUI` by default. 2. Run the `NPS.DbCfg.exe` tool. 3. Locate the **Command Timeout** line and increase the value to `3600`. The extended timeout should allow the Entra ID synchronization to complete. 4. Click **Save** to save changes. diff --git a/docs/kb/privilegesecure/database-and-backend/using-the-database-configuration-tool-to-change-the-postgres-db-password.md b/docs/kb/privilegesecure/database-and-backend/using-the-database-configuration-tool-to-change-the-postgres-db-password.md index 7ab8ad0bda..5bdc2bb80d 100644 --- a/docs/kb/privilegesecure/database-and-backend/using-the-database-configuration-tool-to-change-the-postgres-db-password.md +++ b/docs/kb/privilegesecure/database-and-backend/using-the-database-configuration-tool-to-change-the-postgres-db-password.md @@ -1,8 +1,7 @@ --- description: >- - Learn how to use the Database Configuration tool (DbCfg.msi) to change the - Postgres database password used by Netwrix Privilege Secure (NPS), and ensure - the new password is securely vaulted. + Use the Database Configuration tool (DbCfg.msi) to change the Postgres + password used by Privilege Secure and vault the new password securely. keywords: - Postgres - password @@ -12,44 +11,46 @@ keywords: - Netwrix Privilege Secure - NPS - PAM + - Database Configuration tool + - Stealthbits products: - - privilege-secure-access-management -sidebar_label: Using the Database Configuration Tool to Change th -tags: [] + - privilegesecure +sidebar_label: Using the Database Configuration Tool to Change the Postgres DB Password +tags: + - kb + - database-and-backend title: "Using the Database Configuration Tool to Change the Postgres DB Password" knowledge_article_id: kA04u000001112KCAQ --- # Using the Database Configuration Tool to Change the Postgres DB Password -## Summary +## Overview -While it is essential that remote access to the Netwrix Privilege Secure (NPS) server be locked down, as an additional layer of security, you may wish to further harden your NPS server by periodically changing the password to the NPS Postgres database. As such, Netwrix Privilege Secure includes a Database Configuration tool (`DbCfg.msi`) that allows changing the privileged Postgres service account password used by NPS. +This article describes how to use the Database Configuration tool (`DbCfg.msi`) to change the privileged Postgres service account password used by Netwrix Privilege Secure for Access Management. While it is essential that remote access to the Privilege Secure server be locked down, as an additional layer of security, you may want to further harden your server by periodically changing the password to the Privilege Secure Postgres database. **_The changed password should be securely vaulted, and local Administrator access to the DbCfg tool should be tightly controlled._** ## Instructions -1. On the Netwrix Privilege Secure (NPS) server, navigate to the "Extras" folder in the NPS installer download directory. The Database Configuration tool installer (`DbCfg.msi`) is included in this directory. Launch the installer, and select **Next**. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxNl.png) +1. On the Privilege Secure server, go to the "Extras" folder in the Privilege Secure installer download directory. The Database Configuration tool installer (`DbCfg.msi`) is included in this directory. Launch the installer, and select **Next**. + ![Database Configuration tool installer with the Next button](./../0-images/ka04u00000117Sx_0EM4u000008LxNl.png) -2. Review and accept the EULA. Select **Next**. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxOZ.png) +2. Review and accept the end user license agreement (EULA). Select **Next**. + ![Installer license agreement page with the Next button](./../0-images/ka04u00000117Sx_0EM4u000008LxOZ.png) -3. Choose an installation path. The default installation path is `C:\Program Files\Stealthbits\PAM\`. Select **Next**. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxOj.png) +3. Choose an installation path. The default installation path is `C:\Program Files\Stealthbits\PAM\`. Select **Next**. + ![Installer installation path page with the default path and the Next button](./../0-images/ka04u00000117Sx_0EM4u000008LxOj.png) -4. Select **Install**, and confirm any UAC prompt that occurs. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxOo.png) +4. Select **Install**, and confirm any UAC prompt that occurs. The installation completes shortly. + ![Installer with the Install button](./../0-images/ka04u00000117Sx_0EM4u000008LxOo.png) + ![Installer showing the installation completing](./../0-images/ka04u00000117Sx_0EM4u000008LxOt.png) -5. The installation will complete shortly. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxOt.png) +5. Go to the installation directory and launch `DbCfg.exe` from your chosen installation directory. + ![Installation directory containing DbCfg.exe](./../0-images/ka04u00000117Sx_0EM4u000008LxOy.png) -6. Navigate to the installation directory and launch `DbCfg.exe` from your chosen installation directory. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxOy.png) +6. You can select **Test** to confirm your connection to the Postgres DB. + ![Database Configuration tool with the Test button](./../0-images/ka04u00000117Sx_0EM4u000008LxP3.png) -7. You can click **Test** to confirm your connection to the Postgres DB. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxP3.png) - -8. Set a new password in the Password field and hit **Save** to change the Postgres password. If your Test connection from step 7 was successful, you should receive a "Configuration saved successfully" response, which indicates a successful password change. This change will propagate to any NPS service that needs to use the database password. - ![image.png](./../0-images/ka04u00000117Sx_0EM4u000008LxP8.png) +7. Set a new password in the Password field and select **Save** to change the Postgres password. If your Test connection from step 6 was successful, you should receive a "Configuration saved successfully" response, which indicates a successful password change. This change propagates to any Privilege Secure service that needs to use the database password. + ![Database Configuration tool with the Password field and the Save button](./../0-images/ka04u00000117Sx_0EM4u000008LxP8.png) diff --git a/docs/kb/privilegesecure/high-availability-and-clustering/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md b/docs/kb/privilegesecure/high-availability-and-clustering/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md index 7e3f9a1408..23e8d8b6bd 100644 --- a/docs/kb/privilegesecure/high-availability-and-clustering/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md +++ b/docs/kb/privilegesecure/high-availability-and-clustering/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md @@ -1,9 +1,7 @@ --- description: >- - Explains how to configure PostgreSQL high availability (HA) for Netwrix - Privilege Secure using the NPS.HaMgr.exe tool, and how to upgrade an existing - HA server pair and remote service nodes, including troubleshooting steps and - encryption key handling. + Configure PostgreSQL high availability (HA) with NPS.HaMgr.exe, and upgrade + an HA server pair and remote service nodes, including encryption keys. keywords: - high availability - HA @@ -15,10 +13,13 @@ keywords: - encryption keys - pg_hba.conf - failover + - SbPAM.RotateKey products: - - privilege-secure-access-management -sidebar_label: Configuring and Upgrading in High Availability Mod -tags: [] + - privilegesecure +sidebar_label: "Configuring and Upgrading in High Availability Mode and Using Remote Services Configurations" +tags: + - kb + - high-availability-and-clustering title: "Configuring and Upgrading in High Availability Mode and Using Remote Services Configurations" knowledge_article_id: kA04u0000000K8ICAU --- @@ -27,47 +28,47 @@ knowledge_article_id: kA04u0000000K8ICAU ## Overview -This article explains how to configure PostgreSQL high availability (HA) for Netwrix Privilege Secure using the `NPS.HaMgr.exe` (NPS HA Configuration Tool). It also includes steps to upgrade an existing HA server pair and to upgrade remote service nodes. The `NPS.HaMgr.exe` tool is available in the **Extras** folder of the Netwrix Privilege Secure download directory. This implementation of HA is active/passive—if the primary server becomes unavailable, you must perform a manual failover to switch to the secondary database. All applications and services remain active on their respective servers; however, both write only to the primary database. +This article describes how to configure PostgreSQL high availability (HA) for Netwrix Privilege Secure for Access Management using the `NPS.HaMgr.exe` (NPS HA Configuration Tool). It also includes steps to upgrade an existing HA server pair and to upgrade remote service nodes. The `NPS.HaMgr.exe` tool is available in the **Extras** folder of the Privilege Secure download directory. This implementation of HA is active/passive—if the primary server becomes unavailable, you must perform a manual failover to switch to the secondary database. All applications and services remain active on their respective servers; however, both write only to the primary database. -> **NOTE:** If the primary server becomes unavailable and a failover is required, refer to the "Upgrade an Existing NPS High Availability (HA) Pair" section for steps." +> **NOTE:** If the primary server becomes unavailable and a failover is required, see the "Upgrade an Existing NPS High Availability (HA) Pair" section for steps." -> **IMPORTANT:** Before configuring HA, perform the following steps on both primary and secondary Netwrix Privilege Secure servers: +> **IMPORTANT:** Before configuring HA, perform the following steps on both primary and secondary Privilege Secure servers: > -> 1. Open the HA tool. Click the folder icon to the right of the `PgDataDir` path to open the **Postgres** folder. +> 1. Open the HA tool. Click the folder icon to the right of the `PgDataDir` path to open the **Postgres** folder. > 2. Locate the **Archive** folder. Delete the contents of the **Archive** folder. -> **IMPORTANT:** After establishing the HA pair, use the primary Netwrix Privilege Secure server. The database on the secondary server runs in read-only mode in the HA pair. +> **IMPORTANT:** After establishing the HA pair, use the primary Privilege Secure server. The database on the secondary server runs in read-only mode in the HA pair. -> **IMPORTANT:** A reboot is required on all Netwrix Privilege Secure servers for both initial installations and upgrades. +> **IMPORTANT:** A reboot is required on all Privilege Secure servers for both initial installations and upgrades. + +This article contains the following sections: - Initial Configuration -- Upgrades 1. Before You Begin -2. Upgrading from 3.6 or Higher to 3.7CU1 (3.7.1250) or Higher -3. HA Upgrade Instructions - 1. Summary – HA Upgrade - 2. Failover and Upgrade the Secondary - 3. Upgrade the Primary - 4. Copy appsettings.json File to the Secondary - 5. Copy the Encryption Keys to the Secondary - 6. Re-establish HA on the Secondary - 7. Verify the Secondary - 8. Verify the Primary -4. Remote Service Upgrade Instructions - 1. Summary – Remote Service Upgrade - 2. Upgrade the Netwrix Privilege Secure Server - 3. Upgrade All Remote Services - 4. Export the Encryption Keys from the Netwrix Privilege Secure Server (Action and Scheduler Services only) - 5. Copy the Encryption Keys to the Remote Hosts (Action and Scheduler Services only) - 6. Re-register the Services on the Netwrix Privilege Secure Server -5. HA Troubleshooting - -## Initial Configuration - -Perform the following steps to configure an HA pair: - -1. Verify that both `5432` (PostgreSQL) and `6500` (Netwrix Privilege Secure Web Services) ports are open between the servers. +2. HA Upgrade Instructions + 1. Failover and Upgrade the Secondary + 2. Upgrade the Primary + 3. Copy appsettings.json File to the Secondary + 4. Copy the Encryption Keys to the Secondary + 5. Re-establish HA on the Secondary + 6. Verify the Secondary + 7. Verify the Primary +3. Remote Service Upgrade Instructions + 1. Upgrade the Netwrix Privilege Secure Server + 2. Upgrade All Remote Services + 3. Export the Encryption Keys from the Netwrix Privilege Secure Server (Action and Scheduler Services only) + 4. Copy the Encryption Keys to the Remote Hosts (Action and Scheduler Services only) + 5. Re-register the Services on the Netwrix Privilege Secure Server +4. HA Troubleshooting + +## Instructions + +### Initial Configuration + +Complete the following steps to configure an HA pair: + +1. Verify that both `5432` (PostgreSQL) and `6500` (Privilege Secure Web Services) ports are open between the servers. - If either port was modified, open the corresponding port instead. - The HA tool creates exclusion rules for Windows Firewall, but your network firewall may still block these ports. 2. Copy the HA tool from the **Extras** folder to the following folder on both primary and secondary servers: @@ -88,13 +89,11 @@ Perform the following steps to configure an HA pair: > > **IMPORTANT:** Do not proceed to the next step until both servers have a green check mark in the HA Manager. -5. Follow the instructions in How to Configure Encryption Keys in Multiple Netwrix Privilege Secure Server Environments ⸱ Netwrix to export the encryption keys from the primary server to the secondary server. - [How to Configure Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md) +5. Follow the instructions in [Configuring Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md) to export the encryption keys from the primary server to the secondary server. 6. On the primary server, locate the `appsettings.json` file at `C:\ProgramData\Stealthbits\PAM\HA\appsettings.json` and copy it to the same path on the secondary server. 7. Run the HA tool on the secondary server. Specify the **Primary IP**, **Primary Port**, and **Secondary IP**. - > **IMPORTANT:** The HA tool might prompt errors and warnings after you enter the values. This behavior is expected. - > Do not update or refresh any of the fields. + > **IMPORTANT:** The HA tool might prompt errors and warnings after you enter the values. This behavior is expected. Do not update or refresh any of the fields. 8. Close the HA tool on both the primary and secondary servers. 9. Run the HA tool on the primary server and verify the IP address and port fields. Click **Update** in the **Secondary Node** section to update the `pg_hba.conf` file. @@ -102,171 +101,164 @@ Perform the following steps to configure an HA pair: > **NOTE:** If the **Configure HA Secondary** button does not appear, close the tool on both servers, restart the primary HA tool, and start the secondary HA tool. -11. Click the **Configure HA Secondary** button. Proceed with the backup for the existing database—the stream from the primary to the secondary should begin after. - The initial streaming may take several minutes depending on the amount of data to be replicated. +11. Click the **Configure HA Secondary** button. Proceed with the backup for the existing database—the stream from the primary to the secondary should begin after. The initial streaming may take several minutes depending on the amount of data to be replicated. > **NOTE:** To confirm HA is configured, review the **Postgres Status** values for both nodes—they should state **Running Primary** and **Running Replica** depending on the role. -12. Verify that you can log in to Netwrix Privilege Secure on both servers. - -## Upgrades +12. Verify that you can log in to Privilege Secure on both servers. ### Before You Begin -Determine if your Netwrix Privilege Secure environment has HA and/or remote services configured. - -- For HA, launch the Netwrix Privilege Secure HA Configuration Tool (NPS.HaMgr) that was packaged with your installer on your primary server. If **Replication Status** is listed as **Active**, HA is configured. -- For remote services, launch Netwrix Privilege Secure and check if there are any remote hosts listed under **service nodes**. If there are, you have remote services that will need to be upgraded. - -If neither of these are configured, you may proceed with a standard Netwrix Privilege Secure upgrade and bypass the steps outlined in this article. Otherwise, proceed to the appropriate section(s) for HA and/or remote services. +Determine whether your Privilege Secure environment has HA and/or remote services configured. -### Upgrading from 3.6 or Higher to 3.7CU1 (3.7.1250) or Higher +- For HA, launch the Privilege Secure HA Configuration Tool (NPS.HaMgr) that was packaged with your installer on your primary server. If **Replication Status** is listed as **Active**, HA is configured. +- For remote services, launch Privilege Secure and check whether any remote hosts are listed under **service nodes**. If there are, you have remote services that need to be upgraded. -When upgrading from 3.6, it is assumed that all of your encryption keys are in agreement on all Netwrix Privilege Secure servers and remote service nodes. The 3.7CU1 installer will retain the existing encryption keys on each server, and you can omit any steps in the following instructions involving the export and import of encryption keys. +If neither of these is configured, you may proceed with a standard Privilege Secure upgrade and bypass the steps outlined in this article. Otherwise, proceed to the appropriate sections for HA and/or remote services. -## HA Upgrade Instructions +> **NOTE:** When upgrading from 3.6 or higher to 3.7CU1 (3.7.1250) or higher, it is assumed that all of your encryption keys are in agreement on all Privilege Secure servers and remote service nodes. The 3.7CU1 installer retains the existing encryption keys on each server, and you can omit any steps in the following instructions involving the export and import of encryption keys. -### Summary +### HA Upgrade Instructions -Each host in the active/passive configuration must be upgraded, starting with the secondary (passive) host and proceeding to the primary (active) host. After both hosts are upgraded, steps are included to ensure that both Netwrix Privilege Secure installations share the same encryption keys. Once the encryption keys match, the primary and secondary are restored to an HA configuration and their services are re-registered in the Netwrix Privilege Secure console. +Each host in the active/passive configuration must be upgraded, starting with the secondary (passive) host and proceeding to the primary (active) host. After both hosts are upgraded, steps are included to ensure that both Privilege Secure installations share the same encryption keys. After the encryption keys match, the primary and secondary are restored to an HA configuration and their services are re-registered in the Privilege Secure console. -### Failover and Upgrade the Secondary +#### Step 1 — Failover and Upgrade the Secondary -1. Create a new folder in your Netwrix Privilege Secure installation folder: +1. Create a new folder in your Privilege Secure installation folder: ```text C:\Program Files\Stealthbits\PAM\HA Tools ``` -2. Copy the HA Manager Tool from your download directory `Extras\NPS.HaMgr.exe` to the installation folder `C:\Program Files\Stealthbits\PAM\HA Tools`. If you have an older copy of the HA Tool, make sure to copy the existing configuration file over so the tool has the previous configuration values. +2. Copy the HA Manager Tool from your download directory `Extras\NPS.HaMgr.exe` to the installation folder `C:\Program Files\Stealthbits\PAM\HA Tools`. If you have an older copy of the HA Tool, ensure you copy the existing configuration file over so the tool has the previous configuration values. 3. Start the HA Manager Tool `NPS.HaMgr.exe`. -4. Click the **Failover** button on the HA Tool UI. This will update the PostgreSQL database on the secondary so the upgrade can be performed on the secondary without impacting the primary. +4. Click the **Failover** button on the HA Tool UI. This updates the PostgreSQL database on the secondary so the upgrade can be performed on the secondary without impacting the primary. - > **NOTE:** Clicking **Failover** flips the IP Address of the primary and the secondary hosts. Make sure to undo this change after the upgrade. + > **NOTE:** Clicking **Failover** flips the IP Address of the primary and the secondary hosts. Ensure you undo this change after the upgrade. 5. Run `NPS_Setup` and click the **Upgrade Netwrix Privilege Secure** button. 6. After the installer completes, close the installer and close `NPS_Setup`. -### Upgrade the Primary +#### Step 2 — Upgrade the Primary -1. Create a new folder in your Netwrix Privilege Secure installation folder: +1. Create a new folder in your Privilege Secure installation folder: ```text C:\Program Files\Stealthbits\PAM\HA Tools ``` -2. Copy the HA Manager Tool from the download directory `Extras\NPS.HaMgr.exe` to the installation folder `C:\Program Files\Stealthbits\PAM\HA Tools`. If you have an older copy of the HA Tool, make sure to copy the existing configuration file over so the tool has the previous configuration values. +2. Copy the HA Manager Tool from the download directory `Extras\NPS.HaMgr.exe` to the installation folder `C:\Program Files\Stealthbits\PAM\HA Tools`. If you have an older copy of the HA Tool, ensure you copy the existing configuration file over so the tool has the previous configuration values. 3. Start the HA Manager Tool `NPS.HaMgr.exe`. -4. You will see that HA is not configured; that will be addressed later. +4. The tool shows that HA is not configured; this is addressed later. 5. Run `NPS_Setup` and click the **Upgrade Netwrix Privilege Secure** button. 6. After the installer completes, close the installer and close `NPS_Setup`. -### Copy appsettings.json File to the Secondary +#### Step 3 — Copy appsettings.json File to the Secondary -1. On the primary server, locate the `appsettings.json` file at `C:\ProgramData\Stealthbits\PAM\HA\appsettings.json` and copy it to the same path on the secondary server. +On the primary server, locate the `appsettings.json` file at `C:\ProgramData\Stealthbits\PAM\HA\appsettings.json` and copy it to the same path on the secondary server. -### Copy the Encryption Keys to the Secondary +#### Step 4 — Copy the Encryption Keys to the Secondary 1. On the primary server, run `cmd` as Administrator. -2. Type the following commands to export the encryption keys for the secondary: +2. Enter the following commands to export the encryption keys for the secondary: ```text cd "C:\Program Files\Stealthbits\PAM\KeyTools" .\SbPAM.RotateKey.exe export -n keys.exp ``` 3. Take note of the password for the export file. - > **IMPORTANT:** This temporary password protects the Netwrix Privilege Secure encryption keys during copying. Do not save it to digital media or transmit it with the encryption key package. + > **IMPORTANT:** This temporary password protects the Privilege Secure encryption keys during copying. Do not save it to digital media or transmit it with the encryption key package. 4. Copy the export file to `C:\Program Files\Stealthbits\PAM\KeyTools` on the secondary server. 5. On the secondary server, run `cmd` as Administrator. -6. Type the following commands to import the encryption keys: +6. Enter the following commands to import the encryption keys: ```text cd "C:\Program Files\Stealthbits\PAM\KeyTools" .\SbPAM.RotateKey.exe import -n keys.exp ``` -7. You are prompted for the password. -8. Delete the export file from both the primary and secondary servers. -### Re-establish HA on the Secondary + You are prompted for the password. +7. Delete the export file from both the primary and secondary servers. + +#### Step 5 — Re-establish HA on the Secondary 1. Launch the HA Tool on the secondary server. 2. Enter the primary IP address into the **Primary IP** text box. 3. Enter the secondary IP address into the **Secondary IP** text box. 4. Click the **Configure HA** button. -### Verify the Secondary +#### Step 6 — Verify the Secondary 1. Connect to the secondary Web UI directly. -2. Log in with a Netwrix Privilege Secure Administrator account (`domain\\user`). +2. Log in with a Privilege Secure Administrator account (`domain\\user`). 3. Go to the **Configuration > System Settings > Services** page. Verify the URL is properly configured so the services are communicating with the secondary service. 4. Click **Register Services**. -5. Navigate to **Service Nodes**. - 1. Verify that your secondary server shows up as online. - 2. Verify that your primary server shows up as online. +5. Go to **Service Nodes**. + - Verify that your secondary server shows up as online. + - Verify that your primary server shows up as online. -### Verify the Primary +#### Step 7 — Verify the Primary 1. Connect to the primary Web UI directly. -2. Log in with a Netwrix Privilege Secure Administrator account (`domain\\user`). +2. Log in with a Privilege Secure Administrator account (`domain\\user`). 3. Go to the **Configuration > System Settings > Services** page. Verify the URL is properly configured so the services are communicating with the secondary service. 4. Click **Register Services**. -5. Navigate to **Service Nodes**. - 1. Verify that your primary server shows up as online. - 2. Verify that your secondary server shows up as online. - -## Remote Service Upgrade Instructions +5. Go to **Service Nodes**. + - Verify that your primary server shows up as online. + - Verify that your secondary server shows up as online. -### Summary +### Remote Service Upgrade Instructions -In addition to upgrading the Netwrix Privilege Secure server, you must upgrade each remote host with a remote service. After remote hosts are upgraded, steps are included to ensure that the remote services share the same encryption keys as the Netwrix Privilege Secure server. Once the encryption keys match, the services are re-registered in the Netwrix Privilege Secure console. +In addition to upgrading the Privilege Secure server, you must upgrade each remote host with a remote service. After remote hosts are upgraded, steps are included to ensure that the remote services share the same encryption keys as the Privilege Secure server. After the encryption keys match, the services are re-registered in the Privilege Secure console. > **NOTE:** The encryption key import instructions apply only to remote Action and Scheduler services—not Proxy services. -### Upgrade the Netwrix Privilege Secure Server +#### Step 1 — Upgrade the Netwrix Privilege Secure Server 1. Run `NPS_Setup` and click the **Upgrade Netwrix Privilege Secure** button. 2. After the installer completes, close the installer and close `NPS_Setup`. -### Upgrade All Remote Services +#### Step 2 — Upgrade All Remote Services 1. Run the appropriate service-specific installer on each remote host (for example, `ActionService.exe` for the Action Service). 2. After the installer completes, close the installer. -### Export the Encryption Keys from the Netwrix Privilege Secure Server (Action and Scheduler Services only) +#### Step 3 — Export the Encryption Keys from the Netwrix Privilege Secure Server (Action and Scheduler Services only) -1. On the Netwrix Privilege Secure server, run `cmd` as Administrator. -2. Type the following commands to export the encryption keys for the secondary: +1. On the Privilege Secure server, run `cmd` as Administrator. +2. Enter the following commands to export the encryption keys for the secondary: ```text cd "C:\Program Files\Stealthbits\PAM\KeyTools" .\SbPAM.RotateKey.exe export -n keys.exp ``` 3. Take note of the password for the export file. - > **IMPORTANT:** This temporary password protects the Netwrix Privilege Secure encryption keys during copying. Do not save it to digital media or transmit it with the encryption key package. + > **IMPORTANT:** This temporary password protects the Privilege Secure encryption keys during copying. Do not save it to digital media or transmit it with the encryption key package. -### Copy the Encryption Keys to the Remote Hosts (Action and Scheduler Services only) +#### Step 4 — Copy the Encryption Keys to the Remote Hosts (Action and Scheduler Services only) For each remote host running a remote service, do the following: 1. Copy the `keys.exp` file to `C:\Program Files\Stealthbits\PAM\KeyTools`. -2. Run `cmd` as Administrator. Type the following commands to import the encryption keys: +2. Run `cmd` as Administrator. Enter the following commands to import the encryption keys: ```text cd "C:\Program Files\Stealthbits\PAM\KeyTools" .\SbPAM.RotateKey.exe import -n keys.exp ``` -3. You are prompted for the password. -4. Delete the export file from the remote host. -Once all remote hosts have the correct encryption keys, delete the export file from the Netwrix Privilege Secure server. + You are prompted for the password. +3. Delete the export file from the remote host. + +After all remote hosts have the correct encryption keys, delete the export file from the Privilege Secure server. -### Re-register the Services on the Netwrix Privilege Secure Server +#### Step 5 — Re-register the Services on the Netwrix Privilege Secure Server 1. Connect to the primary Web UI directly. -2. Log in with a Netwrix Privilege Secure Administrator account (`domain\\user`). +2. Log in with a Privilege Secure Administrator account (`domain\\user`). 3. Click **Register Services**. -4. Navigate to **Service Nodes**. Verify that all remote service nodes are listed as online. +4. Go to **Service Nodes**. Verify that all remote service nodes are listed as online. -## HA Troubleshooting +### HA Troubleshooting -The following steps allow you to manually configure critical HA settings on your HA pair. +Complete the following steps to manually configure critical HA settings on your HA pair: -1. On the primary server, navigate to the `%PROGRAMDATA%\Stealthbits\Postgres12` folder. Refer to the following default path: +1. On the primary server, go to the `%PROGRAMDATA%\Stealthbits\Postgres12` folder. The following is the default path: ```text C:\ProgramData\Stealthbits\Postgres16 ``` @@ -276,7 +268,7 @@ The following steps allow you to manually configure critical HA settings on your host all all %SECONDARY_IP%/32 md5 ``` Replace the `%SECONDARY_IP%` placeholders with the IP address of your secondary server. Save the changes. -3. On the secondary server, navigate to the `%PROGRAMDATA%\Stealthbits\Postgres12` folder. Refer to the following default path: +3. On the secondary server, go to the `%PROGRAMDATA%\Stealthbits\Postgres12` folder. The following is the default path: ```text C:\ProgramData\Stealthbits\Postgres16 ``` diff --git a/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md b/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md index 443c23534f..5961f41f0f 100644 --- a/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md +++ b/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md @@ -1,8 +1,7 @@ --- description: >- - This article explains how to export and import Netwrix Privilege Secure (NPS) - encryption keys across multiple NPS servers to enable high availability (HA) - configurations. + Export and import Netwrix Privilege Secure encryption keys across multiple + servers to enable high availability (HA) configurations. keywords: - Netwrix Privilege Secure - NPS @@ -15,54 +14,56 @@ keywords: - license - PostgreSQL products: - - privilege-secure-access-management -sidebar_label: How to Configure Encryption Keys in Multiple NPS S -tags: [] -title: "How to Configure Encryption Keys in Multiple NPS Server Environments" + - privilegesecure +sidebar_label: Configuring Encryption Keys in Multiple NPS Server Environments +tags: + - kb + - high-availability-and-clustering +title: "Configuring Encryption Keys in Multiple NPS Server Environments" knowledge_article_id: kA0Qk0000000rYzKAI --- -# How to Configure Encryption Keys in Multiple NPS Server Environments +# Configuring Encryption Keys in Multiple NPS Server Environments ## Overview -This article covers the steps to configure encryption keys in environments with multiple Netwrix Privilege Secure (NPS) servers. Apply these steps when setting up high availability (HA) in your environment. Refer to the following article for additional information on establishing active/passive HA with PostgreSQL backend: [How to Use NPS.HaMgr.exe](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u0000000HfOCAU.html). +This article describes how to configure encryption keys in environments with multiple Netwrix Privilege Secure for Access Management servers. Apply these steps when setting up high availability (HA) in your environment. For additional information on establishing active/passive HA with PostgreSQL backend, see [How to Use NPS.HaMgr.exe](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u0000000HfOCAU.html). ## Instructions -> **NOTE:** The following steps apply to SbPAM v3.6, v3.7, and higher and to NPS v.4.0 and higher. +> **NOTE:** The following steps apply to SbPAM v3.6, v3.7, and higher and to Privilege Secure v.4.0 and higher. -Refer to the following steps to verify that NPS encryption keys are configured on all NPS servers: +Complete the following steps to verify that Privilege Secure encryption keys are configured on all Privilege Secure servers: > **IMPORTANT:** For the following steps, if the application was installed to a dedicated drive, change the drive letter from **X** to the appropriate letter. -1. Install NPS on the primary and secondary servers. Apply your license file to both NPS instances. Refer to the following article for additional information on applying a license: [Apply a New License](/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md). +1. Install Privilege Secure on the primary and secondary servers. Apply your license file to both Privilege Secure instances. For additional information on applying a license, see [Applying a New License](/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md). 2. On your primary server, run the following lines in elevated Command Prompt: -```bat -cd "X:\Program Files\Stealthbits\PAM\KeyTools" -.\SbPAM.RotateKey.exe export -n keys.exp -``` + ```bat + cd "X:\Program Files\Stealthbits\PAM\KeyTools" + .\SbPAM.RotateKey.exe export -n keys.exp + ``` -3. Command Prompt prompts a password used to protect the NPS encryption keys. Take note of the password to use it later. +3. Command Prompt prompts a password used to protect the encryption keys. Take note of the password to use it later. 4. Copy the exported file to the following path on the secondary server: -`X:\Program Files\Stealthbits\PAM\KeyTools` + `X:\Program Files\Stealthbits\PAM\KeyTools` 5. On your secondary server, run the following lines in elevated Command Prompt: -```bat -cd "X:\Program Files\Stealthbits\PAM\KeyTools" -.\SbPAM.RotateKey.exe import -n keys.exp -``` + ```bat + cd "X:\Program Files\Stealthbits\PAM\KeyTools" + .\SbPAM.RotateKey.exe import -n keys.exp + ``` 6. Enter the password when prompted. 7. Delete the exported keys file and any saved passwords from both servers. -## Related articles +## Related Links - [How to Use NPS.HaMgr.exe](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u0000000HfOCAU.html) -- [Apply a New License](/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md) +- [Applying a New License](/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md) diff --git a/docs/kb/privilegesecure/high-availability-and-clustering/how-to-create-a-service-mesh-between-app-servers.md b/docs/kb/privilegesecure/high-availability-and-clustering/how-to-create-a-service-mesh-between-app-servers.md index ba065d69f9..f5b13fab11 100644 --- a/docs/kb/privilegesecure/high-availability-and-clustering/how-to-create-a-service-mesh-between-app-servers.md +++ b/docs/kb/privilegesecure/high-availability-and-clustering/how-to-create-a-service-mesh-between-app-servers.md @@ -1,9 +1,5 @@ --- -description: >- - Step-by-step instructions to configure a service mesh between Netwrix - Privilege Secure application servers, including high-availability - prerequisites, key exchange requirements, node registration, and optional - recording replication. +description: "Configure a service mesh between Privilege Secure application servers, including HA and key exchange prerequisites, node registration, and replication." keywords: - service mesh - Privilege Secure @@ -12,27 +8,32 @@ keywords: - appsettings.jwt.json - recording replication - iolog + - sbpam_iolog.json - high availability products: - - privilege-secure-access-management -sidebar_label: How to Create a Service Mesh Between App Servers -tags: [] -title: "How to Create a Service Mesh Between App Servers" + - privilegesecure +sidebar_label: Creating a Service Mesh Between App Servers +tags: + - kb + - high-availability-and-clustering +title: "Creating a Service Mesh Between App Servers" knowledge_article_id: kA04u0000000JqxCAE --- -# How to Create a Service Mesh Between App Servers +# Creating a Service Mesh Between App Servers ## Overview -This article outlines the steps to configure a service mesh in Netwrix Privilege Secure for Access Management. Follow these instructions to ensure proper setup and high availability. +This article describes how to configure a service mesh in Netwrix Privilege Secure for Access Management. Follow these instructions to ensure proper setup and high availability. -- If you have two application servers with internal PostgreSQL on each, you must configure high availability (HA) before configuring a service mesh. For additional information on the HA setup, see Configure and Upgrade Netwrix Privilege Secure in High Availability Mode and Using Remote Services Configurations: [Configuring and Upgrading in High Availability Mode and Using Remote Services Configurations](/docs/kb/privilegesecure/high-availability-and-clustering/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md) -- In both PostgreSQL and SQL Server deployments, you must complete the key exchange in your environment before configuring a service mesh. For additional information on the key exchange setup, see [How to Configure Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md) +Complete the following before configuring a service mesh: -> **IMPORTANT:** Multi-factor authentication should be disabled for the Netwrix Privilege Secure Administrator account, if used. While this is indicated by an error message when running `sbpam-proxy.exe`, the error will not indicate the missing 2FA or the need to disable it prior to running. +- If you have two application servers with internal PostgreSQL on each, you must configure high availability (HA) before configuring a service mesh. For additional information on the HA setup, see [Configuring and Upgrading in High Availability Mode and Using Remote Services Configurations](/docs/kb/privilegesecure/high-availability-and-clustering/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md). +- In both PostgreSQL and SQL Server deployments, you must complete the key exchange in your environment before configuring a service mesh. For additional information on the key exchange setup, see [Configuring Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md). -For additional information on used protocols and ports, see [Port, Firewall, and Datacenter Requirements](https://docs.netwrix.com/docs/privilegesecurediscovery/requirements/portsandfirewalls#firewall-rules) +> **IMPORTANT:** Multi-factor authentication (MFA) should be disabled for the Privilege Secure Administrator account, if used. While this is indicated by an error message when running `sbpam-proxy.exe`, the error does not indicate the missing 2FA or the need to disable it before running. + +For additional information on used protocols and ports, see [Port, Firewall, and Datacenter Requirements](https://docs.netwrix.com/docs/privilegesecurediscovery/requirements/portsandfirewalls#firewall-rules). ## Instructions @@ -50,7 +51,7 @@ For additional information on used protocols and ports, see [Port, Firewall, and ``` In the primary `.json` file, locate the `Jwt` node. Copy it to the `appsettings.jwt.json` file on the secondary server. - > **NOTE:** The `Jwt` node consists of the contents found within the `{}` braces following `Jwt`. Typically, the `Jwt` node will be the only node defined in the file. The entire file can be copied from one server to another, as in the following example. + > **NOTE:** The `Jwt` node consists of the contents found within the `{}` braces following `Jwt`. Typically, the `Jwt` node is the only node defined in the file. You can copy the entire file from one server to another, as in the following example. ![Example of Jwt node in appsettings.jwt.json file](./../0-images/ka0Qk000000FWkL_0EMQk000004AOpx.png) @@ -83,7 +84,7 @@ For additional information on used protocols and ports, see [Port, Firewall, and C:\ProgramData\Stealthbits\PAM\tls\certs\sbpam-node.crt ``` - > **NOTE:** The `sbpam-node.crt` file may reappear immediately following deletion—this behavior is expected. + > **NOTE:** The `sbpam-node.crt` file may reappear immediately following deletion. This behavior is expected. 9. On the primary server, run the following command in an elevated Command Prompt to obtain the CA hash: ```text @@ -112,13 +113,13 @@ For additional information on used protocols and ports, see [Port, Firewall, and Restart-Service w3svc ``` -## Enabling Recording Replication (Optional) +### Enabling Recording Replication (Optional) -To enable replication of session recordings (`.webm` files for web sessions, `.iolog` files for non-web sessions), perform the following steps: +Complete the following steps to enable replication of session recordings (`.webm` files for web sessions, `.iolog` files for non-web sessions): > **IMPORTANT:** This must be done on both servers. The `sbpam_iolog.json` file is generated on the C drive regardless of the location from which the command is run. -1. Generate the **iolog config** by opening a command prompt, navigating to `X:\Program Files\Stealthbits\PAM\ProxyService`, and running: +1. Open a command prompt, go to `X:\Program Files\Stealthbits\PAM\ProxyService`, and run the following command to generate the **iolog config**: ```text sbpam-proxy.exe cfg -c sbpam_iolog ``` @@ -128,13 +129,13 @@ To enable replication of session recordings (`.webm` files for web sessions, `.i "replicas": 2 ``` -3. Once the file is saved, restart the proxy service and recording replication should occur. +3. After the file is saved, restart the proxy service. Recording replication should occur. For detailed steps on moving the recording locations, see [Changing the Path Where Session Recordings Are Stored](/docs/kb/privilegesecure/session-management-and-recording/how-to-change-the-path-where-session-recordings-are-stored.md). -## Related Articles +## Related Links - [Configuring and Upgrading in High Availability Mode and Using Remote Services Configurations](/docs/kb/privilegesecure/high-availability-and-clustering/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md) -- [How to Configure Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md) +- [Configuring Encryption Keys in Multiple NPS Server Environments](/docs/kb/privilegesecure/high-availability-and-clustering/how-to-configure-encryption-keys-in-multiple-nps-server-environments.md) - [Port, Firewall, and Datacenter Requirements](https://docs.netwrix.com/docs/privilegesecurediscovery/requirements/portsandfirewalls#firewall-rules) - [Changing the Path Where Session Recordings Are Stored](/docs/kb/privilegesecure/session-management-and-recording/how-to-change-the-path-where-session-recordings-are-stored.md) diff --git a/docs/kb/privilegesecure/high-availability-and-clustering/index-was-outside-the-bounds-of-array-error.md b/docs/kb/privilegesecure/high-availability-and-clustering/index-was-outside-the-bounds-of-array-error.md index f26fd8d12a..a62cb7b793 100644 --- a/docs/kb/privilegesecure/high-availability-and-clustering/index-was-outside-the-bounds-of-array-error.md +++ b/docs/kb/privilegesecure/high-availability-and-clustering/index-was-outside-the-bounds-of-array-error.md @@ -1,9 +1,7 @@ --- description: >- - Netwrix Privilege Secure's High Availability Configuration tool returns "Index - was outside the bounds of the array." when the NPS Rest URL has no port. This - article explains the cause and shows how to resolve it by specifying port 443 - in the URL. + The High Availability Configuration tool returns "Index was outside the bounds + of the array." when the NPS Rest URL has no port. Specify port 443 in the URL. keywords: - NPS Rest URL - HA Configuration @@ -11,11 +9,17 @@ keywords: - NPS.HAMgr - port 443 - Privilege Secure + - High Availability + - HA Configuration tool + - Services page + - FQDN products: - - privilege-secure-access-management + - privilegesecure visibility: public sidebar_label: Index Was Outside the Bounds of Array Error -tags: [] +tags: + - kb + - high-availability-and-clustering title: "Index Was Outside the Bounds of Array Error" knowledge_article_id: kA04u00000110w7CAA --- @@ -24,7 +28,7 @@ knowledge_article_id: kA04u00000110w7CAA ## Symptom -Netwrix Privilege Secure generates the following error on each launch of the High Availability (HA) Configuration tool (`NPS.HAMgr`): +Netwrix Privilege Secure for Access Management generates the following error on each launch of the High Availability (HA) Configuration tool (`NPS.HAMgr`): ``` Index was outside the bounds of the array. @@ -34,16 +38,16 @@ Index was outside the bounds of the array. The HA Configuration tool expects a port value at the end of the NPS Rest URL. If you configured your NPS Rest URL without a port, the HA Configuration tool prompts an error because it expects a port. -> **NOTE:** To verify how your NPS Rest URL is set up, refer to the following steps: +> **NOTE:** To verify how your NPS Rest URL is set up, complete the following steps: > > 1. On the main Privilege Secure screen, click the **Configuration** tab. -> 2. In the left pane, select **Services**. The page will include the **NPS Rest URL** field. To learn more about the **Services** page in Netwrix Privilege Secure, refer to the following article: System Settings Pages − Services Page · v4.0. +> 2. In the left pane, select **Services**. The page includes the **NPS Rest URL** field. For more information about the **Services** page in Privilege Secure, see the following article: System Settings Pages − Services Page · v4.0. > > ![Services page screenshot](./../0-images/ka0Qk0000002ijJ_0EMQk000003vpYj.png) ## Resolution -Specify the `443` port in the NPS Rest URL. Refer to the following code block for the Rest URL syntax and example: +Specify the `443` port in the NPS Rest URL. The following code block shows the Rest URL syntax and an example: ``` FQDN:port diff --git a/docs/kb/privilegesecure/index.md b/docs/kb/privilegesecure/index.md index 33a1a858d5..10c9166e6d 100644 --- a/docs/kb/privilegesecure/index.md +++ b/docs/kb/privilegesecure/index.md @@ -6,13 +6,14 @@ slug: privilegesecure # Privilege Secure Knowledge Base -Welcome to the Privilege Secure knowledge base. Browse our collection of troubleshooting guides, configuration instructions, and best practices. +Welcome to the Privilege Secure knowledge base. Browse the collection of troubleshooting guides, configuration instructions, and best practices. Use the search function above to find specific articles or browse through all Privilege Secure KB articles in this section. -## Need Help? +## Getting Help -If you can't find what you're looking for: -1. Use the search function above -2. Check the main Privilege Secure documentation -3. Contact [Netwrix support](https://www.netwrix.com/support.html) \ No newline at end of file +If you cannot find what you are looking for: + +- Use the search function above. +- Check the main Privilege Secure documentation. +- Contact [Netwrix support](https://www.netwrix.com/support.html). diff --git a/docs/kb/privilegesecure/installation-configuration-and-licensing/add-cache-settings-for-javascript-files-to-improve-nps-page-load-performance.md b/docs/kb/privilegesecure/installation-configuration-and-licensing/add-cache-settings-for-javascript-files-to-improve-nps-page-load-performance.md index 0cc88d5dac..fceb7714c0 100644 --- a/docs/kb/privilegesecure/installation-configuration-and-licensing/add-cache-settings-for-javascript-files-to-improve-nps-page-load-performance.md +++ b/docs/kb/privilegesecure/installation-configuration-and-licensing/add-cache-settings-for-javascript-files-to-improve-nps-page-load-performance.md @@ -1,8 +1,7 @@ --- description: >- - Add an IIS outbound rewrite rule to set Cache-Control for JavaScript files - served by Netwrix Privilege Secure to improve page load performance and reduce - SAML login failures caused by repeated downloads of large ReactJS bundles. + Add an IIS outbound rewrite rule that sets Cache-Control for JavaScript files to + reduce SAML login failures caused by repeated large ReactJS downloads. keywords: - cache-control - IIS @@ -12,29 +11,33 @@ keywords: - SAML - web.config - performance + - ReactJS + - NPS products: - - privilege-secure-access-management -sidebar_label: Add Cache Settings for JavaScript Files to Improve -tags: [] -title: "Add Cache Settings for JavaScript Files to Improve NPS Page Load Performance" + - privilegesecure +sidebar_label: Adding Cache Settings for JavaScript Files to Improve NPS Page Load Performance +tags: + - kb + - installation-configuration-and-licensing +title: "Adding Cache Settings for JavaScript Files to Improve NPS Page Load Performance" knowledge_article_id: kA04u000001113mCAA --- -# Add Cache Settings for JavaScript Files to Improve NPS Page Load Performance +# Adding Cache Settings for JavaScript Files to Improve NPS Page Load Performance -## Summary +## Overview -The main ReactJS bundle for the Netwrix Privilege Secure website is 6.5MB. This is sent with the HTTP header `Cache-Control: no-cache, no-store`. This causes SAML Logins to sometimes fail, as downloading the ReactJS module during each login can cause the SAML token cache to expire. +This article describes how to create an IIS configuration setting that updates the `Cache-Control` header for all JavaScript files that are downloaded from the Netwrix Privilege Secure for Access Management web service. This setting improves the performance of the website and lowers the burden on the webservice. -To address this issue, you can create an IIS configuration setting that will update the `Cache-Control` header for all JavaScript files that are downloaded from the Netwrix Privilege Secure web service. This will improve the performance of the website and lower the burden on the webservice. +The main ReactJS bundle for the Privilege Secure website is 6.5MB. This is sent with the HTTP header `Cache-Control: no-cache, no-store`. This causes SAML Logins to sometimes fail, as downloading the ReactJS module during each login can cause the SAML token cache to expire. ## Instructions -1. On all NPS servers, download and install the Url Rewrite module. +1. On all Privilege Secure servers, download and install the Url Rewrite module. https://www.iis.net/downloads/microsoft/url-rewrite -2. Navigate to your NPS Web directory (by default, `C:\Program Files\Stealthbits\PAM\Web\)` and make a copy of the web.config file. +2. Go to your Privilege Secure Web directory (by default, `C:\Program Files\Stealthbits\PAM\Web\)` and make a copy of the `web.config` file. 3. Open the file `C:\Program Files\Stealthbits\PAM\Web\web.config` in a text editor. Find this line: @@ -56,7 +59,7 @@ To address this issue, you can create an IIS configuration setting that will upd ``` -5. Save the file +5. Save the file. 6. Launch a PowerShell window and restart IIS using the command: @@ -66,16 +69,18 @@ To address this issue, you can create an IIS configuration setting that will upd 7. To verify the file is now cached, open Chrome or Edge and then open the developer tools. -8. Open your NPS web page and look at the `Network` tab in the developer tools Window. +8. Open your Privilege Secure web page and look at the `Network` tab in the developer tools window. -9. See the page download: - ![001.png](./../0-images/ka0Qk0000000zjR_0EM4u000008M2O1.png) +9. See the page download: -10. Reload the page, see it is loaded from the cache: - ![002.png](./../0-images/ka0Qk0000000zjR_0EM4u000008M2O6.png) + ![Network tab in the browser developer tools showing the page download](./../0-images/ka0Qk0000000zjR_0EM4u000008M2O1.png) -11. Copy the updated `web.config` to `C:\Program Files\Stealthbits\PAM\Web\web.config.rewrite`, you will need this for future upgrades. +10. Reload the page, see it is loaded from the cache: -## Upgrades + ![Network tab in the browser developer tools showing the page loaded from the cache](./../0-images/ka0Qk0000000zjR_0EM4u000008M2O6.png) -1. After an upgrade of NPS, you will need to copy the `C:\Program Files\Stealthbits\PAM\Web\web.config.rewrite` file to `C:\Program Files\Stealthbits\PAM\Web\web.config` in order to restore the cache settings. +11. Copy the updated `web.config` to `C:\Program Files\Stealthbits\PAM\Web\web.config.rewrite`; you need this copy for future upgrades. + +### Restoring the Cache Settings After an Upgrade + +After an upgrade of Privilege Secure, copy the `C:\Program Files\Stealthbits\PAM\Web\web.config.rewrite` file to `C:\Program Files\Stealthbits\PAM\Web\web.config` to restore the cache settings. diff --git a/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md b/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md index ddc9b11b63..a1bf4141e6 100644 --- a/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md +++ b/docs/kb/privilegesecure/installation-configuration-and-licensing/apply-a-new-license.md @@ -1,7 +1,7 @@ --- description: >- - Shows how to import a new license file into Netwrix Privilege Secure Access - Management using the web UI or PowerShell. + Import a new license key file into Netwrix Privilege Secure for Access + Management using the web interface or PowerShell. keywords: - license - import license @@ -10,54 +10,58 @@ keywords: - Administrator - About page - trial license + - SbPAM + - LicenseInfo products: - privilegesecure visibility: public -sidebar_label: Apply a New License -tags: [] -title: "Apply a New License" +sidebar_label: "Applying a New License" +tags: + - kb + - installation-configuration-and-licensing +title: "Applying a New License" knowledge_article_id: kA04u000000PdKZCA0 --- -# Apply a New License +# Applying a New License ## Overview -This article outlines how to apply a new license to the Netwrix Privilege Secure Access Management server. +This article describes how to apply a new license to the Netwrix Privilege Secure for Access Management server. ## Instructions -Netwrix Privilege Secure Access Management comes with a 30-day trial license. Once this trial has expired, a new license key file will need to be imported. +Privilege Secure comes with a 30-day trial license. After this trial expires, a new license key file must be imported. -1. Log in to the Netwrix Privilege Secure Access Management web application as an account with the Administrator role. - - In Netwrix Privilege Secure Access Management 3.5 or earlier, the built-in Admin account may be used. - - > **IMPORTANT:** The `Domain` field must be set to `` in order to log in with the built-in Admin account. - - - In Netwrix Privilege Secure Access Management 3.7 or later, a local user with the Administrator role may be used. - -2. Click your account name in the upper-right corner of the page, and then click **About SbPAM** to open the page to update the product's license. +1. Log in to the Privilege Secure web application as an account with the Administrator role. + - In Privilege Secure 3.5 or earlier, you can use the built-in Admin account. - > **IMPORTANT:** If a new license key file is needed, then please contact your Netwrix Account Manager. + > **IMPORTANT:** The `Domain` field must be set to `` to log in with the built-in Admin account. - ![The user settings dropdown menu in Netwrix Privilege Secure Access Management.](./../0-images/ka0Qk000000DgJB_0EM4u000004biJb.png) + - In Privilege Secure 3.7 or later, you can use a local user with the Administrator role. -3. Click **Import License**. A Windows file dialog opens. Navigate to the location of the new license key file, select it, and click **Open**. The license is imported, and the displayed license information is updated. +2. Click your account name in the upper-right corner of the page, and then click **About SbPAM** to open the page to update the product's license. - ![The About page in Netwrix Privilege Secure Access Management's web application interface.](./../0-images/ka0Qk000000DgJB_0EM4u000004biJg.png) + > **IMPORTANT:** If you need a new license key file, contact your Netwrix Account Manager. + + ![User settings dropdown menu in Privilege Secure with the About SbPAM option](./../0-images/ka0Qk000000DgJB_0EM4u000004biJb.png) + +3. Click **Import License**. A Windows file dialog opens. Go to the location of the new license key file, select it, and click **Open**. The license is imported, and the displayed license information is updated. + + ![About page in the Privilege Secure web application with the Import License button](./../0-images/ka0Qk000000DgJB_0EM4u000004biJg.png) ### Alternate Instructions (PowerShell) -1. Open an elevated PowerShell window. +1. Open a PowerShell window as an administrator. 2. Modify the following PowerShell script so that the second line contains the correct local path for your license file: -```powershell -Add-Type -AssemblyName System.Web -$licenseFilePath = "path to license file" ## Change to match the local path to the license file -$license = Get-Content $licenseFilePath -$encoded = [System.Web.HttpUtility]::UrlEncode($license) -$sbpamURI = "http://localhost:6501" -Invoke-RestMethod -Method POST -URI "$($sbpamURI)/api/v1/LicenseInfo?License=$encoded" -``` + ```powershell + Add-Type -AssemblyName System.Web + $licenseFilePath = "path to license file" ## Change to match the local path to the license file + $license = Get-Content $licenseFilePath + $encoded = [System.Web.HttpUtility]::UrlEncode($license) + $sbpamURI = "http://localhost:6501" + Invoke-RestMethod -Method POST -URI "$($sbpamURI)/api/v1/LicenseInfo?License=$encoded" + ``` -3. Copy and paste the modified script into PowerShell and execute it. Your license should now be imported into Netwrix Privilege Secure Access Management. +3. Copy and paste the modified script into PowerShell and execute it. Your license should now be imported into Privilege Secure. diff --git a/docs/kb/privilegesecure/installation-configuration-and-licensing/change-the-built-in-admin-password.md b/docs/kb/privilegesecure/installation-configuration-and-licensing/change-the-built-in-admin-password.md index 7152ff9c36..4be1025c5a 100644 --- a/docs/kb/privilegesecure/installation-configuration-and-licensing/change-the-built-in-admin-password.md +++ b/docs/kb/privilegesecure/installation-configuration-and-licensing/change-the-built-in-admin-password.md @@ -1,8 +1,6 @@ --- description: >- - This article outlines how to change the password of Netwrix Privilege Secure's - built-in Admin account and explains required login settings and post-change - behavior. + Change the password of the built-in Admin account in Privilege Secure, including the required Domain field setting and what happens after the change. keywords: - admin password - built-in admin @@ -11,36 +9,40 @@ keywords: - privileged access - Domain field - login + - Change Password + - Admin account products: - - privilege-secure-access-management -sidebar_label: Change the Built-In Admin Password -tags: [] -title: "Change the Built-In Admin Password" + - privilegesecure +sidebar_label: "Changing the Built-In Admin Password" +tags: + - kb + - installation-configuration-and-licensing +title: "Changing the Built-In Admin Password" knowledge_article_id: kA04u000000PdKjCAK --- -# Change the Built-In Admin Password +# Changing the Built-In Admin Password -## Summary +## Overview -This article outlines how to change the password of Netwrix Privilege Secure's built-in Admin account. +This article describes how to change the password of the built-in Admin account in Netwrix Privilege Secure for Access Management. ## Instructions -1. Sign in to Netwrix Privilege Secure using the Admin account. +1. Sign in to Privilege Secure using the Admin account. - ![A filled-in log-in form for SbPAM's web interface.](./../0-images/ka04u000000HdF3AAK_1.png) + ![A filled-in log-in form for the Privilege Secure web interface.](./../0-images/ka04u000000HdF3AAK_1.png) -2. IMPORTANT: The `Domain` field must be set to `""` in order to log in with the built-in Admin account. + > **IMPORTANT:** The `Domain` field must be set to `""` to log in with the built-in Admin account. -3. In the upper-right of the page, click **Admin** and then **Settings**. +2. In the upper-right of the page, click **Admin** and then **Settings**. - ![The user settings dropdown menu in SbPAM.](./../0-images/ka04u000000HdF3AAK_2.png) + ![The user settings dropdown menu in Privilege Secure.](./../0-images/ka04u000000HdF3AAK_2.png) -4. The **Change Password** menu appears on the page and can be used to set a new password for the built-in Admin account. +3. Use the **Change Password** menu that appears on the page to set a new password for the built-in Admin account. - ![The Change Password form for SbPAM's built-in Admin account.](./../0-images/ka04u000000HdF3AAK_3.png) + ![The Change Password form for the Privilege Secure built-in Admin account.](./../0-images/ka04u000000HdF3AAK_3.png) -5. If the password change is successful, you are immediately logged out of Netwrix Privilege Secure and presented with the log-in page. + If the password change is successful, you are immediately logged out of Privilege Secure and presented with the log-in page. - IMPORTANT: Previously used passwords cannot be used and will result in an error when attempting to change the password. + > **IMPORTANT:** Previously used passwords cannot be used and result in an error when you attempt to change the password. diff --git a/docs/kb/privilegesecure/installation-configuration-and-licensing/exclusions-for-antivirus-av-endpoint-software.md b/docs/kb/privilegesecure/installation-configuration-and-licensing/exclusions-for-antivirus-av-endpoint-software.md index dc5ddc20db..bd0b60db3c 100644 --- a/docs/kb/privilegesecure/installation-configuration-and-licensing/exclusions-for-antivirus-av-endpoint-software.md +++ b/docs/kb/privilegesecure/installation-configuration-and-licensing/exclusions-for-antivirus-av-endpoint-software.md @@ -1,8 +1,7 @@ --- description: >- - Lists antivirus and endpoint protection exclusions required on Netwrix - Privilege Secure servers and registered remote nodes to ensure optimal - workflow performance. + Directories to exclude from antivirus and endpoint protection on Netwrix + Privilege Secure servers and registered remote nodes for optimal performance. keywords: - privilege secure - antivirus exclusions @@ -14,28 +13,35 @@ keywords: - Postgres - performance products: - - privilege-secure-access-management -sidebar_label: Exclusions for Antivirus (AV) & Endpoint Software -tags: [] -title: "Exclusions for Antivirus (AV) & Endpoint Software" + - privilegesecure +sidebar_label: "Configuring Exclusions for Antivirus (AV) & Endpoint Software" +tags: + - kb + - installation-configuration-and-licensing +title: "Configuring Exclusions for Antivirus (AV) & Endpoint Software" knowledge_article_id: kA04u0000000Hi8CAE --- -# Exclusions for Antivirus (AV) & Endpoint Software +# Configuring Exclusions for Antivirus (AV) & Endpoint Software -## Summary -Certain directories should be excluded from antivirus and endpoint protection on the Netwrix Privilege Secure (NPS) server and any registered remote nodes (ex. remote **Proxy Service**, remote **Action Service**) to ensure optimal performance of NPS workflows. +## Overview + +This article describes the directories to exclude from antivirus and endpoint protection software on the Netwrix Privilege Secure for Access Management server and any registered remote nodes (for example, remote **Proxy Service**, remote **Action Service**) to ensure optimal performance of Privilege Secure workflows. Examples of unwanted behaviors caused by antivirus or endpoint protection include: + - **NPS UI** fails to load or crashes to a blank page. - **NPS UI** experience errors in the browser's Developer Console. - **NPS UI** feels unresponsive, with pages taking much longer than usual to load. -- Communication between the NPS server and its remote nodes feels slow (ex. service node's information UI takes a long time to load). +- Communication between the Privilege Secure server and its remote nodes feels slow (for example, service node's information UI takes a long time to load). ## Instructions -On all NPS servers and remote nodes running Action Services, Proxy Services, etc., you should exclude the following directories from antivirus and endpoint protection software. Please note a drive letter is not used in each path as that can be customized during each NPS and service installation. -The following exclusions should be configured on each NPS server: +On all Privilege Secure servers and remote nodes running Action Services, Proxy Services, and so on, exclude the following directories from antivirus and endpoint protection software. + +> **NOTE:** The paths do not include a drive letter because it can be customized during each Privilege Secure and service installation. + +Configure the following exclusions on each Privilege Secure server: ```text \Program Files\Stealthbits\PAM\ActionService @@ -46,13 +52,13 @@ The following exclusions should be configured on each NPS server: \ProgramData\Stealthbits\PostgreSQL16 ``` -The following exclusion should be configured on each server with a remote Proxy Service: +Configure the following exclusion on each server with a remote Proxy Service: ```text \Program Files\Stealthbits\PAM\ProxyService ``` -The following exclusions should be configured on each server with a remote Action Service: +Configure the following exclusions on each server with a remote Action Service: ```text \Program Files\Stealthbits\PAM\ProxyService @@ -60,7 +66,7 @@ The following exclusions should be configured on each server with a remote Actio \Program Files\Stealthbits\PAM\ActionServiceWorker ``` -The following exclusions should be configured on each server with a remote Action Service and Host Scan Service: +Configure the following exclusions on each server with a remote Action Service and Host Scan Service: ```text \Program Files\Stealthbits\PAM\ProxyService @@ -69,7 +75,7 @@ The following exclusions should be configured on each server with a remote Actio \Program Files\Stealthbits\PAM\HostScanService ``` -The following exclusions should be configured on each server with a remote Scheduler Service: +Configure the following exclusions on each server with a remote Scheduler Service: ```text \Program Files\Stealthbits\PAM\ProxyService diff --git a/docs/kb/privilegesecure/installation-configuration-and-licensing/rescheduling-iis-app-pool-recycling.md b/docs/kb/privilegesecure/installation-configuration-and-licensing/rescheduling-iis-app-pool-recycling.md index 67b0fcba48..c656a0822c 100644 --- a/docs/kb/privilegesecure/installation-configuration-and-licensing/rescheduling-iis-app-pool-recycling.md +++ b/docs/kb/privilegesecure/installation-configuration-and-licensing/rescheduling-iis-app-pool-recycling.md @@ -1,9 +1,7 @@ --- description: >- - Explains how to reschedule IIS application pool recycling for the Netwrix - Privilege Secure web service so recycling occurs at specified off‑peak times. - This reduces the chance that recycling will interfere with Netwrix Privilege - Secure services. + Reschedule IIS app pool recycling for the Privilege Secure web service to + off-peak times so recycling is less likely to interfere with its services. keywords: - IIS - application pool @@ -14,24 +12,33 @@ keywords: - off-peak - Recycling schedule products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Rescheduling IIS App Pool Recycling -tags: [] +tags: + - kb + - installation-configuration-and-licensing title: "Rescheduling IIS App Pool Recycling" knowledge_article_id: kA04u000001113cCAA --- # Rescheduling IIS App Pool Recycling -## Summary -Periodic app pool recycling is a necessary IIS process, and as such the Netwrix Privilege Secure web service deploys with the default IIS app pool recycling settings (every 29 hours) enabled. In some Netwrix Privilege Secure environments, especially those with periods of high peak usage, you may want to schedule IIS app pool recycling to occur at specified times of off-peak usage. This reduces the likelihood of recycling interacting with Netwrix Privilege Secure services. +## Overview + +This article describes how to reschedule IIS app pool recycling for the Netwrix Privilege Secure for Access Management web service so that recycling occurs at specified times of off-peak usage. + +Periodic app pool recycling is a necessary IIS process, and as such the Privilege Secure web service deploys with the default IIS app pool recycling settings (every 29 hours) enabled. In some Privilege Secure environments, especially those with periods of high peak usage, you might want to schedule IIS app pool recycling to occur at specified times of off-peak usage. This reduces the likelihood of recycling interacting with Privilege Secure services. ## Instructions -1. On the server hosting Netwrix Privilege Secure, launch IIS Manager (`inetmgr.exe`). -2. In the left-hand menu, select **Application Pools**, and in the main window, select **SbPAMAppPool** - ![image.png](./../0-images/ka0Qk0000000zl3_0EM4u000008Lyes.png) -3. On the right-hand menu, select **Recycling** to open the Recycling settings. - ![image.png](./../0-images/ka0Qk0000000zl3_0EM4u000008LyfH.png) -4. You can change the default value of `1740 minutes (29 hours)` to **Specific time(s)** in order to recycle the application pool either less frequently, and/or to recycle the application pool during off-peak hours. Click **Next**. -5. Click **Finish** to save your new app pool recycling schedule. - ![image.png](./../0-images/ka0Qk0000000zl3_0EM4u000008LyfW.png) + +1. On the server hosting Privilege Secure, launch IIS Manager (`inetmgr.exe`). +2. In the left-hand menu, select **Application Pools**, and in the main window, select **SbPAMAppPool**. + + ![IIS Manager with SbPAMAppPool selected under Application Pools](./../0-images/ka0Qk0000000zl3_0EM4u000008Lyes.png) +3. In the right-hand menu, select **Recycling** to open the Recycling settings. + + ![Recycling option in the right-hand menu for the SbPAMAppPool application pool](./../0-images/ka0Qk0000000zl3_0EM4u000008LyfH.png) +4. You can change the default value of `1740 minutes (29 hours)` to **Specific time(s)** to recycle the application pool less frequently, during off-peak hours, or both. Click **Next**. +5. Click **Finish** to save your new app pool recycling schedule. + + ![Finish page of the recycling settings wizard](./../0-images/ka0Qk0000000zl3_0EM4u000008LyfW.png) diff --git a/docs/kb/privilegesecure/network-and-platform-integration/cisco-ssh-session-fails-with-error-ssh-handshake-failed-ssh-no-common-algorithm-for-key-exchange.md b/docs/kb/privilegesecure/network-and-platform-integration/cisco-ssh-session-fails-with-error-ssh-handshake-failed-ssh-no-common-algorithm-for-key-exchange.md index abe56f9cbd..23c5374d18 100644 --- a/docs/kb/privilegesecure/network-and-platform-integration/cisco-ssh-session-fails-with-error-ssh-handshake-failed-ssh-no-common-algorithm-for-key-exchange.md +++ b/docs/kb/privilegesecure/network-and-platform-integration/cisco-ssh-session-fails-with-error-ssh-handshake-failed-ssh-no-common-algorithm-for-key-exchange.md @@ -1,9 +1,7 @@ --- description: >- - When a Cisco SSH session launched through Netwrix Privilege Secure fails with - a key-exchange algorithm mismatch, update the proxy server's sbpam_ssh.json to - include older key exchanges and ciphers. These steps show how to modify the - configuration and reprovision the session. + Fix a Cisco SSH session that fails with a key exchange algorithm mismatch by + adding older key exchanges and ciphers to the proxy's sbpam_ssh.json. keywords: - SSH - Cisco @@ -13,78 +11,80 @@ keywords: - sbpam-proxy.exe - Netwrix Privilege Secure - handshake error + - SbPAM + - diffie-hellman-group1-sha1 products: - - privilege-secure-access-management -sidebar_label: 'Cisco SSH session fails with error "ssh: handshake' -tags: [] -title: >- - Cisco SSH session fails with error "ssh: handshake failed: ssh: no common - algorithm for key exchange" + - privilegesecure +sidebar_label: 'Cisco SSH Session Fails with Error "ssh: handshake failed: ssh: no common algorithm for key exchange"' +tags: + - kb + - network-and-platform-integration +title: 'Cisco SSH Session Fails with Error "ssh: handshake failed: ssh: no common algorithm for key exchange"' knowledge_article_id: kA04u0000000HQxCAM --- -# Cisco SSH session fails with error "ssh: handshake failed: ssh: no common algorithm for key exchange" +# Cisco SSH Session Fails with Error "ssh: handshake failed: ssh: no common algorithm for key exchange" -## Summary +## Symptom -When launching a Cisco SSH activity through Netwrix Privilege Secure, the session fails with: +When launching a Cisco SSH activity through Netwrix Privilege Secure for Access Management, the session fails with: ```text ssh: handshake failed: ssh: no common algorithm for key exchange; client offered: [curve25519-sha256@libssh.org ecdh-sha2-nistp256 ecdh-sha2-nistp384 ecdh -sha2-nistp521 diffie-hellman-group14-sha1], server offered: [diffie-hellman-group1-sha1] ``` -## Issue +## Cause -The SSH Key Exchange and Ciphers supported by the switch are older than the defaults used by the proxy, so Netwrix Privilege Secure cannot connect with out-of-the-box settings. +The SSH Key Exchange and Ciphers supported by the switch are older than the defaults used by the proxy, so Privilege Secure cannot connect with default settings. -## Instructions +## Resolution -Modify the Netwrix Privilege Secure proxy server's `sbpam_ssh.json` file to include the required Key Exchange algorithms and ciphers. +Modify the Privilege Secure proxy server's `sbpam_ssh.json` file to include the required Key Exchange algorithms and ciphers. -1. Log in to Windows on the Netwrix Privilege Secure proxy server. +1. Log in to Windows on the Privilege Secure proxy server. -2. Open an administrative PowerShell and run the following commands (where `C:\` is the drive Netwrix Privilege Secure is installed to): +2. Open an administrative PowerShell and run the following commands (where `C:\` is the drive Privilege Secure is installed to): -```powershell -cd "C:\Program Files\Stealthbits\PAM\ProxyService" -./sbpam-proxy.exe cfg -c sbpam_ssh -``` + ```powershell + cd "C:\Program Files\Stealthbits\PAM\ProxyService" + ./sbpam-proxy.exe cfg -c sbpam_ssh + ``` 3. Open File Explorer and browse to: -```text -C:\ProgramData\Stealthbits\PAM\ProxyService -``` - -4. Open `sbpam_ssh.json` in a text editor, and replace its contents with the following JSON (this will overwrite any previous configurations in this file, if present): - -```json -{ - "listenaddress": "0.0.0.0:4422", - "ClientSettings": { - "Algorithms": { - "KeyExchanges": [ - "curve25519-sha256@libssh.org", - "ecdh-sha2-nistp256", - "ecdh-sha2-nistp384", - "ecdh-sha2-nistp521", - "diffie-hellman-group14-sha1", - "diffie-hellman-group1-sha1" - ], - "Ciphers": [ - "aes128-gcm@openssh.com", - "chacha20-poly1305@openssh.com", - "aes128-ctr", - "aes192-ctr", - "aes256-ctr", - "aes128-cbc", - "3des-cbc", - "aes192-cbc", - "aes256-cbc" - ] - } - } -} -``` - -5. Save `sbpam_ssh.json` and close the editor. Provision the SSH session again in Netwrix Privilege Secure and verify that the SSH session can successfully log in to the Cisco device. + ```text + C:\ProgramData\Stealthbits\PAM\ProxyService + ``` + +4. Open `sbpam_ssh.json` in a text editor, and replace its contents with the following JSON (this overwrites any previous configurations in this file, if present): + + ```json + { + "listenaddress": "0.0.0.0:4422", + "ClientSettings": { + "Algorithms": { + "KeyExchanges": [ + "curve25519-sha256@libssh.org", + "ecdh-sha2-nistp256", + "ecdh-sha2-nistp384", + "ecdh-sha2-nistp521", + "diffie-hellman-group14-sha1", + "diffie-hellman-group1-sha1" + ], + "Ciphers": [ + "aes128-gcm@openssh.com", + "chacha20-poly1305@openssh.com", + "aes128-ctr", + "aes192-ctr", + "aes256-ctr", + "aes128-cbc", + "3des-cbc", + "aes192-cbc", + "aes256-cbc" + ] + } + } + } + ``` + +5. Save `sbpam_ssh.json` and close the editor. Provision the SSH session again in Privilege Secure and verify that the SSH session can successfully log in to the Cisco device. diff --git a/docs/kb/privilegesecure/network-and-platform-integration/creating-a-custom-platform-for-ssh-activity-sessions.md b/docs/kb/privilegesecure/network-and-platform-integration/creating-a-custom-platform-for-ssh-activity-sessions.md index a771fca8eb..73a39209be 100644 --- a/docs/kb/privilegesecure/network-and-platform-integration/creating-a-custom-platform-for-ssh-activity-sessions.md +++ b/docs/kb/privilegesecure/network-and-platform-integration/creating-a-custom-platform-for-ssh-activity-sessions.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to duplicate the out-of-the-box Linux platform to create a Palo Alto - (PAN-OS) platform in SbPAM, and how to configure the service account, - resource, activity, and access policy to launch SSH Activity Sessions. + Duplicate the Linux platform to create a Palo Alto (PAN-OS) platform, then set + up the service account, resource, activity, and access policy for SSH sessions. keywords: - SbPAM - SSH @@ -14,37 +13,38 @@ keywords: - access policy - resource products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Creating a Custom Platform for SSH Activity Sessio -tags: [] +tags: + - kb + - network-and-platform-integration title: "Creating a Custom Platform for SSH Activity Sessio" knowledge_article_id: kA04u0000000Hk9CAE --- # Creating a Custom Platform for SSH Activity Sessio -## Summary +## Overview -Platforms in SbPAM can be customized to meet specific SSH Activity Session workflow needs. As an example, in this article we will duplicate the out-of-the-box Linux Platform to create a Platform for Palo Alto (PAN-OS). +This article describes how to duplicate the built-in Linux Platform to create a Platform for Palo Alto (PAN-OS) in Netwrix Privilege Secure for Access Management. Platforms can be customized to meet specific SSH Activity Session workflow needs. ## Instructions -1. As an SbPAM admin user, navigate to the **Policy > Platforms** page. Locate the Linux Platform, duplicate it, and name it as desired. In this case, we will name the new Platform "Palo Alto". +1. As a Privilege Secure admin user, go to the **Policy > Platforms** page. Locate the Linux Platform, duplicate it, and name it as desired. In this example, name the new Platform "Palo Alto". - ![User-added image](./../0-images/ka04u000000HcaJ_0EM4u000004cJVQ.png) + ![Platforms page with the duplicated Palo Alto Platform selected in the Platforms list](./../0-images/ka04u000000HcaJ_0EM4u000004cJVQ.png) -2. Navigate to the **Configuration > Service Accounts** page and add a domain-level account as the Palo Alto service account. +2. Go to the **Configuration > Service Accounts** page and add a domain-level account as the Palo Alto service account. - ![User-added image](./../0-images/ka04u000000HcaJ_0EM4u000004cJVz.png) + ![Service Accounts page showing the Palo Alto service account with the Palo Alto Platform selected](./../0-images/ka04u000000HcaJ_0EM4u000004cJVz.png) -3. Navigate to the **Resources** page and manually add the Palo Alto resource by IP or DNS name (using the service account added in step 2). In this step, it is expected for the Host Scan to fail. Close the Host Scan window and proceed to the next step. +3. Go to the **Resources** page and manually add the Palo Alto resource by IP or DNS name (using the service account added in step 2). In this step, it is expected for the Host Scan to fail. Close the Host Scan window and proceed to the next step. - ![User-added image](./../0-images/ka04u000000HcaJ_0EM4u000004cJWE.png) + ![Add Resources page with Add Manually selected and a Palo Alto resource name entered](./../0-images/ka04u000000HcaJ_0EM4u000004cJWE.png) -4. Navigate to the **Activities** page and create a new Activity. For **Login Account**, "Activity Token", "Managed Account", or "Requester" can be used. For the Login Account Template, remove the domain element (ex. ` %targetdomain%`) or use ` %domain%` instead of ` %targetdomain%`. +4. Go to the **Activities** page and create a new Activity. For **Login Account**, you can use "Activity Token", "Managed Account", or "Requester". For the Login Account Template, remove the domain element (for example, ` %targetdomain%`) or use ` %domain%` instead of ` %targetdomain%`. - ![User-added image](./../0-images/ka04u000000HcaJ_0EM4u000004cJWJ.png) + ![New Palo Alto Activity with the Palo Alto Platform, Login Account, Activity Type, and Login Account Template fields](./../0-images/ka04u000000HcaJ_0EM4u000004cJWJ.png) -5. Navigate to the **Access Policy** page, create a new resource-based Access Policy that includes SbPAM users, the activity created in step 4, and the resource added in step 3. - -6. Navigate to **My Activities** as an SbPAM user in the Access Policy, and launch an SSH Activity Session for the Palo Alto resource. +5. Go to the **Access Policy** page, create a new resource-based Access Policy that includes Privilege Secure users, the activity created in step 4, and the resource added in step 3. +6. Go to **My Activities** as a Privilege Secure user in the Access Policy, and launch an SSH Activity Session for the Palo Alto resource. diff --git a/docs/kb/privilegesecure/network-and-platform-integration/onboarding-mac-devices-for-vnc-via-rds-remote-desktop-services.md b/docs/kb/privilegesecure/network-and-platform-integration/onboarding-mac-devices-for-vnc-via-rds-remote-desktop-services.md index 198d5d2868..cc6a634829 100644 --- a/docs/kb/privilegesecure/network-and-platform-integration/onboarding-mac-devices-for-vnc-via-rds-remote-desktop-services.md +++ b/docs/kb/privilegesecure/network-and-platform-integration/onboarding-mac-devices-for-vnc-via-rds-remote-desktop-services.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to onboard macOS devices into Netwrix Privilege Secure so users can - establish VNC connections via an RDS-hosted RemoteApp (RealVNC), including - RemoteApp registration and activity configuration. + Onboard macOS devices into Privilege Secure so users can connect over VNC + through a RealVNC RemoteApp on an RDS host. keywords: - macOS - VNC @@ -15,95 +14,133 @@ keywords: - proxy - '%token%' products: - - privilege-secure-access-management -sidebar_label: Onboarding Mac devices for VNC via RDS (Remote Des -tags: [] -title: "Onboarding Mac devices for VNC via RDS (Remote Desktop Services)" + - privilegesecure +sidebar_label: "Onboarding Mac Devices for VNC via RDS (Remote Desktop Services)" +tags: + - kb + - network-and-platform-integration +title: "Onboarding Mac Devices for VNC via RDS (Remote Desktop Services)" knowledge_article_id: kA0Qk0000000PcjKAE --- -# Onboarding Mac devices for VNC via RDS (Remote Desktop Services) +# Onboarding Mac Devices for VNC via RDS (Remote Desktop Services) ## Overview -This article provides instructions for onboarding macOS devices into Netwrix Privilege Secure (NPS) so that VNC connections can be established by way of an RDS server. The VNC session will leverage RealVNC, run as a RemoteApp. The target resource will automatically be selected, and the user will enter credential information as part of the login process. +This article describes how to onboard macOS devices into Netwrix Privilege Secure for Access Management so that Virtual Network Computing (VNC) connections can be established by way of a Remote Desktop Services (RDS) server. The VNC session uses RealVNC and runs as a RemoteApp. The target resource is selected automatically, and the user enters credential information as part of the login process. -**Note:** This article applies only for Netwrix Privilege Secure 4.2 or higher, as it requires the `%token%` variable for the **Application to Launch** activity setting. +> **NOTE:** This article applies only to Privilege Secure 4.2 or higher, as it requires the `%token%` variable for the **Application to Launch** activity setting. -**Note:** The `nps_realvnc` file used in these instructions must be obtained from Netwrix Support. +> **NOTE:** The `nps_realvnc` file used in these instructions must be obtained from [Netwrix Support](https://www.netwrix.com/support.html). -## Before You Begin +## Instructions -Ensure that VNC access to the target host works. [This documentation](https://support.apple.com/en-au/guide/remote-desktop/apdbed09830/mac) offers some general instructions. +### Before You Begin -## Instructions +Ensure that VNC access to the target host works. [Apple's Remote Desktop documentation](https://support.apple.com/en-au/guide/remote-desktop/apdbed09830/mac) offers some general instructions. + +### Step 1 — Creating the macOS Platform + +1. In Privilege Secure, go to **Policy > Platforms**. +2. Select the **Windows** platform, and click the **Copy** icon. + + ![Policy Platforms page with the Windows platform selected and the Copy icon highlighted](./../0-images/ka0Qk0000006Ukz_0EMQk000002d1vx.png) + +3. Change the name of the new platform to **macOS**. Ensure that the schedules are all set to ``. Then click **Save**. + + ![New platform renamed to macOS with all schedules set to none](./../0-images/ka0Qk0000006Ukz_0EMQk000002czm7.png) + +### Step 2 — Creating Service Accounts + +1. On the **Configuration > Service Accounts** page, click the **+** icon and create a **macOS** service account. + + ![Service Accounts page with the macOS service account being created](./../0-images/ka0Qk0000006Ukz_0EMQk000002d2NN.png) + + > **NOTE:** The username and password do not matter. The macOS devices cannot be scanned, but a service account must be supplied to onboard the macOS resources. + +### Step 3 — Onboarding macOS Resources + +1. Go to **Resources**. Click the **Add** button, and click **New Server**. On the **Add Resources** page, click the **Import from CSV** radio button, and click the **Download CSV Template** button. This downloads a CSV template, which you can then populate with macOS resources, as in this example: + + ![CSV template populated with macOS resources](./../0-images/ka0Qk0000006Ukz_0EMQk000002d2iL.png) + + > **NOTE:** It is crucial that the **Platform** exactly matches the Platform configured earlier, and that the **Credential** exactly matches the Service Account name configured earlier. The **Operating System** value is for informational purposes only, and is not matched to any other values. + +2. Return to the **Add Resources** page in step 1 of this section. Click the **Import CSV** button and upload the CSV file that was just configured. The resources are displayed on the Add Resources page. + + ![Add Resources page listing the imported macOS resources](./../0-images/ka0Qk0000006Ukz_0EMQk000002d3BN.png) + +3. Select the resources you want to onboard (the **Select All** checkbox may be used) and click **Add**. +4. The dialog shows that a scan is **Pending** on all of the resources. This scan ends in an **Error**. This is expected, as Privilege Secure cannot scan macOS, and this error occurs during initial onboarding. + + ![Add Resources dialog showing a Pending scan on the macOS resources](./../0-images/ka0Qk0000006Ukz_0EMQk000002clZS.png) + +5. Go to the **Resources** page and confirm that the onboarded macOS resources are present. + + ![Resources page listing the onboarded macOS resources](./../0-images/ka0Qk0000006Ukz_0EMQk000002d3mT.png) + +### Step 4 — Registering the nps_realvnc RemoteApp + +1. Copy the `nps_realvnc.zip` file to the desktop of the RDS host where the RemoteApp is published. Copy the contents to a folder where they can be accessed, for example `C:\npslaunchers`. -### Creating the macOS Platform - -1. In Netwrix Privilege Secure, navigate to **Policy > Platforms**. -2. Select the **Windows** platform, and click the **Copy** icon. - ![001.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d1vx.png) -3. Change the name of the new platform to **macOS**. Ensure that the schedules are all set to ``. Then click **Save**. - ![002.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002czm7.png) - -### Creating Service Accounts - -1. On the **Configuration > Service Accounts** page, click the **+** icon and create a **macOS** service account. Note that the username and password do not matter - the macOS devices cannot be scanned, but a service account must be supplied to onboard the macOS resources. - ![003.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d2NN.png) - -### Onboarding macOS Resources - -1. Navigate to **Resources**. Click the **Add** button, and click **New Server**. On the **Add Resources** page, click the **Import from CSV** radio button, and click the **Download CSV Template** button. This will download a CSV template, which you can then populate with macOS resources, as in this example - - ![004.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d2iL.png) -2. Note that it is crucial that the **Platform** exactly matches the Platform configured earlier, and that the **Credential** exactly matches the Service Account name configured earlier. The **Operating System** value is for informational purposes only, and will not be matched to any other values. -3. Return to the **Add Resources** page in step 1 of this section. Click the **Import CSV** button and upload the CSV file that was just configured. The resources are displayed on the Add Resources page. - ![005.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d3BN.png) -4. Select the desired resources (the **Select All** checkbox may be used) and click **Add**. -5. The dialogue will show that a scan is **Pending** on all of the resources - this scan ends in an **Error**. This is expected as macOS cannot be scanned by NPS, and this error occurs during initial onboarding. - ![006.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002clZS.png) -6. Navigate to the **Resources** page and observe that the onboarded macOS resources are present. - ![007.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d3mT.png) - -### Registering the nps_realvnc RemoteApp - -1. Copy the `nps_realvnc.zip` file to the desktop of the RDS host where the RemoteApp is published. Copy the contents to a folder where they can be accessed, for example `C:\npslaunchers`. - ![Picture8.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d4aT.png) -2. Edit the `appsettings.json` file and specify the address(es) of your NPS App Server(s). - ![Picture9.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d4yf.png) -3. Open **Server Manager** on the RDS host where the RemoteApp is published and select the **Publish RemoteApp Programs** option as indicated. - ![Picture10.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d494.png) -4. Select the indicated option to **Add a RemoteApp program**. - ![Picture11.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d53V.png) -5. Navigate to the location where the `nps_realvnc` launcher was installed, and publish the RemoteApp. - ![Picture12.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d5BZ.png) -6. In Server Manager, right-click the published RemoteApp and select **Edit Properties**. - ![Picture13.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d5GP.png) -7. Select **Parameters** and choose **Allow any command-line parameters**. The RemoteApp is published. - ![Picture14.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d39m.png) - -### Creating an Activity for VNC Access - -1. Navigate to the **Activities** page and click the **+** icon to create a new Activity. The **Activity Type** of this activity must be set to **Interactive App Launch**, as this will allow VNC sessions to be launched through the `realvnc.exe` launcher configured in RDS. + ![Folder containing the extracted nps_realvnc files](./../0-images/ka0Qk0000006Ukz_0EMQk000002d4aT.png) + +2. Edit the `appsettings.json` file and specify the address of each of your Privilege Secure App Servers. + + ![appsettings.json file with the App Server address specified](./../0-images/ka0Qk0000006Ukz_0EMQk000002d4yf.png) + +3. Open **Server Manager** on the RDS host where the RemoteApp is published and select the **Publish RemoteApp Programs** option as indicated. + + ![Server Manager with the Publish RemoteApp Programs option indicated](./../0-images/ka0Qk0000006Ukz_0EMQk000002d494.png) + +4. Select the indicated option to **Add a RemoteApp program**. + + ![Server Manager with the Add a RemoteApp program option indicated](./../0-images/ka0Qk0000006Ukz_0EMQk000002d53V.png) + +5. Go to the location where the `nps_realvnc` launcher was installed, and publish the RemoteApp. + + ![Add RemoteApp Programs wizard with the nps_realvnc launcher selected for publishing](./../0-images/ka0Qk0000006Ukz_0EMQk000002d5BZ.png) + +6. In Server Manager, right-click the published RemoteApp and select **Edit Properties**. + + ![Server Manager context menu on the published RemoteApp with Edit Properties](./../0-images/ka0Qk0000006Ukz_0EMQk000002d5GP.png) + +7. Select **Parameters** and choose **Allow any command-line parameters**. The RemoteApp is published. + + ![RemoteApp properties Parameters page with Allow any command-line parameters selected](./../0-images/ka0Qk0000006Ukz_0EMQk000002d39m.png) + +### Step 5 — Creating an Activity for VNC Access + +1. Go to the **Activities** page and click the **+** icon to create a new Activity. The **Activity Type** of this activity must be set to **Interactive App Launch**, as this allows VNC sessions to be launched through the `realvnc.exe` launcher configured in RDS. 2. Ensure that the following values are configured: - **Activity Type** - Interactive App Launch - **Login Account Template** – the account used to connect to the RDS host, not the target macOS resource. Be sure to specify a domain, as `%targetdomain%` will not always work. (For example, `mydomain\managedaccountname`) - **Application to Launch** – Specify the same path and filename you used to publish the RemoteApp, and append the `%token%` and `%sessionid%` parameters. For example: -``` -C:\npslaunchers\nps_realvnc.exe %token% %sessionid% -``` + ``` + C:\npslaunchers\nps_realvnc.exe %token% %sessionid% + ``` + +3. If the preceding steps have been followed, your activity configuration should resemble the following: + + ![Activity configuration with Interactive App Launch and the application to launch set](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6M9.png) + +### Step 6 — Running the Activity + +1. After your Activity is created and added to an access policy containing your onboarded macOS resources, you can provision a session as normal. -3. If the preceding steps have been followed, your activity configuration should resemble the following: - ![Picture15.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6M9.png) + ![Session provisioning request for the macOS resource](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6UD.png) -### Running the Activity + ![Provisioned session ready to launch](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6Vp.png) -1. Once your Activity is created and added to an access policy containing your onboarded macOS resources, you can provision a session as normal. - ![Picture16.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6UD.png) - ![Picture17.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6Vp.png) 2. Depending on whether you have installed VNC Connect on the MAC device, you may get a warning similar to the following: - ![Picture18.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d0NF.png) -3. Enter your credentials when prompted. - ![Picture20.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6As.png) -4. A VNC connection is established to the resource, and the session is recorded by the NPS proxy service. - ![Picture21.png](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6ij.png) + + ![Warning shown when VNC Connect is not installed on the Mac device](./../0-images/ka0Qk0000006Ukz_0EMQk000002d0NF.png) + +3. Enter your credentials when prompted. + + ![Credentials prompt for the VNC session](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6As.png) + +4. A VNC connection is established to the resource, and the session is recorded by the Privilege Secure proxy service. + + ![VNC session connected to the macOS resource](./../0-images/ka0Qk0000006Ukz_0EMQk000002d6ij.png) diff --git a/docs/kb/privilegesecure/network-and-platform-integration/onboarding-network-devices-using-tacacs-access-control.md b/docs/kb/privilegesecure/network-and-platform-integration/onboarding-network-devices-using-tacacs-access-control.md index e8a654b2a4..012fed9d4c 100644 --- a/docs/kb/privilegesecure/network-and-platform-integration/onboarding-network-devices-using-tacacs-access-control.md +++ b/docs/kb/privilegesecure/network-and-platform-integration/onboarding-network-devices-using-tacacs-access-control.md @@ -1,8 +1,7 @@ --- description: >- - Provides step-by-step instructions to onboard TACACS-enabled network devices - as Netwrix Privilege Secure resources by creating a custom Platform, a service - account, and importing devices via CSV. + Onboard TACACS-enabled network devices to Privilege Secure by creating a + custom Platform and a service account, then importing the devices from a CSV. keywords: - TACACS - network devices @@ -13,51 +12,75 @@ keywords: - CSV import - host scan - activity + - Fortinet products: - - privilege-secure-access-management -sidebar_label: Onboarding Network Devices Using TACACS Access Con -tags: [] + - privilegesecure +sidebar_label: Onboarding Network Devices Using TACACS Access Control +tags: + - kb + - network-and-platform-integration title: "Onboarding Network Devices Using TACACS Access Control" knowledge_article_id: kA0Qk0000000L7hKAE --- # Onboarding Network Devices Using TACACS Access Control -## Summary -This article provides instructions on how to onboard TACACS-enabled network devices as Netwrix Privilege Secure resources. It will be necessary to create a custom Platform for the device, and a corresponding service account. If multiple types of devices are to be onboarded, multiple sets of custom Platforms and service accounts can be used. +## Overview + +This article describes how to onboard TACACS-enabled network devices as Netwrix Privilege Secure for Access Management resources. You need to create a custom Platform for the device, and a corresponding service account. If multiple types of devices are to be onboarded, multiple sets of custom Platforms and service accounts can be used. ## Instructions -### Creating a Platform -1. Navigate to the **Policy > Platforms** page. Select the **Linux** platform, and click on the **Copy** icon. - ![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xuyT.png) +### Step 1 — Creating a Platform + +1. Go to **Policy > Platforms**. Select the **Linux** platform, and click the **Copy** icon. + + ![The Platforms page with the Linux platform selected and the Copy icon.](./../0-images/ka0Qk00000013dN_0EMQk000001xuyT.png) + 2. Rename the `Linux Copy` platform that was just created. The name should reflect the device you intend to onboard, in this case `Fortinet`. Set the **Password Complexity Policy** to `Default` and all change policies to ``. -### Creating a Service Account -1. Navigate to the **Configuration > Service Accounts** page. Click the **+** icon and create a new Service Account whose name corresponds to the device you intend to onboard (again, `Fortinet` in this example). - ![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xvGD.png) +### Step 2 — Creating a Service Account + +1. Go to **Configuration > Service Accounts**. +2. Click the **+** icon and create a new Service Account whose name corresponds to the device you intend to onboard (again, `Fortinet` in this example). + + ![The Service Accounts page with the new Fortinet service account.](./../0-images/ka0Qk00000013dN_0EMQk000001xvGD.png) + + > **NOTE:** This service account is not used to scan the target device since it is not a supported Platform, so any username/password can be provided. + +### Step 3 — Onboarding the Network Devices + +1. Create a CSV file with the following columns: `DNS Host Name`, `Operating System`, `IP Address`, `Platform`, `Credential`. +2. Populate the CSV file with information for all devices that are to be onboarded. + + > **NOTE:** Ensure that the `Platform` exactly matches the custom Platform you have configured in Privilege Secure. Ensure that the `Credential` exactly matches the service account you have configured in Privilege Secure. -Note that this service account will not be used to scan the target device since it is not a supported Platform, so any username/password can be provided. + ![A CSV file populated with the columns DNS Host Name, Operating System, IP Address, Platform, and Credential.](./../0-images/ka0Qk00000013dN_0EMQk000001xvXx.png) -### Onboarding the Network Devices -1. Create a CSV file with the following columns: `DNS Host Name`, `Operating System`, `IP Address`, `Platform`, `Credential`. -2. Populate the CSV file with information for all devices that will be onboarded. Note: Ensure that the `Platform` exactly matches the custom Platform you have configured in Netwrix Privilege Secure (NPS). Ensure that the `Credential` exactly matches the service account you have configured in Netwrix Privilege Secure (NPS). - ![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xvXx.png) -3. Navigate to the **Resources** page. Click the **+Add** button, and select **New Server**. On the **Add Resources** page, select **Import from CSV**, and select the CSV file you have created. Note that there is a 50-resource batch size limit for CSV import. - ![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xmPq.png) -4. Your resources should be displayed. Click **Add**. - ![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xr4Z.png) -5. The resources are added and a host scan is attempted for each one. This host scan will fail - this is expected for unsupported platforms during initial onboarding. - ![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xtUY.png) +3. Go to the **Resources** page. Click **+Add**, and select **New Server**. On the **Add Resources** page, select **Import from CSV**, and select the CSV file you have created. Your resources should be displayed. + + > **NOTE:** There is a 50-resource batch size limit for CSV import. + + ![The Add Resources page with Import from CSV selected.](./../0-images/ka0Qk00000013dN_0EMQk000001xmPq.png) + +4. Click **Add**. The resources are added and a host scan is attempted for each one. This host scan fails, which is expected for unsupported platforms during initial onboarding. + + ![The Add Resources page listing the resources to add, with the Add button.](./../0-images/ka0Qk00000013dN_0EMQk000001xr4Z.png) + + ![The resources added to the Resources page, with the failed host scan results.](./../0-images/ka0Qk00000013dN_0EMQk000001xtUY.png) Your resources should now be visible on the **Resources** page. ### Notes for Creating an Activity -When creating an Activity that uses domain credentials, it is important not to use the `%targetdomain%` variable in the **Login Account Template**. Rather, use the name of the domain, as indicated. -![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xula.png) -Note that group membership add/remove operations are needed if access control groups are used for the target devices. +When creating an Activity that uses domain credentials, do not use the `%targetdomain%` variable in the **Login Account Template**. Use the name of the domain, as indicated. + +![The Login Account Template field of an Activity showing the domain name.](./../0-images/ka0Qk00000013dN_0EMQk000001xula.png) + +> **NOTE:** Group membership add/remove operations are needed if access control groups are used for the target devices. + +After the activity is configured, it can be added to an access policy in the usual manner, and used to run an activity. + +![An access policy that includes the activity.](./../0-images/ka0Qk00000013dN_0EMQk000001xx6j.png) -Once the activity is configured, it can be added to an access policy in the usual manner, and used to run an activity. -![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xx6j.png) -![image.png](./../0-images/ka0Qk00000013dN_0EMQk000001xx9x.png) +![Running the activity from the access policy.](./../0-images/ka0Qk00000013dN_0EMQk000001xx9x.png) diff --git a/docs/kb/privilegesecure/network-and-platform-integration/resolving-no-common-algorithm-for-key-exchange-ssh-error-for-cisco-resources.md b/docs/kb/privilegesecure/network-and-platform-integration/resolving-no-common-algorithm-for-key-exchange-ssh-error-for-cisco-resources.md index 8222880af3..704ec9490c 100644 --- a/docs/kb/privilegesecure/network-and-platform-integration/resolving-no-common-algorithm-for-key-exchange-ssh-error-for-cisco-resources.md +++ b/docs/kb/privilegesecure/network-and-platform-integration/resolving-no-common-algorithm-for-key-exchange-ssh-error-for-cisco-resources.md @@ -1,8 +1,7 @@ --- description: >- - Explains how to resolve the SSH error "no common algorithm for key exchange" - when Netwrix Privilege Secure brokers SSH connections to Cisco resources by - configuring key exchange algorithms in the sbpam_sshclient.json file. + Resolve the SSH error "no common algorithm for key exchange" on Cisco + resources by adding a key exchange algorithm to sbpam_sshclient.json. keywords: - SSH - key exchange @@ -13,13 +12,15 @@ keywords: - ActionServiceWorker - Cisco - no common algorithm + - handshake failed + - KeyExchanges products: - - privilege-secure-access-management -sidebar_label: Resolving "No Common Algorithm for Key Exchange" S -tags: [] -title: >- - Resolving "No Common Algorithm for Key Exchange" SSH Error for Cisco - Resources + - privilegesecure +sidebar_label: 'Resolving "No Common Algorithm for Key Exchange" SSH Error for Cisco Resources' +tags: + - kb + - network-and-platform-integration +title: 'Resolving "No Common Algorithm for Key Exchange" SSH Error for Cisco Resources' knowledge_article_id: kA04u000000LLlLCAW --- @@ -27,45 +28,47 @@ knowledge_article_id: kA04u000000LLlLCAW ## Overview +This article describes how to resolve the SSH error "no common algorithm for key exchange" when Netwrix Privilege Secure for Access Management brokers an SSH connection to a Cisco resource. + > **IMPORTANT:** This article applies only to Cisco connections. -It may occur that Netwrix Privilege Secure is not configured to use the same key exchange algorithm as a target resource when brokering an SSH connection. This will cause the following error to appear in the **PAM-SSHClient** log: +Privilege Secure may not be configured to use the same key exchange algorithm as a target resource when brokering an SSH connection. In that case, the following error appears in the **PAM-SSHClient** log: ```text Error="ssh: handshake failed: ssh: no common algorithm for key exchange; client offered: [ARRAY_OF_ALGORITHMS], server offered: [ARRAY_OF_ALGORITHMS]" ``` -> **NOTE:** Here, the two arrays of algorithms would **not** contain any shared algorithms. +> **NOTE:** In this error, the two arrays of algorithms do **not** contain any shared algorithms. ## Instructions -Refer to the following steps to configure the use of the same key exchange algorithm as a target resource when brokering an SSH connection: +Complete the following steps to configure the use of the same key exchange algorithm as a target resource when brokering an SSH connection: 1. Choose an acceptable algorithm from the list of **server offered** algorithms given in the error message you have received. For example, suppose your server offered **diffie-hellman-group14-sha1**. -2. On your **Netwrix Privilege Secure** server, navigate to the **ActionServiceWorker** directory. +2. On your **Netwrix Privilege Secure** server, go to the **ActionServiceWorker** directory. > **NOTE:** On a default installation, it should be `C:\Program Files\Stealthbits\PAM\ActionServiceWorker` 3. Open the `sbpam_sshclient.json` file in a text editor. -4. Navigate to the **KeyExchanges** section, which should resemble the following: +4. Go to the **KeyExchanges** section, which should resemble the following: -```json -"KeyExchanges": [ - "diffie-hellman-group-exchange-sha256", - "diffie-hellman-group-exchange-sha1", - "diffie-hellman-group1-sha1" -``` + ```json + "KeyExchanges": [ + "diffie-hellman-group-exchange-sha256", + "diffie-hellman-group-exchange-sha1", + "diffie-hellman-group1-sha1" + ``` -5. Modify the array to include your desired algorithm, keeping the array properly comma-separated. In our example: +5. Modify the array to include your desired algorithm, keeping the array properly comma-separated. In this example: -```json -"KeyExchanges": [ - "diffie-hellman-group-exchange-sha256", - "diffie-hellman-group-exchange-sha1", - "diffie-hellman-group1-sha1", - "diffie-hellman-group14-sha1" -``` + ```json + "KeyExchanges": [ + "diffie-hellman-group-exchange-sha256", + "diffie-hellman-group-exchange-sha1", + "diffie-hellman-group1-sha1", + "diffie-hellman-group14-sha1" + ``` -6. You should now be able to negotiate an SSH connection with the target resource using its preferred algorithm. + You should now be able to negotiate an SSH connection with the target resource using its preferred algorithm. diff --git a/docs/kb/privilegesecure/remote-desktop-and-rds/configuring-the-netwrix-privilege-secure-rds-web-app-launcher.md b/docs/kb/privilegesecure/remote-desktop-and-rds/configuring-the-netwrix-privilege-secure-rds-web-app-launcher.md index de28ae0c16..a2ade4fd46 100644 --- a/docs/kb/privilegesecure/remote-desktop-and-rds/configuring-the-netwrix-privilege-secure-rds-web-app-launcher.md +++ b/docs/kb/privilegesecure/remote-desktop-and-rds/configuring-the-netwrix-privilege-secure-rds-web-app-launcher.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to deploy and configure the Web App Launcher for Netwrix Privilege - Secure to publish websites as RemoteApps using Remote Desktop Services, - including runtime and API settings, directory setup, and launch examples. + Deploy and configure the Web App Launcher to publish websites as RemoteApps + through Remote Desktop Services, including settings and launch examples. keywords: - Netwrix Privilege Secure - Web App Launcher @@ -10,66 +9,81 @@ keywords: - RemoteApp - launch-website.exe - appsettings.json + - ChromeOptions - NPS - API - Remote Desktop Services products: - - privilege-secure-access-management -sidebar_label: Configuring the Netwrix Privilege Secure RDS Web A -tags: [] + - privilegesecure +sidebar_label: "Configuring the Netwrix Privilege Secure RDS Web App Launcher" +tags: + - kb + - remote-desktop-and-rds title: "Configuring the Netwrix Privilege Secure RDS Web App Launcher" knowledge_article_id: kA0Qk0000000Kl7KAE --- # Configuring the Netwrix Privilege Secure RDS Web App Launcher -## Introduction -The Web App Launcher for Netwrix Privilege Secure is an application used to launch websites as RemoteApps using Microsoft Remote Desktop Services (RDS). +## Overview -See [How to Integrate Activities with Remote Desktop Services (RDS)](https://docs.netwrix.com/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-integrate-activities-with-remote-desktop-services-rds) for information about publishing RemoteApps. +This article describes how to deploy and configure the Web App Launcher for Netwrix Privilege Secure for Access Management, an application used to launch websites as RemoteApps using Microsoft Remote Desktop Services (RDS). -## Deployment -The Web App Launcher can be downloaded from [this link](https://dl.netwrix.com/additional/WebAppLauncher.zip). +See [Integrating Activities with Remote Desktop Services (RDS)](https://docs.netwrix.com/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-integrate-activities-with-remote-desktop-services-rds) for information about publishing RemoteApps. -On the RDS server, extract the files to a directory of your choosing. For the examples in this article, `C:\webapp-launcher\` will be used. +## Instructions -![image.png](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tL01.png) +### Deployment -## Configuration +1. Download the [Web App Launcher](https://dl.netwrix.com/additional/WebAppLauncher.zip). +2. On the RDS server, extract the files to a directory of your choosing. The examples in this article use `C:\webapp-launcher\`. -### Runtime Settings -There are configurable runtime settings that you can apply to the Web App Launcher. + ![Extracted Web App Launcher files in the chosen directory on the RDS server](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tL01.png) -- Full Screen - runs the website in full screen mode -- App Mode - runs the browser with no tabs or menu controls -- Disable Extensions - prevent the browser from running extensions -- Start Maximized - runs the browser maximized -- Command Line Arguments - allows certificate and SSL errors to be ignored when using the Web Launcher +### Configuration -In order to configure these settings, open `appsettings.json` in your Web App Launcher directory. The `ChromeOptions` section contains the preceding settings. Change the values as required, and save the file. +#### Runtime Settings -![image.png](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tH7k.png) +The following runtime settings can be configured for the Web App Launcher: -Note that these settings affect all websites launched from this Web App Launcher. If it is necessary to have multiple sets of settings, create another Web App Launcher directory with a different `appsettings.json` configuration, and use the appropriate one in NPS. +- **Full Screen**: runs the website in full screen mode +- **App Mode**: runs the browser with no tabs or menu controls +- **Disable Extensions**: prevents the browser from running extensions +- **Start Maximized**: runs the browser maximized +- **Command Line Arguments**: allows certificate and SSL errors to be ignored when using the Web Launcher -### API Settings -In order to use the Web App Launcher, an Application User must be created in NPS. Once this is done, supply the username and API Key into the `AppUser` and `AppSecret` fields, respectively. The certificate should be placed in the Web App Launcher directory, with the directory indicated in the `AppCert` field as indicated: +To configure these settings: -:::warning -Any backslashes (\\) in the app secret must be escaped with a preceding backslash (\\\\) -::: +1. Open `appsettings.json` in your Web App Launcher directory. The `ChromeOptions` section contains the preceding settings. +2. Change the values as required, and save the file. -![image.png](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tPOb.png) + ![The ChromeOptions section of appsettings.json showing the runtime settings](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tH7k.png) + +> **NOTE:** These settings affect all websites launched from this Web App Launcher. If you need multiple sets of settings, create another Web App Launcher directory with a different `appsettings.json` configuration, and use the appropriate one in Privilege Secure. + +#### API Settings + +To use the Web App Launcher: + +1. Create an Application User in Privilege Secure. +2. Supply the username and API Key into the `AppUser` and `AppSecret` fields, respectively. +3. Place the certificate in the Web App Launcher directory, with the directory indicated in the `AppCert` field as indicated: + + > **IMPORTANT:** Any backslashes (\\) in the app secret must be escaped with a preceding backslash (\\\\) + + ![The AppUser, AppSecret, and AppCert fields in appsettings.json](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tPOb.png) + +#### Web App Launcher Directories -### Web App Launcher Directories Ensure that the indicated paths correspond to the chosen Web App Launcher directory. -![image.png](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tlXC.png) +![Directory paths in appsettings.json that point to the Web App Launcher directory](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tlXC.png) + +### Launch Options and Examples -## Launch Options and Examples +#### 1. Launching Websites and Passing in Username and Password via Command Line -### 1. Launching websites and passing in username and password via command line -In this mode, username and password are passed as parameters on the command line. It is important to remember that in a production setting, any command line parameters can be viewed by other users of the RDS host with access to Task Manager. We recommend that this launch option should be used for testing or non-production use. +In this mode, the username and password are passed as parameters on the command line. In a production setting, any command line parameters can be viewed by other users of the RDS host with access to Task Manager. Netwrix recommends using this launch option for testing or non-production use. Usage: @@ -83,12 +97,13 @@ Example: launch-website.exe https://website.com jsmith Password123 ``` -![image.png](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tMXD.png) +![Example command line launching a website with a username and password](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tMXD.png) + +> **NOTE:** The login account in this example connects to the RDS session running the Web App Launcher as a remote app. The Web App Launcher launches the website under the context of the user and password supplied as command line arguments. -Note that the login account in this example connects to the RDS session running the web app launcher as a remote app. The web app launcher will launch the website under the context of the user and password supplied as command line arguments. +#### 2. Launching Websites by Passing in a Privilege Secure Token and Session ID (Privilege Secure 4.1 and Above) -### 2. Launching websites by passing in an NPS token and session ID (NPS 4.1 and above) -In this mode, token and session ID are passed to the launcher. The launcher will use this information to dynamically pull the username and password from the NPS Proxy and pass it to the website. +In this mode, the token and session ID are passed to the launcher. The launcher uses this information to dynamically pull the username and password from the Privilege Secure Proxy and pass them to the website. Usage: @@ -102,14 +117,16 @@ Example: launch-website.exe https://website.com %token% %sessionid% ``` -![image.png](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tOSX.png) +![Example command line launching a website with a token and session ID](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tOSX.png) -Note that the login account in this example both connects to the RDS session running the web app launcher as a remote app, and is used as the credential to be passed to the website. +> **NOTE:** The login account in this example both connects to the RDS session running the Web App Launcher as a remote app, and is used as the credential to be passed to the website. -### 3. Launching websites by specifying a username, with the password pulled via the NPS API -In this mode, a username is passed on the command line to the launcher. The launcher will call the NPS API to get the password stored in the NPS vault and pass it to the website. +#### 3. Launching Websites by Specifying a Username, with the Password Pulled via the Privilege Secure API + +In this mode, a username is passed on the command line to the launcher. The launcher calls the Privilege Secure API to get the password stored in the Privilege Secure vault and passes it to the website. The username value can be in the following formats: + - `Domain\username` – if the website account is a managed account in the domain - `Resource\username` – if the website account is a managed account on a Resource - `Website Name\username` – if the website account is stored in the Users tab of a website Resource @@ -126,6 +143,6 @@ Example: launch-website.exe https://website.com lab\jsmith ``` -![image.png](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tLo2.png) +![Example command line launching a website with a username only](./../0-images/ka0Qk0000001EP7_00N0g000004CA0p_0EMQk000001tLo2.png) -Note that the login account in this example connects to the RDS session running the web app launcher as a remote app. The web app launcher will launch the website under the context of the username provided on the command line. The web app launcher will call the API to get the managed password of the user, and will enter it into the password field of the website. +> **NOTE:** The login account in this example connects to the RDS session running the Web App Launcher as a remote app. The Web App Launcher launches the website under the context of the username provided on the command line. The Web App Launcher calls the API to get the managed password of the user, and enters it into the password field of the website. diff --git a/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-configure-windows-remote-assistance-integration.md b/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-configure-windows-remote-assistance-integration.md index c165be2846..4413a0b8af 100644 --- a/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-configure-windows-remote-assistance-integration.md +++ b/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-configure-windows-remote-assistance-integration.md @@ -1,8 +1,7 @@ --- description: >- - This document provides an outline and step-by-step guide for Netwrix Privilege - Secure integration with Microsoft Remote Assistance, including group policy - configuration and activity setup. + Configure Netwrix Privilege Secure integration with Microsoft Remote + Assistance, including Group Policy configuration and activity setup. keywords: - Netwrix Privilege Secure - Remote Assistance @@ -13,33 +12,37 @@ keywords: - DirectConnect - Activity Setup products: - - privilege-secure-access-management -sidebar_label: How to Configure Windows Remote Assistance Integra -tags: [] -title: "How to Configure Windows Remote Assistance Integration" + - privilegesecure +sidebar_label: Configuring Windows Remote Assistance Integration +tags: + - kb + - remote-desktop-and-rds +title: "Configuring Windows Remote Assistance Integration" knowledge_article_id: kA04u0000000HSKCA2 --- -# How to Configure Windows Remote Assistance Integration +# Configuring Windows Remote Assistance Integration -## Summary +## Overview -This document provides an outline and guide for Netwrix Privilege Secure integration with Microsoft Remote Assistance. +This article describes how to configure Netwrix Privilege Secure for Access Management integration with Microsoft Remote Assistance. -## Enrollment +## Instructions + +### Prerequisites + +Enrollment: -- Netwrix Privilege Secure Server +- Privilege Secure Server - RDS Server with RemoteApp – single machine CAL license -## Pre-requisites +Pre-requisites: - Group Policy to configure **Offer Remote Assistance** - Domain group to be mapped to Configure Offer Remote Assistance policy - Domain group that is a member of the RDS server local Administrator group - Remote Assistance Feature added to RDS server -## Instructions - ### Group Policy Enable **Configure Offer Remote Assistance** policy. @@ -48,42 +51,42 @@ Enable **Configure Offer Remote Assistance** policy. Policies > Administrative Templates > System > Remote Assistance > Configure Offer Remote Assistance ``` -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWI7.png) +![Group Policy editor showing the Configure Offer Remote Assistance policy under Administrative Templates, System, Remote Assistance](./../0-images/ka04u000000HcZw_0EM4u000004bWI7.png) Enable the policy and assign a domain group to control access. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIC.png) +![Configure Offer Remote Assistance policy enabled with a domain group assigned to control access](./../0-images/ka04u000000HcZw_0EM4u000004bWIC.png) ### Activity Setup Create an Interactive App Launch Activity making note of the following highlighted areas. -**NOTE:** The Domain groups for Group Policy and RDS server local admin will have been created in the previous steps. +> **NOTE:** The Domain groups for Group Policy and RDS server local admin have been created in the previous steps. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIH.png) +![Interactive App Launch activity settings with the highlighted areas for the Remote Assistance activity](./../0-images/ka04u000000HcZw_0EM4u000004bWIH.png) -### Use Case +## Use Case -Via Netwrix Privilege Secure UI or DirectConnect, the helpdesk admin selects the Remote Assistance Activity and chooses the resource to which remote assistance is to be provided. +Via the Privilege Secure UI or DirectConnect, the helpdesk admin selects the Remote Assistance Activity and chooses the resource to which remote assistance is to be provided. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIM.png) +![Privilege Secure interface where the helpdesk admin selects the Remote Assistance activity and the target resource](./../0-images/ka04u000000HcZw_0EM4u000004bWIM.png) When the Activity has been provisioned, the session is launched, and the target users’ desktop displays a message asking permission for the helpdesk admin to connect. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIR.png) +![Message on the target users desktop asking permission for the helpdesk admin to connect](./../0-images/ka04u000000HcZw_0EM4u000004bWIR.png) The helpdesk admin can now view the target users’ desktop and can establish a chat session. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIW.png) +![Helpdesk admin view of the target users desktop with a chat session](./../0-images/ka04u000000HcZw_0EM4u000004bWIW.png) If the helpdesk admin needs to take control of the remote system, they select **Request Control** and the end user is prompted for permission. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIb.png) +![Request Control option and the permission prompt shown to the end user](./../0-images/ka04u000000HcZw_0EM4u000004bWIb.png) -Once shared, control can be terminated at any time by the helpdesk admin or the end user. +After control is shared, the helpdesk admin or the end user can terminate it at any time. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIg.png) +![Remote Assistance session in which shared control can be terminated](./../0-images/ka04u000000HcZw_0EM4u000004bWIg.png) -The live session may be viewed via the Netwrix Privilege Secure administrator dashboard or reviewed later as a recording at any time. +You can view the live session in the Privilege Secure administrator dashboard or review it later as a recording at any time. -![User-added image](./../0-images/ka04u000000HcZw_0EM4u000004bWIl.png) +![Privilege Secure administrator dashboard showing the live Remote Assistance session and its recording](./../0-images/ka04u000000HcZw_0EM4u000004bWIl.png) diff --git a/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-customize-the-rdp-template.md b/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-customize-the-rdp-template.md index bf19c33398..4a54617c10 100644 --- a/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-customize-the-rdp-template.md +++ b/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-customize-the-rdp-template.md @@ -1,9 +1,5 @@ --- -description: >- - Modify the rdp_template.txt on a Netwrix Privilege Secure server to change - default RDP settings such as fullscreen resolution, smart sizing, font - smoothing, and redirection. Back up the file before editing and restore after - product upgrades. +description: "Edit rdp_template.txt on a Privilege Secure server to change default RDP settings such as resolution and redirection. Back up the file before upgrades." keywords: - rdp_template.txt - RDP settings @@ -14,17 +10,20 @@ keywords: - audiomode - redirectsmartcards products: - - privilege-secure-access-management -sidebar_label: How to Customize the RDP Template -tags: [] -title: "How to Customize the RDP Template" + - privilegesecure +sidebar_label: Customizing the RDP Template +tags: + - kb + - remote-desktop-and-rds +title: "Customizing the RDP Template" knowledge_article_id: kA04u0000000HiDCAU --- -# How to Customize the RDP Template +# Customizing the RDP Template -## Summary -Additional configuration settings for Netwrix Privilege Secure RDP sessions can be configured by modifying the `rdp_template.txt` file on a Netwrix Privilege Secure server. Modifications to this file will affect the default RDP settings for all Netwrix Privilege Secure users, and the file includes such settings as: +## Overview + +This article describes how to customize the `rdp_template.txt` file on a Netwrix Privilege Secure for Access Management server to configure additional settings for Privilege Secure RDP sessions. Modifications to this file affect the default RDP settings for all Privilege Secure users. The file includes such settings as: - Fullscreen Resolution (`screen mode id:i:value`) - Smart Sizing (`smart sizing:i:value`) @@ -34,15 +33,18 @@ Additional configuration settings for Netwrix Privilege Secure RDP sessions can - Disable Wallpaper (`disable wallpaper:i:1`) - Audio Mode (`audiomode:i:value`) -A full list of supported RDP settings can be found in the following Microsoft documentation: Supported Remote Desktop RDP file settings | Microsoft Docs (https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/rdp-files). +For a full list of supported RDP settings, see [Supported Remote Desktop RDP file settings | Microsoft Docs](https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/rdp-files). ## Instructions -The `rdp_template.txt` file is located on a Netwrix Privilege Secure server via the following path: + +The `rdp_template.txt` file is located on a Privilege Secure server in the following path: `\Program Files\Stealthbits\PAM\Web\rdp_template.txt` -*IMPORTANT:* **Always back this file up before modifying it.** Also, upgrading Netwrix Privilege Secure will overwrite this file, so perform a backup prior to upgrading and restore it afterward to preserve any custom modifications. +> **IMPORTANT:** **Always back this file up before modifying it.** Also, upgrading Privilege Secure overwrites this file, so perform a backup before upgrading and restore it afterward to preserve any custom modifications. 1. Open `rdp_template.txt`. -2. Modify the value for the desired setting, save the file, and then re-download an RDP file from Netwrix Privilege Secure to use the new settings. -3. For example, to enable Fullscreen Resolution change `screen mode id:i:1` to `screen mode id:i:2`. + +2. Modify the value for the setting you want to change and save the file. For example, to enable Fullscreen Resolution, change `screen mode id:i:1` to `screen mode id:i:2`. + +3. Re-download an RDP file from Privilege Secure to use the new settings. diff --git a/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-integrate-activities-with-remote-desktop-services-rds.md b/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-integrate-activities-with-remote-desktop-services-rds.md index 47ade74a44..d0754f5113 100644 --- a/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-integrate-activities-with-remote-desktop-services-rds.md +++ b/docs/kb/privilegesecure/remote-desktop-and-rds/how-to-integrate-activities-with-remote-desktop-services-rds.md @@ -1,8 +1,8 @@ --- description: >- - This article explains how to integrate Netwrix Privilege Secure activities - with Microsoft Remote Desktop Services (RDS) to launch interactive application - sessions with temporary elevated privileges. + Integrate Privilege Secure activities with Microsoft Remote Desktop Services + (RDS) to launch interactive app sessions with temporarily higher + privileges. keywords: - Remote Desktop Services - RDS @@ -13,121 +13,105 @@ keywords: - session collection - RD Session Host - RD Connection Broker + - Interactive App Launch + - dsa.msc products: - - privilege-secure-access-management -sidebar_label: How to Integrate Activities with Remote Desktop Se -tags: [] -title: "How to Integrate Activities with Remote Desktop Services (RDS)" + - privilegesecure +sidebar_label: Integrating Activities with Remote Desktop Services (RDS) +tags: + - kb + - remote-desktop-and-rds +title: "Integrating Activities with Remote Desktop Services (RDS)" knowledge_article_id: kA04u0000000HZBCA2 --- -# How to Integrate Activities with Remote Desktop Services (RDS) +# Integrating Activities with Remote Desktop Services (RDS) -## Summary +## Overview -This article outlines how to integrate Netwrix Privilege Secure activities with Microsoft Remote Desktop Services (RDS) to launch interactive application sessions with temporary elevated privileges. +This article describes how to integrate Netwrix Privilege Secure for Access Management activities with Microsoft Remote Desktop Services (RDS) to launch interactive application sessions with temporarily higher privileges. -## Licensing +## Instructions -Remote Desktop Services will run without a license for a period determined by Microsoft. For long-term use, you must install and set up RDS licensing based either on named users or RDS clients — this is not covered in this article. +### Licensing -## Instructions +Remote Desktop Services runs without a license for a period determined by Microsoft. For long-term use, you must install and set up RDS licensing based either on named users or RDS clients. This is not covered in this article. ### Configure Remote Desktop Services -1. On the Remote Desktop Services / Terminal Services (RemoteApp) server launch **Server Manager**, click on the **Manager** tab and select **Add Roles and Features**. +1. On the Remote Desktop Services / Terminal Services (RemoteApp) server, launch **Server Manager**, click the **Manager** tab, and select **Add Roles and Features**. 2. Follow the wizard, select **Remote Desktop Services installation**, and click **Next**. -![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkob.png) - + ![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkob.png) 3. Select either **Standard Deployment** (as in this guide) or **Quick Start** if you intend to install all RDS role services on the same server. Click **Next**. -![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkog.png) - + ![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkog.png) 4. Select **Session-based desktop deployment**, and click **Next**. -![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkol.png) - + ![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkol.png) 5. Follow the wizard without making any changes until you get to the **RD Connection Broker** tab. Specify the server intended for the RD Connection Broker server and click **Next**. -![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkov.png) - + ![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkov.png) 6. Specify the server intended for the **RD Web Access server** and click **Next**. -![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkp0.png) - + ![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkp0.png) 7. Specify the server intended for the **RD Session Host server(s)** and click **Next**. -![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkp5.png) - + ![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkp5.png) 8. Review RDS role server selection, check the **Restart the destination server automatically if required** box, and click **Deploy**. -![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkpF.png) - -The RD role services installation begins, and about halfway through the server will automatically reboot. Once the server has rebooted, log in with the same account used when the installation was first started, open **Server Manager**, and the installation dialogue window will resume. + The RD role services installation begins. About halfway through, the server reboots automatically. After the server reboots, log in with the same account used when the installation was first started and open **Server Manager**. The installation dialogue window resumes. -9. After completion of RDS role services installation, launch **Server Manager**, navigate to the RDS overview window, and click on **3 Create session collections**. - -![Screenshot of Windows Server Manager's Remote Desktop Services overview user interface.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyW.png) + ![Screenshot of Windows Server Add Roles and Features Wizard, demonstrating a Remote Desktop Services installation.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkpF.png) +9. After completion of RDS role services installation, launch **Server Manager**, go to the RDS overview window, and click **3 Create session collections**. + ![Screenshot of Windows Server Manager's Remote Desktop Services overview user interface.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyW.png) 10. Follow the wizard until you get to the **Collection Name** tab. Enter a name, such as "NPS Applications", and click **Next**. -![Screenshot of Windows Remote Desktop Service's Create Collection wizard.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyb.png) - + ![Screenshot of Windows Remote Desktop Service's Create Collection wizard.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyb.png) 11. Specify the RD Session Host server (the server you specified earlier during installation of the RD Session Host role) and click **Next**. 12. Add the user groups who will access RemoteApps in the session collection. Click **Next**. -![Screenshot of Windows Remote Desktop Service's Create Collection wizard.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyl.png) + ![Screenshot of Windows Remote Desktop Service's Create Collection wizard.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyl.png) +13. Optionally specify and enable user profile disks (not used in the test environment for this guide). Review the defined session collection parameters and click **Create**. After the session collection is created, close the **Create Collection** wizard. +14. In **Server Manager**, go to the **Remote Desktop Services Overview** and note the new session collection created under the RD Session Host icon. -13. Optionally specify and enable user profile disks (not used in the test environment for this guide). Review the defined session collection parameters and click **Create**. Once the session collection is created, close the **Create Collection** wizard. -14. In **Server Manager** navigate to the **Remote Desktop Services Overview** and note the new session collection created under the RD Session Host icon. + ![Screenshot of Windows Remote Desktop Services Overview in Server Manager, demonstrating an added RD Session Host.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyq.png) +15. Publish RemoteApps by going to the **Collections** tab of **Server Manager** and selecting **Publish RemoteApp Programs** from the **Task** menu. -![Screenshot of Windows Remote Desktop Services Overview in Server Manager, demonstrating an added RD Session Host.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkyq.png) - -15. Publish RemoteApps by navigating to the **Collections** tab of **Server Manager** and selecting **Publish RemoteApp Programs** from the **Task** menu. - -![Screenshot demonstrating Publish RemoteApp Programs in a Windows Remote Desktop Services Session Collection.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkz0.png) - -16. If the required application is listed, select it. For applications such as ADUC (Active Directory Users and Computers) you will need to specify the executable name and path. Click **Add**. - -![Screenshot of the Publish RemoteApp Program wizard for Windows Remote Desktop Services, demonstrating how to add a RemoteApp to the list of programs.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkz5.png) + ![Screenshot demonstrating Publish RemoteApp Programs in a Windows Remote Desktop Services Session Collection.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkz0.png) +16. If the required application is listed, select it. For applications such as ADUC (Active Directory Users and Computers), you need to specify the executable name and path. Click **Add**. + ![Screenshot of the Publish RemoteApp Program wizard for Windows Remote Desktop Services, demonstrating how to add a RemoteApp to the list of programs.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkz5.png) 17. For ADUC, add **MMC (\\c$\Windows\System32\mmc.exe)**. -![Screenshot of Windows Explorer, being used to add mmc.exe as a RemoteApp Program for Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkzF.png) - + ![Screenshot of Windows Explorer, being used to add mmc.exe as a RemoteApp Program for Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkzF.png) 18. After adding all desired programs, click **Next**, click **Publish**, and then click **Close**. -19. Rename the RemoteApp and specify a parameter to launch ADUC. For additional security, you can assign groups of users to RemoteApps. For example, assign the ADUC RemoteApp to an AD group called `RAUsers_ADUC`. +19. Rename the RemoteApp and specify a parameter to launch ADUC. For additional security, you can assign groups of users to RemoteApps. For example, assign the ADUC RemoteApp to an Active Directory (AD) group called `RAUsers_ADUC`. 20. Right-click the **RemoteApp** and select **Edit Properties**. -![Screenshot of editing the Properties of a published RemoteApp in Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkzZ.png) - + ![Screenshot of editing the Properties of a published RemoteApp in Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkzZ.png) 21. Edit the RemoteApp name and set it to "ADUC", then click the **Parameters** tab in the left sidebar. -![Screenshot of editing the name of a published RemoteApp in Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkzj.png) - + ![Screenshot of editing the name of a published RemoteApp in Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bkzj.png) 22. On the **Parameters** tab, select the **Always use the following command-line parameters** radio button. For the path use: `dsa.msc` 23. Click the **User Assignment** tab in the left sidebar. Select the user access control group for the RemoteApp. In this case, specify that users must be a member of the `RAUsers_ADUC` group to run the ADUC RemoteApp. -![Screenshot of defining which Active Directory group(s) can access a published RemoteApp in Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bl0D.png) - -24. Click **OK**. Configuration of ADUC as a RemoteApp that can be accessed via a Netwrix Privilege Secure activity is now complete. Next, perform the necessary setup in a Netwrix Privilege Secure activity. - -25. Log in to Netwrix Privilege Secure (NPS) as an Administrator. You will create an activity to execute the ADUC RemoteApp you created earlier. Ensure **Interactive App Launch** is selected and the full application path to the RemoteApp on the RDS host is specified — but do not use the full path for MMC extensions such as `dsa.msc`. + ![Screenshot of defining which Active Directory groups can access a published RemoteApp in Windows Remote Desktop Services.](./../0-images/ka0Qk0000005qSb_0EM4u000004bl0D.png) +24. Click **OK**. Configuration of ADUC as a RemoteApp that can be accessed via a Privilege Secure activity is now complete. Next, perform the necessary setup in a Privilege Secure activity. +25. Log in to Privilege Secure as an Administrator. Create an activity to execute the ADUC RemoteApp you created earlier. Ensure **Interactive App Launch** is selected and the full application path to the RemoteApp on the RDS host is specified, but do not use the full path for MMC extensions such as `dsa.msc`. -For example: -`C:\Windows\System32\mmc.exe dsa.msc` + For example: + `C:\Windows\System32\mmc.exe dsa.msc` -***IMPORTANT:*** Double check that the Application to Launch field exactly matches the application and parameter you published with the RemoteApp. Note that for the application value you should always use implicit drive/folder names, i.e., use `C:\Windows\` and NOT relative identifiers such as `%SYSTEMROOT%`. - -![User-added image](./../0-images/ka0Qk0000005qSb_0EM4u000004ch3A.png) + > **IMPORTANT:** Double-check that the Application to Launch field exactly matches the application and parameter you published with the RemoteApp. For the application value, always use implicit drive/folder names, that is, use `C:\Windows\` and NOT relative identifiers such as `%SYSTEMROOT%`. + ![Privilege Secure activity with Interactive App Launch selected and the Application to Launch field set to the mmc.exe path and dsa.msc](./../0-images/ka0Qk0000005qSb_0EM4u000004ch3A.png) 26. For this example, add the Login Account to the `RAUsers_ADUC` domain group specified for the RemoteApp by adding an **Add User to Domain Group** action to the activity's pre-session. -![Screenshot of adding a Add User to Domain Group action step for Active Directory group RAUsers_ADUC to a Netwrix Privilege Secure activity's pre-session.](./../0-images/ka0Qk0000005qSb_0EM4u000004bl0h.png) - + ![Screenshot of adding a Add User to Domain Group action step for Active Directory group RAUsers_ADUC to a Netwrix Privilege Secure activity's pre-session.](./../0-images/ka0Qk0000005qSb_0EM4u000004bl0h.png) 27. For temporary privilege elevation, you may also want to add a step to add the Login Account to `Domain Admins`. -28. Create an access policy in Netwrix Privilege Secure that contains the recently created activity, the users who should have access to use it, and the Remote Desktop Services server resource. You can now provision this activity to any user granted privilege to use it. +28. Create an access policy in Privilege Secure that contains the recently created activity, the users who should have access to use it, and the Remote Desktop Services server resource. You can now provision this activity to any user granted privilege to use it. 29. When you connect to the Remote Desktop Services server, you will only have access to the published RemoteApp (in this case, ADUC). The RDP session does not offer a full desktop environment, since this is an Interactive App Launch for a specified program. -![Screenshot of a Netwrix Privilege Secure Interactive App Launch demonstrating an RDP session that opened the ADUC program on the target Remote Desktop Services server.](./../0-images/ka0Qk0000005qSb_0EM4u000004bl1a.png) + ![Screenshot of a Netwrix Privilege Secure Interactive App Launch demonstrating an RDP session that opened the ADUC program on the target Remote Desktop Services server.](./../0-images/ka0Qk0000005qSb_0EM4u000004bl1a.png) diff --git a/docs/kb/privilegesecure/remote-desktop-and-rds/overcoming-rdp-session-timeouts.md b/docs/kb/privilegesecure/remote-desktop-and-rds/overcoming-rdp-session-timeouts.md index 5fb5528f02..26e2fccff1 100644 --- a/docs/kb/privilegesecure/remote-desktop-and-rds/overcoming-rdp-session-timeouts.md +++ b/docs/kb/privilegesecure/remote-desktop-and-rds/overcoming-rdp-session-timeouts.md @@ -1,11 +1,9 @@ --- description: >- - This article explains how to respond to timeouts experienced during Remote - Desktop Protocol (RDP) sessions when Group Policy Objects (GPOs) enforce - strict idle timeouts. It provides steps for sessions created via the Netwrix - Privilege Secure UI and for sessions provisioned through DirectConnect. + Respond to RDP session timeouts caused by strict Group Policy idle timeouts, for sessions started from the UI or through DirectConnect. keywords: - RDP + - Remote Desktop Protocol - timeout - idle timeout - Group Policy @@ -13,10 +11,13 @@ keywords: - Netwrix Privilege Secure - DirectConnect - session deprovision + - My Activities products: - - privilege-secure-access-management -sidebar_label: Overcoming RDP Session Timeouts -tags: [] + - privilegesecure +sidebar_label: "Overcoming RDP Session Timeouts" +tags: + - kb + - remote-desktop-and-rds title: "Overcoming RDP Session Timeouts" knowledge_article_id: kA0Qk00000014nxKAA --- @@ -25,16 +26,17 @@ knowledge_article_id: kA0Qk00000014nxKAA ## Overview -This article explains how to respond to timeouts experienced during Remote Desktop Protocol (RDP) sessions in environments where Group Policy Objects (GPOs) enforce strict idle timeouts. +This article describes how to respond to timeouts experienced during Remote Desktop Protocol (RDP) sessions in environments where Group Policy Objects (GPOs) enforce strict idle timeouts. ## Instructions -### If a Netwrix Privilege Secure RDP session is locked due to timeout, take the following steps. +If a Netwrix Privilege Secure for Access Management RDP session is locked due to timeout, take the following steps for your type of session. -- For sessions provisioned through the Netwrix Privilege Secure UI: - 1. Close your RDP session window. The session will remain active. - 2. Resume your work by launching a new RDP session, either through the **Active** tab of the **Dashboard** or through the **My Activities** card for your activity. +### Sessions Provisioned Through the Privilege Secure UI -- For sessions provisioned through DirectConnect via an RDP manager: - 1. When the RDP session is terminated, the Netwrix Privilege Secure session is deprovisioned. - 2. You will need to relaunch a new DirectConnect session to continue your work. +1. Close your RDP session window. The session remains active. +2. Resume your work by launching a new RDP session, either through the **Active** tab of the **Dashboard** or through the **My Activities** card for your activity. + +### Sessions Provisioned Through DirectConnect via an RDP Manager + +When the RDP session is terminated, the Privilege Secure session is deprovisioned. To continue your work, relaunch a new DirectConnect session. diff --git a/docs/kb/privilegesecure/resource-management/access-denied-error-connecting-to-a-non-domain-joined-windows-resource.md b/docs/kb/privilegesecure/resource-management/access-denied-error-connecting-to-a-non-domain-joined-windows-resource.md index 41f1debabf..4fe50fb277 100644 --- a/docs/kb/privilegesecure/resource-management/access-denied-error-connecting-to-a-non-domain-joined-windows-resource.md +++ b/docs/kb/privilegesecure/resource-management/access-denied-error-connecting-to-a-non-domain-joined-windows-resource.md @@ -1,8 +1,7 @@ --- description: >- - This article explains why you may see an Access Denied error when connecting - to a non-domain-joined Windows resource and provides steps to enable remote - PowerShell authentication for the service account. + Resolve the Access Denied error in the ActionServiceWorker log when connecting to + a non-domain-joined Windows resource by enabling remote PowerShell authentication. keywords: - Access Denied - non-domain-joined @@ -13,9 +12,11 @@ keywords: - lusrmgr.msc - remote troubleshooting products: - - privilege-secure-access-management -sidebar_label: Access Denied Error Connecting to a Non-domain-joi -tags: [] + - privilegesecure +sidebar_label: Access Denied Error Connecting to a Non-domain-joined Windows Resource +tags: + - kb + - resource-management title: "Access Denied Error Connecting to a Non-domain-joined Windows Resource" knowledge_article_id: kA04u000000LLRQCA4 --- @@ -24,7 +25,9 @@ knowledge_article_id: kA04u000000LLRQCA4 ## Overview -When connecting to a non-domain-joined Windows resource, you may receive an `Access Denied` message in the ActionServiceWorker log when trying to provision an activity session or run a resource scan. +This article describes how to resolve the `Access Denied` message you may receive in the ActionServiceWorker log when connecting to a non-domain-joined Windows resource to provision an activity session or run a resource scan. + +Example error: ``` Add-SbPAMActionLog: Warn Message: Unable to create New-PSSSession for HOSTNAME using ComputerName (HOSTNAME) @@ -37,21 +40,23 @@ For more information, see the about_Remote_Troubleshooting Help topic Review the local configuration of the target host resource: -1. Run `lusrmgr.msc` via the Run command window − make sure the NPS service account used is a member of the **Administrators** group. In case the NPS account is not a part of the **Administrators** group, proceed to the next step. +1. Run `lusrmgr.msc` from the Run command window and ensure the Netwrix Privilege Secure for Access Management service account is a member of the **Administrators** group. If the account is not a member of the **Administrators** group, proceed to the next step. -2. Change a UAC setting preventing remote PowerShell authentication for non-Administrator accounts. Run the following line in elevated PowerShell: +2. Change a User Account Control (UAC) setting that prevents remote PowerShell authentication for non-Administrator accounts. Run the following line in elevated PowerShell: -```powershell -New-ItemProperty -Name LocalAccountTokenFilterPolicy ` --Path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System ` --PropertyType DWord -Value 1 -``` + ```powershell + New-ItemProperty -Name LocalAccountTokenFilterPolicy ` + -Path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System ` + -PropertyType DWord -Value 1 + ``` + + You should now be able to use your service account to connect to the resource through Privilege Secure. -> **NOTE:** Learn more in [about_Remote_Troubleshooting − How to enable remoting for administrators in other domains ⸱ Microsoft 🡥](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_troubleshooting?view=powershell-7.3#how-to-enable-remoting-for-administrators-in-other-domains). + > **NOTE:** For details on enabling remoting for administrators in other domains, see [about_Remote_Troubleshooting − How to enable remoting for administrators in other domains ⸱ Microsoft 🡥](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_troubleshooting?view=powershell-7.3#how-to-enable-remoting-for-administrators-in-other-domains). -You should now be able to use your service account to connect to the resource via NPS. For additional information on configuring non-domain-joined NPS resources, to refer to the following article: [Managing Non-domain-joined Windows Computers with Netwrix Privilege Secure](/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md). +For additional information on configuring non-domain-joined Privilege Secure resources, see [Managing Non-Domain-Joined Windows Computers with Netwrix Privilege Secure](/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md). -## Related articles +## Related Links - [about_Remote_Troubleshooting − How to enable remoting for administrators in other domains ⸱ Microsoft 🡥](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_troubleshooting?view=powershell-7.3#how-to-enable-remoting-for-administrators-in-other-domains) -- [Managing Non-domain-joined Windows Computers with Netwrix Privilege Secure](/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md) +- [Managing Non-Domain-Joined Windows Computers with Netwrix Privilege Secure](/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md) diff --git a/docs/kb/privilegesecure/resource-management/adding-resources-from-a-csv-file.md b/docs/kb/privilegesecure/resource-management/adding-resources-from-a-csv-file.md index d601083353..e394944830 100644 --- a/docs/kb/privilegesecure/resource-management/adding-resources-from-a-csv-file.md +++ b/docs/kb/privilegesecure/resource-management/adding-resources-from-a-csv-file.md @@ -1,8 +1,7 @@ --- description: >- - Use a CSV file of DNS hostnames to import resources into Netwrix Privilege - Secure. This article describes how to import the CSV, select a Service - Account, and monitor host scanning. + Import resources into Netwrix Privilege Secure for Access Management from a + CSV file of DNS hostnames, select a Service Account, and monitor host scanning. keywords: - CSV import - resources @@ -13,33 +12,32 @@ keywords: - Resources page - import CSV products: - - privilege-secure-access-management -sidebar_label: Adding Resources From a CSV File -tags: [] -title: "Adding Resources From a CSV File" + - privilegesecure +sidebar_label: "Adding Resources from a CSV File" +tags: + - kb + - resource-management +title: "Adding Resources from a CSV File" knowledge_article_id: kA04u000000Pd7pCAC --- -# Adding Resources From a CSV File +# Adding Resources from a CSV File -## Summary +## Overview -Resources can be imported to Netwrix Privilege Secure from a CSV file, where each line of the CSV is a distinct DNS hostname. +This article describes how to import resources into Netwrix Privilege Secure for Access Management from a CSV file, where each line of the CSV is a distinct DNS hostname. ## Instructions -1. Create a CSV file that contains the distinct DNS hostname of the resources you would like to add to Netwrix Privilege Secure. For example: +1. Create a CSV file that contains the distinct DNS hostname of the resources you want to add to Privilege Secure. For example: -2. In Netwrix Privilege Secure, navigate to the **Resources** page. Click **+ Add**, then select the **Import from CSV** radio button at the top of the dialog that appears. +2. In Privilege Secure, go to the **Resources** page. Click **+ Add**, then select the **Import from CSV** radio button at the top of the dialog that appears. - ![User-added image](./../0-images/ka04u000000HdEp_0EM4u000004bh1g.png) + ![Add Resources dialog with the Import from CSV option selected and the Import CSV button](./../0-images/ka04u000000HdEp_0EM4u000004bh1g.png) -3. Click **Import CSV**, then browse to and select the CSV of DNS hostnames you would like to import to Netwrix Privilege Secure. +3. Click **Import CSV**, then browse to and select the CSV of DNS hostnames you want to import to Privilege Secure. - ![User-added image](./../0-images/ka04u000000HdEp_0EM4u000004bh1q.png) + ![Add Resources dialog listing the hostnames imported from the CSV file](./../0-images/ka04u000000HdEp_0EM4u000004bh1q.png) -4. The **Add Resources** page will now list the resources found in the CSV, with a row for each DNS hostname. - - - In the bottom-right dropdown, select a **Service Account** that has previously been added to Netwrix Privilege Secure. This Service Account is used to scan each resource being added. - - When the desired Service Account is selected, click **+ Add** to start the resource import. You can wait and view the status of each host scan, or close the window to allow scanning to continue in the background. - - As resources are imported, you will see them appear on the **Resources** page, along with information gathered by the host scan such as Operation System, DNS Host Name, and IP Address. +4. On the **Add Resources** page, which lists the resources found in the CSV with a row for each DNS hostname, select a **Service Account** in the bottom-right dropdown. The Service Account must have previously been added to Privilege Secure. This Service Account is used to scan each resource being added. +5. Click **+ Add** to start the resource import. You can wait and view the status of each host scan, or close the window to allow scanning to continue in the background. As resources are imported, they appear on the **Resources** page, along with information gathered by the host scan such as Operation System, DNS Host Name, and IP Address. diff --git a/docs/kb/privilegesecure/resource-management/domain-could-not-be-reached-error.md b/docs/kb/privilegesecure/resource-management/domain-could-not-be-reached-error.md index de0e7dc802..d2181eb19a 100644 --- a/docs/kb/privilegesecure/resource-management/domain-could-not-be-reached-error.md +++ b/docs/kb/privilegesecure/resource-management/domain-could-not-be-reached-error.md @@ -1,8 +1,6 @@ --- description: >- - Netwrix Privilege Secure may report a 'Domain could not be reached' error when - running an Active Directory sync with **Use TLS** enabled. This article - describes causes and steps to resolve the issue. + Resolve the 'Domain could not be reached' error during an AD sync with Use TLS enabled by checking LDAP ports and domain controller certificates. keywords: - Active Directory - AD sync @@ -15,9 +13,11 @@ keywords: - domain resolution - troubleshooting products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Domain Could Not Be Reached Error -tags: [] +tags: + - kb + - resource-management title: "Domain Could Not Be Reached Error" knowledge_article_id: kA0Qk0000000XFJKA2 --- @@ -26,7 +26,7 @@ knowledge_article_id: kA0Qk0000000XFJKA2 ## Symptom -Netwrix Privilege Secure generates the following error when running an Active Directory (AD) sync with the **Use TLS** option enabled: +Netwrix Privilege Secure for Access Management generates the following error when running an Active Directory (AD) sync with the **Use TLS** option enabled: ```text AD Sync [ERR] 'Unable to connect to %domain% with credential %affected_account% with SSL: @@ -35,20 +35,20 @@ AD Sync [ERR] 'Unable to connect to %domain% with credential %affected_account% If the **Use TLS** option is disabled, the AD sync completes with no errors. -## Causes +## Cause -1. Firewall exclusions for LDAP/LDAPS ports are misconfigured in your environment. -2. The domain name cannot be resolved to any DC in your environment. +- Firewall exclusions for Lightweight Directory Access Protocol (LDAP) and LDAP over SSL (LDAPS) ports are misconfigured in your environment. +- The domain name cannot be resolved to any domain controller (DC) in your environment. -## Resolutions +## Resolution -- Verify the LDAP/LDAPS ports are open in your environment. Refer to the following article for additional information on ports required for Netwrix Privilege Secure: https://docs.netwrix.com/docs/privilegesecure/26_03/requirements/ports +- Verify the LDAP and LDAPS ports are open in your environment. See the following article for additional information on ports required for Privilege Secure: https://docs.netwrix.com/docs/privilegesecure/26_07/requirements/ports - Issue Kerberos authentication certificates to domain controllers in your environment. -> **TIP:** The **Use TLS** feature is optional—it is not required to perform AD syncs. When the feature is enabled, the LDAPS protocol is used. It requires the ability to resolve both domain names and FQDNs. +> **NOTE:** The **Use TLS** feature is optional—it is not required to perform AD syncs. When the feature is enabled, the LDAPS protocol is used. It requires the ability to resolve both domain names and fully qualified domain names (FQDNs). > > When the **Use TLS** feature is disabled, only the ability to resolve domain names in your environment is required. -## Related articles +## Related Links -- Requirements − Ports Requirements · v26.03: https://docs.netwrix.com/docs/privilegesecure/26_03/requirements/ports +- Requirements − Ports Requirements · v26.03: https://docs.netwrix.com/docs/privilegesecure/26_07/requirements/ports diff --git a/docs/kb/privilegesecure/resource-management/how-to-bulk-update-the-winrm-disabled-setting-on-nps-resources.md b/docs/kb/privilegesecure/resource-management/how-to-bulk-update-the-winrm-disabled-setting-on-nps-resources.md index b34b0b81a8..363355bb9b 100644 --- a/docs/kb/privilegesecure/resource-management/how-to-bulk-update-the-winrm-disabled-setting-on-nps-resources.md +++ b/docs/kb/privilegesecure/resource-management/how-to-bulk-update-the-winrm-disabled-setting-on-nps-resources.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to bulk-clear the "WinRM Disabled" flag on Windows NPS resources - managed by Netwrix Privilege Secure using a PowerShell script and the SbPAM - API. + Bulk-clear the "WinRM Disabled" flag on Windows resources managed by Netwrix + Privilege Secure using a PowerShell script and the SbPAM API. keywords: - WinRM - NPS @@ -13,10 +12,12 @@ keywords: - managed resources - bulk update products: - - privilege-secure-access-management -sidebar_label: How to Bulk Update the "WinRM Disabled" Setting on -tags: [] -title: How to Bulk Update the "WinRM Disabled" Setting on NPS Resources + - privilegesecure +sidebar_label: "How to Bulk Update the \"WinRM Disabled\" Setting on NPS Resources" +tags: + - kb + - resource-management +title: "How to Bulk Update the \"WinRM Disabled\" Setting on NPS Resources" knowledge_article_id: kA04u000001112eCAA --- @@ -24,85 +25,82 @@ knowledge_article_id: kA04u000001112eCAA ## Question -Some servers are added with the **WinRM Disabled** option. It is only possible to connect by manually changing the option. Is there another way to do this? +How can you bulk update the **WinRM Disabled** option on servers that were added with it, when the only way to connect to them is to change the option manually? ## Answer -> **IMPORTANT:** If WinRM is disabled during the initial scan of the domain resources, the subsequent scan and addition of resources would be performed with WinRM disabled as well +> **IMPORTANT:** If WinRM is disabled during the initial scan of the domain resources, the subsequent scan and addition of resources are also performed with WinRM disabled. -Follow these steps: - -1. Make sure that PowerShell 7.1 is installed. Assets and v7.1.7 release info are available on the [PowerShell Team's Organization Page ⸱ GitHub 🫱🏽‍🫲🏽](https://github.com/PowerShell/PowerShell/releases/tag/v7.1.7) - -2. Install `SbPAMPowershellModules`. Location: Netwrix Privilege Secure installation directory > the **Extras** folder +Complete the following steps: +1. Ensure that PowerShell 7.1 is installed. Assets and v7.1.7 release info are available on the [PowerShell Team's Organization Page ⸱ GitHub 🫱🏽‍🫲🏽](https://github.com/PowerShell/PowerShell/releases/tag/v7.1.7) +2. Install `SbPAMPowershellModules` from the **Extras** folder in the Privilege Secure installation directory. 3. Run the following script: -```powershell -$user = Read-Host -Prompt "Enter your Privilege Secure administrator account (eg: 'DOMAIN\username')" - $password = Read-Host -Prompt "Enter your Privilege Secure admin password" -MaskInput - $sbpamUri = (Read-Host -Prompt "Enter your Privilege Secure URL, ending in :6500 (eg: 'https://localhost:6500')").TrimEnd("/") - $setValueResponse = Read-Host -Prompt "Set all Windows resources with 'WinRM Disabled' = True to 'WinRM Disabled' = False ? Y or N" - if ($setValueResponse.toLower() -eq "y" -or $setValueResponse.ToLower() -eq "yes") { $setValue = $true } - else { $setValue = $false } - - [securestring]$secStringPassword = ConvertTo-SecureString $password -AsPlainText -Force - [pscredential]$userCred = New-Object System.Management.Automation.PSCredential ($user, $secStringPassword) - - #get the SbPAMAPI module (must be installed - PowerShell 7.1 required) - Import-Module SbPAMAPI -Force - - # create the web session - $WebSession = New-Object Microsoft.PowerShell.Commands.WebRequestSession - - # grab the user token - $token = Get-SbPAMToken -Credential $userCred -Uri $sbpamUri -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop - if ($null -eq $userSecret) { - $userCode = Read-Host -Prompt "Enter SbPAM MFA Code (if MFA is OFF - just type '0')" - } - else { - $userCode = Get-SbPAMTotp -Secret $UserSecret - } - $userMfaToken = Get-SbPAMMfaToken -Uri $sbpamUri -Token $token -Code $userCode -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop - - if ($userMfaToken.length -gt 0) { Write-Host "Auth token obtained." } - else { Write-Host "Auth token not obtained." } - - #get the list of all Windows resources - Write-Host "Obtaining list of managed resources" - $hostsArrayList = New-Object System.Collections.ArrayList - $take=1000; $skip = 0; - $hostResourceURI = "$sbpamUri/api/v1/ManagedResource/Search?skip=0&filterText=&take=$take&filterType=0" - $hosts = Invoke-SbPAMRest -Uri $hostResourceURI -Token $userMfaToken -Method GET -ContentType "application/json" - foreach($h in $hosts.data) { $hostsArrayList += $h } - $recordsRemaining = $hosts.recordsTotal - $take - while ($recordsRemaining -gt 0) - { - $skip++ - $startingPoint = ($skip*$take) - $hostResourceURI = "$sbpamUri/api/v1/ManagedResource/Search?skip=$startingPoint&filterText=&take=$take&filterType=0" - $hosts = Invoke-SbPAMRest -Uri $hostResourceURI -Token $userMfaToken -Method GET -ContentType "application/json" - foreach($h in $hosts.data) { $hostsArrayList += $h } - $recordsRemaining = $recordsRemaining - $take - } - - #Write-Host "Resource count (all platforms) - $($hostsArrayList.Count)" - - foreach($row in $hostsArrayList) - { - if ($row.platformName -eq "Windows") - { - Write-Host "Windows Resource: $($row.dnsHostName) has WinRM Disabled set to $($row.disableWinRm)" - if ($row.disableWinRm -ne $false -and $setValue -eq $true) - { - $managedResourceURI = "$sbpamUri/api/v1/ManagedResource/$($row.id)" - $rowPayload = $row - $rowPayload.disableWinRm = $false - $rowJson = $rowPayload | ConvertTo-Json - $putCall = Invoke-SbPAMRest -Uri $managedResourceURI -Token $userMfaToken -Method PUT -ContentType "application/json" -Body $rowJson - Write-Host "$($putCall.name) - WinRM Disabled is now set to False." - } - } - } -``` - + ```powershell + $user = Read-Host -Prompt "Enter your Privilege Secure administrator account (eg: 'DOMAIN\username')" + $password = Read-Host -Prompt "Enter your Privilege Secure admin password" -MaskInput + $sbpamUri = (Read-Host -Prompt "Enter your Privilege Secure URL, ending in :6500 (eg: 'https://localhost:6500')").TrimEnd("/") + $setValueResponse = Read-Host -Prompt "Set all Windows resources with 'WinRM Disabled' = True to 'WinRM Disabled' = False ? Y or N" + if ($setValueResponse.toLower() -eq "y" -or $setValueResponse.ToLower() -eq "yes") { $setValue = $true } + else { $setValue = $false } + + [securestring]$secStringPassword = ConvertTo-SecureString $password -AsPlainText -Force + [pscredential]$userCred = New-Object System.Management.Automation.PSCredential ($user, $secStringPassword) + + #get the SbPAMAPI module (must be installed - PowerShell 7.1 required) + Import-Module SbPAMAPI -Force + + # create the web session + $WebSession = New-Object Microsoft.PowerShell.Commands.WebRequestSession + + # grab the user token + $token = Get-SbPAMToken -Credential $userCred -Uri $sbpamUri -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop + if ($null -eq $userSecret) { + $userCode = Read-Host -Prompt "Enter SbPAM MFA Code (if MFA is OFF - just type '0')" + } + else { + $userCode = Get-SbPAMTotp -Secret $UserSecret + } + $userMfaToken = Get-SbPAMMfaToken -Uri $sbpamUri -Token $token -Code $userCode -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop + + if ($userMfaToken.length -gt 0) { Write-Host "Auth token obtained." } + else { Write-Host "Auth token not obtained." } + + #get the list of all Windows resources + Write-Host "Obtaining list of managed resources" + $hostsArrayList = New-Object System.Collections.ArrayList + $take=1000; $skip = 0; + $hostResourceURI = "$sbpamUri/api/v1/ManagedResource/Search?skip=0&filterText=&take=$take&filterType=0" + $hosts = Invoke-SbPAMRest -Uri $hostResourceURI -Token $userMfaToken -Method GET -ContentType "application/json" + foreach($h in $hosts.data) { $hostsArrayList += $h } + $recordsRemaining = $hosts.recordsTotal - $take + while ($recordsRemaining -gt 0) + { + $skip++ + $startingPoint = ($skip*$take) + $hostResourceURI = "$sbpamUri/api/v1/ManagedResource/Search?skip=$startingPoint&filterText=&take=$take&filterType=0" + $hosts = Invoke-SbPAMRest -Uri $hostResourceURI -Token $userMfaToken -Method GET -ContentType "application/json" + foreach($h in $hosts.data) { $hostsArrayList += $h } + $recordsRemaining = $recordsRemaining - $take + } + + #Write-Host "Resource count (all platforms) - $($hostsArrayList.Count)" + + foreach($row in $hostsArrayList) + { + if ($row.platformName -eq "Windows") + { + Write-Host "Windows Resource: $($row.dnsHostName) has WinRM Disabled set to $($row.disableWinRm)" + if ($row.disableWinRm -ne $false -and $setValue -eq $true) + { + $managedResourceURI = "$sbpamUri/api/v1/ManagedResource/$($row.id)" + $rowPayload = $row + $rowPayload.disableWinRm = $false + $rowJson = $rowPayload | ConvertTo-Json + $putCall = Invoke-SbPAMRest -Uri $managedResourceURI -Token $userMfaToken -Method PUT -ContentType "application/json" -Body $rowJson + Write-Host "$($putCall.name) - WinRM Disabled is now set to False." + } + } + } + ``` diff --git a/docs/kb/privilegesecure/resource-management/how-to-use-non-standard-rdp-ssh-ports-for-proxy-connections.md b/docs/kb/privilegesecure/resource-management/how-to-use-non-standard-rdp-ssh-ports-for-proxy-connections.md index bc65ef7649..f16079438f 100644 --- a/docs/kb/privilegesecure/resource-management/how-to-use-non-standard-rdp-ssh-ports-for-proxy-connections.md +++ b/docs/kb/privilegesecure/resource-management/how-to-use-non-standard-rdp-ssh-ports-for-proxy-connections.md @@ -12,26 +12,28 @@ keywords: - sbpam_ssh.json - non-standard ports products: - - privilege-secure-access-management -sidebar_label: 'How to Use Non-Standard RDP & SSH Ports for Proxy ' -tags: [] -title: "How to Use Non-Standard RDP & SSH Ports for Proxy Connections" + - privilegesecure +sidebar_label: "Using Non-Standard RDP & SSH Ports for Proxy Connections" +tags: + - kb + - resource-management +title: "Using Non-Standard RDP & SSH Ports for Proxy Connections" knowledge_article_id: kA04u0000000HhKCAU --- -# How to Use Non-Standard RDP & SSH Ports for Proxy Connections +# Using Non-Standard RDP & SSH Ports for Proxy Connections -> **IMPORTANT:** This guidance is applicable to Privilege Secure **v3.5** and prior! In the latest release, you can configure ports directly from the Host Details Page. Explore further details in the following article: https://docs.netwrix.com/docs/privilegesecure/26_03/admin/resources/detailspages/host +> **IMPORTANT:** This guidance is applicable to Netwrix Privilege Secure for Access Management **v3.5** and prior! In the latest release, you can configure ports directly from the Host Details Page. Explore further details in the following article: https://docs.netwrix.com/docs/privilegesecure/26_07/resources/servers -## Summary +## Overview -The Privilege Secure Proxy Service can be customized to connect to specific target resources using non-standard ports for both RDP and SSH. By default, the Proxy Service uses standard ports for these communications. +This article describes how to configure the Privilege Secure Proxy Service to connect to specific target resources using non-standard ports for both Remote Desktop Protocol (RDP) and Secure Shell (SSH). By default, the Proxy Service uses standard ports for these communications. ## Instructions Each Privilege Secure Proxy Service can be individually customized to connect to specific target resources via specific RDP and SSH ports, rather than the standard `TCP/3389` (RDP) and `TCP/22` (SSH). -To do so, you need to modify the following files on the server where each Proxy Service is installed: +To do so, modify the following files on the server where each Proxy Service is installed: - `sbpam_rdp.json` - `sbpam_ssh.json` @@ -42,38 +44,43 @@ These files are located in: %ProgramData%\Stealthbits\PAM\ProxyService ``` -If the files are not present, run the following commands to create them. First, open Command Prompt and change directory to: +### Creating the Configuration Files -```text -%Program Files%\Stealthbits\PAM\ProxyService -``` +If the files are not present, create them: -Then run the following two commands to create each JSON file respectively: +1. Open Command Prompt and change directory to: -```powershell -.\sbpam-proxy.exe cfg -c sbpam_rdp -.\sbpam-proxy.exe cfg -c sbpam_ssh -``` + ```text + %Program Files%\Stealthbits\PAM\ProxyService + ``` -You should receive confirmations such as, "Default configuration for sbpam_rdp created". The files will now exist in the aforementioned ProgramData path. +2. Run the following two commands to create each JSON file respectively: -Open the file you want to customize the protocol port for. In the JSON, add the following key/value pair: + ```powershell + .\sbpam-proxy.exe cfg -c sbpam_rdp + .\sbpam-proxy.exe cfg -c sbpam_ssh + ``` -```json -"OverridePort": ["example.host.com:"] -``` + You should receive confirmations such as, "Default configuration for sbpam_rdp created". The files now exist in the `%ProgramData%\Stealthbits\PAM\ProxyService` path. -Replace `example.host.com` with the target resource for which you want to customize the port. This can include wildcards for several hosts, such as `"*.host.com"`. You can also add multiple values to the array, for example: +### Setting a Custom Port -```json -"OverridePort": ["example1.host.com:", "example2.host.com:"] -``` +1. Open the file you want to customize the protocol port for. In the JSON, add the following key/value pair: + + ```json + "OverridePort": ["example.host.com:"] + ``` + +2. Replace `example.host.com` with the target resource for which you want to customize the port. This can include wildcards for several hosts, such as `"*.host.com"`. You can also add multiple values to the array, for example: -Replace `` with the desired port for the protocol's communication. + ```json + "OverridePort": ["example1.host.com:", "example2.host.com:"] + ``` -Once you finish your customizations, save the file. Subsequent Privilege Secure proxy connections to the specified target resources will use the custom port(s). +3. Replace `` with the port you want the protocol to use for communication. +4. After you finish your customizations, save the file. Subsequent Privilege Secure proxy connections to the specified target resources use one or more custom ports. -As an example of proper JSON syntax, here is a basic, customized `sbpam_rdp.json`. All RDP connections to `example.host.com` will now use port `5589`: +As an example of proper JSON syntax, here is a basic, customized `sbpam_rdp.json`. All RDP connections to `example.host.com` now use port `5589`: ```json { diff --git a/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md b/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md index 8073d029df..3462910dfb 100644 --- a/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md +++ b/docs/kb/privilegesecure/resource-management/managing-non-domain-joined-windows-computers-with-privilege-secure.md @@ -1,92 +1,94 @@ --- description: >- - Describes how to manage a non-domain-joined Windows computer with Netwrix - Privilege Secure, including adding a service account, adding the computer as a - resource, and troubleshooting failed scans. + Add a service account and a non-domain-joined Windows computer as a resource + in Privilege Secure, and troubleshoot failed scans. keywords: - - netwrix - - netwrix-privilege-secure + - Netwrix Privilege Secure - non-domain-joined - - windows - - local-administrator - - powershell-remoting - - port-5985 - - service-account + - Windows + - local Administrator + - PowerShell Remoting + - Enable-PSRemoting + - port 5985 + - service account + - Activity Token + - Access Denied products: - - privilege-secure-access-management -sidebar_label: Managing Non-domain-joined Windows Computers with Netwrix Privilege Secure -tags: [] -title: "Managing Non-domain-joined Windows Computers with Netwrix Privilege Secure" + - privilegesecure +sidebar_label: Managing Non-Domain-Joined Windows Computers with Netwrix Privilege Secure +tags: + - kb + - resource-management +title: "Managing Non-Domain-Joined Windows Computers with Netwrix Privilege Secure" knowledge_article_id: kA04u000000Tt1TCAS --- -# Managing Non-domain-joined Windows Computers with Netwrix Privilege Secure +# Managing Non-Domain-Joined Windows Computers with Netwrix Privilege Secure ## Overview -This article describes the process for managing a non-domain-joined Windows computer with Netwrix Privilege Secure. +This article describes how to manage a non-domain-joined Windows computer with Netwrix Privilege Secure for Access Management. -## Before You Begin +## Instructions + +### Before You Begin -Make sure that you have the following: +Ensure that you have the following: - A local Administrator account on the target computer, for which you know the password - PowerShell Remoting enabled on the target computer (`Enable-PSRemoting` ⸱ Microsoft) (https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/enable-psremoting?view=powershell-7.2) -- Port 5985 open for connections from the Netwrix Privilege Secure server (and any hosts running remote action services, if applicable) - -## Instructions +- Port 5985 open for connections from the Privilege Secure server (and any hosts running remote action services, if applicable) ### Adding the Netwrix Privilege Secure Service Account -1. As a user with the Administrator role, open Netwrix Privilege Secure. Navigate to the **Configuration > Service Accounts** page. -2. Click the green plus button to create a new Service Account -3. Enter the required information - 1. Name (a friendly name that is displayed in the rest of the UI for this account) - 2. Description (additional text for identifying this account) - 3. Domain (This MUST be the `NETBIOS` name of the target computer) - 4. Username (A Local Administrator account on the target computer) - 5. Password (The password for the local administrator account) - 6. Platform (`Windows`) - 7. Vault Connecter (``) -4. Click **Save** +1. As a user with the Administrator role, open Privilege Secure. Go to the **Configuration > Service Accounts** page. +2. Click the green plus button to create a new Service Account. +3. Enter the required information: + - Name (a friendly name that is displayed in the rest of the UI for this account) + - Description (additional text for identifying this account) + - Domain (this MUST be the `NETBIOS` name of the target computer) + - Username (a local Administrator account on the target computer) + - Password (the password for the local administrator account) + - Platform (`Windows`) + - Vault Connecter (``) +4. Click **Save**. -![User-added image](./../0-images/ka04u000000ww6m_0EM4u0000052ZhJ.png) + ![Service account form with the Domain, Username, Password, and Platform fields](./../0-images/ka04u000000ww6m_0EM4u0000052ZhJ.png) ### Adding the Computer to Netwrix Privilege Secure -1. Navigate to the **Resources** page -2. Click the **Add** button -3. Select **New Server** from the dropdown list -4. Click the **Add Manually** radio button -5. Enter the FQDN of the target computer -6. Click **Add** +1. Go to the **Resources** page. +2. Click the **Add** button. +3. Select **New Server** from the dropdown list. +4. Click the **Add Manually** radio button. +5. Enter the FQDN of the target computer. +6. Click **Add**. 7. In the lower right, select the Service Account created in the previous step. -8. Click **Add** +8. Click **Add**. -This will start the scanning step, you can close the dialog or wait for the scan to complete. If there are failures during the scan you can review the logs by navigating to the resource page. +The scanning step starts. You can close the dialog or wait for the scan to complete. If there are failures during the scan, you can review the logs on the resource page. -![User-added image](./../0-images/ka04u000000ww6m_0EM4u0000052ZhE.png) +![Add dialog with the scan of the new server in progress](./../0-images/ka04u000000ww6m_0EM4u0000052ZhE.png) ### Troubleshooting a Failed Scan If the scan fails, you can troubleshoot it by viewing the scan logs on the **Resources** page. -1. Search for the computer you attempted to add - -2. Click on the Resource name of the computer -3. Click on the **History** tab -4. Select the last scan event and click **View Logs** +1. Search for the computer you attempted to add. +2. Click the resource name of the computer. +3. Click the **History** tab. +4. Select the last scan event and click **View Logs**. -![User-added image](./../0-images/ka04u000000ww6m_0EM4u0000052Zh9.png) +![History tab of the resource with the last scan event selected and the View Logs option](./../0-images/ka04u000000ww6m_0EM4u0000052Zh9.png) ### Additional Troubleshooting: "Access Denied"" -In the event that you see "Access Denied" when investigating the logs, refer to Netwrix Privilege Secure: Resolving "Access Denied" When Connecting to a Non-domain-joined Windows Resource (https://kb.netwrix.com/8526). +If you see "Access Denied" when investigating the logs, see Netwrix Privilege Secure: Resolving "Access Denied" When Connecting to a Non-domain-joined Windows Resource (https://kb.netwrix.com/8526). -## Summary +### Using the Computer in Activities -After going through this process, you can use this computer's resource in Activities. A non-domain joined Windows computer can be used in any activity that doesn’t require Active Directory. You can create local Activity Token users and local managed accounts. Requester and accounts that require Active Directory will not work. +After you complete this process, you can use this computer's resource in Activities. A non-domain joined Windows computer can be used in any activity that does not require Active Directory. You can create local Activity Token users and local managed accounts. Requester and accounts that require Active Directory do not work. -To configure a local Activity Token/Managed Account activity, when creating the activity remove the “%targetdomain%\” portion of the default Login Account Format. Make sure to use the **Windows** Platform as well. +To configure a local Activity Token/Managed Account activity, when creating the activity remove the “%targetdomain%\” portion of the default Login Account Format. Ensure that you also use the **Windows** Platform. -![User-added image](./../0-images/ka04u000000ww6m_0EM4u0000052Zh4.png) +![Activity configuration with the Login Account Format and the Windows platform](./../0-images/ka04u000000ww6m_0EM4u0000052Zh4.png) diff --git a/docs/kb/privilegesecure/resource-management/resolving-failed-actions-on-a-windows-resource-due-to-error-the-ws-management-service-cannot-process.md b/docs/kb/privilegesecure/resource-management/resolving-failed-actions-on-a-windows-resource-due-to-error-the-ws-management-service-cannot-process.md index 91d923a930..f636ccfb5f 100644 --- a/docs/kb/privilegesecure/resource-management/resolving-failed-actions-on-a-windows-resource-due-to-error-the-ws-management-service-cannot-process.md +++ b/docs/kb/privilegesecure/resource-management/resolving-failed-actions-on-a-windows-resource-due-to-error-the-ws-management-service-cannot-process.md @@ -1,8 +1,7 @@ --- description: >- - Explains how to resolve the WS-Management error caused by Group Policy - disabling remote shell access, including how to verify the GPO and registry - value and how to correct the configuration. + Fix failed Actions caused by a Group Policy that disables remote shell access: + verify the GPO and registry value, then set the GPO to Enabled or Not Configured. keywords: - WinRM - AllowRemoteShellAccess @@ -14,41 +13,42 @@ keywords: - Netwrix Privilege Secure - Action Service products: - - privilege-secure-access-management -sidebar_label: Resolving failed Actions on a Windows resource due -tags: [] -title: >- - Resolving failed Actions on a Windows resource due to error "The - WS-Management service cannot process the request. The service is configured to - not accept any remote shell requests." + - privilegesecure +sidebar_label: "Resolving Failed Actions on a Windows Resource Due to Error \"The WS-Management service cannot process the request. The service is configured to not accept any remote shell requests.\"" +tags: + - kb + - resource-management +title: "Resolving Failed Actions on a Windows Resource Due to Error \"The WS-Management service cannot process the request. The service is configured to not accept any remote shell requests.\"" knowledge_article_id: kA04u0000000HRqCAM --- -# Resolving failed Actions on a Windows resource due to error "The WS-Management service cannot process the request. The service is configured to not accept any remote shell requests." +# Resolving Failed Actions on a Windows Resource Due to Error "The WS-Management service cannot process the request. The service is configured to not accept any remote shell requests." -## Summary +## Symptom -If remote shell access is disabled on a Windows resource, Netwrix Privilege Secure's Action Service cannot perform actions on that host. You can confirm this when an action's logs contain the following error: +If remote shell access is disabled on a Windows resource, the Action Service in Netwrix Privilege Secure for Access Management cannot perform actions on that host. You can confirm this when an action's logs contain the following error: ``` Unable to connect using PowerShell remoting to with user \: Connecting to remote server failed with the following error message : The WS-Management service cannot process the request. The service is configured to not accept any remote shell requests. ``` -![User-added image](./../0-images/ka04u000000HcZv_0EM4u000004bUoa.png) +![Action logs showing the WS-Management error for the failed remote shell connection](./../0-images/ka04u000000HcZv_0EM4u000004bUoa.png) -This is caused by a Group Policy, configured at the local or domain level, that disables remote shell access on the resources the GPO targets: +## Cause -![User-added image](./../0-images/ka04u000000HcZv_0EM4u000004bUof.png) +This is caused by a Group Policy Object (GPO), configured at the local or domain level, that disables remote shell access on the resources the GPO targets: -## Instructions +![Allow Remote Shell Access GPO setting set to Disabled](./../0-images/ka04u000000HcZv_0EM4u000004bUof.png) -You can verify this GPO in the Group Policy Editor on the target resource (or in the domain GPO configuration). Remember that domain configuration takes precedence over local configuration. +## Resolution + +Verify this GPO in the Group Policy Editor on the target resource (or in the domain GPO configuration). Domain configuration takes precedence over local configuration. ``` Computer Configuration > Administrative Templates > Windows Components > Windows Remote Shell > Allow Remote Shell Access ``` -![User-added image](./../0-images/ka04u000000HcZv_0EM4u000004bUok.png) +![Group Policy Editor showing the Allow Remote Shell Access setting set to Disabled](./../0-images/ka04u000000HcZv_0EM4u000004bUok.png) You can also verify the setting in PowerShell, but the GPO must first have been **Enabled** or **Disabled** so the correct registry key exists: @@ -59,6 +59,6 @@ Get-ItemProperty -Path "HKLM:\Software\Policies\Microsoft\Windows\WinRM\Service\ - If the value is set to **0**, then remote shell access is **Disabled**. - If the value is set to **1**, then remote shell access is **Enabled**. -![User-added image](./../0-images/ka04u000000HcZv_0EM4u000004bUop.png) +![PowerShell output showing the AllowRemoteShellAccess registry value](./../0-images/ka04u000000HcZv_0EM4u000004bUop.png) -To resolve the error, set this GPO to either **Enabled** or **Not Configured**. In a domain environment, you should make this change via a domain-configured GPO rather than manually modifying the registry key on the target resource. +To resolve the error, set this GPO to either **Enabled** or **Not Configured**. In a domain environment, make this change in a domain-configured GPO rather than manually modifying the registry key on the target resource. diff --git a/docs/kb/privilegesecure/session-management-and-recording/disable-keystroke-logging.md b/docs/kb/privilegesecure/session-management-and-recording/disable-keystroke-logging.md index 6eaf4813e7..65cd75d50d 100644 --- a/docs/kb/privilegesecure/session-management-and-recording/disable-keystroke-logging.md +++ b/docs/kb/privilegesecure/session-management-and-recording/disable-keystroke-logging.md @@ -1,8 +1,7 @@ --- description: >- - Instructions to disable keystroke logging and SSH session screen recordings in - Netwrix Privilege Secure, and steps to delete existing recordings for a - specified time window. + Disable keystroke logging and SSH session screen recordings in Privilege + Secure, and delete existing recordings for a specified time window. keywords: - keystroke logging - keylogging @@ -14,47 +13,52 @@ keywords: - sbpam_metadata - PostgreSQL products: - - privilege-secure-access-management - - privilege-secure-discovery + - privilegesecure + - privilegesecurediscovery visibility: public -sidebar_label: Disable Keystroke Logging -tags: [] -title: "Disable Keystroke Logging" +sidebar_label: "Disabling Keystroke Logging" +tags: + - kb + - session-management-and-recording +title: "Disabling Keystroke Logging" knowledge_article_id: kA0Qk0000000NvtKAE --- -# Disable Keystroke Logging +# Disabling Keystroke Logging -## Question +## Overview -How to disable keystroke logging (keylogging) in Netwrix Privilege Secure? +This article describes how to disable keystroke logging (keylogging) and SSH session screen recordings in Netwrix Privilege Secure for Access Management, and how to delete existing recordings for a specified time window. -## Answer +## Instructions -> **IMPORTANT:** The following steps will disable all screen recordings of SSH activity. +### Disabling Keystroke Logging and SSH Recordings -Locate the `sbpam_iolog.json` file in the `C:\ProgramData\Stealthbits\PAM\ProxyService` directory. Edit it to include the following lines: +> **IMPORTANT:** The following steps disable all screen recordings of SSH activity. -```json -{ -"idletimeout" : 300000000000, -"path" : "C:\ProgramData\Stealthbits\PAM\ProxyService\iolog", -"replicas" : 1, -"disableMetadata" : true -} -``` +1. Locate the `sbpam_iolog.json` file in the `C:\ProgramData\Stealthbits\PAM\ProxyService` directory. If no such file exists in the directory, create it and name it `sbpam_iolog.json`. +2. Edit the file to include the following lines (add the lines to the new file if you created it): -If no such file exists in the directory, create it, name it `sbpam_iolog.json`, and add the lines in the code block to the new file. Save the changes — this will disable all metadata recording, keylogging, and capture of all SSH session recordings. + ```json + { + "idletimeout" : 300000000000, + "path" : "C:\ProgramData\Stealthbits\PAM\ProxyService\iolog", + "replicas" : 1, + "disableMetadata" : true + } + ``` -> **IMPORTANT:** This will not affect the previous records. +3. Save the changes. This disables all metadata recording, keylogging, and capture of all SSH session recordings. -### Delete recordings from a specific time window + > **IMPORTANT:** This does not affect the previous records. -1. Locate the **iolog** directory — the default path is `C:\ProgramData\Stealthbits\PAM\ProxyService\iolog`. -2. Sort the contents by date and delete the folders matching the desired time window. +### Deleting Recordings from a Specific Time Window + +1. Locate the **iolog** directory. The default path is `C:\ProgramData\Stealthbits\PAM\ProxyService\iolog`. +2. Sort the contents by date and delete the folders matching the time window you want to delete. 3. Locate the **sbpam_metadata** database in the `C:\ProgramData\Stealthbits\PAM\ProxyService\iolog\.meta` directory and delete it. 4. Run the following PostgreSQL query to delete references for recordings: -```sql -delete from proxy_session where start_datetime_utc <= '2023-10-31 13:54:22.315271'; -``` + ```sql + delete from proxy_session where start_datetime_utc <= '2023-10-31 13:54:22.315271'; + ``` diff --git a/docs/kb/privilegesecure/session-management-and-recording/how-to-change-the-path-where-session-recordings-are-stored.md b/docs/kb/privilegesecure/session-management-and-recording/how-to-change-the-path-where-session-recordings-are-stored.md index d61e7ec96c..88ee1bf6e5 100644 --- a/docs/kb/privilegesecure/session-management-and-recording/how-to-change-the-path-where-session-recordings-are-stored.md +++ b/docs/kb/privilegesecure/session-management-and-recording/how-to-change-the-path-where-session-recordings-are-stored.md @@ -1,7 +1,7 @@ --- description: >- - Shows how to change the location where Netwrix Privilege Secure stores - session recordings and web recordings. + Change where Privilege Secure stores session recordings and web recordings, + for example when the install drive is running low on space. keywords: - Netwrix Privilege Secure - session recordings @@ -13,7 +13,7 @@ keywords: - sbpam-proxy.exe - icacls products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Changing the Path Where Session Recordings Are Stored tags: - kb @@ -26,7 +26,7 @@ knowledge_article_id: kA04u000000Pd8JCAS ## Overview -This article describes how to change the location where Netwrix Privilege Secure stores session recordings and web recordings. Changing the recording path can help if the drive where Netwrix Privilege Secure is installed is running low on space. +This article describes how to change the location where Netwrix Privilege Secure for Access Management stores session recordings and web recordings. Changing the recording path can help if the drive where Privilege Secure is installed is running low on space. Perform these changes on each proxy node, including any node in a high availability (HA) or remote configuration. @@ -36,79 +36,79 @@ Perform these changes on each proxy node, including any node in a high availabil 1. Verify that `sbpam_iolog.json`, the file that controls where Privilege Secure stores session recordings, exists at the following path (substitute the "C" drive letter for the server's `%PROGRAMDATA%` drive letter, if necessary): -```text -C:\ProgramData\STEALTHbits\PAM\ProxyService -``` + ```text + C:\ProgramData\STEALTHbits\PAM\ProxyService + ``` -Do one of the following, depending on whether the file exists: + Do one of the following, depending on whether the file exists: -- If the file exists on the Privilege Secure server, you can modify it to change where recorded sessions are stored. Skip to step 3 to edit the file. -- If the file does not exist, create it in the next step. + - If the file exists on the Privilege Secure server, you can modify it to change where recorded sessions are stored. Skip to step 3 to edit the file. + - If the file does not exist, create it in the next step. -2. Generate the iolog config by opening a command prompt, navigating to `\Program Files\Stealthbits\PAM\ProxyService`, and running the following command: +2. Generate the iolog config by opening a command prompt, going to `\Program Files\Stealthbits\PAM\ProxyService`, and running the following command: > **IMPORTANT:** The file needs to be in `\ProgramData\...`, but you must run this command from `\Program Files\...`. -```text -.\sbpam-proxy.exe cfg -c sbpam_iolog -``` + ```text + .\sbpam-proxy.exe cfg -c sbpam_iolog + ``` 3. Open `sbpam_iolog.json`, and add this: -```json -{ - "idletimeout": 300000000000, - "path": "D:\new\path\for\sessions", - "replicas": 1 -} -``` + ```json + { + "idletimeout": 300000000000, + "path": "D:\new\path\for\sessions", + "replicas": 1 + } + ``` -The `path` value determines where new session recordings are stored after you save the change. + The `path` value determines where new session recordings are stored after you save the change. 4. To apply the necessary permissions to the new directory, run the following command in an administrator PowerShell window: -```powershell -$recordingDir = D:\new\path\for\sessions -&icacls.exe $recordingDir /grant "NT SERVICE\SbpamProxy:(OI)(CI)F" /Q /T -``` + ```powershell + $recordingDir = D:\new\path\for\sessions + &icacls.exe $recordingDir /grant "NT SERVICE\SbpamProxy:(OI)(CI)F" /Q /T + ``` Consider the following: - In addition to new session recordings, manually move previous session recordings from the old recording path to the new location. -- If there are active Privilege Secure sessions, Privilege Secure's Proxy Service locks some of the recordings in the old location. It is safe to skip these files for now, and move them later once their associated session has ended and the files are no longer locked. +- If there are active Privilege Secure sessions, Privilege Secure's Proxy Service locks some of the recordings in the old location. It is safe to skip these files for now, and move them later after their associated session has ended and the files are no longer locked. -After you complete these steps, all old and new recordings are stored in the new location and are available for playback in Netwrix Privilege Secure. +After you complete these steps, all old and new recordings are stored in the new location and are available for playback in Privilege Secure. ### Changing the Path Where Web Recordings Are Stored 1. Open `appsettings.json`, located at: -```text -C:\ProgramData\STEALTHbits\PAM\WebService\appsettings.json -``` + ```text + C:\ProgramData\STEALTHbits\PAM\WebService\appsettings.json + ``` -If this file exists on the Privilege Secure server, you can modify it to change where recorded sessions are stored. If the file does not exist, create it. + If this file exists on the Privilege Secure server, you can modify it to change where recorded sessions are stored. If the file does not exist, create it. 2. Open (or create) `appsettings.json`, and locate (or create) the `DataDirectory` key. -```json -{ - "DataDirectory": "D:\new\path\for\webrecordings" -} -``` + ```json + { + "DataDirectory": "D:\new\path\for\webrecordings" + } + ``` -The `DataDirectory` value determines where new web recordings are stored after you save the change. + The `DataDirectory` value determines where new web recordings are stored after you save the change. 3. To apply the necessary permissions to the new directory, run the following command in an administrator PowerShell window (substitute `` with your chosen recording directory): -```powershell -$webRecordingDir = D:\new\path\for\webrecordings -&icacls.exe $webRecordingDir /grant "NT SERVICE\SbPAMProxy:(OI)(CI)F" /Q /T -``` + ```powershell + $webRecordingDir = D:\new\path\for\webrecordings + &icacls.exe $webRecordingDir /grant "NT SERVICE\SbPAMProxy:(OI)(CI)F" /Q /T + ``` Consider the following: - In addition to new web recordings, manually move previous web recordings from the old recording path to the new location. -- If there are active Privilege Secure web recordings, Privilege Secure's Web Service locks some of the recordings in the old location. It is safe to skip these files for now, and move them later once their associated session has ended and the files are no longer locked. +- If there are active Privilege Secure web recordings, Privilege Secure's Web Service locks some of the recordings in the old location. It is safe to skip these files for now, and move them later after their associated session has ended and the files are no longer locked. -After you complete these steps, all old and new recordings are stored in the new location and are available for playback in Netwrix Privilege Secure. +After you complete these steps, all old and new recordings are stored in the new location and are available for playback in Privilege Secure. diff --git a/docs/kb/privilegesecure/session-management-and-recording/how-to-replace-pre-authentication-banner-message-in-ssh-sessions.md b/docs/kb/privilegesecure/session-management-and-recording/how-to-replace-pre-authentication-banner-message-in-ssh-sessions.md index 5776a7b254..7fd2c32466 100644 --- a/docs/kb/privilegesecure/session-management-and-recording/how-to-replace-pre-authentication-banner-message-in-ssh-sessions.md +++ b/docs/kb/privilegesecure/session-management-and-recording/how-to-replace-pre-authentication-banner-message-in-ssh-sessions.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to replace the SSH pre-authentication banner message with a custom - text output in Netwrix Privilege Secure by editing the sbpam_ssh.json file on - Privilege Secure servers. + Replace the SSH pre-authentication banner with custom text by editing + sbpam_ssh.json on every Privilege Secure server. keywords: - SSH banner - pre-authentication banner @@ -11,46 +10,48 @@ keywords: - PAM - ProxyService - 'C:\ProgramData\Stealthbits\PAM\ProxyService' + - listenaddress + - SSH sessions products: - - privilege-secure-access-management -sidebar_label: How to Replace Pre-authentication Banner Message i -tags: [] -title: "How to Replace Pre-authentication Banner Message in SSH Sessions" + - privilegesecure +sidebar_label: Replacing the Pre-Authentication Banner Message in SSH Sessions +tags: + - kb + - session-management-and-recording +title: "Replacing the Pre-Authentication Banner Message in SSH Sessions" knowledge_article_id: kA0Qk0000000YPtKAM --- -# How to Replace Pre-authentication Banner Message in SSH Sessions +# Replacing the Pre-Authentication Banner Message in SSH Sessions ## Overview -This article covers steps to replace the pre-authentication banner message with a regular text output in Netwrix Privilege Secure. +This article describes how to replace the pre-authentication banner message with a regular text output in Netwrix Privilege Secure for Access Management. ## Instructions -Refer to the following steps: +Complete the following steps: -Save the changes. - -1. On all Netwrix Privilege Secure servers, navigate to the following path: +1. On all Privilege Secure servers, go to the following path: `C:\ProgramData\Stealthbits\PAM\ProxyService\` 2. **Optional:** If the `sbpam_ssh.json` file is missing from the target directory, create it and follow these steps. 3. Locate the `sbpam_ssh.json` file and edit it using a text editor. 4. Add the following node to the file: -```json -{ -"listenaddress": "0.0.0.0:4422", -"banner": "New text output from server for SSH sessions" -} -``` + ```json + { + "listenaddress": "0.0.0.0:4422", + "banner": "New text output from server for SSH sessions" + } + ``` -5. **Optional:** In case the file contains any other data, place a comma before the opening brace. Refer to the following example: +5. **Optional:** If the file contains any other data, place a comma before the opening brace. See the following example: -```json -,{ -"listenaddress": "0.0.0.0:4422", -"banner": "New text output from server for SSH sessions" -} -``` + ```json + ,{ + "listenaddress": "0.0.0.0:4422", + "banner": "New text output from server for SSH sessions" + } + ``` -Save the changes. +6. Save the changes. diff --git a/docs/kb/privilegesecure/third-party-integrations/creating-a-custom-byov-connector-to-check-out-service-accounts-from-privilege-secure.md b/docs/kb/privilegesecure/third-party-integrations/creating-a-custom-byov-connector-to-check-out-service-accounts-from-privilege-secure.md index f1ed292b27..0187dab9f7 100644 --- a/docs/kb/privilegesecure/third-party-integrations/creating-a-custom-byov-connector-to-check-out-service-accounts-from-privilege-secure.md +++ b/docs/kb/privilegesecure/third-party-integrations/creating-a-custom-byov-connector-to-check-out-service-accounts-from-privilege-secure.md @@ -1,8 +1,8 @@ --- description: >- - Shows how to create a custom BYOV connector so Netwrix Privilege Secure can - check out service accounts with the "Internal" managed type, and includes an - optional checkin script to rotate the password during checkin. + Create a custom BYOV connector to check out service accounts with the + "Internal" managed type, with an optional checkin script that rotates the + password. keywords: - BYOV - BYOV connector @@ -12,427 +12,433 @@ keywords: - checkin - password rotation - Vault connector + - Internal managed type + - InsecureAllowServiceAccounts products: - - privilege-secure-access-management -sidebar_label: Creating a Custom BYOV Connector to Check out Serv -tags: [] -title: "Creating a Custom BYOV Connector to Check out Service Accounts from Privilege Secure" + - privilegesecure +sidebar_label: "Creating a Custom BYOV Connector to Check Out Service Accounts from Privilege Secure" +tags: + - kb + - third-party-integrations +title: "Creating a Custom BYOV Connector to Check Out Service Accounts from Privilege Secure" knowledge_article_id: kA04u00000111AxCAI --- -# Creating a Custom BYOV Connector to Check out Service Accounts from Privilege Secure +# Creating a Custom BYOV Connector to Check Out Service Accounts from Privilege Secure -## Summary +## Overview -The standard BYOV connector for checking out credentials from Netwrix Privilege Secure will, by design, not allow service accounts with the "Internal" managed type to be checked out. If this functionality is business-critical, this article provides a means for "Internal" type service accounts to be checked out using a BYOV connector. +This article describes how to create a custom BYOV connector so that Netwrix Privilege Secure for Access Management can check out service accounts with the "Internal" managed type. By design, the standard BYOV connector for checking out credentials from Privilege Secure does not allow service accounts with the "Internal" managed type to be checked out. If this functionality is business-critical, this article provides a means for "Internal" type service accounts to be checked out using a BYOV connector. -**Note:** As service accounts are by nature critical, we advise that the day-to-day use of these accounts for Netwrix Privilege Secure sessions be minimized. +> **NOTE:** Because service accounts are by nature critical, Netwrix advises that the day-to-day use of these accounts for Privilege Secure sessions be minimized. -**Note:** This connector will not rotate the account's password during the checkout script. Optional instructions are included that will rotate the password during the checkin. +> **NOTE:** This connector does not rotate the account's password during the checkout script. Optional instructions are included that rotate the password during the checkin. -## Before You Begin +## Instructions -Ensure that the account you wish to check out is configured in Netwrix Privilege Secure as a Service Account (**Configuration > Service Account**), and that the correct password is stored. +### Before You Begin -## Checkout Instructions +Ensure that the account you want to check out is configured in Privilege Secure as a Service Account (**Configuration > Service Account**), and that the correct password is stored. -1. In the Netwrix Privilege Secure console, navigate to the **Configuration** menu, and the **Integration Connectors** submenu. +### Checkout Instructions + +1. In the Privilege Secure console, go to the **Configuration** menu, and then the **Integration Connectors** submenu. 2. Click the green plus icon to add a new Activity Connector. 3. Configure it according to the following table: -| Field | Value | -|---------------------|--------------------------------------------| -| Name | `` | -| Description | `` | -| Connector Template | BYOV | -| API URL | `https://localhost:6500` | -| App Id | `SbPAM` | -| Client Certificate | `x` | -| Skip Certificate Check | `True` | + | Field | Value | + |---------------------|--------------------------------------------| + | Name | `` | + | Description | `` | + | Connector Template | BYOV | + | API URL | `https://localhost:6500` | + | App Id | `SbPAM` | + | Client Certificate | `x` | + | Skip Certificate Check | `True` | 4. Copy and paste the following script into the **Checkout Script Block** field. -```powershell -param ( - $Options, - $Credential -) -$Token = $Options.RestApiToken -$Uri = $Options.RestApiUri -#### -## Allow service accounts to be checked out -## NOTE This is not recommended. -## Service accounts should not be used for interactive logins -#### -$InsecureAllowServiceAccounts = $false - -function Get-CredentialMatch { - [CmdletBinding()] - param ( - $CredentialAccount, - $CredentialResource, - $Token, - $Uri, - $CredentialType = 1 - ) - $credentials = @() - $skip = 0 - $take = 100 - $result = $null - if ($null -ne $CredentialAccount) { - $FilterText = "$($CredentialAccount)" - $Message = "FILTERTEXT: $FilterText" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - - do { - $Params = @{ - RestApiToken = $Token; - Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/Search?skip=$skip&take=$take&filterText=$FilterText&credentialType=$CredentialType"; - } - $result = Invoke-SbPAMRest @Params - <# - $Message = (ConvertTo-Json $result) - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - #> - $result.Data | ForEach-Object { $credentials += $_ } - $skip += $take - } until ($credentials.Count -ge $result.RecordsTotal) - $credentials | Foreach-Object { - $Message = "FOUND: $($_.Id) UserName: '$($_.UserName)' Resource: '$($_.Domain)'" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - } - - $Message = "Find UserName -eq '$CredentialAccount' -and Resource -eq '$CredentialResource'" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - - if ($null -ne $CredentialResource) { - $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount -and $_.Domain -eq $CredentialResource } - } - else { - $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount } - } - - if ($null -eq $result) { - # Try RESOURCE\USERNAME - $Test = "$CredentialResource\$CredentialAccount" - $Message = "Find UserName -eq '$Test'" - - $result = $credentials | Where-Object -Property UserName -eq $Test - } - - if ($null -eq $result) { - $Test = "$($Options.TargetHost.DnsHostName)\$CredentialAccount" - - if ($null -ne $Options.TargetHost.NetBiosName) { - $Test = "$($Options.TargetHost.NetBiosName)\$CredentialAccount" - } - $Message = "Find UserName -eq $Test" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - $result = $credentials | Where-Object -Property UserName -eq $Test - } - else { - $Message = "FOUND Username: '$($result.Username)' Resource: '$($result.Domain)'" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - } - } - if ($result.Count -gt 1) { - $Message = "Multiple matches found for Username: '$CredentialAccount' Resource: '$CredentialResource'" - Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" - return $null - } - return $result -} - -### If this is an activity then use the LoginAccountName -$CredentialAccount = $null -$CredentialResource = $null -if ($null -ne $Options.ActivitySession) { - $CredentialAccount = $Options.ActivitySession.LoginAccountName -} -$Message = "CredentialAccount: $CredentialAccount" -Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - -### This is a service account, so the info should be in the Credential -$IsServiceAccount = $false -if ($null -eq $CredentialAccount) { - $CredentialAccount = $Credential.Username - $IsServiceAccount = $true -} -$Message = "CredentialAccount: $CredentialAccount" -Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - -if ($CredentialAccount -match ".*@.*") { - $Parts = $CredentialAccount.Split("@") - $CredentialAccount = $Parts[0] - $CredentialResource = $Parts[1] -} -elseif ($CredentialAccount -match ".*\.*") { - $Parts = $CredentialAccount.Split("") - $CredentialAccount = $Parts[1] - $CredentialResource = $Parts[0] -} -else { - if ($IsServiceAccount) { - $CredentialResource = $Credential.Domain - } - else { - $CredentialResource = $Options.TargetHost.DnsHostName - } -} -$result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 1 -if ($null -eq $result) { - - if ($InsecureAllowServiceAccounts) - { - Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" - $result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 0 - if ($null -eq $result) { - Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (ServiceAccount)" - } - } - else - { - Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" - } -} - -if ($null -eq $result) { - Add-SbPAMActionLog -Type Error -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource failed" - return $null -} - - -if ($null -ne $result) { - $Params = @{ - RestApiToken = $Token; - Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/$($result.CredentialId)?showPassword=true"; - } - - $result = Invoke-SbPAMRest @Params - # To support domain users in secret vaults - if ($result.Username -contains "") { - $Parts = $result.Username.split("") - $Credential.Username = $Parts[1] - $Credential.Domain = $Parts[0] - } - else { - $Credential.Username = $result.Username - $Credential.Domain = $result.Domain - } - $Credential.Password = $result.Password - Add-SbPAMActionLog -Type Info -Message "Returning Username: '$($Credential.Username)' CredentialResource: '$($Credential.Domain)'" - - return $Credential -} -else { - $Message = "Unable to find credential for $CredentialAccount $CredentialResource" - Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" - return $null -} -``` - -5. Edit line 12 of the **Checkout Script Block** such that the `InsecureAllowServiceAccounts` variable is `true`: - -```powershell -$InsecureAllowServiceAccounts = $true -``` - -## Checkin Instructions (Optional - for Password Rotation) + ```powershell + param ( + $Options, + $Credential + ) + $Token = $Options.RestApiToken + $Uri = $Options.RestApiUri + #### + ## Allow service accounts to be checked out + ## NOTE This is not recommended. + ## Service accounts should not be used for interactive logins + #### + $InsecureAllowServiceAccounts = $false + + function Get-CredentialMatch { + [CmdletBinding()] + param ( + $CredentialAccount, + $CredentialResource, + $Token, + $Uri, + $CredentialType = 1 + ) + $credentials = @() + $skip = 0 + $take = 100 + $result = $null + if ($null -ne $CredentialAccount) { + $FilterText = "$($CredentialAccount)" + $Message = "FILTERTEXT: $FilterText" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + do { + $Params = @{ + RestApiToken = $Token; + Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/Search?skip=$skip&take=$take&filterText=$FilterText&credentialType=$CredentialType"; + } + $result = Invoke-SbPAMRest @Params + <# + $Message = (ConvertTo-Json $result) + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + #> + $result.Data | ForEach-Object { $credentials += $_ } + $skip += $take + } until ($credentials.Count -ge $result.RecordsTotal) + $credentials | Foreach-Object { + $Message = "FOUND: $($_.Id) UserName: '$($_.UserName)' Resource: '$($_.Domain)'" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + } + + $Message = "Find UserName -eq '$CredentialAccount' -and Resource -eq '$CredentialResource'" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + if ($null -ne $CredentialResource) { + $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount -and $_.Domain -eq $CredentialResource } + } + else { + $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount } + } + + if ($null -eq $result) { + # Try RESOURCE\USERNAME + $Test = "$CredentialResource\$CredentialAccount" + $Message = "Find UserName -eq '$Test'" + + $result = $credentials | Where-Object -Property UserName -eq $Test + } + + if ($null -eq $result) { + $Test = "$($Options.TargetHost.DnsHostName)\$CredentialAccount" + + if ($null -ne $Options.TargetHost.NetBiosName) { + $Test = "$($Options.TargetHost.NetBiosName)\$CredentialAccount" + } + $Message = "Find UserName -eq $Test" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + $result = $credentials | Where-Object -Property UserName -eq $Test + } + else { + $Message = "FOUND Username: '$($result.Username)' Resource: '$($result.Domain)'" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + } + } + if ($result.Count -gt 1) { + $Message = "Multiple matches found for Username: '$CredentialAccount' Resource: '$CredentialResource'" + Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" + return $null + } + return $result + } + + ### If this is an activity then use the LoginAccountName + $CredentialAccount = $null + $CredentialResource = $null + if ($null -ne $Options.ActivitySession) { + $CredentialAccount = $Options.ActivitySession.LoginAccountName + } + $Message = "CredentialAccount: $CredentialAccount" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + ### This is a service account, so the info should be in the Credential + $IsServiceAccount = $false + if ($null -eq $CredentialAccount) { + $CredentialAccount = $Credential.Username + $IsServiceAccount = $true + } + $Message = "CredentialAccount: $CredentialAccount" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + if ($CredentialAccount -match ".*@.*") { + $Parts = $CredentialAccount.Split("@") + $CredentialAccount = $Parts[0] + $CredentialResource = $Parts[1] + } + elseif ($CredentialAccount -match ".*\.*") { + $Parts = $CredentialAccount.Split("") + $CredentialAccount = $Parts[1] + $CredentialResource = $Parts[0] + } + else { + if ($IsServiceAccount) { + $CredentialResource = $Credential.Domain + } + else { + $CredentialResource = $Options.TargetHost.DnsHostName + } + } + $result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 1 + if ($null -eq $result) { + + if ($InsecureAllowServiceAccounts) + { + Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" + $result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 0 + if ($null -eq $result) { + Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (ServiceAccount)" + } + } + else + { + Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" + } + } + + if ($null -eq $result) { + Add-SbPAMActionLog -Type Error -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource failed" + return $null + } + + + if ($null -ne $result) { + $Params = @{ + RestApiToken = $Token; + Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/$($result.CredentialId)?showPassword=true"; + } + + $result = Invoke-SbPAMRest @Params + # To support domain users in secret vaults + if ($result.Username -contains "") { + $Parts = $result.Username.split("") + $Credential.Username = $Parts[1] + $Credential.Domain = $Parts[0] + } + else { + $Credential.Username = $result.Username + $Credential.Domain = $result.Domain + } + $Credential.Password = $result.Password + Add-SbPAMActionLog -Type Info -Message "Returning Username: '$($Credential.Username)' CredentialResource: '$($Credential.Domain)'" + + return $Credential + } + else { + $Message = "Unable to find credential for $CredentialAccount $CredentialResource" + Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" + return $null + } + ``` + +5. Edit line 12 of the **Checkout Script Block** so that the `InsecureAllowServiceAccounts` variable is `true`: + + ```powershell + $InsecureAllowServiceAccounts = $true + ``` + +### Checkin Instructions (Optional - for Password Rotation) 1. Copy and paste the following script into the **Checkin Script Block** field: -```powershell -param ( - $Options, - $Credential -) -$Token = $Options.RestApiToken -$Uri = $Options.RestApiUri -#### -## Allow service accounts to be checked out -## NOTE This is not recommended. -## Service accounts should not be used for interactive logins -#### -$InsecureAllowServiceAccounts = $false - -function Get-CredentialMatch { - [CmdletBinding()] - param ( - $CredentialAccount, - $CredentialResource, - $Token, - $Uri, - $CredentialType = 1 - ) - $credentials = @() - $skip = 0 - $take = 100 - $result = $null - if ($null -ne $CredentialAccount) { - $FilterText = "$($CredentialAccount)" - $Message = "FILTERTEXT: $FilterText" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - - do { - $Params = @{ - RestApiToken = $Token; - Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/Search?skip=$skip&take=$take&filterText=$FilterText&credentialType=$CredentialType"; - } - $result = Invoke-SbPAMRest @Params - <# - $Message = (ConvertTo-Json $result) - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - #> - $result.Data | ForEach-Object { $credentials += $_ } - $skip += $take - } until ($credentials.Count -ge $result.RecordsTotal) - $credentials | Foreach-Object { - $Message = "FOUND: $($_.Id) UserName: '$($_.UserName)' Resource: '$($_.Domain)'" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - } - - $Message = "Find UserName -eq '$CredentialAccount' -and Resource -eq '$CredentialResource'" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - - if ($null -ne $CredentialResource) { - $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount -and $_.Domain -eq $CredentialResource } - } - else { - $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount } - } - - if ($null -eq $result) { - # Try RESOURCE\USERNAME - $Test = "$CredentialResource\$CredentialAccount" - $Message = "Find UserName -eq '$Test'" - - $result = $credentials | Where-Object -Property UserName -eq $Test - } - - if ($null -eq $result) { - $Test = "$($Options.TargetHost.DnsHostName)\$CredentialAccount" - - if ($null -ne $Options.TargetHost.NetBiosName) { - $Test = "$($Options.TargetHost.NetBiosName)\$CredentialAccount" - } - $Message = "Find UserName -eq $Test" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - $result = $credentials | Where-Object -Property UserName -eq $Test - } - else { - $Message = "FOUND Username: '$($result.Username)' Resource: '$($result.Domain)'" - Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - } - } - if ($result.Count -gt 1) { - $Message = "Multiple matches found for Username: '$CredentialAccount' Resource: '$CredentialResource'" - Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" - return $null - } - return $result -} - -### If this is an activity then use the LoginAccountName -$CredentialAccount = $null -$CredentialResource = $null -if ($null -ne $Options.ActivitySession) { - $CredentialAccount = $Options.ActivitySession.LoginAccountName -} -$Message = "CredentialAccount: $CredentialAccount" -Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - -### This is a service account, so the info should be in the Credential -$IsServiceAccount = $false -if ($null -eq $CredentialAccount) { - $CredentialAccount = $Credential.Username - $IsServiceAccount = $true -} -$Message = "CredentialAccount: $CredentialAccount" -Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" - -if ($CredentialAccount -match ".*@.*") { - $Parts = $CredentialAccount.Split("@") - $CredentialAccount = $Parts[0] - $CredentialResource = $Parts[1] -} -elseif ($CredentialAccount -match ".*\.*") { - $Parts = $CredentialAccount.Split("") - $CredentialAccount = $Parts[1] - $CredentialResource = $Parts[0] -} -else { - if ($IsServiceAccount) { - $CredentialResource = $Credential.Domain - } - else { - $CredentialResource = $Options.TargetHost.DnsHostName - } -} -$result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 1 -if ($null -eq $result) { - - if ($InsecureAllowServiceAccounts) - { - Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" - $result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 0 - if ($null -eq $result) { - Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (ServiceAccount)" - } - } - else - { - Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" - } -} - -if ($null -eq $result) { - Add-SbPAMActionLog -Type Error -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource failed" - return $null -} - -if ($null -ne $result) { - $Params = @{ - RestApiToken = $Token; - Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/$($result.CredentialId)?showPassword=false"; - } - $Body = @{Ids = @()} - - $Body.Ids += $result.Id; - - ## Rotating password - Add-SbPAMActionLog -Type Info -Message "Rotating Username: '$($Credential.Username)' CredentialResource: '$($Credential.Domain)'" - Invoke-SbPAMRest -Uri "$($Uri.TrimEnd("/"))/api/v1/ManagedUser/RotateAccounts" -Method Post -Body (ConvertTo-Json $Body) -RestApiToken $Token -ErrorAction Stop - - return $Credential -} -else { - $Message = "Unable to find credential for $CredentialAccount $CredentialResource" - Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" -} -``` - -2. Edit line 12 of the **Checkin Script Block** such that the `InsecureAllowServiceAccounts` variable is `true`: - -```powershell -$InsecureAllowServiceAccounts = $true -``` - -## Configuring an Activity - -1. In the Netwrix Privilege Secure console, navigate to the **Activities** menu. + ```powershell + param ( + $Options, + $Credential + ) + $Token = $Options.RestApiToken + $Uri = $Options.RestApiUri + #### + ## Allow service accounts to be checked out + ## NOTE This is not recommended. + ## Service accounts should not be used for interactive logins + #### + $InsecureAllowServiceAccounts = $false + + function Get-CredentialMatch { + [CmdletBinding()] + param ( + $CredentialAccount, + $CredentialResource, + $Token, + $Uri, + $CredentialType = 1 + ) + $credentials = @() + $skip = 0 + $take = 100 + $result = $null + if ($null -ne $CredentialAccount) { + $FilterText = "$($CredentialAccount)" + $Message = "FILTERTEXT: $FilterText" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + do { + $Params = @{ + RestApiToken = $Token; + Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/Search?skip=$skip&take=$take&filterText=$FilterText&credentialType=$CredentialType"; + } + $result = Invoke-SbPAMRest @Params + <# + $Message = (ConvertTo-Json $result) + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + #> + $result.Data | ForEach-Object { $credentials += $_ } + $skip += $take + } until ($credentials.Count -ge $result.RecordsTotal) + $credentials | Foreach-Object { + $Message = "FOUND: $($_.Id) UserName: '$($_.UserName)' Resource: '$($_.Domain)'" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + } + + $Message = "Find UserName -eq '$CredentialAccount' -and Resource -eq '$CredentialResource'" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + if ($null -ne $CredentialResource) { + $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount -and $_.Domain -eq $CredentialResource } + } + else { + $result = $credentials | Where-Object { $_.Username -eq $CredentialAccount } + } + + if ($null -eq $result) { + # Try RESOURCE\USERNAME + $Test = "$CredentialResource\$CredentialAccount" + $Message = "Find UserName -eq '$Test'" + + $result = $credentials | Where-Object -Property UserName -eq $Test + } + + if ($null -eq $result) { + $Test = "$($Options.TargetHost.DnsHostName)\$CredentialAccount" + + if ($null -ne $Options.TargetHost.NetBiosName) { + $Test = "$($Options.TargetHost.NetBiosName)\$CredentialAccount" + } + $Message = "Find UserName -eq $Test" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + $result = $credentials | Where-Object -Property UserName -eq $Test + } + else { + $Message = "FOUND Username: '$($result.Username)' Resource: '$($result.Domain)'" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + } + } + if ($result.Count -gt 1) { + $Message = "Multiple matches found for Username: '$CredentialAccount' Resource: '$CredentialResource'" + Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" + return $null + } + return $result + } + + ### If this is an activity then use the LoginAccountName + $CredentialAccount = $null + $CredentialResource = $null + if ($null -ne $Options.ActivitySession) { + $CredentialAccount = $Options.ActivitySession.LoginAccountName + } + $Message = "CredentialAccount: $CredentialAccount" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + ### This is a service account, so the info should be in the Credential + $IsServiceAccount = $false + if ($null -eq $CredentialAccount) { + $CredentialAccount = $Credential.Username + $IsServiceAccount = $true + } + $Message = "CredentialAccount: $CredentialAccount" + Add-SbPAMActionLog -Type Info -Message "BYOV: $Message" + + if ($CredentialAccount -match ".*@.*") { + $Parts = $CredentialAccount.Split("@") + $CredentialAccount = $Parts[0] + $CredentialResource = $Parts[1] + } + elseif ($CredentialAccount -match ".*\.*") { + $Parts = $CredentialAccount.Split("") + $CredentialAccount = $Parts[1] + $CredentialResource = $Parts[0] + } + else { + if ($IsServiceAccount) { + $CredentialResource = $Credential.Domain + } + else { + $CredentialResource = $Options.TargetHost.DnsHostName + } + } + $result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 1 + if ($null -eq $result) { + + if ($InsecureAllowServiceAccounts) + { + Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" + $result = Get-CredentialMatch -CredentialAccount $CredentialAccount -CredentialResource $CredentialResource -Token $Token -Uri $Uri -CredentialType 0 + if ($null -eq $result) { + Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (ServiceAccount)" + } + } + else + { + Add-SbPAMActionLog -Type Info -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource returned null (UserAccount)" + } + } + + if ($null -eq $result) { + Add-SbPAMActionLog -Type Error -Message "Search using CredentialAccount: $CredentialAccount and CredentialResource: $CredentialResource failed" + return $null + } + + if ($null -ne $result) { + $Params = @{ + RestApiToken = $Token; + Uri = "$($Uri.TrimEnd("/"))/api/v1/Credential/$($result.CredentialId)?showPassword=false"; + } + $Body = @{Ids = @()} + + $Body.Ids += $result.Id; + + ## Rotating password + Add-SbPAMActionLog -Type Info -Message "Rotating Username: '$($Credential.Username)' CredentialResource: '$($Credential.Domain)'" + Invoke-SbPAMRest -Uri "$($Uri.TrimEnd("/"))/api/v1/ManagedUser/RotateAccounts" -Method Post -Body (ConvertTo-Json $Body) -RestApiToken $Token -ErrorAction Stop + + return $Credential + } + else { + $Message = "Unable to find credential for $CredentialAccount $CredentialResource" + Add-SbPAMActionLog -Type Error -Message "BYOV: $Message" + } + ``` + +2. Edit line 12 of the **Checkin Script Block** so that the `InsecureAllowServiceAccounts` variable is `true`: + + ```powershell + $InsecureAllowServiceAccounts = $true + ``` + +### Configuring an Activity + +1. In the Privilege Secure console, go to the **Activities** menu. 2. Click the green plus icon to create a new activity. 3. Configure it with the following values: -| Field | Value | -|------------------------|--------------------------------------------------| -| Name | `` | -| Description | `` | -| Platform | `None specified` | -| Login Account | `Vault` | -| Activity Type | `Interactive` | -| Login Account Template | `` | -| Vault Connector | `` | - -4. Once the activity is properly configured, click **Save**. + | Field | Value | + |------------------------|--------------------------------------------------| + | Name | `` | + | Description | `` | + | Platform | `None specified` | + | Login Account | `Vault` | + | Activity Type | `Interactive` | + | Login Account Template | `` | + | Vault Connector | `` | + +4. After the activity is properly configured, click **Save**. You can now assign this activity to an access policy, and access it by selecting its activity card on the **My Activities** page. diff --git a/docs/kb/privilegesecure/third-party-integrations/how-to-configure-local-administrator-password-solution-laps-integration.md b/docs/kb/privilegesecure/third-party-integrations/how-to-configure-local-administrator-password-solution-laps-integration.md index a678b10cf3..7de5f4b91b 100644 --- a/docs/kb/privilegesecure/third-party-integrations/how-to-configure-local-administrator-password-solution-laps-integration.md +++ b/docs/kb/privilegesecure/third-party-integrations/how-to-configure-local-administrator-password-solution-laps-integration.md @@ -1,8 +1,7 @@ --- description: >- - This article explains how to integrate Netwrix Privilege Secure with Microsoft - Local Administrator Password Solution (LAPS) so activities can access Windows - resources using the built-in Administrator account managed by LAPS. + Integrate Netwrix Privilege Secure with Microsoft Local Administrator Password + Solution (LAPS) so activities can use the built-in Administrator account. keywords: - LAPS - Local Administrator Password Solution @@ -14,17 +13,20 @@ keywords: - vault connector - password rotation products: - - privilege-secure-access-management -sidebar_label: How to Configure Local Administrator Password Solu -tags: [] -title: "How to Configure Local Administrator Password Solution (LAPS) Integration" + - privilegesecure +sidebar_label: Configuring Local Administrator Password Solution (LAPS) Integration +tags: + - kb + - third-party-integrations +title: "Configuring Local Administrator Password Solution (LAPS) Integration" knowledge_article_id: kA04u0000000HbRCAU --- -# How to Configure Local Administrator Password Solution (LAPS) Integration +# Configuring Local Administrator Password Solution (LAPS) Integration -## Summary -This article outlines how to integrate Netwrix Privilege Secure activities with the Microsoft Local Administrator Password Solution (LAPS), enabling activities to access Windows resources using the built-in Administrator account managed by LAPS. +## Overview + +This article describes how to integrate Netwrix Privilege Secure for Access Management activities with the Microsoft Local Administrator Password Solution (LAPS), enabling activities to access Windows resources using the built-in Administrator account managed by LAPS. ## Instructions @@ -33,7 +35,7 @@ This article outlines how to integrate Netwrix Privilege Secure activities with - Place the computers in the appropriate Organizational Units (OUs) in Active Directory. 2. Prepare a service account - - Create a service account, or identify an existing account, that Netwrix Privilege Secure will use to integrate with LAPS. + - Create a service account, or identify an existing account, that Privilege Secure uses to integrate with LAPS. - Delegate the ability to read and reset LAPS passwords to that service account by using the Microsoft PowerShell cmdlets available with the LAPS UI fat client installer: https://www.microsoft.com/en-us/download/details.aspx?id=46899 Use the following PowerShell commands (replace `` and ``): @@ -46,7 +48,7 @@ This article outlines how to integrate Netwrix Privilege Secure activities with Set-AdmPwdResetPasswordPermission -OrgUnit "" -AllowedPrincipals "" ``` - - In these commands, replace `` with the OU containing the computers managed by LAPS, and replace `` with the service account that you will use during the LAPS integration configuration in Netwrix Privilege Secure. + - In these commands, replace `` with the OU containing the computers managed by LAPS, and replace `` with the service account that you use during the LAPS integration configuration in Privilege Secure. Example: if the computers managed by LAPS are in an OU named "LAPS PCs" and the service account is `svc_sbpam@lab.local`, run: @@ -58,32 +60,32 @@ This article outlines how to integrate Netwrix Privilege Secure activities with Set-AdmPwdResetPasswordPermission -OrgUnit "LAPS PCs" -AllowedPrincipals "lab\svc_sbpam" ``` -3. Configure the LAPS connector in Netwrix Privilege Secure - - Log in to Netwrix Privilege Secure as an admin. - - If the service account you granted permissions to is not yet added to Netwrix Privilege Secure, add it via **Configuration > Service Accounts**. - - Navigate to **Configuration > Integration Connectors**. +3. Configure the LAPS connector in Privilege Secure + - Log in to Privilege Secure as an admin. + - If the service account you granted permissions to is not yet added to Privilege Secure, add it via **Configuration > Service Accounts**. + - Go to **Configuration > Integration Connectors**. - Create a new connector and select **LAPS** from the **Connector Template** dropdown. - - Select the service account that has read and reset permissions for the LAPS OU(s) from the **ServiceAccount** dropdown. + - Select the service account that has read and reset permissions for the LAPS OU or OUs from the **ServiceAccount** dropdown. - Add the domain name (for example, `lab.local`) in **DomainName** and click **Save**. ![Screenshot demonstrating LAPS connector configuration in SbPAM's web application interface.](./../0-images/ka04u000000Hca2_0EM4u000004bnRk.png) 4. Create an activity that uses the LAPS connector - - Navigate to **Activities** to create an activity that provides the built-in Administrator access to a Windows resource managed by LAPS. + - Go to **Activities** to create an activity that provides the built-in Administrator access to a Windows resource managed by LAPS. - Create a new activity and set the **Login Account** dropdown to **Vault**. - For **Vault Connector**, select the LAPS connector you created in the previous step. - Set **Platform** to **Windows**. - Ensure the **Login Account Template** matches the expected built-in admin account name (in most cases this is the default value `Administrator`). - ![Screenshot demonstrating an SbPAM activity definition that's configured to use a LAPS connector.](./../0-images/ka04u000000Hca2_0EM4u000004bnS4.png) + ![Screenshot demonstrating an SbPAM activity definition that is configured to use a LAPS connector.](./../0-images/ka04u000000Hca2_0EM4u000004bnS4.png) - Add any other desired actions to the activity. 5. Create Access Policies - - Create one or more **Access Policies** to determine which Netwrix Privilege Secure users can provision this activity session and which resources they can access. - - Configure policies with combinations of Netwrix Privilege Secure users, the LAPS activity you created, and the Windows resources managed by LAPS. + - Create one or more **Access Policies** to determine which Privilege Secure users can provision this activity session and which resources they can access. + - Configure policies with combinations of Privilege Secure users, the LAPS activity you created, and the Windows resources managed by LAPS. 6. Provision and use LAPS-integrated sessions - Users added to the appropriate **Access Policies** can now provision the LAPS activity. - - Provisioned sessions allow users to RDP to Windows resources managed by LAPS as the built-in Administrator account. - - When a LAPS-integrated session ends, Netwrix Privilege Secure triggers a password rotation via LAPS, ensuring the built-in admin account for the accessed resource is secured. + - Provisioned sessions let users RDP to Windows resources managed by LAPS as the built-in Administrator account. + - When a LAPS-integrated session ends, Privilege Secure triggers a password rotation via LAPS, ensuring the built-in admin account for the accessed resource is secured. diff --git a/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-approvals-to-slack.md b/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-approvals-to-slack.md index c8217cd00b..0ee46826e7 100644 --- a/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-approvals-to-slack.md +++ b/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-approvals-to-slack.md @@ -1,7 +1,5 @@ --- -description: >- - Instructions to configure an approval workflow so a Slack channel receives - approval notifications from Netwrix Privilege Secure. +description: "Set up an approval workflow so a Slack channel receives approval notifications from Privilege Secure, using the channel's email address." keywords: - Slack - approval workflow @@ -12,22 +10,33 @@ keywords: - local user - Users and Groups products: - - privilege-secure-access-management -sidebar_label: 'Slack Integration: Send Approvals to Slack' -tags: [] -title: 'Slack Integration: Send Approvals to Slack' + - privilegesecure +sidebar_label: Sending Approvals to Slack +tags: + - kb + - third-party-integrations +title: "Sending Approvals to Slack" knowledge_article_id: kA0Qk0000000JsHKAU --- -# Slack Integration: Send Approvals to Slack +# Sending Approvals to Slack -## Summary -This article describes the process for setting up an Approval workflow in which a Slack channel receives an approval notification. +## Overview + +This article describes how to set up an Approval workflow in Netwrix Privilege Secure for Access Management in which a Slack channel receives an approval notification. ## Instructions -1. In Slack, inspect the channel you wish to message. The **Integrations** pane will have a **Send emails to this channel** setting. Copy the email address. -2. In Netwrix Privilege Secure, navigate to the Users and Groups page. Click the **Add** button and create a new **Local user**. **Note: this user will not need to log in to Netwrix Privilege Secure.** - ![image.png](./../0-images/ka0Qk0000000zeb_0EMQk000001oz7l.png) -3. Set the local user's email address to the Slack channel's email address from step 1: - ![image.png](./../0-images/ka0Qk0000000zeb_0EMQk000001ozUL.png) -4. You may now add this local account as an additional approver in any approval workflow. It will not be used for approvals, but its email address value will allow the configured Slack channel to receive approval messages. + +1. In Slack, inspect the channel you want to message. The **Integrations** pane has a **Send emails to this channel** setting. Copy the email address. + +2. In Privilege Secure, go to the **Users and Groups** page. Click **Add** and create a new **Local user**. + + > **NOTE:** This user does not need to log in to Privilege Secure. + + ![Users and Groups page with Add selected to create a Local user](./../0-images/ka0Qk0000000zeb_0EMQk000001oz7l.png) + +3. Set the local user's email address to the Slack channel's email address from step 1: + + ![Local user email address field set to the Slack channel email address](./../0-images/ka0Qk0000000zeb_0EMQk000001ozUL.png) + +4. You can now add this local account as an additional approver in any approval workflow. It is not used for approvals, but its email address value allows the configured Slack channel to receive approval messages. diff --git a/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-slack-message.md b/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-slack-message.md index beaa334fa7..f966ca23a9 100644 --- a/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-slack-message.md +++ b/docs/kb/privilegesecure/third-party-integrations/slack-integration-send-slack-message.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to create a custom "Send Slack Message" action step for Netwrix - Privilege Secure and import it into activities using a Slack app and provided - addon. + Create a custom "Send Slack Message" action step with a Slack app and the + provided addon, then import it into Privilege Secure activities. keywords: - Slack - Slack integration @@ -15,53 +14,58 @@ keywords: - Activities - Incoming Webhooks products: - - privilege-secure-access-management + - privilegesecure visibility: public -sidebar_label: 'Slack Integration: Send Slack Message' -tags: [] -title: 'Slack Integration: Send Slack Message' +sidebar_label: Integrating Slack to Send Slack Messages +tags: + - kb + - third-party-integrations +title: Integrating Slack to Send Slack Messages knowledge_article_id: kA0Qk0000000JqfKAE --- -# Slack Integration: Send Slack Message +# Integrating Slack to Send Slack Messages -## Summary +## Overview -This article describes how to set up a custom "Send Slack Message" action step in Netwrix Privilege Secure, which you can then add to activities. +This article describes how to set up a custom "Send Slack Message" action step in Netwrix Privilege Secure for Access Management, which you can then add to activities. ## Instructions ### Preparing Your Slack App -A custom Slack application must be created for this integration. +Create a custom Slack application for this integration. -1. In Slack, navigate to the **Your Apps** page: https://api.slack.com/apps/ -2. Click **Create New App** +1. In Slack, go to the **Your Apps** page: https://api.slack.com/apps/ +2. Click **Create New App**. 3. Select **From an app manifest** and paste the following YAML into the provided field: -```yaml -display_information: - name: NPS App -settings: - org_deploy_enabled: false - socket_mode_enabled: false - is_hosted: false - token_rotation_enabled: false -``` + ```yaml + display_information: + name: NPS App + settings: + org_deploy_enabled: false + socket_mode_enabled: false + is_hosted: false + token_rotation_enabled: false + ``` 4. On the **Your Apps** page, select **Incoming Webhooks**. 5. Under **Activate Incoming Webhooks**, click **Add New Webhook to Workspace**. -6. Search for the channel you would like Netwrix Privilege Secure (NPS) to message. Click **Allow**. Copy the provided URL. +6. Search for the channel you want Privilege Secure to message. Click **Allow**. Copy the provided URL. ### Importing the Action Step -1. Download the Send-SlackMessage.zip archive to the SbPAM server: https://dl.netwrix.com/additional/Send-SlackMessage.Addon.zip -2. Extract the archive, which contains a README file, an ActionTemplates directory, and an `Install-Addon.ps1` script file. Right-click `Install-Addon.ps1` and select **Run with PowerShell**. +1. Download the `Send-SlackMessage.zip` archive to the Privilege Secure server: https://dl.netwrix.com/additional/Send-SlackMessage.Addon.zip +2. Extract the archive, which contains a README file, an `ActionTemplates` directory, and an `Install-Addon.ps1` script file. Right-click `Install-Addon.ps1` and select **Run with PowerShell**. 3. When prompted, select `Y` to proceed. -![image.png](./../0-images/ka0Qk0000001ELt_0EMQk000001pkUr.png) + + ![PowerShell prompt asking whether to proceed with running the add-on installation script](./../0-images/ka0Qk0000001ELt_0EMQk000001pkUr.png) + 4. The PowerShell window should quickly execute the script and close. -5. Log in to the SbPAM console. (If SbPAM was already open, be sure to refresh the console.) -6. In SbPAM, navigate to **Activities**, select an **Activity**, and click the green plus sign in either the **Pre-Session** or **Post-Session**. Note that the **Send Message to Slack** activity step is now available. +5. Log in to the Privilege Secure console. If Privilege Secure was already open, refresh the console. +6. In Privilege Secure, go to **Activities**, select an **Activity**, and click the green plus sign in either the **Pre-Session** or **Post-Session**. The **Send Message to Slack** activity step is now available. 7. Provide the URL from step 6 of Preparing Your Slack App when configuring the action step. -![image.png](./../0-images/ka0Qk0000001ELt_0EMQk000001ovYn.png) + + ![Send Message to Slack action step being configured with the webhook URL](./../0-images/ka0Qk0000001ELt_0EMQk000001ovYn.png) diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/logs-location.md b/docs/kb/privilegesecure/troubleshooting-and-errors/logs-location.md index a4a177cf10..7ad8585621 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/logs-location.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/logs-location.md @@ -1,8 +1,6 @@ --- description: >- - Explains where Netwrix Privilege Secure stores logs, how to locate the log - directory using the %PROGRAMDATA% environment variable, and provides - descriptions of the primary log files. + Find where Privilege Secure stores logs, locate the directory with the %PROGRAMDATA% variable, and see what each primary log file records. keywords: - logs - log files @@ -12,50 +10,54 @@ keywords: - Audit & Reporting - log location - PAM logs + - STEALTHbits + - DbUpdater products: - - privilege-secure-access-management -sidebar_label: Logs Location -tags: [] -title: "Logs Location" + - privilegesecure +sidebar_label: "Locating Logs" +tags: + - kb + - troubleshooting-and-errors +title: "Locating Logs" knowledge_article_id: kA04u000000Pd89CAC --- -# Logs Location +# Locating Logs -## Summary +## Overview -By default, Netwrix Privilege Secure logs are stored on the Netwrix Privilege Secure install drive in: +This article describes where Netwrix Privilege Secure for Access Management stores logs and how to locate and view them. By default, Privilege Secure logs are stored on the Privilege Secure install drive in: ``` \ProgramData\STEALTHbits\PAM\Log ``` -Netwrix Privilege Secure uses the `%PROGRAMDATA%` environment variable to determine the location of the log directory. Command Prompt can be used to locate this directory by running the following command: +## Instructions + +### Locate the Log Directory + +Privilege Secure uses the `%PROGRAMDATA%` environment variable to determine the location of the log directory. Use Command Prompt to locate this directory by running the following command: ```bat echo %PROGRAMDATA% ``` -Netwrix Privilege Secure logs can also be viewed, and downloaded, via the Netwrix Privilege Secure web interface by navigating to **Audit & Reporting > Log Files**. +### View and Download Logs in the Web Interface + +You can also view and download Privilege Secure logs in the web interface. Go to **Audit & Reporting > Log Files**. ![Image of Netwrix Privilege Secure web application's log files page, listing log files and displaying contents.](./../0-images/ka04u000000HdEt_0EM4u000004bh8h.png) ## Log Descriptions -- **Action Service -** `PAM-ActionService.log` - The action service is the component that connects Netwrix Privilege Secure to managed resources. Use cases include Active Directory synchronization, password changes, and account orchestration. If an action experiences an issue, this log should be reviewed. +- **Action Service -** `PAM-ActionService.log`: The action service is the component that connects Privilege Secure to managed resources. Use cases include Active Directory synchronization, password changes, and account orchestration. If an action experiences an issue, review this log. -- **DbUpdater -** `PAM-DbUpdater.log` - The DbUpdater updates the database with schema changes and updates to built-in activities and new activity steps (actions). If an upgrade fails or an expected activity update isn't applied, this log should be reviewed. +- **DbUpdater -** `PAM-DbUpdater.log`: The DbUpdater updates the database with schema changes and updates to built-in activities and new activity steps (actions). If an upgrade fails or an expected activity update is not applied, review this log. -- **Proxy Service -** `PAM-Proxy-.log` - The Netwrix Privilege Secure proxy service connects users to resources via RDP and SSH protocols; the proxy is also responsible for storage of session recordings via its iolog component. When a user cannot access a resource via RDP or SSH, this log should be reviewed. +- **Proxy Service -** `PAM-Proxy-.log`: The Privilege Secure proxy service connects users to resources via Remote Desktop Protocol (RDP) and Secure Shell (SSH) protocols; the proxy is also responsible for storage of session recordings via its iolog component. When a user cannot access a resource via RDP or SSH, review this log. -- **Scheduling Service -** `PAM-SchedulingService.log` - The scheduler service is responsible for setting up and maintaining any date/time-specific actions such as password changes and system scans, etc. If a scheduled action fails to execute, this log should be reviewed in addition to the action service log. +- **Scheduling Service -** `PAM-SchedulingService.log`: The scheduler service is responsible for setting up and maintaining any date/time-specific actions such as password changes and system scans, etc. If a scheduled action fails to execute, review this log in addition to the action service log. -- **Siem Service -** `PAM-SiemService.log` - The SIEM service forwards events to configured SIEM endpoints. If there's an issue with event forwarding to a SIEM, this log should be reviewed. +- **Siem Service -** `PAM-SiemService.log`: The Security Information and Event Management (SIEM) service forwards events to configured SIEM endpoints. If there is an issue with event forwarding to a SIEM, review this log. -- **Web Service -** `PAM-Web.log` - The central web service is responsible for database access and communication out to each service component (i.e., licensing, email, action, and proxy). If you experience login failures, this log should be reviewed. Also, if the proxy or action service logs show a failure communicating with the web service, this log should be reviewed for more information. +- **Web Service -** `PAM-Web.log`: The central web service is responsible for database access and communication out to each service component (that is, licensing, email, action, and proxy). If you experience login failures, review this log. Also, if the proxy or action service logs show a failure communicating with the web service, review this log for more information. diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/long-provisioning-times-in-privilege-secure.md b/docs/kb/privilegesecure/troubleshooting-and-errors/long-provisioning-times-in-privilege-secure.md index 9824010581..0668e7ab47 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/long-provisioning-times-in-privilege-secure.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/long-provisioning-times-in-privilege-secure.md @@ -1,9 +1,7 @@ --- description: >- - Provisioning in Netwrix Privilege Secure can take over 30 seconds when the - WinRM HTTP setting prefers HTTPS and no certificate is available. This article - explains the cause and provides steps to verify the setting and two resolution - options. + Provisioning can take over 30 seconds when the WinRM HTTP setting prefers HTTPS + and no certificate is available. Switch to HTTP or use a certificate. keywords: - WinRM - Privilege Secure @@ -15,9 +13,11 @@ keywords: - slow provisioning - secure WinRM products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Long Provisioning Times in Privilege Secure -tags: [] +tags: + - kb + - troubleshooting-and-errors title: "Long Provisioning Times in Privilege Secure" knowledge_article_id: kA0Qk0000000agDKAQ --- @@ -26,25 +26,25 @@ knowledge_article_id: kA0Qk0000000agDKAQ ## Symptom -The provisioning stage in Netwrix Privilege Secure (NPS) takes over 30 seconds to complete. +The provisioning stage in Netwrix Privilege Secure for Access Management takes over 30 seconds to complete. ## Cause -The WinRM HTTP setting set in **Global Settings** is `Use HTTPS if available` or `Use HTTPS only`. During the provisioning stage, NPS attempts to configure a secure connection via HTTPS. In case no certificate is availble, NPS switches to HTTP. +The WinRM HTTP setting set in **Global Settings** is `Use HTTPS if available` or `Use HTTPS only`. During the provisioning stage, Privilege Secure attempts to configure a secure connection via HTTPS. If no certificate is availble, Privilege Secure switches to HTTP. -> **NOTE:** Refer to the following steps to verify the HTTP setting: +> **NOTE:** To verify the HTTP setting, complete the following steps: > -> 1. In the main NPS window, select the **Configuration** tab. +> 1. In the main Privilege Secure window, select the **Configuration** tab. > 2. In the left pane, select **System Settings** > **Global Settings**. > 3. In the **Global Settings** view, review the **WinRM HTTP Setting** value set. -## Resolutions +## Resolution -Refer to the following options to decrease the provisioning times: +Use one of the following options to decrease the provisioning times: - Switch the WinRM HTTP setting to `Use HTTP`. -- Generate a new self-signed SSL certificate, or import a custom SSL certificate for the resource. Refer to the following article for additional information: Resources Page — Configure Secure WinRM Connection Window · v4.1. +- Generate a new self-signed SSL certificate, or import a custom SSL certificate for the resource. For additional information, see Resources Page — Configure Secure WinRM Connection Window · v4.1. -## Related articles +## Related Links - Resources Page — Configure Secure WinRM Connection Window · v4.1 diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/netwrix-privilege-secure-authentication-failures-after-microsoft-kb5082142.md b/docs/kb/privilegesecure/troubleshooting-and-errors/netwrix-privilege-secure-authentication-failures-after-microsoft-kb5082142.md index f8e6135c7d..b0ac115eea 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/netwrix-privilege-secure-authentication-failures-after-microsoft-kb5082142.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/netwrix-privilege-secure-authentication-failures-after-microsoft-kb5082142.md @@ -1,8 +1,7 @@ --- description: >- - Provides the Netwrix Privilege Secure for Access Management-specific causes - and resolutions for authentication failures after Microsoft KB5082142 - changes the default Kerberos encryption type to AES-only. + Fix Privilege Secure authentication failures after Microsoft KB5082142 changes + the default Kerberos encryption type to AES-only. keywords: - KB5082142 - RC4 @@ -17,22 +16,22 @@ keywords: - Computer Account products: - privilegesecure -sidebar_label: NPS-AM Authentication Failures After Microsoft KB5082142 +sidebar_label: "Error: NPS-AM Authentication Failures After Microsoft KB5082142" tags: [kb, troubleshooting-and-errors] -title: "NPS-AM Authentication Failures After Microsoft KB5082142" +title: "Error: NPS-AM Authentication Failures After Microsoft KB5082142" knowledge_article_id: --- -# NPS-AM Authentication Failures After Microsoft KB5082142 +# Error: NPS-AM Authentication Failures After Microsoft KB5082142 For background on what Microsoft KB5082142 changes and why most environments are unaffected, see [Understanding the Microsoft KB5082142 RC4-to-AES Encryption Change](/docs/kb/privilegesecure/certificates-and-security/understanding-the-microsoft-kb5082142-rc4-to-aes-encryption-change). ## Symptom -Netwrix Privilege Secure for Access Management (NPS-AM) shows an authentication-related failure after Microsoft KB5082142 is installed. Depending on which identity is affected, this can include: +Netwrix Privilege Secure for Access Management shows an authentication-related failure after Microsoft KB5082142 is installed. Depending on which identity is affected, this can include: - Active Directory (AD) sync fails to complete. -- RDP sessions fail with the following errors: +- Remote Desktop Protocol (RDP) sessions fail with the following errors: ``` [WRN]Failed to verify RDP X509 certificate @@ -42,24 +41,24 @@ Netwrix Privilege Secure for Access Management (NPS-AM) shows an authentication- ## Cause -For customers running NPS-AM, RC4 dependency is most likely to affect one of two identities: +For customers running Privilege Secure, RC4 dependency is most likely to affect one of two identities: -- The domain service account NPS-AM uses to communicate with Active Directory -- The NPS-AM resource's own computer account +- The domain service account Privilege Secure uses to communicate with Active Directory +- The Privilege Secure resource's own computer account -### The Domain Service Account NPS-AM Uses to Communicate with Active Directory +### The Domain Service Account Privilege Secure Uses to Communicate with Active Directory -This account follows the same risk profile as any other service account: if an administrator provisioned it long ago and configured it with a non-expiring password, it may still be carrying only an RC4-derived key regardless of how recently NPS-AM itself was upgraded or reconfigured. Conveniently, this account is easy to rule in or out. If it is stuck on RC4 and can no longer authenticate under an AES-only policy, NPS-AM will not just show a subtle symptom—it will typically fail to perform an AD sync entirely. A failed or failing AD sync immediately after you install KB5082142 is a strong, direct signal to check this account's `PasswordLastSet` and `msDS-SupportedEncryptionTypes` values first. +This account follows the same risk profile as any other service account: if an administrator provisioned it long ago and configured it with a non-expiring password, it may still be carrying only an RC4-derived key regardless of how recently Privilege Secure itself was upgraded or reconfigured. This account is easy to rule in or out. If it is stuck on RC4 and can no longer authenticate under an AES-only policy, Privilege Secure does not just show a subtle symptom. It typically fails to perform an AD sync entirely. A failed or failing AD sync immediately after you install KB5082142 is a strong, direct signal to check this account's `PasswordLastSet` and `msDS-SupportedEncryptionTypes` values first. -### The NPS-AM Resource Computer Account +### The Privilege Secure Resource Computer Account -This is the most likely culprit. Like any domain-joined machine, the NPS-AM resource has a computer account in Active Directory, and computer account passwords do rotate automatically—by default, roughly every 30 days. But that rotation depends on the machine being online, having a healthy secure channel to a domain controller, and not having been cloned or restored from an old snapshot without proper de-provisioning. As a result, this is the identity most prone to silently missing its normal rotation cycle. If the NPS-AM server itself has been offline for an extended stretch, was provisioned from an older template or image, or has had secure channel issues in the past, its computer account is the first place to check for a stale RC4-only key. +This is the most likely culprit. Like any domain-joined machine, the Privilege Secure resource has a computer account in Active Directory, and computer account passwords do rotate automatically—by default, roughly every 30 days. But that rotation depends on the machine being online, having a healthy secure channel to a domain controller, and not having been cloned or restored from an old snapshot without proper de-provisioning. As a result, this is the identity most prone to silently missing its normal rotation cycle. If the Privilege Secure server itself has been offline for an extended stretch, was provisioned from an older template or image, or has had secure channel issues in the past, its computer account is the first place to check for a stale RC4-only key. -> **NOTE:** NPS-AM's own login accounts—requestor, ephemeral, and managed—are unlikely sources of this issue. A stale requestor account would typically cause broader authentication failures elsewhere in the environment first; ephemeral accounts are always created after KB5082142 takes effect, so they get AES key material from the outset; and NPS-AM rotates the password (and AES key) of managed accounts at the start and end of every session. +> **NOTE:** Privilege Secure's own login accounts—requestor, ephemeral, and managed—are unlikely sources of this issue. A stale requestor account would typically cause broader authentication failures elsewhere in the environment first; ephemeral accounts are always created after KB5082142 takes effect, so they get AES key material from the outset; and Privilege Secure rotates the password (and AES key) of managed accounts at the start and end of every session. ## Resolution -If your authentication issue matches the causes described in [Cause](#cause), here are the paths forward, from most targeted to most broad. +If your authentication issue matches the causes described in [Cause](#cause), use the following options, from most targeted to most broad. ### Step 1 — Identify the Specific Accounts Involved @@ -75,11 +74,11 @@ An account showing a blank or unset `msDS-SupportedEncryptionTypes` value combin ### Step 2 — Reset the Password for Accounts That Can Support AES but Have Not Rotated -Reset the password on any account that can support AES but has not rotated since before AES was introduced. This generates a new AES key immediately, and the account authenticates normally under the new default going forward. For the NPS-AM domain service account or any managed account fitting this profile, this is the recommended fix rather than permanently exempting the account from AES. +Reset the password on any account that can support AES but has not rotated since before AES was introduced. This generates a new AES key immediately, and the account authenticates normally under the new default going forward. For the Privilege Secure domain service account or any managed account fitting this profile, this is the recommended fix rather than permanently exempting the account from AES. -For the NPS-AM server's computer account specifically—the most likely culprit identified in [The NPS-AM Resource Computer Account](#the-nps-am-resource-computer-account)—choose one of the following options depending on scale: +For the Privilege Secure server's computer account specifically (the most likely culprit identified in [The Privilege Secure Resource Computer Account](#the-privilege-secure-resource-computer-account)), choose one of the following options depending on scale: -- **Single machine:** Run the following PowerShell command (as administrator) directly on the NPS-AM resource to force an immediate password rotation: +- **Single machine:** Run the following PowerShell command (as administrator) directly on the Privilege Secure resource to force an immediate password rotation: ```powershell Reset-ComputerMachinePassword @@ -99,15 +98,15 @@ For the NPS-AM server's computer account specifically—the most likely culprit - **Multiple machines / fleet-wide:** Rather than touching each machine individually, temporarily lower the domain policy for computer account password age so that every online machine rotates on its own during its next check-in. - In Group Policy, navigate to `Computer Configuration > Policies > Windows Settings > Security Settings > Local Policies > Security Options > Domain member: Maximum machine account password age`. + In Group Policy, go to `Computer Configuration > Policies > Windows Settings > Security Settings > Local Policies > Security Options > Domain member: Maximum machine account password age`. - This defaults to 30 days. Temporarily setting it to 1 day causes every online, domain-joined machine to rotate its password on its next Netlogon check-in—typically within about an hour of the GPO refreshing. Once you have confirmed the affected machines have rotated, set the value back to 30 (or your normal policy) to avoid unnecessary ongoing churn. + This defaults to 30 days. Temporarily setting it to 1 day causes every online, domain-joined machine to rotate its password on its next Netlogon check-in—typically within about an hour of the GPO refreshing. After you confirm the affected machines have rotated, set the value back to 30 (or your normal policy) to avoid unnecessary ongoing churn. - > **NOTE:** Use this option when you do not need the rotation to happen instantly and would rather let it happen naturally across many machines at once. It still requires each machine to be online and able to reach a domain controller. A machine that is offline during this window rotates the next time it checks in, once it is back online. + > **NOTE:** Use this option when you do not need the rotation to happen instantly and would rather let it happen across many machines at once. It still requires each machine to be online and able to reach a domain controller. A machine that is offline during this window rotates the next time it checks in, after it is back online. ### Step 3 — Configure an Explicit Exception for Accounts or Devices That Genuinely Cannot Support AES -Set the account's own `msDS-SupportedEncryptionTypes` attribute to include RC4 (a common value used for this is `28`, i.e., RC4 + AES128 + AES256). This restores that account's ability to authenticate using RC4 without changing the domain-wide default—everything else in the domain continues to benefit from the AES-only default introduced by KB5082142. +Set the account's own `msDS-SupportedEncryptionTypes` attribute to include RC4 (a common value used for this is `28`, that is, RC4 + AES128 + AES256). This restores that account's ability to authenticate using RC4 without changing the domain-wide default—everything else in the domain continues to benefit from the AES-only default introduced by KB5082142. ```powershell Set-ADUser -Identity -Replace @{"msDS-SupportedEncryptionTypes" = 28} @@ -118,7 +117,7 @@ Treat this as a documented, deliberate, temporary exception, with a plan to reti ### Step 4 — Temporarily Roll Back the Domain-Wide Default as a Last Resort -Set `DefaultDomainSupportedEncTypes` in the registry on all domain controllers to a value that includes RC4 (commonly `0x1C`). This restores the pre-KB5082142 fallback behavior for every account without an explicit override, while keeping the security update itself installed. This is a supported and fully reversible configuration, but it is intentionally broad: it re-exposes every account in the domain that lacks an explicit `msDS-SupportedEncryptionTypes` value, not just the specific ones causing trouble. It will also generate a recurring audit event (Event ID 205) on every domain controller restart or KDC service restart as a reminder that the configuration is insecure. This option is best used only to stabilize an environment quickly while the affected accounts identified in Step 1 are remediated individually, and should be reverted once that remediation is complete. +Set `DefaultDomainSupportedEncTypes` in the registry on all domain controllers to a value that includes RC4 (commonly `0x1C`). This restores the pre-KB5082142 fallback behavior for every account without an explicit override, while keeping the security update itself installed. This is a supported and fully reversible configuration, but it is intentionally broad: it re-exposes every account in the domain that lacks an explicit `msDS-SupportedEncryptionTypes` value, not just the specific ones causing trouble. It also generates a recurring audit event (Event ID 205) on every domain controller restart or KDC service restart as a reminder that the configuration is insecure. This option is best used only to stabilize an environment quickly while the affected accounts identified in Step 1 are remediated individually. Revert it after that remediation is complete. ### Verifying the Fix @@ -127,4 +126,4 @@ Confirm the fix worked: - AD sync completes. - RDP sessions succeed. -> **NOTE:** If you continue to see authentication failures after working through the steps in [Resolution](#resolution), contact [Netwrix Support](https://www.netwrix.com/support.html) with the specific account name(s), the relevant Event IDs from your domain controller logs, and confirmation of the `msDS-SupportedEncryptionTypes` and `PasswordLastSet` values for the accounts involved—this will help pinpoint the cause more quickly. +> **NOTE:** If you continue to see authentication failures after working through the steps in [Resolution](#resolution), contact [Netwrix Support](https://www.netwrix.com/support.html) with one or more specific account names, the relevant Event IDs from your domain controller logs, and confirmation of the `msDS-SupportedEncryptionTypes` and `PasswordLastSet` values for the accounts involved—this helps pinpoint the cause more quickly. diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/resolving-errconnect-security-nego-connect-failed-for-windows-rdp-sessions.md b/docs/kb/privilegesecure/troubleshooting-and-errors/resolving-errconnect-security-nego-connect-failed-for-windows-rdp-sessions.md index c0f6712be3..8e54bccea2 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/resolving-errconnect-security-nego-connect-failed-for-windows-rdp-sessions.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/resolving-errconnect-security-nego-connect-failed-for-windows-rdp-sessions.md @@ -1,9 +1,6 @@ --- description: >- - Resolve ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED when connecting via RDP by - adjusting the RDP SecurityLayer and Network Level Authentication (NLA) - settings, or by updating the Proxy Service configuration for Netwrix Privilege - Secure. + Fix ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED on Windows RDP sessions by changing the SecurityLayer or NLA settings, or the Proxy Service configuration. keywords: - RDP - ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED @@ -14,18 +11,20 @@ keywords: - sbpam-proxy - PowerShell products: - - privilege-secure-access-management -sidebar_label: 'Resolving ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED ' -tags: [] -title: "Resolving ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED for Windows RDP Sessions" + - privilegesecure +sidebar_label: "Error: ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED for Windows RDP Sessions" +tags: + - kb + - troubleshooting-and-errors +title: "Error: ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED for Windows RDP Sessions" knowledge_article_id: kA04u0000000HRlCAM --- -# Resolving ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED for Windows RDP Sessions +# Error: ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED for Windows RDP Sessions -## Summary +## Symptom -When connecting via RDP to a Windows resource, the following error may occur depending on the RDP security settings configured on the target resource: +When connecting via Remote Desktop Protocol (RDP) to a Windows resource, the following error may occur depending on the RDP security settings configured on the target resource: ``` ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED @@ -33,73 +32,76 @@ Failed to connect to target server The connection failed at negotiating security settings ``` -![User-added image](./../0-images/ka04u000000HcZu_0EM4u000004bUoG.png) +![The ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED error shown when connecting to a Windows resource over RDP.](./../0-images/ka04u000000HcZu_0EM4u000004bUoG.png) -## Instructions +## Cause This error is caused by the following combination of RDP settings on the target Windows resource: -1. The RDP **SecurityLayer** setting is set to `0` (RDP is used by server and client for authentication). You can verify this by running the following in PowerShell and checking the resulting **SecurityLayer** on the target Windows resource: +1. The RDP **SecurityLayer** setting is set to `0` (RDP is used by server and client for authentication). To verify this, run the following in PowerShell and check the resulting **SecurityLayer** on the target Windows resource: -```powershell -Get-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\Terminal Server\WinStations\RDP-Tcp" -Name "SecurityLayer" -``` + ```powershell + Get-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\Terminal Server\WinStations\RDP-Tcp" -Name "SecurityLayer" + ``` -If the output for **SecurityLayer** is `0`, then this condition has been met. + If the output for **SecurityLayer** is `0`, this condition is met. -![User-added image](./../0-images/ka04u000000HcZu_0EM4u000004bUoL.png) + ![PowerShell output showing the SecurityLayer value on the target Windows resource.](./../0-images/ka04u000000HcZu_0EM4u000004bUoL.png) -2. **Network Level Authentication (NLA)** has been disabled for RDP. +2. **Network Level Authentication (NLA)** is disabled for RDP. -To check this setting on the target Windows resource, press Windows+R to open a Run menu or open Command Prompt. In either Run or Command Prompt, execute the following: + To check this setting on the target Windows resource, press Windows+R to open a Run menu or open Command Prompt. In either Run or Command Prompt, run the following: -``` -sysdm.cpl -``` + ``` + sysdm.cpl + ``` -In the menu that opens, navigate to the Remote tab. The control **Allow connections only from computers running Remote Desktop with Network Level Authentication** is the correct control. + In the menu that opens, go to the **Remote** tab. The control **Allow connections only from computers running Remote Desktop with Network Level Authentication** is the correct control. -If this control is disabled, then this condition has been met. + If this control is disabled, this condition is met. -![User-added image](./../0-images/ka04u000000HcZu_0EM4u000004bUoQ.png) + ![The Remote tab with the Network Level Authentication control.](./../0-images/ka04u000000HcZu_0EM4u000004bUoQ.png) -There are two ways to resolve the error, depending on the desired security settings for your environment: +## Resolution -1. Change the RDP **SecurityLayer** value to `1` (server and the client negotiate the method for authentication) or `2` (Transport Layer Security (TLS) protocol is used by the server and the client for authentication), while leaving **Network Level Authentication (NLA)** disabled: +There are two ways to resolve the error, depending on the security settings you want for your environment: -```powershell -Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\Terminal Server\WinStations\RDP-Tcp" -Name "SecurityLayer" -Value 2 -``` +- Change the RDP **SecurityLayer** value to `1` (server and the client negotiate the method for authentication) or `2` (Transport Layer Security (TLS) protocol is used by the server and the client for authentication), while leaving **Network Level Authentication (NLA)** disabled: + + ```powershell + Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\Terminal Server\WinStations\RDP-Tcp" -Name "SecurityLayer" -Value 2 + ``` -2. Enable **Network Level Authentication (NLA)** while leaving RDP's **SecurityLayer** value at `0`: +- Enable **Network Level Authentication (NLA)** while leaving RDP's **SecurityLayer** value at `0`: -![User-added image](./../0-images/ka04u000000HcZu_0EM4u000004bUoV.png) + ![The Network Level Authentication control enabled on the Remote tab.](./../0-images/ka04u000000HcZu_0EM4u000004bUoV.png) -IMPORTANT: For optimal security, it's recommended to have RDP's **SecurityLayer** value set to `2` while enabling **Network Level Authentication (NLA)**. +> **IMPORTANT:** For optimal security, it is recommended to have RDP's **SecurityLayer** value set to `2` while enabling **Network Level Authentication (NLA)**. The following links provide additional information about **SecurityLayer** and **Network Level Authentication (NLA)** from Microsoft: - https://docs.microsoft.com/en-us/windows-hardware/customize/desktop/unattend/microsoft-windows-terminalservices-rdp-winstationextensions-securitylayer - https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/remote-desktop-allow-access#why-allow-connections-only-with-network-level-authentication -## Additional Troubleshooting +### Additional Troubleshooting -If the preceding configuration on the remote computer does not resolve the issue, apply the following configuration change to Netwrix Privilege Secure. +If the preceding configuration on the remote computer does not resolve the issue, apply the following configuration change to Netwrix Privilege Secure for Access Management. -1. Open the `sbpam_rdp.json` proxy configuration file in a text editor: `C:\ProgramData\Stealthbits\PAM\ProxyService\sbpam_rdp.json` -2. Edit the file to ensure that the following setting is configured. Note: if the file already exists, ensure that all lines in the file are properly comma-separated after editing the file. +1. Open the `sbpam_rdp.json` proxy configuration file in a text editor: `C:\ProgramData\Stealthbits\PAM\ProxyService\sbpam_rdp.json` +2. Edit the file to ensure that the following setting is configured: -```json -{ - "ClientSettings": [{"key":"RdpSecurity", "Value":true}] -} -``` + ```json + { + "ClientSettings": [{"key":"RdpSecurity", "Value":true}] + } + ``` -3. If the `sbpam_rdp.json` file does not exist, you can create the default file by executing this command from the Proxy Service installation directory (by default `C:\Program Files\Stealthbits\PAM\ProxyService`): + > **NOTE:** If the file already exists, ensure that all lines in the file are properly comma-separated after editing the file. -``` -sbpam-proxy.exe cfg -c sbpam_rdp -``` +3. If the `sbpam_rdp.json` file does not exist, create the default file by running this command from the Proxy Service installation directory (by default `C:\Program Files\Stealthbits\PAM\ProxyService`): + + ``` + sbpam-proxy.exe cfg -c sbpam_rdp + ``` -Notes: -- Preserve file paths and executable names exactly as shown earlier when you edit or run commands. +> **NOTE:** Preserve file paths and executable names exactly as shown earlier when you edit or run commands. diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/services-are-not-running.md b/docs/kb/privilegesecure/troubleshooting-and-errors/services-are-not-running.md index 7b7ebc7162..2f5861b0ce 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/services-are-not-running.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/services-are-not-running.md @@ -1,8 +1,7 @@ --- description: >- - If Netwrix Privilege Secure services are down, the web UI shows a warning. - This article explains how to verify service status, restart services, and - re-register services to restore functionality. + Verify service status, restart services, and re-register services to clear + the service warning in the Netwrix Privilege Secure web UI. keywords: - Privilege Secure - services not running @@ -13,51 +12,54 @@ keywords: - PowerShell - troubleshooting - Netwrix Support + - Register Services products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Services Are Not Running -tags: [] +tags: + - kb + - troubleshooting-and-errors title: "Services Are Not Running" knowledge_article_id: kA04u000000Pd8ECAS --- # Services Are Not Running -## Summary +## Overview -If Netwrix Privilege Secure services are down, you will receive a warning at the top of the user interface. This article outlines steps that you can take to bring Netwrix Privilege Secure services back online. +This article describes how to bring Netwrix Privilege Secure for Access Management services back online. If services are down, a warning appears at the top of the user interface. -![Netwrix Privilege Secure's web application interface, displaying a warning that a service is not running or registered.](./../0-images/ka04u000000HdEuAAK_1.png) +![Privilege Secure web application interface with a warning at the top that a service is not running or registered.](./../0-images/ka04u000000HdEuAAK_1.png) ## Instructions -If a warning appears at the top of the Netwrix Privilege Secure interface stating a service is offline, take the following steps to attempt to bring the affected service back online. +If a warning appears at the top of the Privilege Secure interface stating a service is offline, complete the following steps to attempt to bring the affected service back online. -1. Check the services on the server - - Open **Windows Services** and verify whether any Netwrix Privilege Secure services are not running. +1. Check the services on the server. + - Open **Windows Services** and verify whether any Privilege Secure services are not running. - Example screenshot: - + ![Windows Services interface displaying installed Netwrix Privilege Secure services, with five out of six displayed as not running.](./../0-images/ka04u000000HdEu_0EM4u000004bjCb.png) - - If any services are not running, start them using the **Windows Services** interface or run the following in an elevated PowerShell: + - If any services are not running, start them using the **Windows Services** interface or run the following in PowerShell as an administrator: ```powershell Start-Service sbpam* ``` - - In this instance 1 out of the 5 services are running, so you can manually start the services by opening `services.msc` on the local Netwrix Privilege Secure server. + - In this instance, 1 out of the 5 services is running, so you can manually start the services by opening `services.msc` on the local Privilege Secure server. -2. Re-register services in the web UI (if services are running but the UI still shows a warning) - - If all Netwrix Privilege Secure services are running in **Windows Services** yet there's still a services warning in the Netwrix Privilege Secure web application interface, re-register the services with Netwrix Privilege Secure. - - Log in to Netwrix Privilege Secure's web application as an Admin. +2. If services are running but the UI still shows a warning, re-register the services in the web UI. + - If all Privilege Secure services are running in **Windows Services** yet there is still a services warning in the Privilege Secure web application interface, re-register the services with Privilege Secure. + - Log in to the Privilege Secure web application as an Admin. - In the upper-right, click the current logged-in user's name, then click **Settings**, and then click **Register Services**. - ![The Netwrix Privilege Secure web application interface's user settings menu dropdown.](./../0-images/ka04u000000HdEu_0EM4u000004bjCq.png) + ![The Netwrix Privilege Secure web application interface's user settings menu dropdown.](./../0-images/ka04u000000HdEu_0EM4u000004bjCq.png) - ![The Netwrix Privilege Secure web application interface's settings page, displaying the Register Services button.](./../0-images/ka04u000000HdEu_0EM4u000004bjCv.png) + ![The Netwrix Privilege Secure web application interface's settings page, displaying the Register Services button.](./../0-images/ka04u000000HdEu_0EM4u000004bjCv.png) -3. If issues persist - - Gather Netwrix Privilege Secure's logs by following the steps in this article: https://kb.netwrix.com/5874 - - Contact Netwrix Support: https://www.netwrix.com/support.html +3. If issues persist: + - Gather the Privilege Secure logs by following the steps in this article: https://kb.netwrix.com/5874 + - Contact [Netwrix Support](https://www.netwrix.com/support.html). If issues continue after these steps, provide the gathered logs to Netwrix Support for further assistance. diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshoot_failed_action_service_connections_to_windows_resources_psremotingwinrm.md b/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshoot_failed_action_service_connections_to_windows_resources_psremotingwinrm.md index 3b2e5e8751..2d3158bb47 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshoot_failed_action_service_connections_to_windows_resources_psremotingwinrm.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshoot_failed_action_service_connections_to_windows_resources_psremotingwinrm.md @@ -1,30 +1,38 @@ --- description: >- - This article provides troubleshooting steps for resolving issues with the NPS Action Service connections to Windows resources using PowerShell Remoting (PSRemoting) and WinRM. + Troubleshoot failed Action Service connections to Windows resources by checking PSRemoting and WinRM, ports, Group Policy, and permissions. keywords: - NPS Action Service - PowerShell Remoting - WinRM -sidebar_label: Troubleshoot Failed Action Service Connections + - PSRemoting + - Windows Remote Management + - Test-WSMan + - Enable-PSRemoting + - Get-PSSessionConfiguration + - Remote Management Users + - Group Policy +sidebar_label: "Troubleshooting Failed Action Service Connections to Windows Resources (PSRemoting/WinRM)" tags: - - troubleshooting -title: "Troubleshoot Failed Action Service Connections to Windows Resources (PSRemoting/WinRM)" + - kb + - troubleshooting-and-errors +title: "Troubleshooting Failed Action Service Connections to Windows Resources (PSRemoting/WinRM)" knowledge_article_id: kA04u0000000HiICAU products: - privilegesecure --- -# Troubleshoot Failed Action Service Connections to Windows Resources (PSRemoting/WinRM) +# Troubleshooting Failed Action Service Connections to Windows Resources (PSRemoting/WinRM) ## Overview -The Netwrix Privilege Secure (NPS) Action Service handles various workflows, including host scans and pre- and post-session actions. The Action Service must establish a connection via PowerShell Remoting (PSRemoting) for Windows target resources. PSRemoting is a PowerShell implementation of WinRM (Windows Remote Management). +This article describes the variables that affect whether the Netwrix Privilege Secure for Access Management Action Service connects to a target Windows resource via PowerShell Remoting (PSRemoting), and the steps to resolve them. -Several variables can affect whether the NPS Action Service connects to the target Windows resource via PSRemoting. This article describes those variables and steps to resolve them. +The Action Service handles various workflows, including host scans and pre- and post-session actions. The Action Service must establish a connection via PSRemoting for Windows target resources. PSRemoting is a PowerShell implementation of WinRM (Windows Remote Management). ## Instructions -Before running tests, complete the following steps on the target resource: +Before running tests, complete the following steps on the target resource. ### Verify PSRemoting and WinRM Are Enabled @@ -59,7 +67,7 @@ At line:1 char:1 + FullyQualifiedErrorId : WsManError,Microsoft.WSMan.Management.TestWSManCommand ``` -**Resolution:** Run the following command in elevated PowerShell to enable PSRemoting/WinRM: +**Resolution:** Run the following command in PowerShell with administrator privileges to enable PSRemoting/WinRM: ```powershell Enable-PSRemoting @@ -85,21 +93,21 @@ Verify that ports 5985 (HTTP) and/or 5986 (HTTPS) are open in the Windows firewa Group Policy settings filter the origin of WinRM requests via IPv4 and IPv6 filters. If issues with PSRemoting/WinRM communications persist after enabling PSRemoting/WinRM and verifying firewall settings, the IP filter in Group Policy may be affecting the communication. -Learn more about the **Allow remote server management through WinRM** Group Policy setting in [Configure Remote Management in Server Manager − Enabling or Disabling Remote Management ⸱ Microsoft 🡥](https://learn.microsoft.com/en-us/windows-server/administration/server-manager/configure-remote-management-in-server-manager#enabling-or-disabling-remote-management). +For details about the **Allow remote server management through WinRM** Group Policy setting, see [Configure Remote Management in Server Manager − Enabling or Disabling Remote Management ⸱ Microsoft 🡥](https://learn.microsoft.com/en-us/windows-server/administration/server-manager/configure-remote-management-in-server-manager#enabling-or-disabling-remote-management). ![Windows Group Policy: Allow remote server management through WinRM](./../0-images/servlet_image_16fc9e2e2432.png) ### Allow Full Control to Remote Management Users -Review the access permissions set up for Remote Management Users by running the following command in elevated PowerShell: +Review the access permissions set up for Remote Management Users by running the following command in PowerShell with administrator privileges: ```powershell Get-PSSessionConfiguration -Name Microsoft.PowerShell ``` -Review the permissions of the **BUILTIN\Remote Management Users** group under the **Permission** section. If the permission is **AccessDenied**, authenticated network users (i.e., remote PSRemoting requests) cannot connect, even if credentials and other variables are correct. +Review the permissions of the **BUILTIN\Remote Management Users** group under the **Permission** section. If the permission is **AccessDenied**, authenticated network users (that is, remote PSRemoting requests) cannot connect, even if credentials and other variables are correct. -**Solution:** Run the following command in elevated PowerShell to review and change permissions for Remote Management Users: +**Solution:** Run the following command in PowerShell with administrator privileges to review and change permissions for Remote Management Users: ```powershell Set-PSSessionConfiguration -Name Microsoft.PowerShell -ShowSecurityDescriptorUI -Force @@ -107,17 +115,17 @@ Set-PSSessionConfiguration -Name Microsoft.PowerShell -ShowSecurityDescriptorUI Select **Remote Management Users** and change **Full Control** from **Deny** to **Allow**, then click **Apply** and **OK**. -## Testing +### Testing the Action Service Connection -Test the ability of the NPS Action Service to connect to a target resource via PowerShell Remoting by running the following PowerShell command on the server running Action Service: +Test the ability of the Action Service to connect to a target resource via PowerShell Remoting by running the following PowerShell command on the server running the Action Service: ```powershell Invoke-Command -ComputerName %target_resource% -Credential (Get-Credential) -ScriptBlock { whoami } ``` -> **IMPORTANT:** Replace `%target_resource%` with the target FQDN. +> **IMPORTANT:** Replace `%target_resource%` with the target fully qualified domain name (FQDN). -When prompted for credentials, use the credentials of the service account assigned to the target resource in NPS. If the remote request succeeds, it will return the username used for authentication. +When prompted for credentials, use the credentials of the service account assigned to the target resource in Privilege Secure. If the remote request succeeds, it returns the username used for authentication. ``` PS C:\Users\admin> Invoke-Command -ComputerName TEST-DC -Credential (Get-Credential) -ScriptBlock { whoami } @@ -130,7 +138,7 @@ test\admin The output indicates that the credentials used can run remote PowerShell commands on the target resource from the Action Service server via WinRM. -## Related Articles +## Related Links [Configure Remote Management in Server Manager − Enabling or Disabling Remote Management ⸱ Microsoft 🡥](https://learn.microsoft.com/en-us/windows-server/administration/server-manager/configure-remote-management-in-server-manager#enabling-or-disabling-remote-management) diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshooting-a-user-id-mismatch-error-during-login.md b/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshooting-a-user-id-mismatch-error-during-login.md index 988f87370c..27ba8f4938 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshooting-a-user-id-mismatch-error-during-login.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/troubleshooting-a-user-id-mismatch-error-during-login.md @@ -1,8 +1,7 @@ --- description: >- - When you attempt to log in to Netwrix Privilege Secure, you may receive a - "User Id Mismatch" error caused by a cookie-stored user mismatch. This article - explains how to resolve the issue by clearing sessions and cookies. + Resolve the "User Id Mismatch" login error caused by a user stored in a cookie + by logging out of all sessions and clearing browser cookies. keywords: - user id mismatch - login error @@ -13,23 +12,25 @@ keywords: - browser - multiple sessions products: - - privilege-secure-access-management -sidebar_label: 'Troubleshooting a "User Id Mismatch" Error During ' -tags: [] -title: Troubleshooting a "User Id Mismatch" Error During Login + - privilegesecure +sidebar_label: 'Troubleshooting a "User Id Mismatch" Error During Login' +tags: + - kb + - troubleshooting-and-errors +title: 'Troubleshooting a "User Id Mismatch" Error During Login' knowledge_article_id: kA04u000000LLjtCAG --- # Troubleshooting a "User Id Mismatch" Error During Login -## Summary +## Overview -When logging into the Netwrix Privilege Secure console, you may receive a "User Id Mismatch" response that prevents login. This is caused when there is a mismatch between a Netwrix Privilege Secure user stored in a cookie, and the user attempting login. Generally this is caused when multiple sessions are being launched from the same browser using different users. +This article describes how to resolve a "User Id Mismatch" response that you may receive when logging in to the Netwrix Privilege Secure for Access Management console, which prevents login. The response is caused by a mismatch between a Privilege Secure user stored in a cookie and the user attempting login. Generally this is caused when multiple sessions are being launched from the same browser using different users. -![image.png](./../0-images/ka04u000000HdEG_0EM4u000005gCr9.png) +![Login page showing the "User Id Mismatch" response](./../0-images/ka04u000000HdEG_0EM4u000005gCr9.png) ## Instructions -1. Log out of all active Netwrix Privilege Secure sessions. +1. Log out of all active Privilege Secure sessions. 2. Clear your browser's cookies. 3. Reattempt login using your desired account. You should now be able to successfully log in. diff --git a/docs/kb/privilegesecure/troubleshooting-and-errors/user-interface-errors-due-to-incompatibility-with-webdav.md b/docs/kb/privilegesecure/troubleshooting-and-errors/user-interface-errors-due-to-incompatibility-with-webdav.md index e65ef92b47..1e1a006ea5 100644 --- a/docs/kb/privilegesecure/troubleshooting-and-errors/user-interface-errors-due-to-incompatibility-with-webdav.md +++ b/docs/kb/privilegesecure/troubleshooting-and-errors/user-interface-errors-due-to-incompatibility-with-webdav.md @@ -1,8 +1,7 @@ --- description: >- - WebDAV running on a Netwrix Privilege Secure server can cause UI errors and - loss of functionality. This article shows how to disable WebDAV in the IIS - web.config for Netwrix Privilege Secure. + Disable WebDAV in the Privilege Secure IIS web.config to stop UI errors, such as + HTTP 405 Method Not Allowed, that WebDAV causes. keywords: - WebDAV - IIS @@ -13,53 +12,55 @@ keywords: - iisreset - Privilege Secure products: - - privilege-secure-access-management -sidebar_label: 'User Interface Errors Due to Incompatibility With ' -tags: [] -title: "User Interface Errors Due to Incompatibility With WebDAV" + - privilegesecure +sidebar_label: User Interface Errors Due to Incompatibility with WebDAV +tags: + - kb + - troubleshooting-and-errors +title: "User Interface Errors Due to Incompatibility with WebDAV" knowledge_article_id: kA04u000000PdKyCAK --- -# User Interface Errors Due to Incompatibility With WebDAV +# User Interface Errors Due to Incompatibility with WebDAV -## Summary +## Symptom -Running WebDAV on a Netwrix Privilege Secure server will lead to various errors in the Netwrix Privilege Secure UI, and loss of certain UI functionality. - -## Issue - -For example, after WebDAV is installed on a Netwrix Privilege Secure server, the following error displays in the UI when adding a service account: +For example, after WebDAV is installed on a Netwrix Privilege Secure for Access Management server, the following error displays in the UI when adding a service account: ```html IIS 8.5 Detailed Error - 405.0 - Method Not Allowed

HTTP Error 405.0 - Method Not Allowed

The page you are looking for cannot be displayed because an invalid method (HTTP verb) is being used.

Most likely causes:

  • The request sent to the Web server used an HTTP verb that is not allowed by the module configured to handle the request.
  • A request was sent to the server that contained an invalid HTTP verb.
  • The request is for static content and contains an HTTP verb other than GET or HEAD.
  • A request was sent to a virtual directory using the HTTP verb POST and the default document is a static file that does not support HTTP verbs other than GET or HEAD.

Things you can try:

  • Verify the list of verbs enabled for the module handler this request was sent to, and ensure that this verb should be allowed for the Web site.
  • Check the IIS log file to see which verb is not allowed for the request.
  • Create a tracing rule to track failed requests for this HTTP status code. For more information about creating a tracing rule for failed requests, click here.

Detailed Error Information:

Module WebDAVModule
Notification MapRequestHandler
Handler aspNetCore
Error Code 0x00000000
Requested URL https://cm-sa-vm.cm-vm.com:6500/api/v1/Credential/3c7bad4e-a66a-4928-87b5-706d6220d52d
Physical Path C:\Program Files\Stealthbits\PAM\Web\api\v1\Credential\3c7bad4e-a66a-4928-87b5-706d6220d52d
Logon Method Anonymous
Logon User Anonymous

More Information:

This error means that the request sent to the Web server contained an HTTP verb that is not allowed by the configured module handler for the request.

View more information »

``` -## Instructions +## Cause + +Running WebDAV on a Privilege Secure server leads to various errors in the Privilege Secure UI, and loss of certain UI functionality. + +## Resolution -Netwrix Privilege Secure's incompatibility with WebDAV can be mitigated by disabling WebDAV for Netwrix Privilege Secure's Internet Information Services (IIS) web.config. +To mitigate the incompatibility, disable WebDAV in the Internet Information Services (IIS) `web.config` for Privilege Secure. 1. Back up the following file, then open the original file in a text editor: -```text -%PROGRAMFILES%\Stealthbits\PAM\Web\web.config -``` + ```text + %PROGRAMFILES%\Stealthbits\PAM\Web\web.config + ``` 2. In `web.config`, under `` add the following: -```xml - - - -``` + ```xml + + + + ``` -3. Then, under `` (which is a child field of ``) add the following: +3. Under `` (a child field of ``), add the following: -```xml - -``` + ```xml + + ``` -4. Save the file, open an elevated Command Prompt, and run the following command to restart IIS so the change can take effect: +4. Save the file, open a Command Prompt as an administrator, and run the following command to restart IIS so the change can take effect: -```text -iisreset -``` + ```text + iisreset + ``` diff --git a/docs/kb/privilegesecure/user-and-service-accounts/creating-a-least-privilege-service-account-for-linux-resources.md b/docs/kb/privilegesecure/user-and-service-accounts/creating-a-least-privilege-service-account-for-linux-resources.md index 98112dcfa9..23713f5565 100644 --- a/docs/kb/privilegesecure/user-and-service-accounts/creating-a-least-privilege-service-account-for-linux-resources.md +++ b/docs/kb/privilegesecure/user-and-service-accounts/creating-a-least-privilege-service-account-for-linux-resources.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to create a least-privilege service account and configure a - sudoers.d file so you can onboard Linux resources into Netwrix Privilege - Secure and run workflows without using root. + Create a least-privilege service account and sudoers.d file so Privilege + Secure can onboard Linux resources and run workflows without root. keywords: - linux - sudoers @@ -13,10 +12,15 @@ keywords: - sudo - troubleshooting - script + - requiretty + - NOPASSWD + - visudo products: - - privilege-secure-access-management -sidebar_label: Creating a Least Privilege Service Account for Lin -tags: [] + - privilegesecure +sidebar_label: "Creating a Least Privilege Service Account for Linux Resources" +tags: + - kb + - user-and-service-accounts title: "Creating a Least Privilege Service Account for Linux Resources" knowledge_article_id: kA04u0000000HU1CAM --- @@ -25,39 +29,39 @@ knowledge_article_id: kA04u0000000HU1CAM ## Overview -To onboard Linux resources into Netwrix Privilege Secure (NPS), a service account is required that can execute certain elevated commands on the Linux resource. +This article describes how to create a dedicated service account with a `sudoers` file so that Netwrix Privilege Secure for Access Management can onboard Linux resources. Onboarding requires a service account that can execute certain elevated commands on the Linux resource. -While one could use the root account, it is not secure and would be a drastic over-provisioning of privileges. Instead, create a dedicated service account with a `sudoers` file that only allows elevation for the commands required by Netwrix Privilege Secure. +While you could use the root account, it is not secure and would be a drastic over-provisioning of privileges. Instead, create a dedicated service account with a `sudoers` file that only allows elevation for the commands required by Privilege Secure. ## Instructions 1. Create a new user on the Linux resource that is used as the service account such as **svc_sbpam**. On most Linux distros, this is performed with the `useradd` command, for example: `useradd svc_sbpam -m`. - > NOTE: Alternatively, you may create the user interactively using the `adduser svc_sbpam` command. + > **NOTE:** Alternatively, you may create the user interactively using the `adduser svc_sbpam` command. -2. Create a file named after the user (e.g., **svc_sbpam**) in the Linux resource's sudoers directory. Typically, this is: `/etc/sudoers.d`. +2. Create a file named after the user (for example, **svc_sbpam**) in the sudoers directory of the Linux resource. Typically, this is `/etc/sudoers.d`. -3. The contents of the file should be as follows, which will grant the service account the least amount of privilege required for Netwrix Privilege Secure to onboard the Linux resource and execute workflows on it: +3. Add the following contents to the file. They grant the service account the least amount of privilege required for Privilege Secure to onboard the Linux resource and execute workflows on it: -```text -Cmnd_Alias ACT_CHKSUM = /usr/bin/find, /usr/bin/test, /usr/bin/md5sum -Cmnd_Alias ACT_SUDOERS = /usr/bin/ls, /usr/bin/tee, /usr/bin/visudo, /usr/bin/rm, /usr/bin/mv, /usr/bin/chmod, /sbin/visudo -Cmnd_Alias SB_PASS = /usr/bin/chpasswd, /usr/sbin/chpasswd, /usr/bin/groups, /usr/sbin/usermod, /usr/sbin/userdel, /usr/sbin/useradd, /usr/bin/gpasswd -Cmnd_Alias SB_CMNDS = /usr/bin/grep, /usr/bin/ps, /usr/bin/kill, /usr/bin/which, /usr/bin/write, /usr/bin/who, /usr/bin/w, /usr/bin/last, /usr/bin/cat, -/usr/bin/uname, /usr/bin/ls, /usr/bin/yum, /usr/bin/chage, /usr/bin/rpm, /usr/share/bash-completion/completions/dpkg, /usr/bin/id, /usr/sbin/ip, -/usr/sbin/ifconfig, /usr/bin/dpkg - -svc_sbpam ALL = NOPASSWD: ACT_CHKSUM, ACT_SUDOERS, SB_PASS, SB_CMNDS -Defaults:svc_sbpam !requiretty -``` + ```text + Cmnd_Alias ACT_CHKSUM = /usr/bin/find, /usr/bin/test, /usr/bin/md5sum + Cmnd_Alias ACT_SUDOERS = /usr/bin/ls, /usr/bin/tee, /usr/bin/visudo, /usr/bin/rm, /usr/bin/mv, /usr/bin/chmod, /sbin/visudo + Cmnd_Alias SB_PASS = /usr/bin/chpasswd, /usr/sbin/chpasswd, /usr/bin/groups, /usr/sbin/usermod, /usr/sbin/userdel, /usr/sbin/useradd, /usr/bin/gpasswd + Cmnd_Alias SB_CMNDS = /usr/bin/grep, /usr/bin/ps, /usr/bin/kill, /usr/bin/which, /usr/bin/write, /usr/bin/who, /usr/bin/w, /usr/bin/last, /usr/bin/cat, + /usr/bin/uname, /usr/bin/ls, /usr/bin/yum, /usr/bin/chage, /usr/bin/rpm, /usr/share/bash-completion/completions/dpkg, /usr/bin/id, /usr/sbin/ip, + /usr/sbin/ifconfig, /usr/bin/dpkg + + svc_sbpam ALL = NOPASSWD: ACT_CHKSUM, ACT_SUDOERS, SB_PASS, SB_CMNDS + Defaults:svc_sbpam !requiretty + ``` -The `Cmnd_Alias` lines are the commands the service account needs to run on the Linux resource, while the second to last line associates those commands with the Netwrix Privilege Secure service account as a sudoers rule. Additionally, `NOPASSWD` allows the service account to execute elevated commands without manually entering a password each time, and `!requiretty` allows elevated commands to be run in non-interactive shell sessions. + The `Cmnd_Alias` lines are the commands the service account needs to run on the Linux resource, while the second to last line associates those commands with the Privilege Secure service account as a sudoers rule. Additionally, `NOPASSWD` allows the service account to execute elevated commands without manually entering a password each time, and `!requiretty` allows elevated commands to be run in non-interactive shell sessions. -> NOTE: The account name **svc_sbpam** is not required and can be changed. The only requirement is that the account name added as a service account in Netwrix Privilege Secure (NPS) must match the account name used in the `sudoers` file (anywhere **svc_sbpam** is replaced). + > **NOTE:** The account name **svc_sbpam** is not required and can be changed. The only requirement is that the account name added as a service account in Privilege Secure must match the account name used in the `sudoers` file (anywhere **svc_sbpam** is replaced). -4. The service account is now ready to be added to Netwrix Privilege Secure and can be assigned to the Linux resource when it is onboarded or via the Resources page if the Linux resource has already been onboarded. +4. The service account is now ready to be added to Privilege Secure. You can assign it to the Linux resource when the resource is onboarded, or on the **Resources** page if the Linux resource has already been onboarded. -## Troubleshooting +### Troubleshooting You may receive the following error message when attempting to provision a session against a Linux resource using this service account: @@ -65,19 +69,19 @@ You may receive the following error message when attempting to provision a sessi sudo: no tty present and no askpass program specified ``` -To resolve this, perform the following steps: +To resolve this, complete the following steps: 1. Check the logs on the Linux resource for error messages involving the **svc_sbpam** account (or whatever service account name you chose) with the following command: -```bash -sudo grep svc_sbpam /var/log/* -``` + ```bash + sudo grep svc_sbpam /var/log/* + ``` -2. If any of the entries reference a particular command that the service account failed to run due to insufficient sudoer privileges, be sure to note the path of the command (for example, `/sbin/ifconfig/`) and add it to the end of the `Cmnd_Alias SB_CMNDS` entries in the service account's `/etc/sudoers.d/` file. +2. If any of the entries reference a particular command that the service account failed to run due to insufficient sudoer privileges, note the path of the command (for example, `/sbin/ifconfig/`) and add it to the end of the `Cmnd_Alias SB_CMNDS` entries in the service account's `/etc/sudoers.d/` file. -3. Reattempt to provision a session now that the necessary command alias is configured for the service account. +3. Try to provision a session again, now that the necessary command alias is configured for the service account. -## Additional Troubleshooting +### Additional Troubleshooting You may receive the following error when performing a host scan or activity: @@ -86,109 +90,107 @@ Error: 'Could not chdir to home directory /home/svc_sbpam: Not a directory sudo: standard input or configure an askpass helper sudo: a password is required.' ``` -This would indicate that your service account (such as **svc_sbpam**) is not listed in the `/etc/sudoers` file. +This indicates that your service account (such as **svc_sbpam**) is not listed in the `/etc/sudoers` file. -> NOTE: This can be confirmed by attempting to use `sudo` as your service account. +> **NOTE:** You can confirm this by attempting to use `sudo` as your service account. -To fix this, perform the following steps: +To fix this, complete the following steps: 1. Edit your `sudoers` file, typically with the following command: -```bash -sudo visudo -``` + ```bash + sudo visudo + ``` -2. Then, ensure that there is an entry for your service account under the **user privilege specification** header. For example: +2. Ensure that there is an entry for your service account under the **user privilege specification** header. For example: -```text -# User privilege specification -root ALL=(ALL:ALL) ALL -sbpam_svc ALL=NOPASSWD: ALL -``` + ```text + # User privilege specification + root ALL=(ALL:ALL) ALL + sbpam_svc ALL=NOPASSWD: ALL + ``` -## Using a Shell Script to Determine sudoers.d File Configuration +### Using a Shell Script to Determine sudoers.d File Configuration -Instead of using the methods described in the preceding sections, a shell script can be deployed to determine the exact contents of the `/etc/sudoers.d/` file that should be created. Perform the following steps: +Instead of using the methods described in the preceding sections, you can deploy a shell script to determine the exact contents of the `/etc/sudoers.d/` file that should be created. Complete the following steps: 1. Copy the following script: -```bash -#!bash -echo "Enter the least privileged account's name:" -read lprivacct -append_comma=0 -cmd_alias="Cmnd_Alias ACT_CHKSUM = " -for cmd in find test md5sum -do - cmd=`which ${cmd} 2>/dev/null` - if [ ${append_comma} -eq 1 ] - then - if [ "" != "${cmd}" ] - then - cmd_alias+=", " - fi - fi - cmd_alias+="${cmd}" - append_comma=1 -done -append_comma=0 -echo ${cmd_alias} -cmd_alias="Cmnd_Alias ACT_SUDOERS = " -for cmd in ls tee visudo rm mv chmod -do - cmd=`which ${cmd} 2>/dev/null` - if [ ${append_comma} -eq 1 ] - then - if [ "" != "${cmd}" ] - then - cmd_alias+=", " - fi - fi - cmd_alias+="${cmd}" - append_comma=1 -done -append_comma=0 -echo ${cmd_alias} -cmd_alias="Cmnd_Alias SB_PASS = " -for cmd in chpasswd groups usermod userdel useradd gpasswd -do - cmd=`which ${cmd} 2>/dev/null` - if [ ${append_comma} -eq 1 ] - then - if [ "" != "${cmd}" ] - then - cmd_alias+=", " - fi - fi - cmd_alias+="${cmd}" - append_comma=1 -done -append_comma=0 -echo ${cmd_alias} -cmd_alias="Cmnd_Alias SB_CMNDS = " -for cmd in "grep" "ps" "kill" "which" "write" "who" "w" "last" "cat" "uname" "ls" "yum" "chage" "rpm" "dpkg" "id" "ip" "ifconfig" -do - cmd=`which ${cmd} 2>/dev/null` - if [ ${append_comma} -eq 1 ] - then - if [ "" != "${cmd}" ] - then - cmd_alias+=", " - fi - fi - cmd_alias+="${cmd}" - append_comma=1 -done -append_comma=0 -echo ${cmd_alias} -echo "${lprivacct} ALL = NOPASSWD: ACT_CHKSUM, ACT_SUDOERS, SB_PASS, SB_CMNDS" -echo "Defaults: ${lprivacct} " '!requiretty' -``` - -2. Paste the script into the terminal and hit enter. - -3. When prompted, enter the least privileged account's name (for example, **svc_sbpam**, or whichever account name you have chosen). - -4. The script will output the contents of a `sudoers.d` file for a least-privilege user with the exact command paths used on your Linux server. - -5. Copy the output and use it to complete the steps in the Instructions, using the file contents you have just generated instead of those provided in the Instructions section. + ```bash + #!bash + echo "Enter the least privileged account's name:" + read lprivacct + append_comma=0 + cmd_alias="Cmnd_Alias ACT_CHKSUM = " + for cmd in find test md5sum + do + cmd=`which ${cmd} 2>/dev/null` + if [ ${append_comma} -eq 1 ] + then + if [ "" != "${cmd}" ] + then + cmd_alias+=", " + fi + fi + cmd_alias+="${cmd}" + append_comma=1 + done + append_comma=0 + echo ${cmd_alias} + cmd_alias="Cmnd_Alias ACT_SUDOERS = " + for cmd in ls tee visudo rm mv chmod + do + cmd=`which ${cmd} 2>/dev/null` + if [ ${append_comma} -eq 1 ] + then + if [ "" != "${cmd}" ] + then + cmd_alias+=", " + fi + fi + cmd_alias+="${cmd}" + append_comma=1 + done + append_comma=0 + echo ${cmd_alias} + cmd_alias="Cmnd_Alias SB_PASS = " + for cmd in chpasswd groups usermod userdel useradd gpasswd + do + cmd=`which ${cmd} 2>/dev/null` + if [ ${append_comma} -eq 1 ] + then + if [ "" != "${cmd}" ] + then + cmd_alias+=", " + fi + fi + cmd_alias+="${cmd}" + append_comma=1 + done + append_comma=0 + echo ${cmd_alias} + cmd_alias="Cmnd_Alias SB_CMNDS = " + for cmd in "grep" "ps" "kill" "which" "write" "who" "w" "last" "cat" "uname" "ls" "yum" "chage" "rpm" "dpkg" "id" "ip" "ifconfig" + do + cmd=`which ${cmd} 2>/dev/null` + if [ ${append_comma} -eq 1 ] + then + if [ "" != "${cmd}" ] + then + cmd_alias+=", " + fi + fi + cmd_alias+="${cmd}" + append_comma=1 + done + append_comma=0 + echo ${cmd_alias} + echo "${lprivacct} ALL = NOPASSWD: ACT_CHKSUM, ACT_SUDOERS, SB_PASS, SB_CMNDS" + echo "Defaults: ${lprivacct} " '!requiretty' + ``` + +2. Paste the script into the terminal and press Enter. + +3. When prompted, enter the least privileged account's name (for example, **svc_sbpam**, or whichever account name you have chosen). The script outputs the contents of a `sudoers.d` file for a least-privilege user with the exact command paths used on your Linux server. + +4. Copy the output and use it to complete the steps in [Instructions](#instructions), using the file contents you have just generated instead of those provided in that section. diff --git a/docs/kb/privilegesecure/workflows-and-automation/exporting-the-activity-log-as-a-csv.md b/docs/kb/privilegesecure/workflows-and-automation/exporting-the-activity-log-as-a-csv.md index 2cecd7d54b..7065285ce2 100644 --- a/docs/kb/privilegesecure/workflows-and-automation/exporting-the-activity-log-as-a-csv.md +++ b/docs/kb/privilegesecure/workflows-and-automation/exporting-the-activity-log-as-a-csv.md @@ -1,8 +1,7 @@ --- description: >- - Shows how to export the Activity Log from Netwrix Privilege Secure to a CSV - file using a PowerShell script that calls the SbPAM API and handles MFA - tokens. + Export the Activity Log from Privilege Secure to a CSV file using a + PowerShell script that calls the SbPAM API and handles MFA tokens. keywords: - activity log - CSV export @@ -12,119 +11,130 @@ keywords: - MFA - ActivitySession - Invoke-SbPAMRest + - SbPAMPowerShellModules + - ActivityReport.ps1 products: - - privilege-secure-access-management + - privilegesecure sidebar_label: Exporting the Activity Log as a CSV -tags: [] +tags: + - kb + - workflows-and-automation title: "Exporting the Activity Log as a CSV" knowledge_article_id: kA04u0000004mylCAA --- # Exporting the Activity Log as a CSV -## Summary +## Overview -Exporting the "Activity Log" report is a common auditing and compliance use case. This article provides a scripted method of exporting the Activity Log data from Netwrix Privilege Secure. +This article describes how to export the Activity Log data from Netwrix Privilege Secure for Access Management by using a script. Exporting the "Activity Log" report is a common auditing and compliance use case. ## Instructions -1. On your Netwrix Privilege Secure server, ensure that PowerShell 7.1 is installed. It can be obtained from the official PowerShell github repository: https://github.com/PowerShell/PowerShell/releases/tag/v7.1.7. _Note: This specific version of PowerShell is a necessary prerequisite to running the SbPAM API. Do not install PowerShell 7.2+._ +1. On your Privilege Secure server, ensure that PowerShell 7.1 is installed. It can be obtained from the official PowerShell GitHub repository: https://github.com/PowerShell/PowerShell/releases/tag/v7.1.7. -2. Locate the "Extras" folder, which was packaged alongside your Netwrix Privilege Secure installer. Run the `SbPAMPowerShellModules` installer. - ![User-added image](./../0-images/ka04u000000HdD5_0EM4u000005yZ7y.png) + > **NOTE:** This specific version of PowerShell is a necessary prerequisite to running the SbPAM API. Do not install PowerShell 7.2+. + + > **NOTE:** In Privilege Secure 26.07 and later, the requirement changed to PowerShell 7.6 or later. Follow the version in the [system requirements](/docs/privilegesecure/26_07/requirements/application-server) for your release. + +2. Locate the "Extras" folder, which was packaged alongside your Netwrix Privilege Secure installer. Run the `SbPAMPowerShellModules` installer. + + ![The Extras folder with the SbPAMPowerShellModules installer.](./../0-images/ka04u000000HdD5_0EM4u000005yZ7y.png) 3. In your preferred text editor, paste the following PowerShell script. Save it as `ActivityReport.ps1`. -```powershell -[cmdletbinding()] -param( - [Parameter(Mandatory)][PSCredential]$UserCred, - [Parameter()][String]$UserCode = $null, - [Parameter(Mandatory)][String]$SbPamUrl, - [Parameter(Mandatory)][datetime]$StartDate, - [Parameter(Mandatory)][datetime]$EndDate, - [Parameter()][string]$FilePath = "out.csv" -) - -Import-Module SbPAMAPI -Force - -function Renew-Token { - [CmdletBinding()] - param ( - [string] - $Token, - $Uri + ```powershell + [cmdletbinding()] + param( + [Parameter(Mandatory)][PSCredential]$UserCred, + [Parameter()][String]$UserCode = $null, + [Parameter(Mandatory)][String]$SbPamUrl, + [Parameter(Mandatory)][datetime]$StartDate, + [Parameter(Mandatory)][datetime]$EndDate, + [Parameter()][string]$FilePath = "out.csv" ) - $mfaObj = Convert-SbPAMToken $Token - if ($null -eq $global:expiration) { - $global:expiration = Get-Date -UnixTimeSeconds $mfaObj.exp - } - if ($global:expiration -lt (Get-Date).AddMinutes(7)) { - Write-Host "$(Get-Date) Refreshing token" - $Token = Invoke-SbPAMRest -Uri "$Uri/api/v1/UserToken" -Token $Token -ErrorAction Stop -SkipCertificateCheck + Import-Module SbPAMAPI -Force + + function Renew-Token { + [CmdletBinding()] + param ( + [string] + $Token, + $Uri + ) $mfaObj = Convert-SbPAMToken $Token - $global:expiration = Get-Date -UnixTimeSeconds $mfaObj.exp + if ($null -eq $global:expiration) { + $global:expiration = Get-Date -UnixTimeSeconds $mfaObj.exp + } + + if ($global:expiration -lt (Get-Date).AddMinutes(7)) { + Write-Host "$(Get-Date) Refreshing token" + $Token = Invoke-SbPAMRest -Uri "$Uri/api/v1/UserToken" -Token $Token -ErrorAction Stop -SkipCertificateCheck + $mfaObj = Convert-SbPAMToken $Token + $global:expiration = Get-Date -UnixTimeSeconds $mfaObj.exp + } + return $Token } - return $Token -} -function Get-SbPAMActivitySessionReport { - param( - $Uri, - $Token, - $StartDate, - $EndDate - ) - $Token = Renew-Token -Uri $Uri -Token $Token - $Skip = 0 - $Take = 100 - $StartDateString = $StartDate.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ") - $EndDateString = $EndDate.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ") - - $ApiUri = "$($Uri)/api/v1/ActivitySession/Search?skip=$($Skip)&filterText=&filterDateTimeMin=$($StartDateString)&filterDateTimeMax=$($EndDateString)&filterTopUsersType=1&take=$Take" - $Data = @() - - $Results = Invoke-SbPAMRest -Uri $ApiUri -SkipCertificateCheck -Token $Token - while ($Results.Data.Length -ge $Take) { - $Data += $Results.Data - $Skip += $Take - Write-Progress -Activity "Fetching activity report from $StartDate to $EndDate" -PercentComplete 0 -Status "$Skip of $($Results.recordsTotal) $($Results.Data.Length)" + function Get-SbPAMActivitySessionReport { + param( + $Uri, + $Token, + $StartDate, + $EndDate + ) + $Token = Renew-Token -Uri $Uri -Token $Token + $Skip = 0 + $Take = 100 + $StartDateString = $StartDate.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ") + $EndDateString = $EndDate.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ") $ApiUri = "$($Uri)/api/v1/ActivitySession/Search?skip=$($Skip)&filterText=&filterDateTimeMin=$($StartDateString)&filterDateTimeMax=$($EndDateString)&filterTopUsersType=1&take=$Take" + $Data = @() + $Results = Invoke-SbPAMRest -Uri $ApiUri -SkipCertificateCheck -Token $Token + while ($Results.Data.Length -ge $Take) { + $Data += $Results.Data + $Skip += $Take + Write-Progress -Activity "Fetching activity report from $StartDate to $EndDate" -PercentComplete 0 -Status "$Skip of $($Results.recordsTotal) $($Results.Data.Length)" + + $ApiUri = "$($Uri)/api/v1/ActivitySession/Search?skip=$($Skip)&filterText=&filterDateTimeMin=$($StartDateString)&filterDateTimeMax=$($EndDateString)&filterTopUsersType=1&take=$Take" + $Results = Invoke-SbPAMRest -Uri $ApiUri -SkipCertificateCheck -Token $Token + } + $Data += $Results.Data + $Data } - $Data += $Results.Data - $Data -} -# "https://192.168.77.99:6500/api/v1/ActivitySession/Search?skip=0&filterText=&filterDateTimeMin=2022-07-01T05:00:00.000Z&filterDateTimeMax=2022-08-24T04:59:59.999Z&filterTopUsersType=1&take=30" -# Create the web session -$WebSession = New-Object Microsoft.PowerShell.Commands.WebRequestSession -# Set up the user credentials - MFA and JWT objects -$userToken = Get-SbPAMToken -Credential $userCred -Uri $SbPamUrl -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop -if ("" -eq $UserCode -or $null -eq $UserCode) { - $userCode = Read-Host -Prompt "Enter MFA code" -} -$userToken = Get-SbPAMMfaToken -Uri $SbPamUrl -Token $userToken -Code $userCode -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop + # "https://192.168.77.99:6500/api/v1/ActivitySession/Search?skip=0&filterText=&filterDateTimeMin=2022-07-01T05:00:00.000Z&filterDateTimeMax=2022-08-24T04:59:59.999Z&filterTopUsersType=1&take=30" + # Create the web session + $WebSession = New-Object Microsoft.PowerShell.Commands.WebRequestSession + # Set up the user credentials - MFA and JWT objects + $userToken = Get-SbPAMToken -Credential $userCred -Uri $SbPamUrl -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop + if ("" -eq $UserCode -or $null -eq $UserCode) { + $userCode = Read-Host -Prompt "Enter MFA code" + } + $userToken = Get-SbPAMMfaToken -Uri $SbPamUrl -Token $userToken -Code $userCode -WebSession $WebSession -SkipCertificateCheck -ErrorAction Stop + + Write-Progress -Activity "Fetching activity report from $StartDate to $EndDate" -PercentComplete 0 -Status "Fetching..." + Write-Host "Exporting From $StartDate to $EndDate to $FilePath" + + $Data = Get-SbPAMActivitySessionReport -Uri $SbpamUrl -Token $userToken -StartDate $StartDate -EndDate $EndDate -Write-Progress -Activity "Fetching activity report from $StartDate to $EndDate" -PercentComplete 0 -Status "Fetching..." -Write-Host "Exporting From $StartDate to $EndDate to $FilePath" + $Data | ConvertTo-Csv -NoTypeInformation -UseQuotes Always | Out-File -FilePath $FilePath + Write-Host "Export complete found $($Data.Length) records" + ``` -$Data = Get-SbPAMActivitySessionReport -Uri $SbpamUrl -Token $userToken -StartDate $StartDate -EndDate $EndDate +4. Open PowerShell 7. Go to the directory containing `ActivityReport.ps1`, and run the following command: -$Data | ConvertTo-Csv -NoTypeInformation -UseQuotes Always | Out-File -FilePath $FilePath -Write-Host "Export complete found $($Data.Length) records" -``` + ```powershell + .\ActivityReport.ps1 + ``` -4. Open up PowerShell 7. Navigate to the directory containing `ActivityReport.ps1`, and execute the following command: +5. When prompted, enter a Privilege Secure administrator username and password, your Privilege Secure URL, and a multi-factor authentication (MFA) code (if applicable). -```powershell -.\ActivityReport.ps1 -``` + ![The prompts for the administrator credentials, the Privilege Secure URL, and the MFA code.](./../0-images/ka04u000000HdD5_0EM4u000005yZ83.png) -5. You are prompted for a Netwrix Privilege Secure administrator username and password, your Netwrix Privilege Secure URL, and an MFA code (if applicable). - ![User-added image](./../0-images/ka04u000000HdD5_0EM4u000005yZ83.png) + Your activity data is then output to a file called `out.csv`. -6. Your activity data will then be output to a file called `out.csv`. - ![User-added image](./../0-images/ka04u000000HdD5_0EM4u000005yZ88.png) + ![The out.csv file containing the exported activity data.](./../0-images/ka04u000000HdD5_0EM4u000005yZ88.png) diff --git a/docs/kb/privilegesecure/workflows-and-automation/task-automation-write-to-file-on-target-resource.md b/docs/kb/privilegesecure/workflows-and-automation/task-automation-write-to-file-on-target-resource.md index 1950b0e6df..c4dba7ef87 100644 --- a/docs/kb/privilegesecure/workflows-and-automation/task-automation-write-to-file-on-target-resource.md +++ b/docs/kb/privilegesecure/workflows-and-automation/task-automation-write-to-file-on-target-resource.md @@ -1,8 +1,7 @@ --- description: >- - Example Task Automation script for Netwrix Privilege Secure that writes to a - specified file on the target resource. Includes a basic find-and-replace - PowerShell script you can modify for your use case. + Example Task Automation script that finds and replaces strings in a file on a + target resource, using a PowerShell script you can modify. keywords: - task automation - write file @@ -12,64 +11,69 @@ keywords: - Netwrix Privilege Secure - remote execution - Invoke-Command + - Run Custom Powershell Script products: - - privilege-secure-access-management -sidebar_label: Task Automation - Write to File on Target Resource -tags: [] -title: "Task Automation - Write to File on Target Resource" + - privilegesecure +sidebar_label: Writing to a File on a Target Resource with Task Automation +tags: + - kb + - workflows-and-automation +title: "Writing to a File on a Target Resource with Task Automation" knowledge_article_id: kA0Qk00000015GzKAI --- -# Task Automation - Write to File on Target Resource +# Writing to a File on a Target Resource with Task Automation ## Overview -This article provides an example of a Task Automation script that can be used to write to a specified file on the targeted resource. This gives a basic framework for using Task Automation to write to files and can be modified as needed. The example provided is a simple find-and-replace script. -## Summary -1. In Netwrix Privilege Secure, navigate to the **Activities** page and create an Activity with the **Task Automation** Activity Type. The activity should be configured to provide sufficient privilege to remotely execute scripts on the target resource, and the **Login Account**, **Requester Login Format**, and **Pre- and Post-Session** action steps should reflect this. - ![image.png](./../0-images/ka0Qk0000003etl_0EMQk000004iG8P.png) +This article describes how to use a Task Automation script to write to a specified file on the targeted resource in Netwrix Privilege Secure for Access Management. The example provided is a simple find-and-replace script. It gives a basic framework for using Task Automation to write to files and can be modified as needed. + +## Instructions + +1. In Privilege Secure, go to the **Activities** page and create an Activity with the **Task Automation** Activity Type. Configure the activity to provide sufficient privilege to remotely execute scripts on the target resource. The **Login Account**, **Requester Login Format**, and **Pre- and Post-Session** action steps should reflect this. + ![Activity configured with the Task Automation Activity Type, showing the Login Account, Requester Login Format, and Pre- and Post-Session settings](./../0-images/ka0Qk0000003etl_0EMQk000004iG8P.png) 2. In the **Session** of the Activity, click the **+** button and add a **Run Custom Powershell Script** action step. -3. Supply the following script block inside of the action step: +3. Enter the following script block in the action step: -```powershell -$findString = "findMe" -$replaceString = "replaceMe" -$filePath = "C:\sampledir\example.txt" #specify your file path here! + ```powershell + $findString = "findMe" + $replaceString = "replaceMe" + $filePath = "C:\sampledir\example.txt" #specify your file path here! -Import-Module (Join-Path $SbPAMScriptDirectory "SbPAMWindows.psm1") -if (![string]::IsNullOrEmpty($HostId)) { - $targetHost = Get-SbPAMHost -Id $HostId - if ($null -eq $targetHost -or [string]::IsNullOrEmpty($targetHost.DnsHostName)) { - Write-Error "Unable to find host." - exit 2 - } - Write-Host (ConvertTo-Json $targetHost) -} + Import-Module (Join-Path $SbPAMScriptDirectory "SbPAMWindows.psm1") + if (![string]::IsNullOrEmpty($HostId)) { + $targetHost = Get-SbPAMHost -Id $HostId + if ($null -eq $targetHost -or [string]::IsNullOrEmpty($targetHost.DnsHostName)) { + Write-Error "Unable to find host." + exit 2 + } + Write-Host (ConvertTo-Json $targetHost) + } -$session = New-SbPAMPSSession -RemoteHost $targetHost -Credential (Get-PSCredential -Credentials $Credentials) -if ($null -ne $session) { - try{ - Add-SbPAMActionLog -Type Info -Message "Running custom powershell script block - Write to File: $filePath - Find: $findString - Replace: $replaceString" - Invoke-Command -Session $Session -ArgumentList $findString,$replaceString,$filePath ` - -ScriptBlock { - param($findString,$replaceString,$filePath) + $session = New-SbPAMPSSession -RemoteHost $targetHost -Credential (Get-PSCredential -Credentials $Credentials) + if ($null -ne $session) { + try{ + Add-SbPAMActionLog -Type Info -Message "Running custom powershell script block - Write to File: $filePath - Find: $findString - Replace: $replaceString" + Invoke-Command -Session $Session -ArgumentList $findString,$replaceString,$filePath ` + -ScriptBlock { + param($findString,$replaceString,$filePath) - try { - (Get-Content $filePath).Replace($findString,$replaceString) | Set-Content $filePath - Add-SbPAMActionLog -Type Info -Message "Running custom powershell script block - Write to File - SUCCESS" - } - catch { - Add-SbPAMActionLog -Type Info -Message "Running custom powershell script block - Write to File - ERROR" - } } -ErrorAction SilentlyContinue - } - finally {Remove-PSSession -Session $session} -} + try { + (Get-Content $filePath).Replace($findString,$replaceString) | Set-Content $filePath + Add-SbPAMActionLog -Type Info -Message "Running custom powershell script block - Write to File - SUCCESS" + } + catch { + Add-SbPAMActionLog -Type Info -Message "Running custom powershell script block - Write to File - ERROR" + } } -ErrorAction SilentlyContinue + } + finally {Remove-PSSession -Session $session} + } -Add-SbPAMActionLog -ActionQueueActionId $ActionQueueActionId -Type Info -Message "Finished custom powershell script block - Write to File: $filePath - Find: $findString - Replace: $replaceString" -``` + Add-SbPAMActionLog -ActionQueueActionId $ActionQueueActionId -Type Info -Message "Finished custom powershell script block - Write to File: $filePath - Find: $findString - Replace: $replaceString" + ``` 4. Modify the script block according to your needs. This example is for a find-and-replace, with the ` $findString` and ` $replaceString` containing the original and replacement values, and the ` $filePath` containing the local path for the target file. This is just a basic example and can be modified for different use cases. -5. Save the activity. Ensure that the activity is added to an **Access Policy**. You can now run the activity; it will find/replace strings in the targeted file on the targeted resource. +5. Save the activity and ensure that it is added to an **Access Policy**. You can now run the activity; it finds and replaces strings in the targeted file on the targeted resource. diff --git a/docs/privilegesecure/26.03/admin/activities/addaction/activityactiontypes.md b/docs/privilegesecure/26.03/admin/activities/addaction/activityactiontypes.md index 476bd4501f..e7c87e4efe 100644 --- a/docs/privilegesecure/26.03/admin/activities/addaction/activityactiontypes.md +++ b/docs/privilegesecure/26.03/admin/activities/addaction/activityactiontypes.md @@ -14,23 +14,23 @@ sidebar_position: 10 # Action Types -The following tables list all available actions that can be added to an activity. +The following tables list all available actions that you can add to an activity. ## Pre-Session (Grant) Actions | Action Type | Action Description | Related Fields | |------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| -| AD Sync with Args | Trigger Domain Controller replication rather than waiting for the next scheduled AD sync. This will run on the ActionService directly and not use WinRM to connect to any servers. The action uses the service account associated with the domain to run the sync.| Destinations — Enter a comma-separated list of domain controllers to replicate to. Domain — Enter the domain controller source. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. | +| AD Sync with Args | Trigger Domain Controller replication rather than waiting for the next scheduled AD sync. This action runs on the ActionService directly and doesn't use WinRM to connect to any servers. The action uses the service account associated with the domain to run the sync.| Destinations — Enter a comma-separated list of domain controllers to replicate to. Domain — Enter the domain controller source. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. | | Add ADUC Permissions | Add Active Directory Users and Computers rights to the login account. You can add rights such as Reset, Change, and Unexpire the password. The "Update Password Not Required Bit" lets you set the userAccountControl (UAC) toggle so accounts don't require passwords. | AD Object Type — Select which type of object to manage in the Organizational Unit: User or Computer. AD Organizational Unit — Enter a pre-existing Organizational Unit the login account have delegated permissions for. AD Rights to be Added — Select which right to delegate to the login account for managing the specified Organizational Unit. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Add Microsoft Entra ID Role | Add login account to an Microsoft Entra ID role | Microsoft Entra ID Role (Allows Custom Entries) — Enter which Microsoft Entra ID Directory Role is added to the login account, or select from the Role options in the dropdown. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | -| Add Sudoers Rule | Create a new rule file in sudoers.d directory to grant user additional permissions | Run As — Enter which accounts the logged-in user can run commands as. Commands — Enter the commands the user can run as a comma-separated list, or, enter **ALL** for all commands on the target resource. ensure to use absolute paths in the command list. For example: `/usr/bin/yum`, `/usr/bin/docker`, `/usr/bin/rpm`. Prompt for Password — If enabled, the logged-in user must enter their password to run elevated commands. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | +| Add Sudoers Rule | Creates a rule file in the sudoers.d directory on a Linux or BSD resource so the logged-in user can run commands with sudo during the session. In 26.03, the rule always reads ` ALL=(ALL) NOPASSWD:ALL`, which lets the user run every command as any user without a password. The service account needs sudo permission to write and remove the rule file. See [Configure a least-privilege sudoers policy for Linux and BSD](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md). | The Run As, Commands, and Prompt for Password fields appear in the action, but 26.03 doesn't apply them. Leave them at their defaults. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Add to Microsoft Entra ID Group | Add login account to a Microsoft Entra ID Security Group | Microsoft Entra ID Security Group (Allows Custom Entries) — Enter which Microsoft Entra ID Security Group is added to the login account. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Add User to Domain Group | Add login account to a domain group | Domain — Enter an Active Directory domain. Group (Allows Custom Entries) — Enter a pre-existing Group the login account is added to in the specified Domain. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Add User to Local Group | Add login account to a local group | Group (Allows Custom Entries) — Enter a pre-existing Group the login account is added to in the specified Domain. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | -| Add User to Groups and Roles (User Selected) | Admins set this up to allow the user to select from a list of groups or roles that the login account can be promoted into. A connection to a resource is optional. This allows NPS to control privilege, but have work done outside of an NPS session. | Admin creates list of groups/roles. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | +| Add User to Groups and Roles (User Selected) | Admins set this up to allow the user to select from a list of groups or roles that the login account can be promoted into. A connection to a resource is optional. This allows Privilege Secure to control privilege, but have work done outside of a Privilege Secure session. | Admin creates list of groups/roles. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Add Requester to Database Server | Add login account to the database server | Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Add User to Database Role | Add login account the Database Role. | Database – (Optional) If you specify a database, the role applies to the specific database. If you leave the database field blank, the role applies to the database instance. Role – Privilege Secure adds the user to this role. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | -| Create Windows File Share | Creates a temporary, encrypted SMB share on the activity's target Windows resource. This action creates a hidden lock file at the root of the share's map path. This is used by the console to identify a folder as being created/owned by the console. Users shouldn't attempt to modify or delete this lock file. | Windows File Share Name — The name of the File Share that is created on the activity's target Windows resource. Windows File Share Map Path — A folder is created in this location (local path) as a map for the session's Windows File Share. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | +| Create Windows File Share | Creates a temporary, encrypted SMB share on the activity's target Windows resource. This action creates a hidden lock file at the root of the share's map path. The console uses this file to identify a folder as being created/owned by the console. Don't modify or delete this lock file. | Windows File Share Name — The name of the File Share that is created on the activity's target Windows resource. Windows File Share Map Path — A folder is created in this location (local path) as a map for the session's Windows File Share. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Enable RDP on Host | Allows the user to enable RDP on the Host during the pre-session. This action comes paired with the Disable RDP on Host post-session action type. | Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Monitor File for Changes | Monitors the specified file for modifications. If no changes are detected, an Info event is logged to the action log. If changes are detected (or the file goes missing after the pre-session hash), a Warning is logged to the action and event logs. | File to Monitor — Enter the full local path to the file to be monitored. Fail Pre-Session on Missing File — Fail session provisioning if the file to monitor can't be found. Fail Post-Session on Mismatch — Fail session during Activity post-session if monitored file checksum doesn't match. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Purge Kerberos Tickets for Host | Purge all Kerberos tickets from the resource | Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. | @@ -65,8 +65,8 @@ The following tables list all available actions that can be added to an activity | Remove ADUC Permission | Remove AD rights from the login account | AD Object Type — Select which type of object to manage in the Organizational Unit, a User or Computer. AD Organizational Unit — Enter a pre-existing Organizational Unit the login account have delegated permissions for. AD Rights to be Added — Select which right is delegated to the login account for managing the previously specified Organizational Unit. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Remove from Microsoft Entra ID Role | Remove Microsoft Entra ID role from the login account | Microsoft Entra ID Role (Allows Custom Entries) — Enter which Microsoft Entra ID Directory Role is added to the login account, or select from the Role options in the dropdown. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Remove Requester from Database Server | Remove the login user from the database | Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | -| Remove User from Database Role | Remove the "Remove User from Database Role" login user from the given database role | Database – (Optional) If a database is specified, the role gets removed from the specific database. If the database field is left blank, the role gets removed from the login user in the database instance. Role – The user is removed from this role. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | -| Remove Sudoers rule | Remove previously created file in Sudoers directory | Run As — Enter which accounts the logged-in user can run commands as. Commands — Enter the commands the user can run as a comma-separated list, or, enter **ALL** for all commands on the target resource. ensure to use absolute paths in the command list. For example: `/usr/bin/yum`, `/usr/bin/docker`, `/usr/bin/rpm`. Prompt for Password — If enabled, the logged-in user must enter their password to run elevated commands. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | +| Remove User from Database Role | Remove the "Remove User from Database Role" login user from the given database role | Database – (Optional) If you specify a database, the role gets removed from the specific database. If you leave the database field blank, the role gets removed from the login user in the database instance. Role – The user is removed from this role. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | +| Remove Sudoers rule | Removes the rule file that Add Sudoers Rule created in the sudoers.d directory. The service account needs sudo permission to remove the rule file. See [Configure a least-privilege sudoers policy for Linux and BSD](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md). | The Run As, Commands, and Prompt for Password fields appear in the action, but 26.03 doesn't apply them. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Remove User from Domain Group | Remove login account from domain group | Domain — Enter an Active Directory domain. Group (Allows Custom Entries) — Enter a pre-existing Group the login account is added to in the specified Domain. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Remove User from Local Group | Remove login account from local group | Group (Allows Custom Entries) — Enter a pre-existing Group the login account is added to in the specified Domain. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. Paired Action's Name — (Optional) Edit the name of the paired action. | | Run Custom PowerShell Script | Execute custom PowerShell script during Activity | Definition — Enter a custom Powershell script here. Continue on Error — If an error occurs, continue to the next step rather than halting the action. Action Name — (Optional) Edit the name of the action. | diff --git a/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md new file mode 100644 index 0000000000..fc601dd5b1 --- /dev/null +++ b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md @@ -0,0 +1,176 @@ +--- +title: "Configure a least-privilege sudoers policy for Linux and BSD" +description: "Create a sudoers policy that lets the Privilege Secure service account manage Linux and BSD resources with only the commands it needs." +keywords: + - sudoers + - least privilege + - service account + - Linux + - BSD + - NOPASSWD + - Cmnd_Alias + - requiretty +sidebar_position: 30 +--- + +# Configure a least-privilege sudoers policy for Linux and BSD + +Netwrix Privilege Secure signs in to Linux and BSD resources as a service account and runs commands +with `sudo`. Granting that account `ALL=(ALL) NOPASSWD: ALL` works, but a single misused credential +then gives full root access on the host. This page shows a policy that replaces the blanket grant +with a list of the commands that Privilege Secure 26.03 runs through `sudo`. + +Use the policy as a starting point. Adjust the command lists to the resource, and don't grant a +command that the account never uses. + +## Before you begin + +- Create the local account on the resource, or use a central domain account for hosts bridged to + Active Directory. On Linux, `useradd svc_sbpam -m` creates a local account. +- Use the same account name in the sudoers file and in the Privilege Secure service account. See + [Service Accounts Page](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccounts.md). +- Confirm that `sudo` is installed. On Linux, `sudo` is part of the base system. On BSD, it's an + installed package, so its files are under `/usr/local`. +- Replace `svc_sbpam` in the examples with your account name. + +## Create the policy file + +Create a file named after the account in the sudoers drop-in directory. Sudo ignores a drop-in file +unless root owns it and only root can write to it. + +| | Linux | BSD | +| --- | --- | --- | +| Directory | `/etc/sudoers.d` | `/usr/local/etc/sudoers.d` | +| Owner | `root:root` | `root:wheel` | +| Mode | `0440` | `0440` | + +Create the file with `visudo`. On Linux, run `visudo -f /etc/sudoers.d/svc_sbpam`. On BSD, run `visudo -f /usr/local/etc/sudoers.d/svc_sbpam`. You add the policy content in [Add the policy](#add-the-policy). Then set the owner and mode. + +On Linux: + +```bash +chown root:root /etc/sudoers.d/svc_sbpam +chmod 0440 /etc/sudoers.d/svc_sbpam +``` + +On BSD: + +```bash +chown root:wheel /usr/local/etc/sudoers.d/svc_sbpam +chmod 0440 /usr/local/etc/sudoers.d/svc_sbpam +``` + +On BSD, confirm that the drop-in directory exists and that the main sudoers file includes it. Privilege +Secure doesn't create the directory. + +### Give every alias a unique name + +`Cmnd_Alias` names are global across every file in the drop-in directory. If two files declare an +alias with the same name, `sudo` fails with an `Alias already defined` parse error and refuses to +load its configuration for every account on the host, not only the two that collided. + +Before you install a policy file: + +1. Prefix each `Cmnd_Alias` name with the account name or another tag that's unique to the account. + The examples use the prefix `SVC_`. +1. Confirm that no other file in the drop-in directory uses the same alias names. +1. Check the syntax with `visudo -cf`. + +## Add the policy + +Add the block for the platform to the file. Each alias covers one group of commands: + +| Alias | Used for | +| --- | --- | +| `SVC_ACT_CHKSUM` | Checking the state of a file, as in **Monitor File for Changes**. | +| `SVC_ACT_SUDOERS` | Writing and removing the rule files that **Add Sudoers Rule** creates. | +| `SVC_SB_PASS` | Creating, changing, locking, and deleting local accounts and groups. | +| `SVC_SB_CMNDS` | Read-only lookups, ending a user's processes, session state, and messages. | +| `SVC_SB_SHELL` | Running a shell wrapper for scripted commands, such as the account scan and SSH key operations. | + +### Linux + +```text +Cmnd_Alias SVC_ACT_CHKSUM = /usr/bin/find, /usr/bin/test, /usr/bin/stat, /usr/bin/md5sum +Cmnd_Alias SVC_ACT_SUDOERS = /usr/bin/tee, /usr/sbin/visudo, /bin/rm, /bin/mv, /bin/chmod, /bin/sed +Cmnd_Alias SVC_SB_PASS = /usr/bin/chpasswd, /usr/sbin/chpasswd, /usr/sbin/usermod, /usr/sbin/userdel, /usr/sbin/useradd, /usr/sbin/groupadd, /usr/sbin/groupdel, /usr/bin/gpasswd +Cmnd_Alias SVC_SB_CMNDS = /usr/bin/getent, /bin/grep, /usr/bin/id, /usr/sbin/adcli, /bin/ps, /bin/kill, /bin/cat, /usr/bin/who, /usr/bin/w, /usr/bin/last, /usr/bin/write +Cmnd_Alias SVC_SB_SHELL = /bin/bash -c *, /bin/sh -c * + +svc_sbpam ALL = NOPASSWD: SVC_ACT_CHKSUM, SVC_ACT_SUDOERS, SVC_SB_PASS, SVC_SB_CMNDS, SVC_SB_SHELL +Defaults:svc_sbpam !requiretty +``` + +### BSD + +```text +Cmnd_Alias SVC_ACT_CHKSUM = /usr/bin/find, /bin/test, /sbin/md5sum +Cmnd_Alias SVC_ACT_SUDOERS = /usr/bin/tee, /usr/local/sbin/visudo, /bin/rm, /bin/mv, /bin/chmod, /usr/bin/sed +Cmnd_Alias SVC_SB_PASS = /usr/sbin/pw +Cmnd_Alias SVC_SB_CMNDS = /usr/bin/grep, /bin/cat, /bin/ps, /bin/kill, /usr/bin/who, /usr/bin/w, /usr/bin/last, /usr/bin/write +Cmnd_Alias SVC_SB_SHELL = /bin/sh -c * + +svc_sbpam ALL = NOPASSWD: SVC_ACT_CHKSUM, SVC_ACT_SUDOERS, SVC_SB_PASS, SVC_SB_CMNDS, SVC_SB_SHELL +Defaults:svc_sbpam !requiretty +``` + +- `NOPASSWD` lets the account run the listed commands without a password prompt. Privilege Secure + can't answer one. +- `!requiretty` lets the account run commands with root privileges in a session that has no terminal. Some + 26.03 features, such as logging off a user, sending a message, reading session state, and the + file checksum actions, connect this way. +- `kill` and `ps` are needed to log off a user, and `cat` is needed to confirm that + **Remove Sudoers Rule** removed a rule file. +- Replace the `SVC_` prefix with a tag that's unique to the account when more than one service + account uses the same host. +- The paths in the examples match a typical layout. Confirm each path on the host with + `command -v `, because some distributions keep a command in `/bin` and others in + `/usr/bin`. On a system where `/bin` is a link to `/usr/bin`, either path matches. + +:::warning +`SVC_SB_SHELL` lets the account run any command through a shell, which is effectively full root +access. Privilege Secure uses a shell for the account scan and for the SSH key certificate +operations. Leave out the shell entries on resources where you don't use those operations. Then +check the other aliases against the commands those resources run. +::: + +## Check the policy + +1. Validate the file before you rely on it: + + ```bash + visudo -cf /etc/sudoers.d/svc_sbpam + ``` + + On BSD, use the `visudo` that the package installed, for example `/usr/local/sbin/visudo`, and + the BSD file path. + +1. List the account's permissions while signed in as the service account: + + ```bash + sudo -l + ``` + + An administrator can also run `sudo -l -U svc_sbpam`. + +1. Test a command that the policy allows and a closely related command that it must refuse. + +Keep a second privileged session open while you test, so a broken rule can't lock you out. + +## Add a command that's missing + +If the account lacks a grant for a command that Privilege Secure runs, `sudo` asks for a password +that nothing can answer. Depending on how Privilege Secure connects, the action fails at once with +an error such as `sudo: no tty present and no askpass program specified`, or it waits and then +fails, and the session can be reported as lost instead of naming the command. When an action fails +this way: + +1. Run `sudo -l` as the service account and confirm that the expected aliases are listed. +1. Search the logs for the account on the resource: `sudo grep svc_sbpam /var/log/*`. +1. Find the command that `sudo` refused and note its full path. +1. Add the path to the matching alias and validate the file again. + +## Narrow a command with arguments + +See [Sudoers pattern reference](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/sudoerspatterns.md) +for how sudoers matches command paths and arguments, and how to narrow an entry safely. diff --git a/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccount.md b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccount.md index f878d50091..bd8ba1c1c9 100644 --- a/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccount.md +++ b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccount.md @@ -25,7 +25,10 @@ To add a service account to the console. - For service accounts checked out through a vault connector, select a previously added vault connector from the dropdown list. See the [Bring Your Own Vault (BYOV) Integration](/docs/privilegesecure/26.03/admin/configuration/integrationconnector/integrationbyov/integrationbyov.md) topic for additional information. + - For a Linux or BSD resource, the account name must match the account name in the sudoers file on + the resource. See + [Configure a least-privilege sudoers policy for Linux and BSD](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md). 4. Click **Save** to create the new service account. -The new service account is added to the Service Accounts list. +The new service account appears in the Service Accounts list. diff --git a/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccounts.md b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccounts.md index f159dc7c7d..5245054269 100644 --- a/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccounts.md +++ b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccounts.md @@ -26,7 +26,7 @@ has the following features: table or list is filtered to the matching results. - **Green + button** — Create a new service account. See the [Add Service Account](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/serviceaccount.md) topic for additional information. -- **Trashcan icon** — Deletes the service account. Icon appears when activity is hovered over. A +- **Trashcan icon** — Deletes the service account. The icon appears when you hover over the service account. A confirmation window displays. The selected service account details display at the top of the main pane: @@ -44,20 +44,21 @@ The selected service account details display at the top of the main pane: [Microsoft Entra ID App Registration](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/entraidappregistration.md) for additional information. - **Elevation Command** — Displays the elevation mechanism for the host, such as: sudo, pbrun, pmrun, - dzdo, etc. This field only applies to Linux platforms. + dzdo, etc. This field only applies to Linux platforms. For the sudo permissions the account needs, see + [Configure a least-privilege sudoers policy for Linux and BSD](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md). - **Vault Connector** — Displays the name of the assigned vault connector. See the [Bring Your Own Vault (BYOV) Integration](/docs/privilegesecure/26.03/admin/configuration/integrationconnector/integrationbyov/integrationbyov.md) topic for additional information. - **Authentication**: - **Enable Password** — Temporarily elevates the Service Account to `Privileged EXEC` mode, allowing the account to manage the users and privileges required by Privilege Secure workflows on Cisco - resources. The Enable Password can be used with any existing user account on the Cisco device + resources. You can use the Enable Password with any existing user account on the Cisco device (privilege level 1 - 15). This field only applies to Cisco platforms. - **Authentication Method** — Displays the method by which a service account is authenticated. This field only applies to Linux platforms. - - **Password** — Use a password to use for authentication - - **SSH Certificate** — Use an SSH certificate to use for authentication - - **SSH Certificate and Password** — Use both a password and an SSH certificate to use for + - **Password** — Use a password for authentication + - **SSH Certificate** — Use an SSH certificate for authentication + - **SSH Certificate and Password** — Use both a password and an SSH certificate for authentication - **Password** — Contains the service account password. The Eye icon lets you view the password. This field doesn't apply to Microsoft Entra ID platforms. diff --git a/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/sudoerspatterns.md b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/sudoerspatterns.md new file mode 100644 index 0000000000..1f5ddc4ec2 --- /dev/null +++ b/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/sudoerspatterns.md @@ -0,0 +1,328 @@ +--- +title: "Sudoers pattern reference" +description: "Reference for wildcard and POSIX regular-expression patterns in sudoers rules on Linux and BSD, with test examples." +keywords: + - sudoers + - wildcard + - regular expression + - Cmnd_Alias + - Linux + - FreeBSD + - OpenBSD + - NetBSD +sidebar_position: 40 +--- + +# Sudoers pattern reference + +This page describes wildcard and POSIX regular-expression patterns in sudoers rules, with safe test +examples for Linux, FreeBSD, OpenBSD, and NetBSD. Use it when you narrow the commands in a +[least-privilege sudoers policy](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md). + +## Scope and version requirements + +The sudoers policy on Linux and BSD supports shell-style wildcard patterns. Starting with sudo +1.9.10, you can also match command paths and command-line arguments with POSIX extended regular +expressions. + +Check the installed version before you rely on regular-expression support: + +```bash +sudo --version +``` + +Regular expressions in sudoers: + +- Must begin with `^` and end with `$`. +- Are POSIX extended regular expressions, not Perl Compatible Regular Expressions (PCRE). +- Can match command paths and command arguments. +- Are limited to 1,024 characters. +- Require sudo 1.9.10 or later. + +POSIX extended operators such as `+`, `{m,n}`, grouping, and alternation are available on supported +versions. PCRE-specific constructs such as `\d`, `\w`, lookahead, and lookbehind aren't portable +sudoers syntax. + +## Wildcard definitions + +| Pattern | Meaning | +| --- | --- | +| `*` | Matches zero or more characters. | +| `?` | Matches exactly one character. | +| `[abc]` | Matches one character from the listed set. | +| `[a-z]` | Matches one character in the specified range. | +| `[!abc]` | Matches one character not in the listed set. | +| `\x` | Treats `x` as a literal character where escaping is supported or required. | + +### Slash behavior + +Wildcard behavior depends on what sudo is matching: + +- In a command path, wildcards don't match `/`. `/opt/myapp/*` matches `/opt/myapp/tool`, but not + `/opt/myapp/subdir/tool`. +- In command arguments, `/` has no special meaning, and `*` or `?` can match it. + +## Command-argument matching + +When a command specification includes arguments, sudo joins the invoked arguments into one +space-separated string and matches that complete string. A wildcard can therefore span spaces and +match multiple arguments. + +For example, this entry matches an argument string that begins with `status`: + +```text +/usr/bin/systemctl status * +``` + +It doesn't mean "exactly one argument." The wildcard can match more than one argument after +`status`. + +Other cases: + +- A command specification with no argument pattern allows the command with any arguments. +- An argument string of `""` allows the command only when it's invoked with no command-line + arguments. +- Avoid wildcards in arguments for security-sensitive rules when a precise POSIX regular expression + or a purpose-built wrapper can do the job. + +## Test entries + +Use these entries on an isolated test system. Don't treat broad command wildcards such as +`/usr/bin/*` as safe production policy. + +```text +# Any directly nested command path under /usr/bin +Cmnd_Alias TEST_USRBIN = /usr/bin/* + +# Command basename must start with an ASCII letter +Cmnd_Alias TEST_ALPHA = /usr/sbin/[A-Za-z]* + +# Command basename must start with a character other than an ASCII digit +Cmnd_Alias TEST_NODIGIT = /usr/local/bin/[!0-9]* + +# Exactly "ls" followed by one character, such as lsX +Cmnd_Alias TEST_SINGLECHAR = /usr/bin/ls? + +# Command basename must start with a lowercase letter from a through m +Cmnd_Alias TEST_RANGE = /usr/bin/[a-m]* + +# Explicit command list +Cmnd_Alias TEST_EXPLICIT = /usr/bin/whoami, /usr/bin/id, /usr/bin/uptime + +# Directly nested command names beginning with "git" +Cmnd_Alias TEST_PREFIX = /usr/bin/git* + +# Directly nested command paths under /opt/myapp; does not cross another slash +Cmnd_Alias TEST_ONE_LEVEL = /opt/myapp/* + +# The complete argument string must begin with "status " +Cmnd_Alias TEST_ARGS = /usr/bin/systemctl status * + +# Broad match followed by two exclusions +Cmnd_Alias TEST_EXCLUDE = /usr/bin/[A-Za-z]*, !/usr/bin/passwd, !/usr/bin/su + +# Grant the test aliases to members of testgroup as root +%testgroup ALL = (root) TEST_USRBIN, TEST_ALPHA, TEST_NODIGIT, \ + TEST_SINGLECHAR, TEST_RANGE, TEST_EXPLICIT, TEST_PREFIX, \ + TEST_ONE_LEVEL, TEST_ARGS, TEST_EXCLUDE +``` + +### Regular-expression examples + +These examples require sudo 1.9.10 or later: + +```text +# Command path ending in one or more ASCII digits +Cmnd_Alias TEST_REGEX_PATH = ^/usr/local/bin/tool[0-9]+$ + +# systemctl status followed by exactly one service-unit argument +Cmnd_Alias TEST_REGEX_ARGS = /usr/bin/systemctl ^status [A-Za-z0-9_.@-]+\.service$ +``` + +The second example matches sudo's complete, space-separated argument string. It doesn't permit a +second argument after the service-unit name. + +### Notes on the examples + +- `TEST_SINGLECHAR` doesn't match `/usr/bin/ls`, because `?` requires one additional character. +- `TEST_ALPHA` constrains only the first character of the basename. The following `*` can match + digits, periods, and hyphens, so names such as `mount.cifs` and `iptables-restore` match if they + exist in the specified directory. +- `TEST_ONE_LEVEL` doesn't match `/opt/myapp/subdir/tool`, because a wildcard in a command path + doesn't match `/`. +- `TEST_ARGS` can match multiple arguments after `status`, because sudo matches the combined + argument string rather than each argument separately. +- `TEST_EXCLUDE` illustrates negation, but exclusions are fragile when other matching rules exist. + A later applicable allow entry can permit the command again. + +## Rule ordering and negation + +When multiple sudoers entries match, sudo applies them in order and uses the last matching entry. +The most specific textual rule doesn't automatically win. + +Negation isn't a reliable way to make a broad wildcard safe. An allowlist that contains a shell, +interpreter, editor, pager, or another program that can run commands can let a user perform an +excluded operation indirectly: + +```bash +sudo /usr/bin/bash -c '/usr/sbin/shutdown -h now' +``` + +Sudo evaluates the command that the user requests directly. It doesn't generally infer every +operation that the permitted program can perform later. + +## Path and system differences + +Command locations differ among operating systems and distributions. For example, a command might be +installed as `/sbin/shutdown` or `/usr/sbin/shutdown`. On a system where `/usr` is merged with the +root directories, one path can be a symbolic link to the other. On another system, only one path +exists. + +Confirm command paths on the target host: + +```bash +command -v systemctl +command -v shutdown +ls -l "$(command -v shutdown)" +``` + +Don't assume that a rule tested on one distribution has the same effective command set on another. + +## BSD examples + +The wildcard and regular-expression rules on this page belong to the installed sudo version, not to +the operating-system kernel. They apply on BSD systems that use sudo, subject to the installed sudo +version. + +BSD command locations and service-management tools differ from Linux and from one BSD family to +another. Verify every path with `command -v`, `type`, or the system manual pages before you install +a rule. Use `sudo -V` to inspect the local sudo build and configuration paths. + +The following examples allow exact service operations instead of an unrestricted +service-management command. + +### FreeBSD + +FreeBSD commonly manages services through `/usr/sbin/service`. This example allows members of +`bsdops` to inspect and restart only the nginx service: + +```text +Cmnd_Alias FREEBSD_NGINX = /usr/sbin/service nginx status, \ + /usr/sbin/service nginx restart + +%bsdops ALL = (root) FREEBSD_NGINX +``` + +This wildcard test uses a typical FreeBSD local-software directory: + +```text +# Test only: matches one path component beneath /usr/local/sbin +Cmnd_Alias FREEBSD_LOCAL_TEST = /usr/local/sbin/[A-Za-z]* +``` + +Don't deploy that broad test alias as an administrative allowlist. + +### OpenBSD + +OpenBSD includes `doas` in the base system and doesn't require sudo. If you install sudo +separately, its sudoers rules still use sudo syntax. This example permits two exact `rcctl` +operations for the base-system `httpd` service: + +```text +Cmnd_Alias OPENBSD_HTTPD = /usr/sbin/rcctl check httpd, \ + /usr/sbin/rcctl restart httpd + +%bsdops ALL = (root) OPENBSD_HTTPD +``` + +Don't copy these lines into `/etc/doas.conf`. The `doas.conf` file has a different grammar and +matching model. An approximately equivalent `doas.conf` policy uses separate exact rules: + +```text +permit :bsdops as root cmd /usr/sbin/rcctl args check httpd +permit :bsdops as root cmd /usr/sbin/rcctl args restart httpd +``` + +Validate an OpenBSD `doas` policy, and optionally test a command match, with: + +```bash +doas -C /etc/doas.conf +doas -C /etc/doas.conf /usr/sbin/rcctl check httpd +``` + +### NetBSD + +NetBSD controls services through individual `/etc/rc.d` scripts. This example permits status and +restart operations for only `sshd`: + +```text +Cmnd_Alias NETBSD_SSHD = /etc/rc.d/sshd status, \ + /etc/rc.d/sshd restart + +%bsdops ALL = (root) NETBSD_SSHD +``` + +Software installed through pkgsrc commonly uses the `/usr/pkg` prefix. This wildcard test uses that +layout: + +```text +# Test only: matches one path component beneath /usr/pkg/sbin +Cmnd_Alias NETBSD_PKG_TEST = /usr/pkg/sbin/[A-Za-z]* +``` + +The pkgsrc prefix is configurable, so confirm it on the target host. + +### BSD validation notes + +- The sudoers file and the `visudo` binary can be under a package prefix such as `/usr/local` or + `/usr/pkg`. Use the paths that the installed package reports. +- Run the installed `visudo` against a temporary policy before you deploy it: + + ```bash + visudo -c -f /path/to/testfile + ``` + +- Keep Linux-only commands such as `systemctl` out of BSD-specific aliases. +- Confirm the local service name and whether it's enabled before you test a restart operation. +- Treat `/usr/local/*` and `/usr/pkg/*` wildcards as broad privileges, not as safe substitutes for + an explicit command list. + +## Safer policy design + +Prefer the smallest explicit command and argument allowlist possible: + +1. List exact executable paths instead of granting an entire directory. +1. Restrict arguments with an exact string or an anchored POSIX regular expression where supported. +1. Avoid granting shells, interpreters, editors, pagers, package managers, or general-purpose + file-manipulation tools. +1. Use a root-owned wrapper with fixed behavior when sudoers can't express the required validation + safely. +1. Consider a command digest when the policy should authorize specific file content as well as a + path. + +Example wrapper-only rule: + +```text +%testgroup ALL = (root) /usr/local/sbin/admin-wrapper +``` + +Root should own the wrapper and every directory in its path, and the authorized user shouldn't be +able to write to them. + +## Validation and testing + +Always validate a policy file before you deploy it: + +```bash +visudo -c -f /etc/sudoers.d/testfile +``` + +Check the effective permissions for a test user: + +```bash +sudo -l -U testuser +``` + +Test both the commands that should be allowed and closely related commands that must be rejected. +Test in a disposable environment, or keep a separate privileged session open, so a broken rule +doesn't lock out administrators. diff --git a/docs/privilegesecure/26.03/requirements/target.md b/docs/privilegesecure/26.03/requirements/target.md index d6d30160ee..9bf5bc75df 100644 --- a/docs/privilegesecure/26.03/requirements/target.md +++ b/docs/privilegesecure/26.03/requirements/target.md @@ -14,7 +14,7 @@ sidebar_position: 40 # Target Environments -Netwrix Privilege Secure supports management of the following target environments: +Netwrix Privilege Secure can manage the following target environments: - Microsoft® Active Directory® - **Windows Server 2008 R2 or later** — Requires PowerShell v5.1 @@ -24,7 +24,7 @@ Netwrix Privilege Secure supports management of the following target environment - Microsoft SQL Server databases - Oracle databases (container instances) - Microsoft Entra ID (formerly Azure AD) -- Linux distributions with SSHv2 or higher that are under LTS +- Linux distributions with SSHv2 or higher that are under long-term support (LTS) - Debian - CentOS - Red Hat Enterprise Linux (RHEL) @@ -37,15 +37,18 @@ Additional Supported Platforms (no local account management or pre-configured ac ## Permissions -The following permissions are required for the service accounts: +The service accounts require the following permissions: - For Active Directory and Windows member server/desktop management: - Membership in the Domain Administrators group in the target domains - For Linux server management: - Service account on each server to be managed or a central domain account in the case of AD-bridged hosts - - Permissions may either be root or delegated via sudo or other commercial least privilege - solutions + - Use a dedicated account with least-privilege permissions, delegated via sudo or another + commercial least privilege solution. Avoid root and blanket sudo access (`ALL=(ALL) NOPASSWD: ALL`). + The account name in the sudoers file must match the service account name in Privilege Secure. + For a sudoers policy that grants only the commands Privilege Secure runs, see + [Configure a least-privilege sudoers policy for Linux and BSD](/docs/privilegesecure/26.03/admin/configuration/serviceaccounts/linuxbsdsudoers.md). - For standalone Windows Servers/desktops: - Membership in the local Administrator group on each server/desktop to be managed - For Cisco diff --git a/docs/privilegesecure/26.07/admin/_category_.json b/docs/privilegesecure/26.07/admin/_category_.json new file mode 100644 index 0000000000..d5bb8739ea --- /dev/null +++ b/docs/privilegesecure/26.07/admin/_category_.json @@ -0,0 +1,10 @@ +{ + "label": "Administration", + "position": 400, + "collapsed": true, + "collapsible": true, + "link": { + "type": "doc", + "id": "overview" + } +} diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/_category_.json b/docs/privilegesecure/26.07/admin/audit-reporting/_category_.json new file mode 100644 index 0000000000..b5e9b2bbfb --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/_category_.json @@ -0,0 +1,10 @@ +{ + "label": "Auditing and Reporting", + "position": 50, + "collapsed": true, + "collapsible": true, + "link": { + "type": "doc", + "id": "audit-reporting" + } +} diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/access-certification.md b/docs/privilegesecure/26.07/admin/audit-reporting/access-certification.md new file mode 100644 index 0000000000..03899b24e8 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/access-certification.md @@ -0,0 +1,116 @@ +--- +title: "Run an access certification" +description: "Create an access certification task, assign a reviewer, and commit the review so denied access is removed from the users you chose." +sidebar_position: 20 +--- + +# Run an access certification + +An access certification asks a reviewer to confirm that users still need the access they have. An Administrator creates a task that names the users and a reviewer. The reviewer approves or denies each entitlement, then commits the review. A denied entitlement stops the user from starting that activity. + +An entitlement is the access that a policy gives a user: a resource or credential, an activity, and the permissions that come with it. + +To open the page, select **Auditing & Reporting** > **Access Certification**. + +## Who does what + +- **Administrators** create, change, and delete tasks. They also add the users to review and export the results. +- **Reviewers** see only the tasks assigned to them and are the only people who can review the entitlements of a task. + +A person is a reviewer when they hold the Reviewer role directly, or through a group or user and group collection that holds it. See [Assign administrators, reviewers, and auditors](/docs/privilegesecure/26.07/admin/roles/assign-roles.md). Only a user with the Reviewer role can be chosen as the reviewer of a task. + +## Task statuses + +| Status | Meaning | +| --- | --- | +| **Setup** | The Administrator is creating the task. The reviewer can't see it. | +| **Ready to Start** | The task waits for the reviewer to begin. | +| **Incomplete** | The reviewer started the review and hasn't committed it. | +| **Complete** | The reviewer committed the review. | + +A new task starts in **Setup**. It moves to **Ready to Start** when the Administrator opens the task's **Users** tab, selects **Add**, chooses the accounts to review in the **Add Users** window, and selects **Save**. Privilege Secure then lists the entitlements of those accounts on the **Entitlements** tab, and **Add** is no longer available for the task. You don't set a start time. + +## Create a task + +1. Select **Auditing & Reporting** > **Access Certification**. +2. Above the task list, select **+** (add task). +3. Enter a name in **Enter Access Certification Name**, for example `Q4 server access review`. +4. (Optional) Enter a **Description**. +5. In **Reviewer**, select a reviewer. The default is ``, and you must choose a reviewer. +6. Select **Save**. +7. Select the **Users** tab, and then select **Add**. +8. In the **Add Users** window, search the **Available Accounts** table and select the accounts to review. +9. Select **Save**. + +:::warning +You can't add or remove users after you add them to the task. To change the list, create a new task. +::: + +![The Access Certification page with a task selected, showing the task list on the left and the task details and Users tab on the right.](/images/privilegesecure/26.07/admin/access-certification-users-tab.webp) + +The task list on the left has a **Search** box, a status for each task, and a delete icon. The details on the right show **Name**, **Description**, **Reviewer**, **Status**, **Date Started** (after the review starts), and **Date Completed**. + +### The Users tab + +The **Users** tab lists the accounts under review. The columns are **Name**, **User Name**, and **Email**. Select a name to open the details page of that account. See [User and group details](/docs/privilegesecure/26.07/admin/users-groups/user-details.md). + +### The Entitlements tab + +The **Entitlements** tab lists the access of the users in the task. It stays empty until you add users on the **Users** tab. The columns are: + +- **Status:** **Requested**, **Approved**, or **Denied**. +- **User Name:** The account. +- **Resource:** The resource. +- **Activity:** The activity. +- **Credential:** The credential the policy lets the activity release. +- **Permissions:** The permissions the policy grants. +- **Access Policies:** The policies that grant the access. + +![The Entitlements tab with the entitlement list and the Access Policies column.](/images/privilegesecure/26.07/admin/access-certification-entitlements-tab.webp) + +The tab has three buttons: + +- **Review:** Opens the **Review Entitlements** window. Only the assigned reviewer can use it. +- **Commit:** Applies the review. Only the assigned reviewer can use it, and only after every entitlement is approved or denied. +- **Export as CSV:** Exports the task and its entitlements to `task_and_entitlements_spreadsheet.csv`. Available after the review is committed. + +## Review the entitlements + +The assigned reviewer completes these steps. For the reviewer's view, see [Review access](/docs/privilegesecure/26.07/user-guide/review-access.md). + +1. Select **Auditing & Reporting** > **Access Certification**. +2. Select the task, and then select the **Entitlements** tab. +3. Select **Review**. +4. In the **Review Entitlements** window, select the rows to change. The columns include **Name**, **Resource**, **Activity**, **Credential**, **Permissions**, **Access Policies**, **Connection Profile**, and **Last Accessed**. +5. Select **Approve** to keep the access, or **Deny** to remove it. +6. Select **Close**. +7. When every entitlement is reviewed, select **Commit**. + +For example, the reviewer approves the `Server-Admins` entitlements on the finance servers and denies one stale entry for a former contractor, then selects **Commit**. + +The reviewer doesn't have to finish in one visit. The review saves as the reviewer works, and the task status is **Incomplete** until the commit. + +:::warning +You can't undo a commit or delete the task afterward. To review again, create a new task. +::: + +## What denial does + +A denial sets a deny flag on that user, activity, and resource or credential. The user stays in the access policy. After the commit, a session request for that combination fails with an access denied message that names the user, the activity, and the resource or credential. + +To restore the access, an Administrator removes the denial from the access policy: + +1. Open the access policy and select the **Users** tab. +2. Expand the user's row. The **Access Denied** table lists each denied activity, resource, and credential with the access certification task that denied it. +3. In the **Enable** column, select the unlock icon for the denial. +4. In the **Enable Activity** window, select **Enable**. + +This deletes the denial. + +For how certification affects a policy, see [Resource-based policies](/docs/privilegesecure/26.07/configuration/access-policies/resource-based-policy.md). + +## Delete a task + +Select the task, and then select the delete icon. Confirm the prompt. You can delete a task only before the review is committed. + +For example, to remove a task created for the wrong resource group, select it before anyone commits a review, select the delete icon, and confirm. diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/activity-log.md b/docs/privilegesecure/26.07/admin/audit-reporting/activity-log.md new file mode 100644 index 0000000000..4395f70a4e --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/activity-log.md @@ -0,0 +1,71 @@ +--- +title: "Activity log" +description: "Review the sessions that ran in a date range, who ran them, and for how long, and export the results as a CSV file." +sidebar_position: 30 +--- + +# Activity log + +The **Activity Log** page lists the sessions that ran in a date range. Use it to see which users ran sessions, on which resources, under which access policies, and for how long. + +To open it, select **Auditing & Reporting** > **Activity Log** in the Privilege Secure Console. + +![The Activity Log page with the summary, top 5 users, and sessions tables and the Export as CSV button.](/images/privilegesecure/26.07/admin/activity-log.webp) + +## Filter the log + +The toolbar has these controls: + +| Control | Description | +| --- | --- | +| **Search** | Filters the sessions table to rows that match the text you enter. | +| **Change type** | `` (the default) shows the top 5 users and every session. **Top 5 Users** or **Top 10 Users** lists that many users and limits the sessions table to their sessions. | +| **Date range** | Sets the start and end dates. The default range is the last 30 days. | +| **Refresh** | Reloads the data. | + +**Search** applies to the sessions table. It finds the text anywhere in the **Session User**, **Login Account**, **Policy**, **Activity**, **Notes**, **Ticket Number**, or **Host** value and ignores case. A space at the start or end counts as part of the text, so a full name typed with a trailing space doesn't match that name. **Change type** doesn't match on text. + +When a table has no rows for the range, it shows **None**. Widen the date range if you expect results. + +## Summary for the date range + +The **Summary for the date range** table combines all sessions in the range. + +| Column | Description | +| --- | --- | +| **SESSIONS** | Total number of sessions. | +| **TOTAL DURATION** | Combined duration of all sessions. | +| **AVERAGE** | Average session duration. | +| **MINIMUM** | Shortest session duration. | +| **MAXIMUM** | Longest session duration. | + +## Top 5 users for the date range + +The **Top 5 users for the date range** table lists the users with the most sessions. It has the **USER**, **SESSIONS**, **TOTAL DURATION**, **AVERAGE**, **MINIMUM**, and **MAXIMUM** columns, calculated per user. Select a user to open the user's details. See [User and group details](/docs/privilegesecure/26.07/admin/users-groups/user-details.md). + +## Sessions by all users + +The sessions table is titled with the number of sessions, for example "12 sessions by all users". It has these columns: + +| Column | Description | +| --- | --- | +| **SESSION USER** | The user who ran the session. | +| **HOST** | The resource the session used. | +| **LOGIN ACCOUNT** | The account the user signed in with on the resource. | +| **POLICY** | The access policy that granted the session. See [Access policies](/docs/privilegesecure/26.07/configuration/access-policies/overview.md). | +| **ACTIVITY** | The activity the session ran. See [Activities](/docs/privilegesecure/26.07/configuration/activities/activities.md). | +| **START** | When the session started. | +| **DURATION** | How long the session ran. | +| **END** | When the session ended. | +| **NOTES** | Notes entered when the session was requested. | +| **TICKET NUMBER** | Ticket number entered when the session was requested. | + +You can resize and sort the columns. + +## Export the log as a CSV file + +Select **Export as CSV** above the sessions table to save the log as a CSV file. + +To export the log with a script instead, see [Exporting the Activity Log as a CSV](/docs/kb/privilegesecure/workflows-and-automation/exporting-the-activity-log-as-a-csv). + +The export follows the current **Search**, **Change type**, and **Date range** settings and includes every matching session, not only the rows on screen. The file is named `activity_logs.csv`. Its header row uses the field names of the session data rather than the on-screen column titles. diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/audit-reporting.md b/docs/privilegesecure/26.07/admin/audit-reporting/audit-reporting.md new file mode 100644 index 0000000000..e7ec70c87b --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/audit-reporting.md @@ -0,0 +1,45 @@ +--- +title: "Auditing and reporting overview" +description: "Find the Privilege Secure audit pages, what each one shows, which roles can open them, and the default date range of each." +sidebar_position: 10 +--- + +# Auditing and reporting overview + +The **Auditing & Reporting** menu groups the pages that show what happened in Privilege Secure: who accessed what, what changed in the configuration, what the system logged, and what the services wrote to their log files. Use these pages to answer audit questions, certify access, and schedule reports. + +To open them, select **Auditing & Reporting** in the left navigation. The menu lists, in order, **Access Certification**, **Activity Log**, **DB Change History**, **Events**, **Log Files**, and **Reporting**. + +## Pages + +| Page | Question it answers | Default range | +| --- | --- | --- | +| [Run an access certification](/docs/privilegesecure/26.07/admin/audit-reporting/access-certification.md) | Who still needs the access they have, according to a reviewer? | Not applicable | +| [Activity log](/docs/privilegesecure/26.07/admin/audit-reporting/activity-log.md) | What sessions ran, and for how long? | Last 30 days | +| [Database change history](/docs/privilegesecure/26.07/admin/audit-reporting/db-change-history.md) | Who changed the configuration, and when? | Last 7 days | +| [Events](/docs/privilegesecure/26.07/admin/audit-reporting/events.md) | What did the system log? | Not applicable | +| [Log files](/docs/privilegesecure/26.07/admin/audit-reporting/log-files.md) | What did each service write to its log file? | Not applicable | +| [Reports and subscriptions](/docs/privilegesecure/26.07/admin/audit-reporting/reports.md) | How are reports run, customized, and scheduled? | Last 7 days for a new report, last 30 days for a predefined report | + +For a session-by-session view of live and past sessions, see the [Dashboard](/docs/privilegesecure/26.07/admin/sessions/dashboard.md). + +## Who can open the pages + +| Role | Pages | +| --- | --- | +| Administrators | All pages | +| Users with **Admin View Read Only** | All pages, read-only | +| Reviewers | **Access Certification**, limited to the tasks assigned to them | +| Auditors with the **Reporting** permission | **Activity Log**, **DB Change History**, **Events**, **Log Files**, and **Reporting** | + +An auditor whose role doesn't include the **Reporting** permission doesn't see the **Auditing & Reporting** menu. + +Auditors work within the users and resources assigned to their role. For auditor permissions, see [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md). To give auditors a read-only view of every administration page, see [Give auditors read-only console access](/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md). + +## Common tasks + +- Review who has access to what: [Run an access certification](/docs/privilegesecure/26.07/admin/audit-reporting/access-certification.md). +- Export session history to a spreadsheet: [Activity log](/docs/privilegesecure/26.07/admin/audit-reporting/activity-log.md). +- Check a recent configuration change: [Database change history](/docs/privilegesecure/26.07/admin/audit-reporting/db-change-history.md). +- Send a report to your inbox on a schedule: [Reports and subscriptions](/docs/privilegesecure/26.07/admin/audit-reporting/reports.md). +- Collect logs for a support case: [Log files](/docs/privilegesecure/26.07/admin/audit-reporting/log-files.md). diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/db-change-history.md b/docs/privilegesecure/26.07/admin/audit-reporting/db-change-history.md new file mode 100644 index 0000000000..b576ce5449 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/db-change-history.md @@ -0,0 +1,43 @@ +--- +title: "Database change history" +description: "See who added, updated, or deleted configuration records in Privilege Secure, and when, and filter the history by change type, table, and date." +sidebar_position: 40 +--- + +# Database change history + +The **DB Change History** page records each addition, update, and deletion of a record in the Privilege Secure database. Use it to answer who changed the configuration, and when. + +To open it, select **Auditing & Reporting** > **DB Change History**. + +![The DB Change History page with one Action Service Property row expanded to show the changed field and its old and new values.](/images/privilegesecure/26.07/admin/db-change-history-expanded-row.webp) + +## Filter the history + +| Control | Description | +| --- | --- | +| **Search** | Filters the table to rows that match the text you enter. | +| **Change type** | Shows all changes (the default), **Additions**, **Updates**, or **Deletes**. | +| **Data table** | Limits the history to one record type, such as Access Control Policy, Action, or Action Group. The default is ``. | +| **Date range** | Sets the start and end of the history. The default range is the last 7 days. | +| **Refresh** | Reloads the data. | + +The toolbar also shows the number of matching changes, abbreviated for large counts (for example, 4.3k). + +The default range here is 7 days. The [Activity log](/docs/privilegesecure/26.07/admin/audit-reporting/activity-log.md) defaults to 30 days. + +## Read the table + +| Column | Description | +| --- | --- | +| **WHEN** | Timestamp of the change. | +| **BY** | The user who made the change. Changes made by the product itself show ``. | +| **CHANGE** | The type of change: addition, update, or deletion. | +| **RECORD TYPE** | The type of record that changed. | +| **WHICH RECORD** | The record that changed. Some records, such as managed users, show ``. | + +Select the expander at the start of a row to view its details. + +The expanded row lists each field that changed. For an update, it shows the old value and the new value, for example `Name: old-value → new-value`. For an addition or a deletion, it shows the value only. An empty value shows as ``. + +You can sort the columns. diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/events.md b/docs/privilegesecure/26.07/admin/audit-reporting/events.md new file mode 100644 index 0000000000..769c18be71 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/events.md @@ -0,0 +1,54 @@ +--- +title: "Events" +description: "Review the events that Privilege Secure logs for sessions, services, and configuration changes, and open the log of a session from its event." +sidebar_position: 50 +--- + +# Events + +The **Events** page lists the events that Privilege Secure logs, such as password changes, sign-ins, service starts, and session activity. Use it to see what the system did and for whom. + +To open it, select **Auditing & Reporting** > **Events**. + +![The Events page with the Status, Time, User, Access Policy, Event Message, and Session ID columns and the result count.](/images/privilegesecure/26.07/admin/events-page.webp) + +## Browse events + +The toolbar has these controls: + +| Control | Description | +| --- | --- | +| **View Logs** | Opens the log for the selected event. The button is unavailable until you select one row that has a session or an action log. For an event with an action log, it opens the **Event Logs** window. Otherwise it opens the **Session Logs** window for the event's session. See [View session logs](/docs/privilegesecure/26.07/admin/sessions/session-logs.md). | +| **Search** | Filters the list to events that match the text you enter. | +| **Refresh** | Reloads the list. | + +The toolbar shows the number of events, abbreviated for large counts (for example, 60.9k results). The list is paged, so you can browse all events. + +## Read the list + +| Column | Description | +| --- | --- | +| **STATUS** | The severity of the event: Information, Warning, or Error. | +| **TIME** | When the event occurred, shown relative to now (for example, "18 minutes ago") or as the time of day. | +| **USER** | The user associated with the event. System events show ``. | +| **ACCESS POLICY** | The access policy of the session. Events with no policy show ``. | +| **EVENT MESSAGE** | A description of the event. | +| **SESSION ID** | The identifier of the session, when the event belongs to one. | + +You can sort the columns. + +## Events you see + +The list includes events such as these: + +- Password changed, and failed to update a password (shown as a Warning). +- One-time-use token created. +- Login success, with the source IP address. +- Service started, for the Scheduler, security information and event management (SIEM), Action, and Email services. +- Changes to activities. + +The list has no column for the event type. SIEM templates can include the event type and the service that logged the event. See [SIEM templates and event fields](/docs/privilegesecure/26.07/integrations/siem/siem-templates.md). + +When a SIEM server is enabled, Privilege Secure forwards each event that appears in this list to it. The Remote Access Gateway service writes its events only to its own log file, so they don't appear in the list or reach a SIEM. + +To forward events to a SIEM, see [Forward events to a SIEM](/docs/privilegesecure/26.07/integrations/siem/siem-servers.md). diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/log-files.md b/docs/privilegesecure/26.07/admin/audit-reporting/log-files.md new file mode 100644 index 0000000000..7347b1c143 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/log-files.md @@ -0,0 +1,112 @@ +--- +title: "Log files" +description: "Find where Privilege Secure services write log files, read them in the console, download them, and change the minimum log level for a service." +sidebar_position: 60 +--- + +# Log files + +Each Privilege Secure service writes a log file. Use the **Log Files** page to read these logs in the console, export them, and download them for support. + +To open it, select **Auditing & Reporting** > **Log Files**. + +![The Log Files page with PAM-Web20261024.log selected and its entries listed by line, date, time, and status.](/images/privilegesecure/26.07/admin/log-files-page.webp) + +## Log file location and names + +Log files are in `C:\ProgramData\Stealthbits\PAM\Log` on the server that runs the service. + +Files are named `PAM-.log`, where `` is the service and `` is the date. For example, `PAM-ActionService20191002.log`. + +The page lists logs for these services: + +| Service | Log | +| --- | --- | +| Web | `PAM-Web` | +| Web API | `PAM-WebAppApi` | +| Proxy | `PAM-Proxy` | +| SSH client | `PAM-SSHClient` | +| Host Scan | `PAM-HostScanService`, `PAM-HostScanServiceWorker` | +| Action | `PAM-ActionService`, `PAM-ActionServiceWorker` | +| Email | `PAM-EmailService` | +| Security information and event management (SIEM) | `PAM-SiemService` | +| Scheduler | `PAM-SchedulingService` | +| License | `PAM-LicenseService` | +| Installer and maintenance | `PAM-InstallCmd`, `PAM-RotateKey`, `PAM-DbUpdater` | +| PostgreSQL upgrade | `NPS-PGUpgrade`, `NPS-PGUpgradeErr` | + +Services keep a limited number of files. By default, the Web, Action, Host Scan, Email, Scheduler, SIEM, and Proxy services start a new file each day, keep 10 files, and start another file when one reaches 100 MB. The **Options** window shows and changes the file count and size limit that a service uses. The Proxy service also deletes log files older than 30 days. + +The SSH client service starts a new file when one reaches 100 MB, keeps 10 files, and deletes files older than 30 days. It doesn't start a new file each day. The License service follows the same default as the first group: a new file each day, 10 files, and 100 MB per file. + +### Remote Access Gateway hosts + +The Remote Access Gateway and Portal write to the same folder on their own hosts: + +- `PAM-RagGateway.log` on the gateway server. The file is empty until the first request. +- `PAM-RagPortal.log` on the portal server. +- `nginx-access.log` on the portal server. + +The **Log Files** page lists only the logs on the Privilege Secure server that serves the console. To read the Remote Access Gateway and portal logs, open them on those hosts. + +## Read a log + +1. Select **Auditing & Reporting** > **Log Files**. +2. Enter text in **Search Log Files...** to filter the list on the left. +3. Select a log file. + +For example, to find problems in a service, select its log and set **Log Level** to **Warn** or **Error**. + +The right pane shows the log lines in four columns: **LINE**, **DATETIME**, **STATUS**, and **MESSAGE**. It has these controls: + +| Control | Description | +| --- | --- | +| **Search** | Searches the log. | +| **Log Level** | Filters lines by level. The values are **Debug**, **Info**, **Warn**, and **Error**. The default is **Debug**. | +| **Requested date** | Filters lines by date. | +| **Export as CSV** | Saves the displayed log as a CSV file. | +| **Refresh** | Reloads the log. | + +The pane also shows the number of lines. + +## Download logs + +Select **Download Logs** above the log list to download the logs, for example to send them to support. + +1. In the **Download Logs** window, set **Start Date** and **End Date**. The start date can't be in the future or after the end date. +2. Select **Download**. + +The download is a ZIP file named `nps-logs.zip`. It contains every log file in the log folder of the server that runs the console whose dates fall in the range, not only the selected log. + +## Change the log level + +The log level controls how much detail a service writes. Set a more detailed level, such as Debug, only when support asks. Debug and Verbose logs can contain sensitive data. Treat them as confidential and share them only with Netwrix Support. + +1. Select a log file. +2. Select **Options** (the gear icon) above the log list. The **\ Options** window opens for the service that wrote that log. +3. Select a field to edit it. +4. Set **Minimum Log Level**, **Retained File Count Limit** (1 to 40), or **File Size Limit Bytes** (1 to 250,000,000). +5. Select **Save**. Select **Cancel** to discard your changes. + +For example, when support asks for detailed logs, select the Action Service and set **Minimum Log Level** to **Debug**. After you collect the logs, set it back to **Information**. + +| Setting | Description | +| --- | --- | +| **Minimum Log Level** | The lowest level the service logs. See the following levels. | +| **Retained File Count Limit** | The number of log files to keep before the oldest are deleted. | +| **File Size Limit Bytes** | The maximum size of one log file, in bytes. | + +The levels, from most to least detailed, are: + +- **Verbose**: The most detailed logging. Privilege Secure writes few Verbose messages, so the difference from Debug is small. +- **Debug**: Detailed information for analysis. Support may ask you to enable this level to troubleshoot. +- **Information**: Normal operation. This is the recommended level. +- **Warning**: An unusual condition that the system can recover from. +- **Error**: An unrecoverable condition that may indicate data loss. +- **Fatal**: An error that caused the service to stop. + +The Proxy service offers **Debug**, **Information**, **Warning**, **Error**, **Panic**, and **Fatal**. It has no **Verbose** level. + +**Options** is available to Administrators for the Action, Email, Proxy, Scheduler, SIEM, Web, and Host Scan services. It isn't shown for License service logs, to users who aren't Administrators, or to Admin View Read Only users. For other logs, such as SSH client, installer, and PostgreSQL upgrade logs, the icon appears but the window doesn't load any settings. + +For help with a specific problem, see [Troubleshooting](/docs/privilegesecure/26.07/troubleshooting/overview.md). diff --git a/docs/privilegesecure/26.07/admin/audit-reporting/reports.md b/docs/privilegesecure/26.07/admin/audit-reporting/reports.md new file mode 100644 index 0000000000..dd388e4f42 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/audit-reporting/reports.md @@ -0,0 +1,137 @@ +--- +title: "Reports and subscriptions" +description: "Run, customize, download, and schedule reports on sessions, resource syncs, password rotations, and password age from the Reporting page." +sidebar_position: 70 +--- + +# Reports and subscriptions + +The **Reporting** page lists predefined reports on sessions, resource syncs, password rotations, and password age. You can run a report, change its filters, save your own version, download it, and subscribe to receive it by email on a schedule. + +To open it, select **Auditing & Reporting** > **Reporting**. + +Administrators can use reports. Auditors can use them when their role includes the **Reporting** permission. + +![The Reporting page with the report tree on the left and the All Activity Sessions report open on the Filters tab.](/images/privilegesecure/26.07/admin/reporting-page.webp) + +## Prerequisites + +To subscribe to a report, you need: + +- The Email service configured. See [Configure email notifications](/docs/privilegesecure/26.07/configuration/system-settings/email.md). +- An email address on your user account. Check it on the **Users & Groups** page. + +## Find a report + +The report tree is on the left. Use **Search Reports...** to filter the tree by report name. The search covers predefined and custom reports. + +The tree has these folders: + +| Folder | Contents | +| --- | --- | +| **Favorites** | Reports you marked with a star. Select the star beside a report name again to remove it. | +| **Predefined Reports** | **Account Password Age**, **All Activity Sessions**, **Password Rotations**, and the **Platform Based** folder. | +| **Platform Based** | **All Active Directory Sessions**, **All Cisco Sessions**, **All Entra ID Sessions**, **All Linux Sessions**, **All Microsoft SQL Server Sessions**, **All Oracle Sessions**, **All Website Sessions**, and **All Windows Sessions**. | +| **My Reports** | Reports you created, and copies you saved from a predefined report. | + +Each report has a **Filters** tab and a **Subscriptions** tab. + +## Run a report + +1. Select **Auditing & Reporting** > **Reporting**. +1. Select a report in the tree. +1. On the **Filters** tab, change the **Timeframe** if needed. Predefined reports default to **Last 30 Days**. +1. Select **Run Query**. + +The results appear under the filters. + +## Download a report + +1. Open the report and select **Run Query**. +1. Select **Download Report**. +1. In the **Download Report** window, select **Download PDF** or **Download CSV**. + +Both buttons are unavailable while you have unsaved changes to the filters. The downloaded file name includes the report name and the time of the download. + +## Create a report + +1. Select **+** (**Add Report**) beside **Search Reports...**. +1. In **Enter Report Name**, enter a name, for example `Windows sessions last 7 days`. +1. In **Source**, select the data to report on. +1. Leave **Timeframe** at **Last 7 Days**, or select another value. +1. Add filters. For each one, select an **Attribute**, an operator, and a value. +1. Select **Save**. + +The report appears in **My Reports**. The **Subscriptions** tab stays disabled until you save the report. + +For example, to report on Windows sessions only, select the source **Activity Sessions** and add a filter with the attribute **Platform**, an operator that means equals, and the value **Windows**. + +### Sources + +| Source | Reports on | +| --- | --- | +| **Activity Sessions** | Sessions that users ran. Filter attributes are **Domain**, **Platform**, **Activity**, **Target User**, **Target Host**, and **User**. | +| **Resource Sync** | Resources that synced. Filter attributes are **Name**, **Operating System**, **Version**, **IP Address**, and **DnsHostName**. | +| **Password Rotation** | Password rotation events. Filter attributes are **User**, **Target Resource**, **Change Reason**, and **Results**. | +| **Password Age** | The age of account passwords. Filter attributes are **Name**, **Password Age**, **Account Name**, **Privilege**, and **Computer**. | + +The operators are **Equals**, **Not Equals**, **Contains**, **Not Contains**, **Starts With**, **Ends With**, **Less Than**, and **Greater Than**. Each attribute offers only the operators that fit it. For example, **Domain** and **Platform** offer only **Equals** and **Not Equals**, and **Password Age** offers **Equals**, **Not Equals**, **Less Than**, and **Greater Than**. + +The **Activity Sessions** source has no **Access Policy** attribute. + +### Timeframes + +The **Timeframe** list offers **Last Hour**, **Last 4 Hours**, **Last 8 Hours**, **Last 24 Hours**, **Last 5 Days**, **Last 7 Days**, **Last 14 Days**, **Last 30 Days**, and **Custom**. **Custom** shows a **Start date** and an **End date** picker. + +A new report defaults to **Last 7 Days**. The predefined **Account Password Age**, **All Activity Sessions**, and **Password Rotations** reports default to **Last 30 Days**. The reports in the **Platform Based** folder default to **Last 7 Days**. + +The session reports, including **All Website Sessions**, have a **Target** column. For a website session, the column shows the website name. If the website resource has a display name, that shows instead. + +## Customize a report + +Predefined, platform-based, and custom reports work the same way. The **Filters** tab has these buttons: + +| Button | Description | +| --- | --- | +| **Run Query** | Runs the report and shows the matching data. | +| **Download Report** | Downloads the report. | +| **Save** | Saves your changes. The button stays disabled until you change something. Saving a predefined report creates a copy in **My Reports**. | +| **Delete** | Deletes the report. Available for custom reports only. | + +## Subscribe to a report + +A subscription emails the report to you on a schedule. + +To subscribe to a predefined report, first change a filter and select **Save** to create a copy in **My Reports**. The **Subscriptions** tab is disabled until the report is saved. + +1. Open a report you saved, and select the **Subscriptions** tab. +1. Select **Subscribe**. +1. In **Subscription Schedule**, select **Every 1 hours**, **Every 4 hours**, **Every 8 hours**, or **Every 24 hours**. +1. Select **Okay**. + +The **Okay** button stays disabled until you select a schedule. Privilege Secure sends the report to the email address on your user account. + +For example, to receive the `Windows sessions last 7 days` report once a day, select **Every 24 hours**. + +The **Subscription Schedule** list shows every schedule policy, sorted by name, including any you create under **Platforms** > **Schedule Policies**. + +After you subscribe, the **Subscriptions** tab shows **CSV** and **PDF** check boxes and the current schedule. **Subscribe** becomes **Unsubscribe**. Both check boxes are selected by default, and the email attaches each selected format. Keep at least one selected. The email has the subject `Netwrix Privilege Secure Report`. + +The **Subscriptions** tab has these controls: + +| Control | Description | +| --- | --- | +| **Search** | Filters the subscriptions by user name. | +| **Subscribe** | Subscribes you to the report. | +| **Refresh** | Reloads the list. | + +The table has these columns: + +| Column | Description | +| --- | --- | +| **USER** | The subscribed user. | +| **REPORT** | The report name. | +| **SCHEDULE** | How often the report is sent. | +| **JOB** | The scheduled job for the subscription. | + +![The Subscriptions tab of the All Activity Sessions report with the Subscribe dialog open, showing the Subscription Schedule list.](/images/privilegesecure/26.07/admin/reporting-subscribe-dialog.webp) diff --git a/docs/privilegesecure/26.07/admin/credentials/_category_.json b/docs/privilegesecure/26.07/admin/credentials/_category_.json new file mode 100644 index 0000000000..8dd8b9d66a --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/_category_.json @@ -0,0 +1,10 @@ +{ + "label": "Credentials", + "position": 45, + "collapsed": true, + "collapsible": true, + "link": { + "type": "doc", + "id": "overview" + } +} diff --git a/docs/privilegesecure/26.07/admin/credentials/credential-groups.md b/docs/privilegesecure/26.07/admin/credentials/credential-groups.md new file mode 100644 index 0000000000..87b8ebd7bf --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/credential-groups.md @@ -0,0 +1,67 @@ +--- +title: "Credential groups" +description: "Create credential groups in Privilege Secure and add managed credentials to them, so a credential-based access policy can grant access to the group." +sidebar_position: 70 +--- + +# Credential groups + +A credential group is a named set of managed credentials. Credential-based access policies use groups to decide which accounts users can check out. See [Create a credential-based access policy](/docs/privilegesecure/26.07/configuration/access-policies/credential-based-policy.md). + +The **Credential Groups** page is under **Credentials** in the left navigation. It has two panes. The left pane lists the groups. The right pane shows the selected group. + +![The Credential Groups page with the Linux Servers Build Administrators group selected and its two credentials listed.](/images/privilegesecure/26.07/admin/credential-groups-page.webp) + +## The left pane + +- **Search Credential Groups...**: Filters the list. +- **+**: Creates a group. +- Trash icon: Appears when you hover over a group. It deletes the group after a confirmation. + +## The group details + +The details pane shows the **Name** and **Description** of the group. If you change either, **Save** and **Cancel** appear. Select **Save** to keep the change or **Cancel** to discard it. + +The member table has these controls: + +- **Search**: Filters the members. +- **Type**: Filters by managed type: All, Internal, Standard, or Service. +- **Add Credentials**: Opens the Add Credentials dialog. +- **Remove**: Removes the selected members from the group. It is disabled until you select a row. +- **Refresh**: Reloads the table. + +The table has the columns **Account**, **Resource**, **Platform**, **Method**, **Managed Type**, **Dependents**, **Password Changed**, **Age**, **Status**, **Last Checked**, and **Next Change**. Managed accounts show the **Copy Password to Clipboard** and **View Password** icons. For the meaning of the columns and status values, see [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md). + +## Create a credential group + +1. In the left navigation, select **Credentials** > **Credential Groups**. +2. Select **+**. +3. Enter a name in **Enter Credential Group Name**. +4. Enter a **Description**. +5. Select **Save**. + +For example, name a group `` with the description ``. + +## Add credentials to a group + +1. On the **Credential Groups** page, select the group. +2. Select **Add Credentials**. +3. Use the search box and the type dropdown (All, Internal, Standard, Service) to find accounts. +4. Select the checkbox for each account in **Available Credentials**. The account moves to **Credentials to Add**. +5. Optional: Clear a checkbox in **Credentials to Add** to move the account back. +6. Select **Add**. + +![The Add Credentials dialog with Available Credentials on the left and the empty Credentials to Add pane on the right.](/images/privilegesecure/26.07/admin/add-credentials-dialog.webp) + +**Available Credentials** lists the credentials that aren't already in the group. It leaves out deleted credentials and application credentials. The search box matches the account name, and the type dropdown limits the list to one account type. + +## Remove credentials from a group + +1. Select the group. +2. Select the checkbox for each account to remove. +3. Select **Remove**. + +## Related topics + +- [Credential policy overrides](/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md) +- [Password rotation methods](/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md) diff --git a/docs/privilegesecure/26.07/admin/credentials/internal-service-accounts.md b/docs/privilegesecure/26.07/admin/credentials/internal-service-accounts.md new file mode 100644 index 0000000000..d2120e1769 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/internal-service-accounts.md @@ -0,0 +1,64 @@ +--- +title: "Manage internal service accounts" +description: "Bring an internal service account under management so Privilege Secure can rotate its password automatically or you can set it manually." +sidebar_position: 50 +--- + +# Manage internal service accounts + +An internal service account is an account that Privilege Secure itself uses. It has no dependencies, which means no Windows services or scheduled tasks use it. On the **Credentials** page, these accounts have the **Managed type** value **Internal**. + +When you manage an internal account, Privilege Secure searches for a matching user and offers you a choice of management method. + +:::note +Internal accounts rotate on the primary domain controller (PDC) of the domain. +::: + +## Prerequisites + +- Add the service account on the **Service Accounts** page. See [Service accounts](/docs/privilegesecure/26.07/configuration/service-accounts/service-accounts.md). +- Ensure the user exists in Active Directory in the expected domain. + +## Manage an internal service account + +1. In the left navigation, select **Credentials**. +2. Open the **Managed type** filter and select **Internal**. +3. Select the checkbox for the account. +4. Select **Manage**. + + ![The Manage Account dialog for an internal account, with the Automatic, Manual, and Cancel buttons.](/images/privilegesecure/26.07/admin/internal-manage-account-dialog.webp) + +5. If Privilege Secure finds a matching user, choose one of these options: + + - **Automatic**: Privilege Secure manages the account and its password. + - **Manual**: You manage the account and its password. A dialog opens so you can set the password. + - **Cancel**: Closes the dialog without changes. + +For example, select an internal account named ``, and then select **Manage**. Choose **Automatic** to let Privilege Secure rotate the password on the schedule that applies to the account. + +## Resolve "No matching user found" + +If the dialog shows the message "No matching user found", Privilege Secure can't find a matching user in Active Directory. Try these fixes: + +- Run an Active Directory sync to collect the latest data from the domain. See [Active Directory domains](/docs/privilegesecure/26.07/resources/domains.md#run-a-synchronization). +- Check that the user is added to the console. See [Users and groups](/docs/privilegesecure/26.07/admin/users-groups/add-users-groups.md). +- Check the spelling of the user name on the service account. See [Service accounts](/docs/privilegesecure/26.07/configuration/service-accounts/service-accounts.md). +- Check that the user is in Active Directory in the expected domain. + +## Set the password manually + +If you choose **Manual**, a dialog opens to set the password for the credential. + +1. In the **Set Password for Credential** window, enter the password in **Password**. Use the eye icon to show or hide what you type. +2. Select **Save**. **Save** stays unavailable until you enter a password. + +The window reminds you that the password must match the account password on the platform. For a manually managed account, Privilege Secure doesn't change the password on the target. + +For example, enter the password that `` already has in Active Directory. + +The **Credentials** page doesn't show the **Set Password**, **Copy Password to Clipboard**, or **View Password** icons for Internal accounts, and **View History** isn't available for them. The **Set Password** icon appears only for Standard accounts. + +## Related topics + +- [Manage, rotate, and verify credentials](/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md) +- [Password rotation methods](/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md) diff --git a/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md b/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md new file mode 100644 index 0000000000..358e1228df --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md @@ -0,0 +1,108 @@ +--- +title: "Manage, rotate, and verify credentials" +description: "Bring accounts under Privilege Secure management, rotate and verify their passwords, and keep accounts enabled after a credential release." +sidebar_position: 20 +--- + +# Manage, rotate, and verify credentials + +Use the **Credentials** page to bring an account under Privilege Secure management, rotate its password, and verify that the stored password still works. For the columns and filters, see [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md). + +## Toolbar buttons and row states + +The toolbar buttons stay disabled until you select a row. The selected row decides which buttons are enabled. + +| Selected row | Enabled buttons | +| --- | --- | +| **Not Managed**, managed type **Standard** or **Internal** | **Manage** | +| **Managed**, managed type **Standard**, method **Automatic** | **Unmanage**, **Rotate**, **Verify**, **View History** | +| **Managed**, managed type **Standard**, method **Manual** | **Unmanage**, **Verify**, **View History** | +| **Managed**, managed type **Internal**, method **Automatic** or **Manual** | **Unmanage**, **Rotate**, **Verify** | +| **Not Managed**, managed type **Service** | **Service Account Details** | +| **Managed**, managed type **Service** | **Unmanage**, **Service Account Details**, **Verify**, **View History** | + +A button also needs the role permission for its action. **View History** isn't available for Internal accounts. + +**View History** works on one managed row at a time. See [View passwords and password history](/docs/privilegesecure/26.07/admin/credentials/password-history.md). + +## Prerequisites + +- The account appears on the **Credentials** page. +- You're an Administrator, or you hold a custom role with the **Credentials** target and the permission for the action: **[C] Manage**, **[C] Unmanage**, **[C] Schedule Rotation** (Rotate), or **[C] Verify**. See [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md). + +## Manage an account + +1. In the left navigation, select **Credentials**. +2. Select the row of a **Not Managed** account. For example, select the `` account on ``. +3. Select **Manage**. +4. In the **Manage Account** window, wait for Privilege Secure to search for a matching user. When it lists the account under **Found matching user:** or **Credentials:**, select **Automatic** or **Manual**. Select **Cancel** to close the window without changes. If no match exists, the window shows **No matching user found.** + +The row's **Method** changes to **Automatic** or **Manual**. Both choices are available for Standard and Internal accounts. + +For an Internal account, a dialog searches for a matching user. See [Manage internal service accounts](/docs/privilegesecure/26.07/admin/credentials/internal-service-accounts.md). + +![The Manage Account dialog for a Standard account, with the Automatic, Manual, and Cancel buttons.](/images/privilegesecure/26.07/admin/manage-account-dialog.webp) + +To stop managing an account, select its row, and then select **Unmanage**. + +### Passwords of manually managed accounts + +For a manually managed account, the **Set Password for Credential** window records the account's password in Privilege Secure. It doesn't change the password on the resource, so change it there first. Administrators and users who hold the **[C] Manage** permission can set the password. + +When you manage an account as **Manual**, the **Set Password for Credential** window opens for it. To set the password again later, select the **Set Password** icon (a wrench) beside the account name. It appears in the **Account** column on the **Credentials** page and in the **User Name** column on the **Users** tab of a resource. It appears only for Standard accounts with method **Manual**. The toolbar has no Set Password button. + +## Rotate an account + +1. Select the row of a **Managed** account with method **Automatic**, or an **Internal** account with method **Manual**. +2. Select **Rotate**. + +Privilege Secure schedules a rotation job that runs right away. The console shows a message such as **1 credential rotation scheduled.** If it schedules only some of the selected accounts, the message reads, for example, **1/2 rotations scheduled.** When the job changes the password on the resource, Privilege Secure stores the new value, and **Password Changed**, **Age**, and **Next Change** update. The list refreshes every 5 seconds, so the row updates after the job finishes. How long the job takes depends on the resource. + +For example, rotate `` on `` after a person who knew the password leaves the team. + +Automatic accounts also rotate on the schedule of their platform or [credential policy override](/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md). + +:::note +A rotation doesn't run while a session on the account is active. This applies to manual and scheduled rotation. The console doesn't block the **Rotate** button. The rotation job stops, marks the rotation as failed, and logs that it aborted because the account has active sessions. Wait until the session ends, then select **Rotate** again. +::: + +To rotate a service account that services or scheduled tasks use, see [Rotate service accounts and their dependencies](/docs/privilegesecure/26.07/admin/credentials/service-account-dependencies.md). Internal accounts rotate on the primary domain controller (PDC). See [Password rotation methods](/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md). + +## Verify an account + +1. Select the row of a managed account. +2. Select **Verify**. + +Privilege Secure checks that the password on the resource matches the stored password. The **Status** and **Last Checked** columns update. For the status values, see [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md). + +For example, verify `` after someone reports a failed sign-in. **Status** shows **Verified** when the passwords match. + +## Control the account state after a session + +Privilege Secure changes the state of a managed account around a session. In a resource-based session, the account is enabled when the session starts and disabled when it ends. In a credential-release session, the account is disabled again after the release by default. + +To keep the account enabled after a credential release, set **Keep Enabled** on the account: + +1. Open the resource, domain, or database that holds the account. +2. Select the **Users** tab. +3. Select the row of a managed account. +4. Select **Password Reset Options**. +5. Select the options you need: + - **Rotate on Session Start** + - **Rotate on Session End** + - **Keep Enabled (Credential Release only)** +6. Select **Okay**. + +The **Users** tab then shows the settings in the **Rotate Start | End** and **Keep Enabled** columns. For example, an account with both rotate options selected and **Keep Enabled** cleared shows **Yes | Yes** and **No**. + +A newly managed account has **Rotate on Session Start** and **Rotate on Session End** selected and **Keep Enabled** cleared. + +![The Password Reset Options dialog with Rotate on Session Start, Rotate on Session End, and Keep Enabled options.](/images/privilegesecure/26.07/admin/password-reset-options-dialog.webp) + +:::note +These options belong to the account on the resource. You can't set them for each requesting user. +::: + +When the last credential-release session that uses the account ends, Privilege Secure disables the account. It doesn't disable a platform's built-in administrator account or a vaulted account. With **Keep Enabled** selected, it leaves the account enabled instead. **Keep Enabled** is cleared by default, so the account is disabled after the release. Privilege Secure reads the setting only for credential-release sessions, so it has no effect on resource-based sessions. + +For how policy types treat the account, see [Key concepts](/docs/privilegesecure/26.07/getting-started/key-concepts.md) and [Create a credential-based access policy](/docs/privilegesecure/26.07/configuration/access-policies/credential-based-policy.md). diff --git a/docs/privilegesecure/26.07/admin/credentials/overview.md b/docs/privilegesecure/26.07/admin/credentials/overview.md new file mode 100644 index 0000000000..4754c9d0b9 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/overview.md @@ -0,0 +1,87 @@ +--- +title: "Credentials" +description: "See which accounts Privilege Secure manages, filter the Credentials list, and read the method, managed type, and status columns." +sidebar_position: 10 +--- + +# Credentials + +The **Credentials** page lists the accounts that Privilege Secure discovers in your environment. It covers host local accounts, domain accounts, and Privilege Secure application local accounts. It also covers the managed accounts that activity sessions create. + +A managed account is an account whose password Privilege Secure stores and rotates. Use the page to bring an account under management, rotate its password, verify its password, and see how old the password is. + +The **Credentials** tile on the Dashboard shows the same table. See [Dashboard](/docs/privilegesecure/26.07/admin/sessions/dashboard.md). + +To open the page, select **Credentials** in the left navigation. The **Credentials** menu also holds **Credential Groups** and **Credential Policy Overrides**. + +![The Credentials page with a managed account selected, showing the Manage, Unmanage, Rotate, Verify, and View History toolbar and the Method, Managed type, and Privilege type filters.](/images/privilegesecure/26.07/admin/credentials-page-row-selected.webp) + +## Toolbar + +The toolbar buttons are **Manage**, **Unmanage**, **Service Account Details**, **Rotate**, **Verify**, and **View History**. Each button stays disabled until you select a row. Which buttons are enabled depends on the selected row. See [Manage, rotate, and verify credentials](/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md). + +## Filters + +Select a filter chip to open its "Filter by" popup. An active filter stays on the page as a chip with an **X**. Select the **X** to clear it. Use **Search** to match an account or resource name. + +| Filter | Values | +| --- | --- | +| **Method** | All, Not Managed, Managed, Automatic, Manual | +| **Managed type** | All, Internal, Standard, Service | +| **Privilege type** | Not Set, Administrator, Power User, Guest, User, Superuser, Linux User, Cisco Privilege 0, Cisco Privilege 1, Cisco Privilege 15 | + +For example, to find every service account that has dependencies, set **Managed type** to **Service**. + +The page also shows the number of results and a **Refresh** button. + +## Columns + +You can sort and resize every column. + +| Column | Shows | +| --- | --- | +| **Account** | The account name. Managed rows also show the **Copy Password to Clipboard** and **View Password** icons. The name isn't a link, because accounts have no detail page. | +| **Resource** | The resource that holds the account. Select the link to open the resource. | +| **Privilege** | The privilege type of the account on the resource. | +| **Platform** | The platform of the resource. | +| **Method** | How the account is managed: **Automatic**, **Manual**, or **Not Managed**. | +| **Managed Type** | **Standard**, **Internal**, or **Service**. | +| **Dependents** | The number of Windows services and scheduled tasks that run as the account. | +| **Password Changed** | When the password last changed. | +| **Age** | The number of days since the last rotation, or since the password was first stored. | +| **Status** | The result of the last verification. | +| **Last Checked** | When Privilege Secure last verified the account. | +| **Next Change** | When the next scheduled rotation runs. | +| **Last Logon** | When the account last authenticated. | + +## Method + +| Value | Meaning | +| --- | --- | +| **Automatic** | Privilege Secure rotates the password on the schedule of the platform, or of a [credential policy override](/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md). | +| **Manual** | You rotate the password yourself, or you update it on both the resource and in Privilege Secure. | +| **Not Managed** | Privilege Secure doesn't manage the account and has never stored a password for it. | + +The **Managed** filter value matches both **Automatic** and **Manual** accounts. + +## Managed type + +The managed type decides how an account rotates. See [Password rotation methods](/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md). + +| Value | Meaning | +| --- | --- | +| **Standard** | A local or domain user account, including managed users that activity sessions create. | +| **Internal** | An account that Privilege Secure itself uses, with no dependencies. See [Manage internal service accounts](/docs/privilegesecure/26.07/admin/credentials/internal-service-accounts.md). | +| **Service** | An account that one or more Windows services or scheduled tasks use. This includes Internal accounts that have dependencies. See [Rotate service accounts and their dependencies](/docs/privilegesecure/26.07/admin/credentials/service-account-dependencies.md). | + +## Status + +| Status | Meaning | +| --- | --- | +| **Unspecified** | No verification has run. | +| **Verified** | The password on the resource matches the password that Privilege Secure stores. | +| **Mismatch** | The verification found that the password on the resource doesn't match the stored password. | +| **Changed** | Privilege Secure reset the password on the resource to match its stored value. This status appears only when **Reset On Mismatch** is on. | +| **Failed** | The reset to the stored value failed. This status appears only when **Reset On Mismatch** is on. | + +Platform settings control **Reset On Mismatch**, the rotation schedule, and the verification schedule. See [Platforms](/docs/privilegesecure/26.07/resources/platforms/platforms.md#platform-settings). diff --git a/docs/privilegesecure/26.07/admin/credentials/password-history.md b/docs/privilegesecure/26.07/admin/credentials/password-history.md new file mode 100644 index 0000000000..632c5ddcc1 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/password-history.md @@ -0,0 +1,77 @@ +--- +title: "View passwords and password history" +description: "View or copy the current password of a managed account in Privilege Secure, and review its stored password history, history limits, and retention." +sidebar_position: 60 +--- + +# View passwords and password history + +Privilege Secure stores the current password and a history of previous passwords for each managed account. You can copy or view the current password, and you can open the history to see earlier ones. + +Passwords stay hidden until you reveal them. Reveal a password only when you need it. + +## Prerequisites + +You're an Administrator, or you hold a custom role with the **[C] View Password** permission. See [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md). + +## View the current password + +On the **Credentials** page, each managed account shows two icons beside its name: + +- **Copy Password to Clipboard**: Copies the current password. +- **View Password**: Opens the View Password dialog. + +The same icons appear in credential groups and policy overrides. + +To view the current password: + +1. In the left navigation, select **Credentials**. +2. Find the managed account and select the **View Password** icon. +3. Reveal the password with the eye icon, or copy it with **Copy to Clipboard**. + +The dialog closes automatically after a 20-second countdown. The countdown restarts when you reveal the password. Select **Cancel** to close it sooner. + +For example, view the password of `` to sign in to `` during an outage. + +![The View Password dialog with the password masked, a Copy to Clipboard button, and a 20-second countdown.](/images/privilegesecure/26.07/admin/view-password-dialog.webp) + +## View password history + +1. In the left navigation, select **Credentials**. +2. Select the checkbox for a managed account. +3. Select **View History**. + +The **Password History** dialog opens. + +![The Password History dialog with the creation date of each password and the values hidden.](/images/privilegesecure/26.07/admin/password-history-dialog.webp) + +The dialog has these controls: + +| Control | Description | +| --- | --- | +| **Show Password(s)** | Reveals the password of the selected row. It is unavailable until you select a row. | +| **Hide Password(s)** | Hides the password of the selected row again. It is unavailable until you select a row whose password is shown. | +| **Refresh** | Reloads the list. | + +You can select one row at a time, so **Show Password(s)** reveals one password at a time. + +The table has these columns: + +| Column | Description | +| --- | --- | +| **Creation Date** | When the password was created. | +| **Password (click to view)** | The password, shown as `` until you reveal it with **Show Password(s)**. Select a revealed password to highlight its text. | + +You can resize and sort the columns. Until you sort, the newest entry is first. + +For example, an account whose password rotated three times shows one row for each stored password, each with its own creation date. + +## History limits + +By default, Privilege Secure keeps up to 7 passwords for each account and keeps each one for 30 days. To change these limits, edit **Historical Password Limit** (1 to 50) and **Days Of Password Retention** (1 to 365) in **System Settings**. See [System settings reference](/docs/privilegesecure/26.07/configuration/system-settings/system-settings.md#password-history). + +The two limits work independently. When Privilege Secure stores a new password for an account that is at the count limit, it deletes the oldest entry. A separate cleanup deletes every entry that is older than the retention period. + +## Related topics + +- [Manage, rotate, and verify credentials](/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md) diff --git a/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md b/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md new file mode 100644 index 0000000000..78bbec35bf --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md @@ -0,0 +1,71 @@ +--- +title: "Credential policy overrides" +description: "Give selected managed credentials in Privilege Secure their own change schedule and verification schedule instead of the ones from their platform." +sidebar_position: 80 +--- + +# Credential policy overrides + +By default, a managed credential takes its scheduled change policy and verification schedule from its platform. A credential policy override replaces both for the credentials you add to it. + +Use an override when some accounts need a different rotation or verification frequency than the rest of the platform. For example, rotate a sensitive account every hour while other accounts on the platform rotate daily. + +The **Credential Policy Overrides** page is under **Credentials** in the left navigation. Like **Credential Groups**, it has a list on the left and the selected override on the right. + +![The Credential Policy Overrides page with an empty override list.](/images/privilegesecure/26.07/admin/credential-policy-overrides-empty.webp) + +## The left pane + +- **Credential Policy Overrides...** search box: Filters the list. +- **+**: Creates an override. +- Trash icon: Appears when you hover over an override. It deletes the override after a confirmation. + +When no override exists, the left pane shows `` and the right pane shows "none". + +## Override settings + +| Setting | Description | +| --- | --- | +| **Name** | The name of the override. | +| **Description** | A description. | +| **Scheduled Change Policy** | The schedule policy that controls how often the credentials rotate. Select a policy you created earlier. The default is ``. | +| **Verification Schedule** | How often Privilege Secure verifies the credentials. The default is ``. | + +Both dropdowns have a **+** button to add a schedule. For schedule policies, see [Schedule policies](/docs/privilegesecure/26.07/resources/platforms/schedule-policies.md). + +## Create an override + +1. In the left navigation, select **Credentials** > **Credential Policy Overrides**. +2. Select **+**. +3. Enter a name in **Enter Credential Policy Override Name**. +4. Enter a **Description**. +5. Select a **Scheduled Change Policy**. +6. Select a **Verification Schedule**. +7. Select **Save**. + +For example, create an override named `` with the **Scheduled Change Policy** set to a policy that runs every hour. + +![The new credential policy override form with the name, Description, Scheduled Change Policy, and Verification Schedule fields.](/images/privilegesecure/26.07/admin/credential-policy-override-new-form.webp) + +## Add credentials to an override + +Only credentials with the method **Automatic** appear in the **Available Credentials** list. For the methods, see [Password rotation methods](/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md). + +1. Select the override. +2. Select **Add Credentials**. +3. Select the checkbox for the account in **Available Credentials**. +4. Optional: Clear the checkbox in **Credentials to Add** to move the account back. +5. Select **Add**. + +For example, add `\` to the `` override. + +You can select several accounts and add them in one step. + +The override table has **Search**, **Add Credentials**, **Remove**, and **Refresh**. Select a row, and then select **Remove** to take a credential out of the override. It then uses the rotation and verification schedules from its platform again. If the platform has no schedule for rotation or verification, that job is disabled for the account. + +The override table shows **Account**, **Resource**, **Password Changed**, **Age**, **Status**, **Last Checked**, and **Next Change** for each credential. + +## Related topics + +- [Credential groups](/docs/privilegesecure/26.07/admin/credentials/credential-groups.md) +- [Password rotation methods](/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md) diff --git a/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md b/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md new file mode 100644 index 0000000000..d5580e7f94 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md @@ -0,0 +1,45 @@ +--- +title: "Password rotation methods" +description: "Compare how Privilege Secure rotates passwords for Standard, Internal, and Service accounts, and which toolbar button starts each rotation." +sidebar_position: 30 +--- + +# Password rotation methods + +How an account rotates depends on its **Managed Type** and its **Method**. The **Credentials** page shows both columns. See [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md). + +## Rotation by account type + +| Managed type | Dependencies | Method | How the password rotates | +| --- | --- | --- | --- | +| **Standard** | None | **Automatic** | Privilege Secure rotates the password on the platform's schedule. Select **Rotate** to rotate it now. | +| **Standard** | None | **Manual** | You update the password on the resource and in Privilege Secure. | +| **Standard** | None | **Not Managed** | Privilege Secure has never stored a password. Select **Manage** first. | +| **Internal** | None | **Automatic** | Privilege Secure rotates the password on the platform's schedule. Select **Rotate** to rotate it now. | +| **Internal** | None | **Manual** | You update the password on the resource and in Privilege Secure. | +| **Service** | One or more | **Manual** | Rotation starts from **Service Account Details**, because services and scheduled tasks must receive the new password. | +| **Service** | One or more | **Not Managed** | Privilege Secure has never stored a password. Rotate from **Service Account Details**. | + +After you rotate a Not Managed Service account from **Service Account Details**, the account is managed. Its method is **Manual**, because any account with dependents shows the method **Manual**. + +## Standard accounts + +A Standard account is a local or domain user account, including the managed users that activity sessions create. For an Automatic account, the platform's **Scheduled Change Policy** sets the rotation schedule, unless a [credential policy override](/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md) applies. See [Schedule policies](/docs/privilegesecure/26.07/resources/platforms/schedule-policies.md). + +## Internal accounts + +An Internal account is an account that Privilege Secure itself uses, with no dependencies. Internal accounts rotate on the primary domain controller (PDC) of the domain. Privilege Secure finds the PDC through the DNS SRV record `_ldap._tcp.pdc._msdcs.`. If that lookup fails, Privilege Secure records a warning in the rotation job's action log (open it with **View Logs** on the **Events** page) and uses the domain name as the target instead. + +{/* TODO verify: what happens when the DNS lookup finds the PDC but the PDC can't be reached. The scripts show no handling specific to that case, and the outcome depends on the environment. */} + +To manage an Internal account, see [Manage internal service accounts](/docs/privilegesecure/26.07/admin/credentials/internal-service-accounts.md). + +## Service accounts + +A Service account is a local or domain account that one or more Windows services or scheduled tasks use. Internal accounts that have dependencies also show as Service. The **Dependents** column shows how many. A Service account rotates from the **Account Dependencies** dialog, which you open with **Service Account Details** on the **Credentials** page. The dialog updates each dependent after the password changes. See [Rotate service accounts and their dependencies](/docs/privilegesecure/26.07/admin/credentials/service-account-dependencies.md). + +## Rotation rules + +- A rotation doesn't run while a session on the account is active. See [Manage, rotate, and verify credentials](/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md). +- **Rotate on Session Start** and **Rotate on Session End** rotate an account around its sessions. See [Manage, rotate, and verify credentials](/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md#control-the-account-state-after-a-session). +- Privilege Secure keeps a limited password history for each managed account. See [View passwords and password history](/docs/privilegesecure/26.07/admin/credentials/password-history.md). diff --git a/docs/privilegesecure/26.07/admin/credentials/service-account-dependencies.md b/docs/privilegesecure/26.07/admin/credentials/service-account-dependencies.md new file mode 100644 index 0000000000..f4a469291f --- /dev/null +++ b/docs/privilegesecure/26.07/admin/credentials/service-account-dependencies.md @@ -0,0 +1,83 @@ +--- +title: "Rotate service accounts and their dependencies" +description: "Rotate the password of a service account and see the Windows services and scheduled tasks that depend on it in the Account Dependencies dialog." +sidebar_position: 40 +--- + +# Rotate service accounts and their dependencies + +A service account is an account that Windows services or scheduled tasks run as. Its managed type is **Service**. When the password of such an account changes, each dependent must receive the new password. Use the **Account Dependencies** dialog to rotate the account and see its dependents. + +## Prerequisites + +- The account appears on the **Credentials** page with managed type **Service**. Privilege Secure finds the dependents when it scans a resource. The host scan reads the Windows services and scheduled tasks on the resource and records the account each one runs as. Scan the resource before you rotate so the **Dependencies** tab is current. See [Scan resources for dependents](#scan-resources-for-dependents). +- You're an Administrator, or you hold a custom role with the **Rotate Services** permission. See [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md). +- No session is active on the account. A rotation doesn't run while a session is active. See [Manage, rotate, and verify credentials](/docs/privilegesecure/26.07/admin/credentials/manage-credentials.md). + +## Open the Account Dependencies dialog + +1. In the left navigation, select **Credentials**. +2. Set the **Managed type** filter to **Service**. +3. Select the row of the account. For example, select `\svc-example`. +4. Select **Service Account Details**. + +The **Account Dependencies** dialog opens. + +![The Account Dependencies dialog on the Dependencies tab, showing the account details, the Rotate, Rollback, and Cancel buttons, and one dependent scheduled task.](/images/privilegesecure/26.07/admin/account-dependencies-dialog.webp) + +## Read the dialog + +The top of the dialog shows these fields: + +| Field | Shows | +| --- | --- | +| **Account Name** | The account. | +| **Last Changed** | When the password last changed. | +| **Last Checked** | When Privilege Secure last verified the password. | +| **Age** | The number of days since the password changed. | +| **Credential Status** | The verification status. See [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md). | + +The buttons are **Rotate**, **Rollback**, and **Cancel**. **Cancel** stops a service rotation that's in progress. It isn't a close button. **Rollback** returns the account and its dependents to the previous password. + +- **Rotate** is disabled while a rotation or rollback is queued or running for the account. +- **Rollback** is enabled when the account has a previous password on record and no rotation or rollback is queued or running. Before the first rotation there's no previous password, so it's disabled. +- **Cancel** is enabled only while a rotation or rollback is queued or running. + +The **Dependencies** tab lists what uses the account. Use **Search Dependencies...** to filter the list and **Refresh** to reload it. + +| Column | Shows | +| --- | --- | +| **Resource** | The resource that holds the dependent. | +| **Type** | **Service** or **ScheduledTask**. | +| **Name** | The name of the service or task. | +| **Last Scan** | When Privilege Secure last scanned the resource. | +| **Last Change** | When the dependent last received a password. | +| **Status** | The status of the dependent, as an icon. | + +The **Resources** tab lists the resources to scan for dependents. Its columns are **Name** and **Operating System**. It has a **Scan** button, a **Search Resources...** box, and a **Refresh** button. + +### Scan resources for dependents + +Select one or more rows on the **Resources** tab and select **Scan**. **Scan** is enabled only when at least one row is selected and you're an Administrator. Privilege Secure schedules a host scan for each selected resource. When the scan finishes, the **Last Scan** column on the **Dependencies** tab updates, and any new or removed services and scheduled tasks appear in the list. + +For example, `\svc-example` can show one **Service** dependent on `` and one **ScheduledTask** dependent on ``. + +## Rotate a service account + +1. Open the **Account Dependencies** dialog. See [Open the Account Dependencies dialog](#open-the-account-dependencies-dialog). +2. Check the **Dependencies** tab for the services and tasks that run as the account. +3. Select **Rotate**. + +Privilege Secure changes the account password first. When that succeeds, it schedules an update for each dependent in the list. The console shows the message "N service rotate(s) scheduled", where N is the number of dependents. If the account has no dependents, the console shows the warning "No services rotated". The account password still changes in that case, because the password job runs first and finishes before Privilege Secure checks the dependents list. If the password change itself fails or is cancelled, Privilege Secure doesn't update any dependent. + +The **Rotation Status** field and the **Status** column on the **Dependencies** tab show the progress. For each dependent, the **Status** column shows the state of its last update, such as Queued, Running, Complete, or Failed. Failed, Completed With Errors, and Completed Not Run show in red. + +The **Rotate** button on the **Credentials** page doesn't rotate an account that has dependents. Rotate a service account from this dialog so that its dependents are updated. + +The **Dependents** count on the **Credentials** page leaves out services and scheduled tasks that a later host scan found removed, and services on resources that were deleted from Privilege Secure. Deleting a resource removes its managed-resource record, so its services leave the count at the next scan. If a removed dependent still appears, run a host scan on its resource from the **Resources** tab. + +## Roll back a rotation + +Select **Rollback** to return the account to its previous password. Privilege Secure restores the most recent previous password first, then schedules an update for each dependent so that they use it again, the same way as a rotation. Select **Cancel** to stop a rollback that's in progress. + +For how the account types differ, see [Password rotation methods](/docs/privilegesecure/26.07/admin/credentials/rotation-methods.md). diff --git a/docs/privilegesecure/26.07/admin/overview.md b/docs/privilegesecure/26.07/admin/overview.md new file mode 100644 index 0000000000..c1ae93804a --- /dev/null +++ b/docs/privilegesecure/26.07/admin/overview.md @@ -0,0 +1,41 @@ +--- +title: "Administration overview" +description: "Find the Privilege Secure administrator tasks for sessions, users, roles, credentials, auditing, and service health, and the pages that cover each one." +sidebar_position: 10 +--- + +# Administration overview + +Administrators run Netwrix Privilege Secure day to day. They watch and control sessions, decide who can sign in to the console, delegate responsibilities through roles, keep credentials rotating, review the audit trail, and check that the services are healthy. + +This section assumes you have installed the product and signed in to the console at `https://:6500` for the first time. See [Sign in to the console](/docs/privilegesecure/26.07/user-guide/sign-in.md). + +## Roles and permissions + +The built-in roles are Administrators, Users, Reviewers, and Auditors. You can assign a person more than one role, and the permissions are cumulative. If one of the roles is Administrator, you don't need to add an Auditors role, because administrators can already see all session history. + +The product has no Approver role. The approvers for a session request are the users and groups named in an approval tier of the connection profile. See [Approval workflows](/docs/privilegesecure/26.07/configuration/access-policies/approval-workflows.md). + +**Admin View Read Only** is a permission that lets auditors see the console without changing anything. See [Give auditors read-only console access](/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md). + +For the full list of roles and what each can do, see [Roles and permissions](/docs/privilegesecure/26.07/admin/roles/roles.md). + +## Administrative tasks + +| Task | Where to start | +| --- | --- | +| Watch, lock, or end sessions in progress, and review past sessions | [Dashboard](/docs/privilegesecure/26.07/admin/sessions/dashboard.md) | +| Add users and groups, create local and application users, and check license use | [Users and groups](/docs/privilegesecure/26.07/admin/users-groups/users-groups.md) | +| Assign built-in roles or create a custom role | [Roles and permissions](/docs/privilegesecure/26.07/admin/roles/roles.md) | +| Manage, rotate, and verify credentials | [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md) | +| Review the activity log, events, change history, log files, and reports | [Auditing and reporting overview](/docs/privilegesecure/26.07/admin/audit-reporting/audit-reporting.md) | +| Check service health and scheduled system jobs | [Monitor service nodes](/docs/privilegesecure/26.07/admin/service-nodes/service-nodes.md) | +| Add and maintain servers, domains, websites, and other resources | [Resources](/docs/privilegesecure/26.07/resources/overview.md) | +| Manage the Remote Access Gateway for sessions from outside the network | [Remote Access Gateway overview](/docs/privilegesecure/26.07/remote-access-gateway/overview.md) | + +## Daily policy maintenance + +Access policies and activities control what users can do. You set them up once and then adjust them as needs change. Maintain them on these pages: + +- [Access policies](/docs/privilegesecure/26.07/configuration/access-policies/overview.md) +- [Activities](/docs/privilegesecure/26.07/configuration/activities/activities.md) diff --git a/docs/privilegesecure/26.07/admin/roles/_category_.json b/docs/privilegesecure/26.07/admin/roles/_category_.json new file mode 100644 index 0000000000..d8161e03bd --- /dev/null +++ b/docs/privilegesecure/26.07/admin/roles/_category_.json @@ -0,0 +1,10 @@ +{ + "label": "Roles", + "position": 40, + "collapsed": true, + "collapsible": true, + "link": { + "type": "doc", + "id": "roles" + } +} diff --git a/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md b/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md new file mode 100644 index 0000000000..0e0487b32b --- /dev/null +++ b/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md @@ -0,0 +1,76 @@ +--- +title: "Give auditors read-only console access" +description: "Let auditors see every Privilege Secure administration page without changing anything by assigning the Admin View Read Only permission." +sidebar_position: 40 +--- + +# Give auditors read-only console access + +**Admin View Read Only** is a permission. It appears in the permission list of the Auditors target, next to **Reporting**. A user who holds it sees every administration page in the console but can't change anything. Use it for auditors who need to inspect the configuration, sessions, and reports without any risk of changing them. + +## How it behaves + +- The user sees the same administration pages as an Administrator, including **Users & Groups**, **Resources**, **System Settings**, and **Auditing & Reporting**. +- The console shows the banner "You are in read-only mode. Changes are not permitted." Buttons that change data are disabled, and their tooltip reads "Not available in read-only mode". If a change reaches the server anyway, the server refuses it with the error "This account has read-only access and cannot perform write operations." (HTTP 403). +- The permission takes precedence over the Administrator role. A person who holds both the Administrator role and **Admin View Read Only** gets read-only access. +- The **Log Files** page doesn't show the **Options** (gear) icon. + +:::warning +Don't give **Admin View Read Only** to an Administrator who needs to make changes. The permission overrides the Administrator role. +::: + +### What a read-only user can still do + +Privilege Secure blocks every change request (create, update, and delete) from a read-only user, except for these actions, which auditors need. Requests that only read data stay open. + +- Register for multi-factor authentication (MFA). +- Lock or terminate a live session, and replay a recorded session, within the scope of the role. See [Watch, lock, or terminate a live session](/docs/privilegesecure/26.07/admin/sessions/live-session-viewer.md) and [Replay a recorded session](/docs/privilegesecure/26.07/admin/sessions/replay-viewer.md). +- Create, save, delete, run, favorite, and subscribe to reports, and send a report to a subscriber. See [Reports and subscriptions](/docs/privilegesecure/26.07/admin/audit-reporting/reports.md). +- Download reports and exports. + +## Prerequisites + +- You're signed in as an Administrator. +- The auditors are on the **Users & Groups** page. See [Add domain users and groups](/docs/privilegesecure/26.07/admin/users-groups/add-users-groups.md). + +## Assign the permission + +You can add **Admin View Read Only** to the built-in Auditors role or to a custom role with the Auditors target. Use a custom role. The built-in Auditors role applies to everyone who holds it, so adding the permission there makes all of those users read-only. + +1. In the left navigation, select **Users & Groups** > **Role Management**. +2. Select **+** (**Add Role**). +3. In **Enter Role Name**, enter a name, for example `Read-only auditors`. +4. Set **Target** to **Auditors**, and select **Save**. +5. In **Permission Assignment**, select **Admin View Read Only** and move it to the assigned column. Privilege Secure adds **Reporting** automatically. +6. Select the **Users** tab, and then select **All Users**, or add the users whose sessions the auditors can see. +7. Select the **Resources** tab, and then select **All Resources**, or add the resources the auditors can see. +8. Select **Add Role Users**, choose the auditors, and select **Add**. + +Read-only users still need session scope. Without **All Users** and **All Resources**, they see only the sessions of the users and resources you add on the **Users** and **Resources** tabs. + +![The Permission Assignment list of the Auditors role, which includes Admin View Read Only and Reporting.](/images/privilegesecure/26.07/admin/admin-view-read-only-permissions.webp) + +If you later remove **Reporting**, Privilege Secure also removes **Admin View Read Only**. + +Hover over **Admin View Read Only** to see this tooltip: *"Admin View Read Only" may overrule permissions granted by other custom roles assigned to the same user.* + +Privilege Secure locks a permission in two cases and explains why in its tooltip. The tooltips still use the former permission name, "Auditing and Reporting", for **Reporting**: + +- When you select **Reporting** for removal, **Admin View Read Only** is locked with this tooltip: *"Admin View Read Only" will be removed automatically because it requires "Auditing and Reporting".* +- While **Admin View Read Only** is selected to be added, **Reporting** is locked with this tooltip: *"Auditing and Reporting" is required by "Admin View Read Only".* + +## Example: read-only access for the compliance team + +Give the compliance team a view of all sessions and settings, with no ability to change them. + +1. Create the role `Compliance read-only` with **Target** set to **Auditors**. +2. Assign **Admin View Read Only**. **Reporting** is added with it. +3. On **Users**, select **All Users**. On **Resources**, select **All Resources**. +4. Add the compliance team group with **Add Role Users**. + +When a team member signs in, the read-only banner appears at the top of the console. + +## Related topics + +- [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md) +- [Auditing and reporting overview](/docs/privilegesecure/26.07/admin/audit-reporting/audit-reporting.md) diff --git a/docs/privilegesecure/26.07/admin/roles/assign-roles.md b/docs/privilegesecure/26.07/admin/roles/assign-roles.md new file mode 100644 index 0000000000..aaada9d677 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/roles/assign-roles.md @@ -0,0 +1,78 @@ +--- +title: "Assign administrators, reviewers, and auditors" +description: "Give a user or group the Administrator, Reviewer, or Auditors role in Privilege Secure from the Role Management page or the account's details page." +sidebar_position: 20 +--- + +# Assign administrators, reviewers, and auditors + +Assign a built-in role to give a user or group the matching access to the console. You can start from the role, or from the account. The result is the same. + +Only accounts that are already on the **Users & Groups** page can receive a role. To add accounts first, see [Add domain users and groups](/docs/privilegesecure/26.07/admin/users-groups/add-users-groups.md). For what each role grants, see [Roles and permissions](/docs/privilegesecure/26.07/admin/roles/roles.md). + +When you assign a role to a group or a collection, every member of the group or collection receives it. + +## Assign a role from Role Management + +1. In the left navigation, click **Users & Groups**, then **Role Management**. +2. In the role list, select **Administrators**, **Reviewers**, or **Auditors**. +3. Add the accounts. + - For **Administrators**, click **Add User** to open the **Add Administrators** window. + - For **Reviewers**, click **Add User** to open the **Add Reviewers** window. + - For **Auditors**, click **Add Role Users** at the bottom of the page to open the **Add Role Users** window. +4. Select each account in the left list (**Available Accounts**, or **Available Role Users** for Auditors) to move it to the right list. +5. Click **Add**. + +The accounts appear in the member list of the role. + +![The Add Administrators window with a search for NPS and the NPS Approvers group in Accounts to Add.](/images/privilegesecure/26.07/admin/role-add-members-window.webp) + +In these windows, **Filter** limits the list to users, groups, applications, collections, or local users. The columns are the account type, name, user name, email address, and last login. + +### Example + +To make the members of `` administrators: + +1. Select **Administrators** in the role list. +2. Click **Add User**. +3. Select `` in **Available Accounts**. +4. Click **Add**. + +Every member of the group now has the Administrator role, and the group appears in the **Administrators** list. + +:::note +For an Auditors role, the members see only the sessions in the role's scope. Set the scope before you add members. See [Roles and permissions](/docs/privilegesecure/26.07/admin/roles/roles.md#scope-of-an-auditors-role). +::: + +## Assign a role from an account + +1. In the left navigation, click **Users & Groups**. +2. Click the name of the user or group to open its details page. +3. Click the **User Roles** tab for a user, or the **Group Roles** tab for a group. +4. Click **Add** to open the **Add Roles** window. +5. Select one or more roles. The list shows **Administrator**, **Reviewer**, and every custom role, including **Auditors**, that the account doesn't already hold. +6. Click **Add**. + +The role appears on the tab with its **ROLE**, **DESCRIPTION**, and **CREATED** values. + +The **Users** role isn't assignable here. + +### Example + +To make a user a reviewer, open the user's details page, click the **User Roles** tab, click **Add**, select **Reviewer**, and click **Add**. The user can then review access. See [Run an access certification](/docs/privilegesecure/26.07/admin/audit-reporting/access-certification.md). + +## Remove a role + +1. Open the role in **Role Management**, or open the account's **User Roles** or **Group Roles** tab. +2. Select the accounts or roles to remove. +3. Click **Remove**. + +A confirmation window lists the roles or accounts you selected. Confirm to remove them. The accounts leave the role. + +Removing an account from the Administrators or Reviewers role takes effect at the user's next sign-in or token renewal, not at the moment you click **Remove**. Auditors and custom-role permissions are checked on each request, so removing those roles takes effect at once. + +The console doesn't let you remove yourself from the **Administrators** role. **Remove** is disabled when you select your own account, or a group that you belong to, for that role. Its tooltip reads "Admins can't remove themselves from the admin role." or "Admins can't remove groups they're in from the admin role." This applies to the **Administrators** role only. + +## Custom roles + +Create a custom role and add its members from **Role Management**. See [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md). diff --git a/docs/privilegesecure/26.07/admin/roles/custom-roles.md b/docs/privilegesecure/26.07/admin/roles/custom-roles.md new file mode 100644 index 0000000000..d90a716163 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/roles/custom-roles.md @@ -0,0 +1,137 @@ +--- +title: "Create a custom role" +description: "Create a custom role that delegates part of Privilege Secure administration, choose its permissions, scope it to entities, and assign users to it." +sidebar_position: 30 +--- + +# Create a custom role + +A custom role delegates part of administration to people who aren't Administrators. Each custom role has one **Target** that decides which permissions it offers: + +| Target | Delegates | Typical use | +| --- | --- | --- | +| **Access Policies** | Changes to selected parts of selected access policies | A team lead who maintains the policies for one group of servers | +| **Credentials** | Managing, verifying, and rotating selected credentials | A team that owns a set of service accounts | +| **Auditors** | Viewing recordings and live sessions for selected users and resources, and running reports | An audit team that reviews one business unit | + +A custom role grants only the permissions you assign, and only over the entities you add to it. For the built-in roles and how to assign them, see [Roles and permissions](/docs/privilegesecure/26.07/admin/roles/roles.md) and [Assign administrators, reviewers, and auditors](/docs/privilegesecure/26.07/admin/roles/assign-roles.md). + +## Prerequisites + +- You're signed in as an Administrator. +- The users or groups that will receive the role are already on the **Users & Groups** page. See [Add domain users and groups](/docs/privilegesecure/26.07/admin/users-groups/add-users-groups.md). + +## Create a custom role + +1. In the left navigation, select **Users & Groups** > **Role Management**. +2. Select **+** (**Add Role**). +3. In **Enter Role Name**, enter a name, for example `Policy editors`. +4. (Optional) Enter a **Description**, for example `Maintains the access policies for the finance servers`. +5. In the **Target** dropdown, select **Access Policies**, **Credentials**, or **Auditors**. +6. Click **Save**. + +The new role appears in the role list. Select it to assign permissions, scope it, and add users. + +![The new role form with the Role Name, Description, and Target fields, with Target set to Access Policies.](/images/privilegesecure/26.07/admin/role-new-form.webp) + +The role list shows copy and delete icons beside each role. They're enabled only for custom roles. The copy icon clones the role with its permissions, scope, and members. + +## Assign permissions + +The **Permission Assignment** section is a two-column list. Permissions on the left aren't assigned to the role. Permissions on the right are. Select a permission and use the arrows to move it between the columns. + +Changes save as soon as you move a permission. There is no **Save** button. + +### Access Policies permissions + +Each permission lets a role member change one part of a policy. + +| Permission | Lets the member | +| --- | --- | +| **Modify Name** | Change the policy name | +| **Modify Description** | Change the policy description | +| **Modify Connection Profile** | Change the connection profile of the policy | +| **Modify Activities** | Change the activities in the policy. Turns on the **Activities** tab. | +| **Modify Users** | Change the users and groups in the policy. Turns on the **Users** tab. | +| **Modify Resources** | Change the resources in the policy. Turns on the **Resources** tab. | + +For how these permissions work in a policy, see [Access policies](/docs/privilegesecure/26.07/configuration/access-policies/overview.md). + +### Credentials permissions + +| Permission | Lets the member | +| --- | --- | +| **Manage** | Put an account and its credentials under Privilege Secure control | +| **Unmanage** | Remove an account and its credentials from Privilege Secure control | +| **View Password** | See the credential | +| **Schedule Rotation** | Rotate the credential from the **Credentials** page with **Rotate** | +| **Verify** | Check that the stored credential still works | +| **Rotate Services** | Open the **Account Dependencies** dialog of a service account, and rotate, roll back, or cancel a rotation there so the Windows services and scheduled tasks that run as the account receive the new password | + +**Rotate Services** doesn't control the **Rotate** button on the **Credentials** page. That button needs **Schedule Rotation**. + +For the credential tasks themselves, see [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md). + +### Auditors permissions + +| Permission | Lets the member | Depends on | +| --- | --- | --- | +| **View Recordings** | Review recordings of historical sessions for the assigned users and resources | | +| **Live Session Viewer** | Watch live sessions for the assigned users and resources | | +| **Terminate Session** | Stop a live session. The user can start a new session. | **Live Session Viewer** | +| **Lock Session** | Lock a live session so the user can't work, and optionally block new sessions | **Live Session Viewer** | +| **Reporting** | Create, change, delete, and run reports | | +| **Admin View Read Only** | See every administration page without changing anything | **Reporting** (added automatically) | + +**Terminate Session** and **Lock Session** stay disabled until **Live Session Viewer** is assigned. For the viewer, see [Watch, lock, or terminate a live session](/docs/privilegesecure/26.07/admin/sessions/live-session-viewer.md). For **Admin View Read Only**, see [Give auditors read-only console access](/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md). + +## Scope the role + +A role member can use a permission only on the entities you add to the role. + +### Access Policies role + +Select the **Policies** tab, then select **Add Policies** and choose the policies the role can change. The tab has **Search**, **Remove**, and **Refresh** buttons. The table shows **Name** and **Description**. Select a name to open the policy. + +The **Activities**, **Users**, and **Resources** tabs appear when you assign **Modify Activities**, **Modify Users**, or **Modify Resources**. Use them to limit which activities, users, and resources the member can change in those policies. + +On each tab, select **Add Users**, **Add Activities**, or **Add Resources** to open the **Add Users And Groups**, **Add Activities And Groups**, or **Add Resources And Groups** window. Or select **All Users**, **All Activities**, or **All Resources** to cover every entity of that type. While that checkbox is selected, the add and **Remove** buttons are disabled. + +### Credentials role + +Select the **Credentials** tab to add the credentials the role manages. The tab has **Search**, **Type**, **Remove**, and **Refresh** controls. The table shows **Type**, **Name**, and **Resource**. The **Resource** column shows the resource the credential belongs to, if any. + +### Auditors role + +An Auditors role has two scope tabs, **Users** and **Resources**. The tab description reads "Select access to live sessions and historical recordings." + +- On **Users**, select **Add Users** to choose the users whose sessions the auditor can see, or select the **All Users** checkbox. +- On **Resources**, select **Add Resources** to choose the resources, or groups of resources, whose sessions the auditor can see, or select the **All Resources** checkbox. The table shows **Type**, **Name**, and **Operating System**. + +A session is in scope only when both its user and its resource are covered, either by an entry you added or by the **All Users** or **All Resources** checkbox. For example, a role with one user added and **All Resources** selected covers every session of that user, on any resource. When a member holds more than one Auditors role, the scopes add together. Members always see their own sessions. + +## Add users to the role + +The **Role Users** table at the bottom of the role page lists the accounts that hold the role. + +1. Select **Add Role Users**. The **Add Users and Groups** window opens. +2. Search for or filter to the accounts you want, and select them. +3. Click **Add**. + +The toolbar has **Search**, a **Type** filter, **Remove**, and **Refresh**. **Type** filters by **User**, **Group**, **Application**, **Collection**, and **Local User**. The table columns are **Type**, **Name**, **User Name**, **User Principal Name**, **Email**, and **Last Login**. You can resize and sort the columns. + +To remove a person from the role, select the row and select **Remove**. + +You can also assign a custom role from a user's details page. See [Assign administrators, reviewers, and auditors](/docs/privilegesecure/26.07/admin/roles/assign-roles.md). + +## Example: an audit team for one business unit + +Create a role that lets the finance audit team watch live sessions and replay recordings for the finance servers. + +1. Create a role named `Finance auditors` with **Target** set to **Auditors**. +2. Assign **View Recordings** and **Live Session Viewer**. +3. On **Resources**, add the resource group that holds the finance servers. +4. On **Users**, select **All Users**. +5. Select **Add Role Users** and add the audit team group. + +Members of the group can watch and replay sessions on the finance servers. diff --git a/docs/privilegesecure/26.07/admin/roles/roles.md b/docs/privilegesecure/26.07/admin/roles/roles.md new file mode 100644 index 0000000000..2ec792d3e0 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/roles/roles.md @@ -0,0 +1,82 @@ +--- +title: "Roles and permissions" +description: "Learn which built-in roles Netwrix Privilege Secure provides, what each role can do, and which permissions a custom role can include." +sidebar_position: 10 +--- + +# Roles and permissions + +A role controls what a user can see and do in the console. Netwrix Privilege Secure has four built-in roles. You can add custom roles to delegate part of administration. + +Open the page from the left navigation: click **Users & Groups**, then **Role Management**. + +![The Role Management page with the role list on the left and the members of the Administrators role on the right.](/images/privilegesecure/26.07/admin/roles-role-management.webp) + +## Built-in roles + +| Role | What it grants | +| --- | --- | +| **Administrators** | Access to every configuration option in the console. | +| **Users** | The ability to request and start sessions under the access policies that include the user. The role is assigned when you add the user to the console. | +| **Reviewers** | The ability to review access entitlements. See [Run an access certification](/docs/privilegesecure/26.07/admin/audit-reporting/access-certification.md). | +| **Auditors** | The permissions on the **Permission Assignment** list: for example, watching live sessions, viewing recordings of historical sessions, and running reports. | + +The description of the Auditors role in the console reads "Auditors have permissions to view the Historical Sessions of other users." + +The **Users** role isn't offered in the **Add Roles** window. The console assigns it, and you can't add it by hand. See [Assign administrators, reviewers, and auditors](/docs/privilegesecure/26.07/admin/roles/assign-roles.md). + +An account can have more than one role. To see who holds a role, select the role in the list. + +You can't copy, delete, or rename the built-in roles (**Administrators**, **Users**, **Reviewers**, and **Auditors**) or change their descriptions. The copy and delete icons are disabled for them, and the server refuses to copy a built-in role. The one exception is the **Auditors** role, whose **Permission Assignment** list you can edit. + +### Approvers + +There is no Approver role. Approvers are the users and groups that you name in a tier of an approval workflow on a connection profile. See [Approval workflows](/docs/privilegesecure/26.07/configuration/access-policies/approval-workflows.md). + +## Role list + +The role list on the left has a **Search Roles...** box and a **+** button (**Add Role**) that creates a custom role. The copy and delete icons appear beside each role. They're enabled only for custom roles. The copy icon clones the role with its permissions, scope, and members, and the trash can icon deletes it after you confirm. To create custom roles, see [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md). + +For the **Administrators** and **Reviewers** roles, the member list has these controls: + +| Control | What it does | +| --- | --- | +| **Search** and **Type** filter | Find members by text or by account type. | +| **Add User** | Opens a window to add members. | +| **Remove** | Takes the selected members out of the role. | + +The columns are **TYPE**, **NAME**, **USER NAME**, **EMAIL**, and **LAST LOGIN**. + +The **Users** role lists every licensed user and shows the same filters and the license counter as the **Users & Groups** page. See [Users and groups](/docs/privilegesecure/26.07/admin/users-groups/users-groups.md). + +## Permission reference + +Custom roles and the **Auditors** role are built from permissions. A role has one target, and the target decides which permissions the role can hold. + +| Target | Permission | What it allows | +| --- | --- | --- | +| Auditors | **View Recordings** | Review recorded sessions of the users and resources assigned to the role. | +| Auditors | **Live Session Viewer** | Watch sessions in progress. | +| Auditors | **Terminate Session** | End a live session. Requires **Live Session Viewer**. | +| Auditors | **Lock Session** | Lock a live session. Requires **Live Session Viewer**. | +| Auditors | **Reporting** | Create, change, delete, and run reports. | +| Auditors | **Admin View Read Only** | Open every administration page without the ability to change settings. See [Give auditors read-only console access](/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md). | +| Access Policies | **Modify Name**, **Modify Description**, **Modify Connection Profile**, **Modify Activities**, **Modify Users**, **Modify Resources** | Change the named part of an access policy. | +| Credentials | **Manage**, **Unmanage**, **Schedule Rotation**, **Verify**, **View Password**, **Rotate Services** | Perform the named action on credentials. | + +Two rules apply when you edit the **Permission Assignment** list for an Auditors role: + +- **Terminate Session** and **Lock Session** stay disabled until **Live Session Viewer** is on the role. +- Adding **Admin View Read Only** also adds **Reporting**. Removing **Reporting** also removes **Admin View Read Only**. + +### Scope of an Auditors role + +An Auditors role also has a scope that decides whose sessions its members can watch and replay. The **Users** tab and the **Resources** tab each have an **All Users** or **All Resources** checkbox. When the checkbox is selected, the role covers everyone. Otherwise, add the users or resources that the role covers. + +To use scope in practice, give the built-in **Auditors** role access to all users and resources, and add custom Auditors roles for narrower groups. See [Create a custom role](/docs/privilegesecure/26.07/admin/roles/custom-roles.md). + +## Read-only console access + +The **Admin View Read Only** permission lets an auditor open the administration pages without changing anything. It is a permission. Add it to a role with the Auditors target. See [Give auditors read-only console access](/docs/privilegesecure/26.07/admin/roles/admin-view-read-only.md). + +A read-only user sees the banner "You are in read-only mode. Changes are not permitted." Only a few actions stay available, such as running reports, replaying recordings, and locking or terminating live sessions. diff --git a/docs/privilegesecure/26.07/admin/service-nodes/_category_.json b/docs/privilegesecure/26.07/admin/service-nodes/_category_.json new file mode 100644 index 0000000000..c8968d6571 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/service-nodes/_category_.json @@ -0,0 +1,10 @@ +{ + "label": "Service Nodes", + "position": 60, + "collapsed": true, + "collapsible": true, + "link": { + "type": "doc", + "id": "service-nodes" + } +} diff --git a/docs/privilegesecure/26.07/admin/service-nodes/scheduled-tasks.md b/docs/privilegesecure/26.07/admin/service-nodes/scheduled-tasks.md new file mode 100644 index 0000000000..a485d3bf27 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/service-nodes/scheduled-tasks.md @@ -0,0 +1,78 @@ +--- +title: "Scheduled tasks" +description: "See which recurring system jobs Privilege Secure runs, when each last ran and runs next, and whether each succeeded." +sidebar_position: 20 +--- + +# Scheduled tasks + +The **Scheduled Tasks** page lists the recurring jobs that Privilege Secure runs, such as host scans, password rotation and verification, and Active Directory sync. Use it to check that a job ran and whether it succeeded. + +To open it, select **Configuration** > **Scheduled Tasks**. + +![The Scheduled Tasks page with the task list, the last run time, the next run time, the recurrence, the last status, and the result count.](/images/privilegesecure/26.07/admin/scheduled-tasks-list.webp) + +## Read the list + +The toolbar has these controls: + +| Control | Description | +| --- | --- | +| **Search** | Filters the list by task name. | +| **View Logs** | Shows the log for the selected task. The button is disabled until you select a row. | +| **Refresh** | Reloads the list. | + +The toolbar shows the number of tasks. You can sort the columns. + +| Column | Description | +| --- | --- | +| **TASK NAME** | The name of the task. | +| **LAST RUN TIME** | When the task last ran. | +| **NEXT RUN TIME** | When the task runs next. | +| **RECURRENCE** | How often the task repeats. | +| **LAST STATUS** | The result of the last run. | +| **STATUS** | The state of the task. | + +**LAST STATUS** and **STATUS** use the same set of labels: Scheduled, Pending, Queued, Running, Complete, Completed With Errors, Failed, Cancelled, and Unknown. A task in any other internal state, such as paused, shows as Unknown. + +## Task names + +Task names follow patterns such as these: + +| Pattern | Task | +| --- | --- | +| `Scan host ` | Scans a host. | +| `Rotate password for ` | Rotates the password of an account. | +| `Verify password for ` | Checks that the stored password still works. | +| `Sync AD ` | Syncs a domain with Active Directory. | + +For example, `Rotate password for ` can repeat every 24 hours or every hour, depending on the schedule that applies to the account. + +## Change when a task runs + +The page is read-only. A task takes its schedule from the item that created it. To change when a task runs, change the schedule on that item: + +| Task | Where to change the schedule | +| --- | --- | +| `Scan host ` | **Scan Schedule** on the platform of the resource. | +| `Rotate password for ` | **Scheduled Change Policy** on the platform, or a credential policy override. | +| `Verify password for ` | **Verification Schedule** on the platform, or a credential policy override. | +| `Sync AD ` | The schedule row on the details page of the domain. | + +The platform schedules are schedule policies. See [Platforms](/docs/privilegesecure/26.07/resources/platforms/platforms.md), [Schedule policies](/docs/privilegesecure/26.07/resources/platforms/schedule-policies.md), [Credential policy overrides](/docs/privilegesecure/26.07/admin/credentials/policy-overrides.md), and [Active Directory domains](/docs/privilegesecure/26.07/resources/domains.md#schedule-synchronization). Protection policies run on the **Protection Policy Schedule** of the platform. + +## Check task times after a daylight saving time change + +Version 26.07.3 fixes task schedules that shifted by an hour after a daylight saving time change. + +If a task still starts an hour off after you upgrade, open the schedule that drives the task and save it again. Saving recalculates the next start time. + +## Troubleshoot a failed task + +1. Select the task. +2. Click **View Logs**. +3. Read the log lines for the last run. + +The log shows the steps the task completed. If the log has no error text, check the related page for the cause, for example the **Sync Errors** tab of a domain for an Active Directory sync. + +To check whether the services that run tasks are healthy, see [Monitor service nodes](/docs/privilegesecure/26.07/admin/service-nodes/service-nodes.md). diff --git a/docs/privilegesecure/26.07/admin/service-nodes/service-nodes.md b/docs/privilegesecure/26.07/admin/service-nodes/service-nodes.md new file mode 100644 index 0000000000..3226be1ad3 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/service-nodes/service-nodes.md @@ -0,0 +1,123 @@ +--- +title: "Monitor service nodes" +description: "Check the status of the services on each service node, read service logs and queues, and restart a Host Scan service that shows Offline." +sidebar_position: 10 +--- + +# Monitor service nodes + +A service node is a server that runs Privilege Secure services. The **Service Nodes** page shows each node, the services on it, and whether they are healthy. Use it to find a stopped service and to read what each service is doing. + +To open it, select **Configuration** > **Service Nodes**. + +The page is for monitoring and reading logs. The only settings you change here are the Email service settings. To run services on more servers, see [Install services on additional servers](/docs/privilegesecure/26.07/install/additional-services.md). + +![The Service Nodes page with a node selected, the list of services with status icons, and the Action Service selected showing the Action Logs tab.](/images/privilegesecure/26.07/admin/service-nodes-action-service.webp) + +## Read the page + +The page has three panes: + +1. The node list, with **Search Service Nodes...**. +2. The service list for the selected node, with **Search Services...**. +3. The details of the selected service. + +On the main server, the node lists six services: Action, Email, Host Scan, Proxy, Scheduler, and security information and event management (SIEM). A node lists only the services registered on that server. For example, a server that runs only the Proxy Service lists Proxy, and a server where you installed the Action Service lists Action and Proxy. + +## Understand the status icons + +Each node and each service has a status icon. Hover over an icon to see its status. + +| Icon | Status | Meaning | +| --- | --- | --- | +| Green | Online | The service is online. On a node, all services are online. | +| Amber | Partial | A node status. Some of the node's services are offline. | +| Red | Offline | The service is offline. | + +The status of a node comes from the services registered under its name. The node is **Online** when every one of those services is online, **Offline** when none is, and **Partial** when some are online and some aren't. A service is online while it keeps its connection to the console open. The tooltip on the icon shows the status name: Online, Partial, or Offline. The console refreshes the statuses every 15 seconds. + +### Fix a Host Scan service that shows Offline + +A red Host Scan service reflects the service's heartbeat to the web service. It doesn't show whether the Windows service is running. A Host Scan service can show Offline while the `SbPAMHostScan` Windows service runs. + +1. On the service node, open the Host Scan log from the **Log Files** page. See [Log files](/docs/privilegesecure/26.07/admin/audit-reporting/log-files.md). The file is `PAM-HostScanService.log`. +2. Look for repeated lines that start with "Heartbeat unable to connect". They show that the heartbeat fails. +3. Search all `PAM-HostScanService*.log` files for `RemoteCertificate`. The repeated warning hides the inner exception, which is logged only occasionally. A certificate name mismatch on the console port (6500 by default) means the certificate doesn't cover the name the heartbeat uses. +4. If the certificate doesn't cover the name, reissue the certificate, bind it, and then register the services with the new DNS name. See [Certificates](/docs/privilegesecure/26.07/configuration/certificates.md). +5. On the service node, open **Services** and restart the `SbPAMHostScan` Windows service. + +The **Register Services** action might not restart the Host Scan service, so restart `SbPAMHostScan` yourself. + +"Heartbeat unable to connect" means that the service's web request to the console failed. The text after the colon is the underlying error. The service tries again every 5 seconds, and the status returns to online when a request succeeds. To fix it, ensure that the console address the service uses is correct and reachable from the node. Also ensure that the certificate on that address covers the name in the address. See [Set the NPS REST URL and register services](/docs/privilegesecure/26.07/configuration/system-settings/services-url.md). + +To reissue the certificate, see [Certificates](/docs/privilegesecure/26.07/configuration/certificates.md). After you bind the certificate and register the services with the new DNS name, the node returns to online when the heartbeat succeeds. + +### Show a secondary node in a high availability deployment + +After an upgrade, a secondary node in a high availability deployment might not appear in the primary console. Sign in to the console on the secondary server and register the services there. See [Set the NPS REST URL and register services](/docs/privilegesecure/26.07/configuration/system-settings/services-url.md) and [High availability options](/docs/privilegesecure/26.07/install/high-availability.md). + +## Action Service + +The Action Service runs the actions that other features queue, such as password rotation and Active Directory sync. It has two tabs: + +| Tab | Description | +| --- | --- | +| **Action Logs** | The actions the service processed. | +| **Action Queue** | The actions waiting to run. | + +Both tables have **Search**, **View Logs**, and **Refresh**. **View Logs** is disabled until you select a row. The columns are **NAME**, **RESOURCE**, **USER**, **STATUS**, **START TIME**, and **END TIME**. **STATUS** shows Complete or Failed. + +## Email Service + +The Email Service sends notifications. It has an **Email Settings** tab and an **Email Queue** tab. For the settings, see [Configure email notifications](/docs/privilegesecure/26.07/configuration/system-settings/email.md). + +The **Email Queue** tab shows the outgoing messages. **Search** matches the **To Address** and **Subject** columns. + +## Host Scan Service + +The Host Scan Service collects information from resources. It has these tabs: + +| Tab | Description | +| --- | --- | +| **Scan Logs** | The scans that ran, with their status. | +| **Scan Queue** | The scans waiting to run. | + +The columns match the Action Service tables. Select a row and click **View Logs** to read the detailed log for that scan. + +## Proxy Service + +The Proxy Service page has no tabs. It shows a **Name** and **Value** table of properties for the proxy on the node. The properties are GoMaxProcs, HasInternetAccess, ComputerName, FullyQualifiedDomainName, NodeID, RegionID, OperatingSystem, GoVersion, RunAsAccount, ProxyServiceVersion, RegionHash, and NumCPU. + +## Scheduler Service + +The Scheduler Service starts the scheduled jobs. It has these tabs: + +| Tab | Description | +| --- | --- | +| **Statistics** | The number of actions in each status. | +| **Action Queues** | The scheduled jobs and their queue status. | + +The **Statistics** tab shows the heading "Action Statuses Last Updated" with a time, and one tile for each status: Unknown, Pending, Queued, Running, Complete, Failed, Cancelled, Completed With Errors, and Completed Not Run. + +The counts cover the actions that changed in the past 24 hours. + +![The Scheduler Service Statistics tab showing status tiles for Unknown, Pending, Queued, Running, Complete, Failed, Cancelled, Completed With Errors, and Completed Not Run actions.](/images/privilegesecure/26.07/admin/service-nodes-scheduler-statistics.webp) + +The **Action Queues** tab has **Search** and **Refresh**. The columns are **START TIME**, **END TIME**, **JOB NAME**, **AQ STATUS**, **AQ STATUS DESCRIPTION**, and **ACTIVITY STATUS**. + +For the list of scheduled jobs, see [Scheduled tasks](/docs/privilegesecure/26.07/admin/service-nodes/scheduled-tasks.md). + +## SIEM Service + +The SIEM Service page has no tabs. It lists the events queued for your SIEM servers. It has **Search** on the message, a **Status** filter, and **Refresh**. The **Status** filter offers All, Sent, and Not Sent. + +| Column | Description | +| --- | --- | +| **SENT TIME** | When the service processed the event. | +| **SENT** | Whether the service sent the message. | +| **MESSAGE** | The SIEM event. | +| **SIEM HOST** | The SIEM server the event goes to. | +| **RESOURCE** | The related resource, if any. | +| **ACCOUNT** | The related account, if any. | +| **ACTIVITY** | The related activity, if any. | +| **USER NAME** | The related user name, if any. | diff --git a/docs/privilegesecure/26.07/admin/sessions/_category_.json b/docs/privilegesecure/26.07/admin/sessions/_category_.json new file mode 100644 index 0000000000..7c42049fe7 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/sessions/_category_.json @@ -0,0 +1,10 @@ +{ + "label": "Sessions", + "position": 20, + "collapsed": true, + "collapsible": true, + "link": { + "type": "doc", + "id": "dashboard" + } +} diff --git a/docs/privilegesecure/26.07/admin/sessions/active-sessions.md b/docs/privilegesecure/26.07/admin/sessions/active-sessions.md new file mode 100644 index 0000000000..c340096d76 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/sessions/active-sessions.md @@ -0,0 +1,114 @@ +--- +title: "Manage active and scheduled sessions" +description: "End, lock, unlock, and inspect Privilege Secure sessions in progress, and find sessions scheduled to start later, from the Active and Scheduled tiles." +sidebar_position: 20 +--- + +# Manage active and scheduled sessions + +The **Active** tile lists sessions that are provisioning, available, or in progress. The **Scheduled** tile lists sessions set to start later. From these tables you can create, end, lock, unlock, and inspect sessions. + +To open them, select **Dashboard** in the left navigation, then select the **Active** or **Scheduled** tile. For an overview of all tiles, see [Dashboard](/docs/privilegesecure/26.07/admin/sessions/dashboard.md). + +## Active tab + +### Tabs and filters + +The **Active** tile has two tabs: + +- **All Active** (the default) shows sessions for all users. +- **Mine** shows sessions for the signed-in user. + +The filters are **Search**, **Resource name**, **User name**, and **Recording data**. The **Mine** tab has no **User name** filter. The **Recording data** filter works on keystroke data and, when the Remote Desktop Monitor is installed on the target hosts, on Windows event activity from RDP sessions. See [Install the Remote Desktop Monitor on target hosts](/docs/privilegesecure/26.07/install/rdp-monitor.md). + +### Toolbar + +| Button | What it does | +| --- | --- | +| **Create Session** | Opens the **Activity Request** dialog. See [Request a session](/docs/privilegesecure/26.07/user-guide/request-session.md). | +| **End Session** | Cancels the selected sessions. You need the Terminate Session permission. | +| **View Logs** | Opens the session logs for the selected session. See [View session logs](/docs/privilegesecure/26.07/admin/sessions/session-logs.md). | +| **Lock Activity** | Opens the lock dialog for the selected session. You need the Lock Session permission. | +| **Unlock Activity** | Unlocks the selected session. Administrators can unlock any session. Auditors and read-only users need the Lock Session permission. | + +All buttons except **Create Session** stay disabled until you select a row. **Refresh** reloads the table. + +### Columns + +| Column | Shows | +| --- | --- | +| Checkbox | Selects the row. | +| **STATUS** | The state of the session. See [Session statuses](#session-statuses). | +| **REQUESTED** | When the session was created. | +| **REQUESTED BY** | The user who requested the session. Select the name to open the user's details. | +| **HOST** | The resource the activity runs on. Select the name to open the resource's details. | +| **LOGIN ACCOUNT** | The account used to sign in to the resource. | +| **ACTIVITY** | The name of the activity. Select the name to see its details. | +| **START** | When the activity's actions began running. This isn't the time the user signed in to the resource. | +| **END** | When the session is scheduled to end: the start time plus the maximum session duration set in the access policy's connection profile. | +| **NOTES** | Notes the requester entered. | +| **TICKET NUMBER** | The ticket number the requester entered. | + +Select the expand icon on a row to show more about the session. The expanded row has the live session viewer for a session in progress, and a replay viewer when a recording is available. If the user signed in more than once, the row lists one recording for each sign-in. See [Watch, lock, or terminate a live session](/docs/privilegesecure/26.07/admin/sessions/live-session-viewer.md) and [Replay a recorded session](/docs/privilegesecure/26.07/admin/sessions/replay-viewer.md). + +## Scheduled tab + +The **Scheduled** tile has no tabs and one filter, **Search**. The toolbar has only **Create Session** and **End Session**. The columns are the same as on the **Active** tab. A scheduled session has the status **Pending** until its start time. + +## Session statuses + +The **Status** column uses these values on both tiles: + +| Status | Meaning | +| --- | --- | +| **Provisioning** | Privilege Secure is assigning permissions to the login account before the session. | +| **Pending** | The scheduled start time is still in the future. Scheduled tab only. | +| **Waiting for approval** | The session needs approval before it can begin. | +| **Available** | The session is ready. The user can start it or sign in through a client. | +| **Failed** | The provisioning stage encountered an error. | +| **Logged In** | The user is signed in to the resource, either directly or through the proxy. Privilege Secure detects a direct sign-in by polling the resource at regular intervals, so the status can lag. | +| **Deprovisioning** | The session expired, the user or an administrator ended it, or a pre-session action failed. Privilege Secure is running the activity's post-session actions. | +| **Locked** | An administrator locked the session. | + +When an approver denies a request or the approval fails, the session moves to the **Historical** tile. + +## End a session + +End a session to cancel it before its scheduled end time. + +1. Open the **Active** or **Scheduled** tile. +2. Select the checkbox for each session to end. +3. Select **End Session**. + +The status of each selected session changes to **Deprovisioning**. When the session ends, it moves to the **Historical** tile. + +For example, to stop a contractor's session that is still running after the change window, select its row on the **Active** tile and select **End Session**. The status changes to **Deprovisioning**. + +If you don't have the Terminate Session permission, the console shows "You need 'Terminate Session' permission to end sessions". + +:::note +If the session has a ServiceNow ticket, the console asks "End Session - How should the ServiceNow ticket be updated?" Choose **Keep In Progress**, **On Hold**, or **Resolved**. The prompt links to the ticket. For setup, see [Use ServiceNow tickets with sessions](/docs/privilegesecure/26.07/user-guide/servicenow-tickets.md). +::: + +## Lock a session + +Lock a session when you see suspicious or unauthorized activity. A locked session stays active, but the user can't work on the host. + +1. Open the **Active** tile. +2. Select the session. +3. Select **Lock Activity**. +4. Enter a lock title and message. The user sees them in their RDP or SSH client. +5. Choose what to prevent the user from doing, and select **Okay**. + +The status of the session changes to **Locked**. For the dialog options, see [Watch, lock, or terminate a live session](/docs/privilegesecure/26.07/admin/sessions/live-session-viewer.md). + +To unlock a session, select it, and then select **Unlock Activity**. Administrators can unlock any session. Auditors and read-only users need the **Lock Session** permission. The console shows "Session successfully unlocked.", the lock icon leaves the status column, and the row shows its normal status again, for example **Logged In**. + +If you selected **Any further activity with this account (Unlock via Users & Groups)**, the account stays locked after you unlock the session. Unlock it on the user's details page. See [User and group details](/docs/privilegesecure/26.07/admin/users-groups/user-details.md). + +## Inspect a session + +1. Select a session, and then select **View Logs** to see what happened while the session was provisioned. +2. Select the expand icon on the row to watch the session live. + +![The Active tab with a session row selected and the toolbar enabled, showing Create Session, End Session, View Logs, and Lock Activity.](/images/privilegesecure/26.07/admin/active-session-selected.webp) diff --git a/docs/privilegesecure/26.07/admin/sessions/dashboard.md b/docs/privilegesecure/26.07/admin/sessions/dashboard.md new file mode 100644 index 0000000000..a83bdebaf5 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/sessions/dashboard.md @@ -0,0 +1,59 @@ +--- +title: "Dashboard" +description: "Find what each Privilege Secure Dashboard tile shows, who sees it, and where to manage sessions, approvals, users, resources, and credentials." +sidebar_position: 10 +--- + +# Dashboard + +The **Dashboard** is the console's page for managing sessions. A row of tiles at the top shows live counts, and each tile opens a table of the matching items. Use the session tiles to follow requests from approval to completion. Use the **Users**, **Resources**, and **Credentials** tiles as shortcuts to pages you can also reach from the left navigation. + +To open the dashboard, select **Dashboard** in the left navigation. The console opens the tile you used last. + +## Tiles + +Each tile shows a count. Hover over a tile to see what the count measures, for example "pending approval" for the **Approvals** tile. + +| Tile | Shows | Details | +| --- | --- | --- | +| **Active** | Sessions that are provisioning, available, or in progress | [Manage active and scheduled sessions](/docs/privilegesecure/26.07/admin/sessions/active-sessions.md) | +| **Scheduled** | Sessions set to start at a later time | [Manage active and scheduled sessions](/docs/privilegesecure/26.07/admin/sessions/active-sessions.md) | +| **Approvals** | Session requests waiting for an approver | See [Approvals](#approvals) | +| **Historical** | Completed, canceled, and failed sessions | [Review historical sessions](/docs/privilegesecure/26.07/admin/sessions/historical-sessions.md) | +| **Users** | Users and groups that can sign in to the console | [Users and groups](/docs/privilegesecure/26.07/admin/users-groups/users-groups.md) | +| **Resources** | Resources that Privilege Secure manages | [Resources](/docs/privilegesecure/26.07/resources/overview.md) | +| **Credentials** | Managed accounts and their rotation status | [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md) | + +Every user who can open the dashboard sees **Active**, **Scheduled**, **Approvals**, and **Historical**. **Users** and **Resources** appear only for administrators. **Credentials** appears for administrators and for users whose role includes a Credentials permission. The session tile counts update as sessions change. For administrators, the **Users**, **Resources**, and **Credentials** counts also refresh every 60 seconds. + +Every table has a **Refresh** button at the top right that reloads the rows. A counter next to it shows the number of results. + +![The Dashboard tile row with the Active tile selected and an empty All Active session list below the Create Session toolbar.](/images/privilegesecure/26.07/admin/dashboard-active-tile-empty.webp) + +## Approvals + +The **Approvals** tile lists session requests that need approval before they start. Approvers are the users and groups named in an approval tier of the connection profile. See [Approval workflows](/docs/privilegesecure/26.07/configuration/access-policies/approval-workflows.md). + +The toolbar has two buttons, which stay disabled until you select a row: + +- **Approve** approves the selected sessions. +- **Deny** opens the **Deny Activity Session** dialog, where you can enter a reason for the denial. + +For the approver procedure, see [Approve or deny session requests](/docs/privilegesecure/26.07/user-guide/approve-requests.md). + +## Requester and session user columns + +The session tables name the person who started a session in two different ways: + +- The **Active**, **Scheduled**, and **Approvals** tables use the column **REQUESTED BY**. +- The **Historical** table uses the column **SESSION USER**. + +Both columns show the same person. Select a name to open that user's details. + +## Users, Resources, and Credentials tiles + +These three tiles show the same tables as the main pages, so this page doesn't repeat them. + +- **Users:** see [Users and groups](/docs/privilegesecure/26.07/admin/users-groups/users-groups.md). +- **Resources:** see [Resources](/docs/privilegesecure/26.07/resources/overview.md). +- **Credentials:** see [Credentials](/docs/privilegesecure/26.07/admin/credentials/overview.md). diff --git a/docs/privilegesecure/26.07/admin/sessions/historical-sessions.md b/docs/privilegesecure/26.07/admin/sessions/historical-sessions.md new file mode 100644 index 0000000000..9799c706b3 --- /dev/null +++ b/docs/privilegesecure/26.07/admin/sessions/historical-sessions.md @@ -0,0 +1,82 @@ +--- +title: "Review historical sessions" +description: "Find past Privilege Secure sessions by user, resource, or date, search recording data, replay recordings, and export the session list to a CSV file." +sidebar_position: 30 +--- + +# Review historical sessions + +The **Historical** tile lists every session that has ended, with its final status. Use it to find a past session, open its logs or recording, or export the list. + +To open it, select **Dashboard** in the left navigation, then select the **Historical** tile. + +## Tabs and toolbar + +The tile has two tabs: + +- **All Historical** (the default) shows sessions for all users. +- **Mine** shows sessions for the signed-in user. + +The toolbar has two buttons: + +- **Export as CSV** creates a CSV file of the table and downloads it to your browser's default download folder. The file name shows which table you exported. +- **Refresh** reloads the table. + +## Filters + +| Filter | Narrows the list by | Tab | +| --- | --- | --- | +| **Search** | Any column value. Partial matches count. | Both | +| **Resource name** | The value in the **Host** column. | Both | +| **User name** | The value in the **Session User** column. | **All Historical** | +| **User type** | The type of user: **All**, **User**, **Application**, or **Local User**. | **All Historical** | +| **Recording data** | Text in the session recordings, such as keystroke data and, when the Remote Desktop Monitor is installed, Windows event activity from RDP sessions. Enter the text to search for. Available to administrators and auditors. | Both | +| **Start date** | A start date, an end date, or both. | Both | + +Search and filters match partial strings. Within the filtered list, you can search any column, including **Login Account**, **Activity**, **Notes**, and **Ticket Number**. + +When you search recording data and open the matching recording, playback jumps to the first point where the text appears. + +For the Remote Desktop Monitor, see [Install the Remote Desktop Monitor on target hosts](/docs/privilegesecure/26.07/install/rdp-monitor.md). + +## Columns + +| Column | Shows | +| --- | --- | +| **ACTIONS** | The expand icon, the logs icon, and, on your own sessions, the quick launch icon. See [Row actions](#row-actions). | +| **REQUESTED** | When the session was created. | +| **STATUS** | The final state of the session. See [Statuses](#statuses). | +| **SESSION USER** | The user who requested the session. Select the name to open the user's details. | +| **HOST** | The resource the activity ran on. Select the name to open the resource's details. | +| **LOGIN ACCOUNT** | The account used to sign in to the resource. | +| **ACTIVITY** | The name of the activity. Select the name to see its details. | +| **START** | When the activity's actions began running. This isn't the time the user signed in to the resource. | +| **DURATION** | How long the activity ran, until it reached its scheduled end or someone canceled it. | +| **NOTES** | Notes entered when the session was created. | +| **TICKET NUMBER** | The ticket number entered when the session was created. | + +You can resize the columns and sort them in ascending or descending order. + +### Statuses + +| Status | Meaning | +| --- | --- | +| **Completed** | The activity reached its scheduled end, or the requester ended it early. | +| **Cancelled** | An administrator canceled the activity before its scheduled end. | +| **Failed** | The provisioning stage encountered an error. | +| **Approval denied** | An approver denied the request. | +| **Approval failed** | The approval process failed, or the session reached its scheduled end time before it was approved. | + +### Row actions + +- **Expand icon:** Shows a one-line summary of a completed session, for example `RDP Session completed at