xpra

RFB / VNC

RFB (“Remote FrameBuffer”) is the protocol used by VNC. Xpra speaks it in both directions:

This page covers both. See also: network, SSL, authentication, desktop and shadow servers.

What this adds to xpra

RFB is a single-framebuffer protocol: a session is one screen of pixels, with pointer and keyboard input, an optional text clipboard and a server-rendered cursor. It has no concept of individual application windows.

That model maps cleanly onto xpra’s whole-desktop session types but not onto its seamless mode (which forwards individual windows). So:

Direction Mode Supported with
Xpra server ← VNC client exposes one framebuffer desktop and shadow servers only — not seamless
Xpra client → VNC server renders one framebuffer as a single window any RFB / VNC server

When xpra acts as a VNC client, the remote desktop is presented as a single fixed-size window. The client negotiates the RFB protocol version (3.3 / 3.7 / 3.8), authenticates, and decodes the screen updates. It also forwards pointer and keyboard input, follows server-side desktop resizes, renders the remote cursor locally, and synchronizes the text clipboard in both directions.

Using xpra as a VNC server

Any desktop or shadow server can listen for VNC clients by adding a bind-rfb socket:

xpra shadow --bind-rfb=0.0.0.0:5900

xpra desktop --start=xterm --bind-rfb=0.0.0.0:5900

Then connect with any VNC viewer (including xpra’s own client, see below):

vncviewer localhost:5900

Secure it with the rfb-auth option (see authentication):

xpra shadow --bind-rfb=0.0.0.0:5900,auth=file(filename=password.txt)

A plain TCP socket can also be upgraded to RFB automatically after a short delay, so a single port can serve both xpra and VNC clients - this is the rfb-upgrade option (in seconds, 0 to disable):

xpra desktop --start=xterm --bind-tcp=0.0.0.0:10000 --rfb-upgrade=5

Connecting to a real VNC server

Use a vnc:// URL (the rfb:// scheme is an alias). The default port is 5900:

Setting up a test VNC server

To exercise the xpra VNC client it is handy to run a throwaway VNC server with a known configuration. The commands below use TigerVNC’s Xvnc and match the authentication modes the xpra client supports. :1 is the X11 display number, which corresponds to RFB port 5901 (5900 + display); -localhost only accepts connections from the same machine.

Note: these command lines are TigerVNC’s. Other VNC server implementations (RealVNC, TightVNC, the Xvnc/vncserver wrappers shipped by some distributions, etc) use different options and defaults - consult their own documentation.

No authentication 
Xvnc :1 -rfbport 5901 -localhost -SecurityTypes None -geometry 1280x720 -desktop test

Connect with xpra attach vnc://localhost:5901/.

VNC password

Create an obfuscated password file with vncpasswd (TigerVNC’s -f reads the password from stdin and writes the file to stdout), then start the server with VncAuth:

echo "secret12" | vncpasswd -f > passwd
Xvnc :1 -rfbport 5901 -localhost -SecurityTypes VncAuth -PasswordFile passwd -geometry 1280x720 -desktop test

Connect with xpra attach vnc://localhost:5901/ --password-file=password.txt (where password.txt contains the plaintext password), or let the client prompt for it.

Encrypted, no password (VeNCrypt / X509None)

Generate a throwaway self-signed certificate (see also SSL), then start the server with the X509None security type so it negotiates VeNCrypt and presents the certificate:

openssl req -new -x509 -days 1 -nodes -newkey rsa:2048 -keyout key.pem -out cert.pem -subj "/CN=localhost"
Xvnc :1 -rfbport 5901 -localhost \
     -SecurityTypes X509None -X509Cert cert.pem -X509Key key.pem \
     -geometry 1280x720 -desktop test

Connect with xpra attach vnc://localhost:5901/ --ssl-ca-certs=cert.pem (or --ssl-server-verify-mode=none for a quick test). This is the configuration used by the unit.net.rfb.rfb_vencrypt_test integration test.

Encrypted with a password (VeNCrypt / X509Vnc)

Combine a certificate and a password file, using the X509Vnc security type (TLS first, then the VNC password challenge inside the tunnel):

echo "secret12" | vncpasswd -f > passwd
Xvnc :1 -rfbport 5901 -localhost \
     -SecurityTypes X509Vnc -X509Cert cert.pem -X509Key key.pem -PasswordFile passwd \
     -geometry 1280x720 -desktop test

Connect with xpra attach vnc://localhost:5901/ --ssl-ca-certs=cert.pem --password-file=password.txt.

The TLS* security types (TLSNone, TLSVnc, …) use anonymous-DH TLS without a certificate and are not supported by the xpra client - use the X509* variants above.

Connecting

Basic connection 
xpra attach vnc://localhost:5900/

The remote desktop appears as a single xpra window. The standard xpra client options apply (window scaling, the system tray menu, etc).

With a VNC password

VNC password authentication (the classic DES challenge) is supported. The client will prompt for the password, or you can supply it non-interactively with a password file:

xpra attach vnc://localhost:5900/ --password-file=password.txt
Over an encrypted connection (VeNCrypt / TLS)

If the VNC server offers VeNCrypt with an X509 certificate (see the X509None / X509Vnc server setups above), xpra will negotiate VeNCrypt and upgrade the connection to TLS before authenticating - reusing the same SSL machinery as the rest of xpra. The usual --ssl-* options control certificate verification.

For a self-signed certificate you can either verify against its CA file:

xpra attach vnc://host:5900/ --ssl-ca-certs=/path/to/cert.pem

or, for testing only, skip verification:

xpra attach vnc://host:5900/ --ssl-server-verify-mode=none
Tunnelled over SSH

vnc+ssh:// connects to the VNC server through an SSH tunnel. When a display number is given in the path it is mapped to the matching VNC port (5900 + display):

xpra attach vnc+ssh://user@host/2

This logs in over SSH and connects to vnc://localhost:5902/ on the remote host.

Capabilities and limitations (VNC client)

The VNC client is intended to be lightweight and interoperable, not a full-featured VNC viewer.

Supported:

Not (yet) supported:

This site is open source. Improve this page.