From 2436081088b2965a13773703e88a25792d034ec3 Mon Sep 17 00:00:00 2001 From: "F. Duncanh" Date: Wed, 6 Aug 2025 09:23:35 -0400 Subject: [PATCH] README update to document -pw changes --- README.html | 27 +++++++++++++++++---------- README.md | 20 +++++++++++++++----- README.txt | 25 ++++++++++++++++--------- 3 files changed, 48 insertions(+), 24 deletions(-) diff --git a/README.html b/README.html index d647f50..6aeef12 100644 --- a/README.html +++ b/README.html @@ -1069,16 +1069,23 @@ options -restrict, -block, -allow for more ways to control client access). (Add a line “reg” in the startup file if you wish to use this feature.)

-pw [pwd]. (since 1.72). As an alternative -to -pin, client access can be controlled with a password set when uxplay -starts (set it in the .uxplay startup file, where it is stored as -cleartext.) All users must then know this password. This uses HTTP md5 -Digest authentication, which is now regarded as providing weak security, -but it is only used to validate the uxplay password, and no user -credentials are exposed. If pwd is not -specified, a random 4-digit pin code is displayed, and must be entered -on the client at each new connection. Note: -pin -and -pw are alternatives: if both are specified at startup, the earlier -of these two options is discarded.

+to -pin, client access can be controlled with a password. If a password +pwd (of length at least six characters) is set when uxplay +starts (usually set in the startup file, where it is stored as +cleartext), all users must know this password to connect to UxPlay (the +client prompts for it). This method uses HTTP md5 Digest authentication, +which is now regarded as providing weak security, but it is only used to +validate the uxplay password, and no user credentials are exposed. After +a successful authentication, the client stores the password, and will +use it initially for future authentications without prompting, so long +as the UxPlay deviceID has not changed (this initial authentication will +fail if the UxPlay password has changed). If pwd is +not specified with the -pw option when UxPlay starts, a +new random 4-digit pin code is generated and displayed on the UxPlay +terminal for each new connection, and must be entered +on the client (there are three chances to enter it, before it is +changed). Note: -pin and -pw are alternatives: if both are specified +at startup, the earlier of these two options is discarded.

-vsync [x] (In Mirror mode:) this option (now the default) uses timestamps to synchronize audio with video on the server, with an optional audio delay in (decimal) diff --git a/README.md b/README.md index 2821164..2817808 100644 --- a/README.md +++ b/README.md @@ -1064,13 +1064,23 @@ deregisters the corresponding client (see options -restrict, -block, the startup file if you wish to use this feature.)* **-pw** [*pwd*]. (since 1.72). As an alternative to -pin, client access -can be controlled with a password set when uxplay starts (set it in -the .uxplay startup file, where it is stored as cleartext.) All users must -then know this password. This uses HTTP md5 Digest authentication, +can be controlled with a password. If a password *pwd* (of length at least +six characters) is set when uxplay +starts (usually set in the startup file, where it is stored as +cleartext), all users must know this password to connect to UxPlay +(the client prompts for it). +This method uses HTTP md5 Digest authentication, which is now regarded as providing weak security, but it is only used to validate the uxplay password, and no user credentials are exposed. -If *pwd* is **not** specified, a random 4-digit pin code is displayed, and must -be entered on the client at **each** new connection. +After a successful authentication, the client stores the password, and will use +it initially for future authentications without prompting, so long as +the UxPlay deviceID has not changed (this initial authentication will fail +if the UxPlay password has changed). +If *pwd* is **not** specified with the -pw option when UxPlay starts, a +new random 4-digit pin code is generated and displayed on the UxPlay terminal +for **each** new connection, and must +be entered on the client (there are three +chances to enter it, before it is changed). _Note: -pin and -pw are alternatives: if both are specified at startup, the earlier of these two options is discarded._ diff --git a/README.txt b/README.txt index c2283ef..8e84d2d 100644 --- a/README.txt +++ b/README.txt @@ -1083,15 +1083,22 @@ deregisters the corresponding client (see options -restrict, -block, the startup file if you wish to use this feature.)* **-pw** \[*pwd*\]. (since 1.72). As an alternative to -pin, client -access can be controlled with a password set when uxplay starts (set it -in the .uxplay startup file, where it is stored as cleartext.) All users -must then know this password. This uses HTTP md5 Digest authentication, -which is now regarded as providing weak security, but it is only used to -validate the uxplay password, and no user credentials are exposed. If -*pwd* is **not** specified, a random 4-digit pin code is displayed, and -must be entered on the client at **each** new connection. *Note: -pin -and -pw are alternatives: if both are specified at startup, the earlier -of these two options is discarded.* +access can be controlled with a password. If a password *pwd* (of length +at least six characters) is set when uxplay starts (usually set in the +startup file, where it is stored as cleartext), all users must know this +password to connect to UxPlay (the client prompts for it). This method +uses HTTP md5 Digest authentication, which is now regarded as providing +weak security, but it is only used to validate the uxplay password, and +no user credentials are exposed. After a successful authentication, the +client stores the password, and will use it initially for future +authentications without prompting, so long as the UxPlay deviceID has +not changed (this initial authentication will fail if the UxPlay +password has changed). If *pwd* is **not** specified with the -pw option +when UxPlay starts, a new random 4-digit pin code is generated and +displayed on the UxPlay terminal for **each** new connection, and must +be entered on the client (there are three chances to enter it, before it +is changed). *Note: -pin and -pw are alternatives: if both are specified +at startup, the earlier of these two options is discarded.* **-vsync \[x\]** (In Mirror mode:) this option (**now the default**) uses timestamps to synchronize audio with video on the server, with an