Synnefo » snf-vncauthproxy

Its main use is to enable VNC clients to connect to firewalled VNC servers.

snf-vncauthproxy is currently packaged only for Debian (stable).

In case you're upgrading from an older snf-vncauthproxy version or it's the

first time you're installing snf-vncauthproxy, you will prompted to configure

a vncauthproxy user (see below for more information on user management).

snf-vncauthproxy listens on a TCP socket for control (JSON) messages from

clients. The format of the control messages is:

If you're using the init script, snf-vncauthproxy reads its options from its

Refer to the vncauthproxy help output for a detailed listing and information

on all available options:

.. code-block:: console

    # vncauthproxy --help

By default snf-vncauthproxy will listen to ``127.0.0.1:24999`` TCP, for

incoming control connections and uses the ``25000-30000`` range for the

listening / data sockets.

Version 1.5 replaced Unix domain control sockets with TCP control sockets. This

change made it necessary to introduce an authentication file to replace the

POSIX file permissions, which protected the domain sockets.

    username:$6$salt$hash

The password part of the line (after the colon) is the output of crypt(), using

a random 16-char salt with SHA-512.

To manage the authentication file, you can use the vncauthproxy-passwd tool,

to easily add, update and delete users:

To add a user:

.. code-block:: console

    # vncauthproxy-passwd /var/lib/vncauthproxy/users user

You will be prompted for a password.

To delete a user:

.. code-block:: console

    # vncauthproxy-passwd -D /var/lib/vncauthproxy/users user

See the help output of the tool for more options:

.. code-block:: console

    # vncauthproxy-passwd -h

.. warning:: The vncauthproxy daemon requires a restart for the changes in the

 authentication file to take effect.

.. warning:: After installing snf-vncauthproxy for the fist time, make sure

 that you create a valid authentication file and define any users needed. The

 vncauthproxy daemon will start but will not be usable if no users are defined

 or if no authentication file is present.

Changelog

^^^^^^^^^

* v1.5 :ref:`Changelog <Changelog-1.5>`

Upgrade notes

^^^^^^^^^^^^^

.. toctree::

   :maxdepth: 1

    v1.4 -> v1.5 <upgrade/upgrade-1.5.rst>