Skip to content

Commit 315764e

Browse files
authored
Merge pull request #283 from netwrix/AlexeiBelous/PPE11.1
PPE 11.1 docs update
2 parents bd521c4 + 51e2fa6 commit 315764e

File tree

16 files changed

+110
-35
lines changed

16 files changed

+110
-35
lines changed

docs/passwordpolicyenforcer/11.1/admin/cmdlets/cmdlets.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ sidebar_position: 60
99
The PPE Cmdlets are available to manage Password Policy Enforcer from a Windows PowerShell. The
1010
cmdlets are not case-sensitive.
1111

12+
Starting with version **11.1**, the PowerShell cmdlets are built on .NET 8.0 and require PowerShell version 7.5 or newer to function.
13+
**Installation link**: [https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5)
14+
1215
To establish the connection:
1316

1417
**Step 1 –** Open a Windows PowerShell. Some cmdlets require administrative permissions. You can use

docs/passwordpolicyenforcer/11.1/admin/command_line_interface.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,8 @@ If a reboot was not done, add **/forcerestart** at the end
3535
## Mailer
3636

3737
You can run the Password Policy Enforcer Mailer from the command line to deliver email immediately,
38-
or to troubleshoot problems. PPEMail.exe is copied into the \Program Files (x86)
39-
40-
\Password Policy Enforcer\ folder when the Password Policy Enforcer Mailer is installed.
38+
or to troubleshoot problems. PPEMail.exe is copied into the \Program Files\Netwrix\Password Policy
39+
Enforcer\ folder when the Password Policy Enforcer Mailer is installed.
4140

4241
PPEMail.exe starts a simulation when run without any parameters. It finds users whose password will
4342
expire soon, but no email is sent or saved to the pickup folder. Use the simulation mode to find

docs/passwordpolicyenforcer/11.1/admin/compromisedpasswordcheck.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ sidebar_position: 30
66

77
# Compromised Password Check
88

9-
The Compromised Password Checker finds compromised passwords. Users can be notified via email and
10-
advised or forced to change their password. The check can be scheduled to check existing passwords
11-
against a compromised hash list at any time.
9+
The Compromised Password Checker identifies weak or unsafe passwords, including compromised, reused,
10+
or empty ones. Users can be notified via email and advised or forced to change their password.
11+
The check can be scheduled to run at any time to verify existing passwords against security rules.
1212

1313
:::note
1414
Create the **Compromised Passwords Base** file prior to enabling the Compromised Password
@@ -39,6 +39,9 @@ Click the **Compromised Password Check** toggle to enable/disable the feature.
3939
- **Log events in Windows Application Event Viewer** select this option if you want to log events.
4040
- **Force users to change password** select this option to force users to change compromised
4141
passwords.
42+
- **Report password reuse by another account** select this option to generate password reuse report.
43+
- **Force users to change password** select this option to force users to change reused
44+
passwords.
4245
- **Recipient of the full report on the found compromised passwords** specify the email address of
4346
the administrator who should receive the full report.
4447
- **From** specify the email sender.
@@ -54,13 +57,27 @@ Click **Save** to save your settings before running the check or setting up a sc
5457
Click **Run now** to run the check. Depending on your network, the check can take quite a while to
5558
complete. You can schedule it for off hours instead of running it now.
5659

57-
Here is an example of the compromised passwords list:
60+
Here is an example of the compromised passwords report:
5861

62+
---
63+
**List of compromised passwords**
5964
|User | Account | Sid | Email | Description |
6065
| --- | --- | --- | --- | --- |
6166
| admin | Administrator | S-1-5-21-1006207104-1546379664-2458629591-500 | | Sending emails is not possible due to the lack of an email address in the account. |
6267
| user2 | user2 | S-1-5-21-1006207104-1546379664-2458629591-1118 | [email protected] | Email has been sent |
6368

69+
70+
**List of reused passwords**
71+
|User | Account | Sid | Email | Description |
72+
| --- | --- | --- | --- | --- |
73+
| admin | Administrator | S-1-5-21-1006207104-1546379664-2458629591-500 | | Sending emails is not possible due to the lack of an email address in the account. |
74+
| user2 | user2 | S-1-5-21-1006207104-1546379664-2458629591-1118 | [email protected] | Email has been sent |
75+
76+
**Users with empty password:**
77+
Guest (S-1-5-21-1006207104-1546379664-2458629591-501)
78+
79+
---
80+
6481
#### Schedule the Compromised Password Check
6582

