README update to document -pw changes

This commit is contained in:
F. Duncanh
2025-08-06 09:23:35 -04:00
parent 2b0da9125a
commit 2436081088
3 changed files with 48 additions and 24 deletions

View File

@@ -1069,16 +1069,23 @@ options -restrict, -block, -allow for more ways to control client
access). <em>(Add a line “reg” in the startup file if you wish to use access). <em>(Add a line “reg” in the startup file if you wish to use
this feature.)</em></p> this feature.)</em></p>
<p><strong>-pw</strong> [<em>pwd</em>]. (since 1.72). As an alternative <p><strong>-pw</strong> [<em>pwd</em>]. (since 1.72). As an alternative
to -pin, client access can be controlled with a password set when uxplay to -pin, client access can be controlled with a password. If a password
starts (set it in the .uxplay startup file, where it is stored as <em>pwd</em> (of length at least six characters) is set when uxplay
cleartext.) All users must then know this password. This uses HTTP md5 starts (usually set in the startup file, where it is stored as
Digest authentication, which is now regarded as providing weak security, cleartext), all users must know this password to connect to UxPlay (the
but it is only used to validate the uxplay password, and no user client prompts for it). This method uses HTTP md5 Digest authentication,
credentials are exposed. If <em>pwd</em> is <strong>not</strong> which is now regarded as providing weak security, but it is only used to
specified, a random 4-digit pin code is displayed, and must be entered validate the uxplay password, and no user credentials are exposed. After
on the client at <strong>each</strong> new connection. <em>Note: -pin a successful authentication, the client stores the password, and will
and -pw are alternatives: if both are specified at startup, the earlier use it initially for future authentications without prompting, so long
of these two options is discarded.</em></p> as the UxPlay deviceID has not changed (this initial authentication will
fail if the UxPlay password has changed). If <em>pwd</em> is
<strong>not</strong> specified with the -pw option when UxPlay starts, a
new random 4-digit pin code is generated and displayed on the UxPlay
terminal for <strong>each</strong> new connection, and must be entered
on the client (there are three chances to enter it, before it is
changed). <em>Note: -pin and -pw are alternatives: if both are specified
at startup, the earlier of these two options is discarded.</em></p>
<p><strong>-vsync [x]</strong> (In Mirror mode:) this option <p><strong>-vsync [x]</strong> (In Mirror mode:) this option
(<strong>now the default</strong>) uses timestamps to synchronize audio (<strong>now the default</strong>) uses timestamps to synchronize audio
with video on the server, with an optional audio delay in (decimal) with video on the server, with an optional audio delay in (decimal)

View File

@@ -1064,13 +1064,23 @@ deregisters the corresponding client (see options -restrict, -block,
the startup file if you wish to use this feature.)* the startup file if you wish to use this feature.)*
**-pw** [*pwd*]. (since 1.72). As an alternative to -pin, client access **-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 can be controlled with a password. If a password *pwd* (of length at least
the .uxplay startup file, where it is stored as cleartext.) All users must six characters) is set when uxplay
then know this password. This uses HTTP md5 Digest authentication, 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 which is now regarded as providing weak security, but it is only used to
validate the uxplay password, and no user credentials are exposed. 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 After a successful authentication, the client stores the password, and will use
be entered on the client at **each** new connection. 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 _Note: -pin and -pw are alternatives: if both are specified at startup, the
earlier of these two options is discarded._ earlier of these two options is discarded._

View File

@@ -1083,15 +1083,22 @@ deregisters the corresponding client (see options -restrict, -block,
the startup file if you wish to use this feature.)* the startup file if you wish to use this feature.)*
**-pw** \[*pwd*\]. (since 1.72). As an alternative to -pin, client **-pw** \[*pwd*\]. (since 1.72). As an alternative to -pin, client
access can be controlled with a password set when uxplay starts (set it access can be controlled with a password. If a password *pwd* (of length
in the .uxplay startup file, where it is stored as cleartext.) All users at least six characters) is set when uxplay starts (usually set in the
must then know this password. This uses HTTP md5 Digest authentication, startup file, where it is stored as cleartext), all users must know this
which is now regarded as providing weak security, but it is only used to password to connect to UxPlay (the client prompts for it). This method
validate the uxplay password, and no user credentials are exposed. If uses HTTP md5 Digest authentication, which is now regarded as providing
*pwd* is **not** specified, a random 4-digit pin code is displayed, and weak security, but it is only used to validate the uxplay password, and
must be entered on the client at **each** new connection. *Note: -pin no user credentials are exposed. After a successful authentication, the
and -pw are alternatives: if both are specified at startup, the earlier client stores the password, and will use it initially for future
of these two options is discarded.* 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**) **-vsync \[x\]** (In Mirror mode:) this option (**now the default**)
uses timestamps to synchronize audio with video on the server, with an uses timestamps to synchronize audio with video on the server, with an