Skip to content

Commit

Permalink
Doc: Use more consistent/standard terminology
Browse files Browse the repository at this point in the history
- "server machine" = "VNC host", "TurboVNC host", or "host", depending
  on the context
- "machine" = "host", when referring to the machine on which the VNC
  server runs
- "server" = "host", when referring to the machine rather than the
  software
- "server" = "session", when referring to a specific instance of Xvnc
- "TurboVNC Server session" = "TurboVNC session" ("TurboVNC Server
  session" is redundant)
- "server session" = "VNC session", when used generically, or "TurboVNC
  session", when it applies only to TurboVNC
- "client" = "viewer", when referring to the software rather than the
  machine
- Use specific references to the TurboVNC Server and Viewer (as opposed
  to generic references, such as "a TurboVNC server" or "TurboVNC
  viewers") when referring to performance, since we can't guarantee the
  same performance with anyone else's software, but leave the generic
  references when referring to compatibility (mainly because
  LibVNCServer/LibVNCCLient is arguably "a TurboVNC server/viewer",
  since it uses our codec and all of our extensions.)

ChangeLog.md:
- Fix a factual error in the description of 1.2[6] (not that it matters,
  given that the applet feature no longer exists)

unix/Xvnc/README:
- Eliminate vestigial reference to Xorg 7.7

unix/Xvnc/programs/Xserver/Xvnc.man:
- "XFree86" = "X.org"

unix/Xvnc/programs/Xserver/hw/vnc/auth.c:
- Change vestigial "authentication method" references to "security
  type", both in identifier names and user-visible messages

+ A few minor formatting tweaks
  • Loading branch information
dcommander committed Nov 1, 2018
1 parent 9470003 commit 5d5c714
Show file tree
Hide file tree
Showing 36 changed files with 732 additions and 672 deletions.
153 changes: 75 additions & 78 deletions ChangeLog.md

Large diffs are not rendered by default.

35 changes: 18 additions & 17 deletions doc/auth.txt
Expand Up @@ -32,22 +32,22 @@ uses the following terminology when referring to its security extensions:
VNC Password Authentication :: {:}
A session password sent from the VNC viewer is validated against a password
file, which is typically located under the user's home directory on the
server machine. The VNC password is separate from any other login
credentials and thus represents less of a security threat if compromised
(that is, assuming the VNC password and the user's account password are not
the same.)
VNC host. The VNC password is separate from any other login credentials
and thus represents less of a security threat if compromised (that is,
assuming the VNC password and the user's account password are not the
same.)

One-Time Password (OTP) Authentication :: {:}
Using the ''vncpasswd'' program, a unique password is generated "on the
fly" for the VNC server session, and the password is printed on the
command line (see the man page for ''vncpasswd'' for more details.) The
user enters this password in the VNC viewer, and the VNC viewer sends the
password to the VNC server as if it were a VNC password. However, once the
OTP has been used to authenticate a viewer, the OTP is forgotten and cannot
be reused. OTP authentication can be used, for instance, to launch or
connect to TurboVNC sessions from an automated web portal or from a job
scheduler. OTP authentication is also useful for allowing temporary access
to a TurboVNC session for collaboration purposes.
fly" for the TurboVNC session, and the password is printed on the command
line (see the man page for ''vncpasswd'' for more details.) The user
enters this password in the VNC viewer, and the VNC viewer sends the
password to the server as if it were a VNC password. However, once the OTP
has been used to authenticate a viewer, the OTP is forgotten and cannot be
reused. OTP authentication can be used, for instance, to launch or connect
to TurboVNC sessions from an automated web portal or from a job scheduler.
OTP authentication is also useful for allowing temporary access to a
TurboVNC session for collaboration purposes.

PAM User/Password Authentication :: {:}
The VNC server uses Pluggable Authentication Modules (PAM) to validate a
Expand All @@ -58,9 +58,10 @@ uses the following terminology when referring to its security extensions:
through PAM. Since the user/password authentication schemes supported by
TurboVNC (see below) transmit the password from the VNC viewer to the VNC
server as plain text, it is strongly recommended that the PAM User/Password
authentication method be used only with session encryption or if the server
is restricted to allow only loopback (SSH) connections and to disallow
reverse connections (see {ref prefix="Section ": Secure_TurboVNC_Usage}.)
authentication method be used only with session encryption or if the
session is restricted to allow only loopback (SSH) connections and to
disallow reverse connections (see
{ref prefix="Section ": Secure_TurboVNC_Usage}.)

** TurboVNC Viewer Authentication Schemes

Expand Down Expand Up @@ -130,7 +131,7 @@ The default behavior of the TurboVNC Server is for all security types except
"TLSNone", "X509None", and "None" to be enabled and for VNC Password and OTP
authentication to be preferred over PAM User/Password authentication. However,
the system administrator can disable one or more of the security types or set
the preferred order of the security types by editing the server's security
the preferred order of the security types by editing the TurboVNC security
configuration file. See the ''Xvnc'' man page for more details.

If the VNC server allows multiple security types, then the VNC viewer's default
Expand Down
12 changes: 6 additions & 6 deletions doc/compatibility.txt
Expand Up @@ -2,11 +2,11 @@
{anchor: Compatibility}

In order to realize the full performance benefits of TurboVNC, it is necessary
to use a TurboVNC server and a TurboVNC viewer in concert. However, TurboVNC
is fully compatible with [[http://www.tigervnc.com][TigerVNC]], TightVNC,
RealVNC, and other VNC flavors. You can use the TurboVNC Viewer to connect to
a non-TurboVNC server (or vice versa), although this will generally result in
some decrease in performance.
to use the TurboVNC Server and the TurboVNC Viewer in concert. However,
TurboVNC is fully compatible with [[http://www.tigervnc.com][TigerVNC]],
TightVNC, RealVNC, and other VNC flavors. You can use the TurboVNC Viewer to
connect to a non-TurboVNC server (or vice versa), although this will generally
result in some decrease in performance.

The following sections list additional things to bear in mind when mixing
TurboVNC with other VNC flavors.
Expand Down Expand Up @@ -100,7 +100,7 @@ TurboVNC with other VNC flavors.
the framebuffer updates with no zlib compression, and the TightVNC and
TigerVNC viewers don't support this.
{nl}{nl}
A similar issue occurs when using more than four encoding threads on the
A similar issue occurs when using more than four encoding threads in the
server. Since the Tight encoding type is limited to four zlib streams,
any encoding threads beyond the first four cannot use zlib compression.
{nl}{nl}
Expand Down
12 changes: 6 additions & 6 deletions doc/config.txt
Expand Up @@ -54,7 +54,7 @@ compare full rectangles, as TurboVNC 1.2.x did. |
smaller block sizes can decrease network usage if only a few pixels are
changing between updates, but using smaller block sizes can also interfere
with the Tight encoder's ability to efficiently split rectangles into
subrectangles, thus increasing server CPU usage (and sometimes increasing
subrectangles, thus increasing host CPU usage (and sometimes increasing
network usage as well, which runs counter to the purpose of interframe
comparison.) Setting the block size to 0 causes the ICE to compare full
framebuffer update rectangles, as TurboVNC 1.2.x did.
Expand Down Expand Up @@ -154,8 +154,8 @@ along with the ''extssh'' parameter) is used, the TurboVNC Viewer reads the
''VNC_TUNNEL_CMD'' environment variable (the Java viewer can also read this
information from the ''turbovnc.tunnel'' system property), expands patterns
beginning with the "%" character, and uses the resulting command line to
establish the secure tunnel to the VNC server. If ''VNC_TUNNEL_CMD'' is not
set, then this command line defaults to
establish the secure tunnel to the VNC host. If ''VNC_TUNNEL_CMD'' is not set,
then this command line defaults to
''/usr/bin/ssh -f -L %L:localhost:%R %H sleep 20'' (or
''ssh.exe -f -L %L:localhost:%R %H sleep 20'' if using the Windows native
viewer.)
Expand All @@ -166,9 +166,9 @@ must be present in the command template, and ''%G'' must also be present if
using the ''-via'' option):

| ''%%'' | A literal "%" |
| ''%G'' | gateway machine name |
| ''%H'' | remote VNC machine name (if using the ''-via'' option, then this \
is specified from the point of view of the gateway) |
| ''%G'' | gateway host name or IP address |
| ''%H'' | remote VNC host name or IP address (if using the ''-via'' option, \
then this is specified from the point of view of the gateway) |
| ''%L'' | local TCP port number |
| ''%R'' | remote TCP port number |

Expand Down

0 comments on commit 5d5c714

Please sign in to comment.