6683
Click **Schedule** to set up a schedule to run the Compromised Password Check.

docs/passwordpolicyenforcer/11.1/admin/configconsole.md

Lines changed: 74 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Users with write permission to these objects can configure Password Policy Enfor
8686
Policy to distribute a local configuration to many computers. See the
8787
[Domain and Local Policies](/docs/passwordpolicyenforcer/11.1/installation/domain_and_local_policies.md) topic for additional information.
8888

89-
![Connected To Local Configuration](/images/passwordpolicyenforcer/11.1/administration/connecttodomain.webp)
89+
![Connected To Local Configuration](/images/passwordpolicyenforcer/11.1/administration/connecttolocal.webp)
9090

9191
### Help
9292

@@ -105,10 +105,11 @@ Links to documentation and support tools.
105105

106106
### Settings
107107

108-
There are three tabs:
108+
There are four tabs:
109109

110110
- General
111111
- Notifications
112+
- Mail Service
112113
- License
113114

114115
#### General
@@ -174,36 +175,26 @@ Here are the default settings.
174175
- **Log event when password accepted by service** adds an entry to the Windows Application Event Log
175176
whenever a password is accepted. The logged event includes the username. Default is not checked.
176177

178+
- **Use old icons in Live Policy Feedback** allows switching between displaying old-style and new-style icons in the Password Policy Enforcer Client on the change password screen.
179+
177180
#### Notifications
178181

179182
Open the **Settings** > **Notifications** tab to set up notifications. Notifications are only
180183
available when **domain** is selected with the Connected To configuration setting.
181184

182185
If you make changes, click **Save** to keep your changes or **Discard** to cancel.
183186

184-
Here are the default settings.
185-
186187
![Notifications Settings](/images/passwordpolicyenforcer/11.1/administration/settingsnotifications.webp)
187188

188189
- **Send email reminders**: check this option to send reminders. Default is not checked.
189-
190-
- **SMTP Server**: enter IP address.
191-
- **Port**: enter port number.
192-
- **Username**: enter your username.
193-
- **Password**: enter your password.
194-
- **Use TLS**: check this option to enable TLS email encryption.
195-
196-
- **Save email to a pickup folder**: check this option to have the Mailer save emails to a folder
197-
for later delivery by a mail server. The mail server must monitor this folder for new email.
198-
190+
- **Save email to a pickup folder**: check this option to have the Mailer save emails to a folder for later delivery by a mail server. The mail server must monitor this folder for new email.
199191
- **Path**: Click **Browse** and select the path to the pickup folder.
200192

201193
:::note
202194
Saving email to a pickup folder is the fastest and most reliable delivery method. Use this
203195
option if your mail server supports pickup folders.
204196
:::
205197

206-
207198
The Password Policy Enforcer Mailer sends emails at 2:00 AM every day (local time on your server).
208199
Check the Windows Application Event Log to monitor its progress. You can also run the Password
209200
Policy Enforcer Mailer from the command line to send email immediately, or to troubleshoot problems.
@@ -214,6 +205,74 @@ You can change the time the mailer runs. Set the **PPE Mailer** service startup
214205
desired time.
215206
:::
216207

208+
##### Configuring Email Settings
209+
210+
There are three possible ways to configure email settings:
211+
- **SMTP Server**
212+
- **Google OAuth2**
213+
- **O365 OAuth2**
214+
215+
###### SMTP Server
216+
217+
![Notifications Settings](/images/passwordpolicyenforcer/11.1/administration/settingsnotifications2.webp)
218+
219+
- **SMTP Server**: enter IP address.
220+
- **Port**: enter port number.
221+
- **Username**: enter your username.
222+
- **Password**: enter your password.
223+
- **Use TLS**: check this option to enable TLS email encryption.
224+
225+
###### Google OAuth2
226+
227+
![Notifications Settings](/images/passwordpolicyenforcer/11.1/administration/settingsnotifications3.webp)
228+
229+
- **User Account**: authenticated Google Workspace account.
230+
- **Client ID**: value configured in the Google Workspace Admin Console.
231+
- **Client Secret**: value configured in the Google Workspace Admin Console.
232+
- **Clear Credentials**: removes stored values and tokens.
233+
- **Update Credentials**: initiates token generation in a browser window.
234+
235+
:::note
236+
The Google OAuth2 timeout can be configured in **PPEConfiguration.json**.
237+
By default, it is set to **1 minute**:
238+
```
239+
"Configuration": {
240+
"GoogleOAuthTimeout": 60
241+
}
242+
```
243+
:::
244+
245+
###### O365 OAuth2
246+
247+
![Notifications Settings](/images/passwordpolicyenforcer/11.1/administration/settingsnotifications4.webp)
248+
249+
- **User Account**: Office 365 account.
250+
- **Client ID**: value configured in the Office 365 Admin Console.
251+
- **Client Secret**: value configured in the Office 365 Admin Console.
252+
- **Tenant ID**: Office 365 tenant identifier.
253+
- **Clear Credentials**: removes values.
254+
255+
#### Mail Service
256+
257+
Open the **Settings** > **Mail Service** tab to set up mail service for notifications.
258+
259+
If you make changes, click **Save** to keep your changes or **Discard** to cancel.
260+
261+
![Mail Server Tab](/images/passwordpolicyenforcer/11.1/administration/settingsmailserver.webp)
262+
263+
- **Service**: specify the address of the machine where the mail service is installed.
264+
- **Port**: specify the port number.
265+
266+
:::note
267+
If you need to use a port other than 12345, open the **PPEMailService.json** file on the machine where
268+
the mail service is installed, update the port value, and restart the mail service to apply the changes.
269+
```
270+
"MailService": {
271+
"HostName": "localhost",
272+
"Port": 6000
273+
}
274+
```
275+
:::
217276

218277
#### License
219278

docs/passwordpolicyenforcer/11.1/admin/manage-policies/manage_policies.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,12 @@ Policy Guide have been added.
2828

2929
The policy management links are all on the Password Policies tile:
3030

31-
- Add a Policy.
32-
- Set Up a Policy (click on existing policy name).
33-
- Test Policy.
34-
- Set Priorities.
35-
- Export.
36-
- Context menu (3 stacked dots) beside each defined policy Make Copy, Make Default/Remove Default,
37-
Rename and Delete .
31+
- [Add a Policy.](#add-a-policy)
32+
- [Set Up a Policy](#set-up-a-policy) (click on existing policy name).
33+
- [Test Policy.](#test-policy)
34+
- [Set Priorities.](#set-priorities)
35+
- [Export.](#export)
36+
- Context menu (3 stacked dots) beside each defined policy [Make Copy](#make-copy), [Make Default/Remove Default](#make-defaultremove-default), [Rename](#rename) and [Delete](#delete).
3837

3938
## Add a Policy
4039

docs/passwordpolicyenforcer/11.1/admin/manage-policies/rules/dictionary_rule.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ for long passwords.
1818

1919
Select the **Dictionary** check box to enable the Dictionary rule.
2020

21-
Browse to a dictionary file. A sample file **Dict.txt** is installed in the **\Program
22-
Files\Password Policy Enforcer** folder. This file is sorted and ready to use. It contains
21+
Browse to a dictionary file. A sample file **Dict.txt** is installed in the **\Program Files\Netwrix\Password Policy Enforcer\\** folder. This file is sorted and ready to use. It contains
2322
approximately 257,000 words, names, and acronyms.
2423

2524
Select the **Detect inclusion of non-alpha characters** check box if Password Policy Enforcer should
@@ -114,7 +113,7 @@ local disk. Using a shared dictionary degrades performance, and could jeopardize
114113

115114
:::note
116115
The `\Program Files (x86)\` folder does not exist on 32-bit Windows, so move the
117-
dictionary into the `\Program Files\Password Policy Enforcer\` folder if you have 32-bit and 64-bit
116+
dictionary into the `\Program Files\Netwrix\Password Policy Enforcer\` folder if you have 32-bit and 64-bit
118117
computers sharing a common Password Policy Enforcer configuration.
119118
:::
120119

docs/passwordpolicyenforcer/11.1/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Here are the requirements for both the full and evaluation Password Policy Enfor
7676
- 10
7777
- 11
7878

79-
- .NET 8.0.15 or higher
79+
- .NET Desktop Runtime 8.0.15 or higher
8080

8181
## Password Policy Enforcer Web
8282

docs/passwordpolicyenforcer/11.1/installation/installationserver.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ Agreement**.
6262
selected by default.
6363
- Configuration Console – manages policy configuration. Install where ever needed. Selected by
6464
default.
65-
- Mailer Service – sends email reminders. Should be installed on a Domain Controller. It is not
66-
selected by default.
65+
- Mailer Service – sends email reminders. It is not selected by default.
6766

6867
**Step 8 –** The default location is shown. Click **Browse** and select a new location if needed.
6968

9.52 KB
Loading
21.3 KB
Loading

0 commit comments

Comments
 (0)