Go to file
Ben Cohen 5ff8fb8a95 Add shared memory file to rediscover sessions #800
Allow xrdp-sesman to discover sessions still running that were created
by a previous xrdp-sesman process.

Implement this using a file-backed shared mmap region, visible to both
the daemon and session instances of xrdp-sesman.  Add a heartbeat
timestamp updated by the session instance so that the daemon instance
can infer whether the sessions in the mmap region are current or stale.

The shared memory can also be used to pass other data between daemon and
session instances, for example the session's idle time.

Add locking around access to g_sessions and the mmap region.  This is a
PTHREAD_PROCESS_SHARED lock which protects shared memory used by
separate processes.  Defining DEBUG_SESSION_LOCK enables logging to help
debug locking bugs.

Notes:

1. The number of sessions is limited by the size of the array in shared
memory, SESMAN_SHAREDMEM_MAX_SESSIONS.  This could be made dynamic
instead by growing the file and the mmap region.

2. If sesshm_try_open_existing_shm() finds a shm file but it looks
wrong, it creates a new one.  Perhaps it should instead exit with an
error?

3. In sesshm_thread() if the session xrdp-sesman notices that it has
been removed from the daemon's list it exits.  It should kill the X
server and/or window manager first.

4. This doesn't yet update idle times.  I need to work out how to get
this information from the X server.

5. This uses an array of sessions in the mmap region so the linked list
g_sessions might be redundant now.

6. Defining DONT_USE_SHM will let xrdp-sesman run without creating or
trying to use the mmap file.  This could be removed in the future.

7. I think the locking fixes an theorised bug where a session can be
removed from the g_sessions linked list in session_kill() (called from
the signal handler) at the same time as a session is added in
session_start_fork().
2019-11-26 18:56:55 +00:00
common cleanup refresh rect and check stream bounds 2019-11-07 02:03:57 +00:00
docs docs: sesman and sesrun now have xrdp- prefix 2019-03-20 16:55:02 +09:00
fontdump Don't ignore files known to git 2016-02-12 23:52:46 -08:00
genkeymap Add dvorak keyboard layout 2017-11-01 10:24:54 -07:00
instfiles mkpamrules: Support openSUSE's usage of /usr/etc/pam.d 2019-11-13 11:13:07 +08:00
keygen Eliminate APP_CC and DEFAULT_CC 2017-03-14 00:21:48 -07:00
libpainter@cc66c2c55d update submodules to their release tag head commit 2017-03-30 09:07:07 +03:00
librfxcodec@6cb61ab7ca update submodule to the latest release 2019-08-20 00:25:07 +09:00
libxrdp cleanup refresh rect and check stream bounds 2019-11-07 02:03:57 +00:00
m4 Update m4/ax_type_socklen_t.m4, it works with -Wall now 2017-02-02 21:33:05 -08:00
mc Make changes to generate dylibs in mac again 2018-01-30 01:21:07 -08:00
neutrinordp update the module version 2019-04-25 14:54:25 -07:00
pkgconfig Fix include path in xrdp-uninstalled.pc.in 2016-11-18 23:42:26 +00:00
sesman Add shared memory file to rediscover sessions #800 2019-11-26 18:56:55 +00:00
tcutils tcutils: fix WTSVirtualChannelWrite return codes check according to API change 2017-09-13 11:18:41 +09:00
tests Eliminate APP_CC and DEFAULT_CC 2017-03-14 00:21:48 -07:00
vnc update the module version 2019-04-25 14:54:25 -07:00
vrplayer Remove trailing whitespace 2017-02-08 13:30:56 +09:00
xrdp Merge pull request #1319 from metalefty/sighup 2019-11-21 18:42:52 +09:00
xrdpapi dynamic virtual channel improvements 2018-10-11 22:09:20 -07:00
xrdpvr xrdpvr: adjust xrdpvr_write_to_client to xrdpapi API change 2017-09-13 11:18:41 +09:00
xup xup: fix for when shmem_id changes 2019-11-07 23:28:07 -08:00
.gitignore .gitignore, change configure_params.h to xrdp_configure_options.h 2018-08-13 22:33:45 -07:00
.gitmodules Use special name "." for the branches in .gitmodules 2017-03-01 20:38:33 -08:00
.travis.yml travis: unbreak the build, libxfixed-dev is required at minimum 2019-08-19 15:20:14 +09:00
astyle_config.as Remove --break-blocks option, it doesn't match the existing code style 2017-02-07 13:51:22 +09:00
bootstrap bootstrap: checkout submodules if they are missing 2016-12-28 21:22:29 -08:00
coding_style.md Merge prog_std.txt into coding_style.md 2016-10-17 08:38:22 -07:00
configure.ac default rdpsnd audin off, can enable with --enable-rdpsndaudin 2019-10-22 22:48:15 -07:00
COPYING o moved from GNU General Public License to Apache License, Version 2.0 2012-09-19 20:51:34 -07:00
description-pak helper file for checkinstall 2013-03-20 19:09:08 +00:00
design.txt More spelling fixes found by codespell and aspell 2016-01-30 17:39:25 -08:00
faq-compile.txt Update faq-compile.txt 2014-05-29 21:29:15 -07:00
faq-general.txt Fix incorrect use of "it's" and "its", adjust wording 2016-06-21 16:30:15 -07:00
file-loc.txt Remove librdp.so sources, it's obsoleted by neutrinordp 2017-01-19 20:13:49 -08:00
install.txt More spelling fixes found by codespell and aspell 2016-01-30 17:39:25 -08:00
Makefile.am xrdp: unify inconsistent mixed use of 2018-06-27 09:00:55 +09:00
NEWS.md NEWS: fix typo in version s/v1.9.11/v0.9.11/ 2019-08-19 17:16:10 +09:00
postinstall-pak clear things that are handled by the init script 2013-03-21 18:20:16 +00:00
README.md bump version to v0.9.11 2019-08-19 16:00:33 +09:00

Build Status Gitter Apache-License

Current Version: 0.9.11

xrdp - an open source RDP server

Overview

xrdp provides a graphical login to remote machines using Microsoft Remote Desktop Protocol (RDP). xrdp accepts connections from a variety of RDP clients: FreeRDP, rdesktop, NeutrinoRDP and Microsoft Remote Desktop Client (for Windows, Mac OS, iOS and Android).

RDP transport is encrypted using TLS by default.

demo

Features

Remote Desktop Access

  • Connect to a Linux desktop using RDP from anywhere (requires xorgxrdp Xorg module)
  • Reconnect to an existing session
  • Session resizing
  • RDP/VNC proxy (connect to another RDP/VNC server via xrdp)

Access to Remote Resources

Quick Start

Most Linux distributions should distribute the latest release of xrdp in their repository. You would need xrdp and xorgxrdp packages for the best experience. It is recommended that xrdp depends on xorgxrdp, so it should be sufficient to install xrdp. If xorgxrdp is not provided, use Xvnc server.

xrdp listens on 3389/tcp. Make sure your firewall accepts connection to 3389/tcp from where you want to access.

Ubuntu / Debian

apt install xrdp

RedHat / CentOS / Fedora

On RedHat and CentOS, make sure to enable EPEL packages first.

yum install epel-release

Install xrdp package.

yum install xrdp

yum is being replaced with dnf, so you may need to use dnf instead of yum in the above commands.

Environment

xrdp primarily targets to GNU/Linux. Tested on x86, x86_64, SPARC and PowerPC.

xorgxrdp and RemoteFX Codec have special optimization for x86 and x86_64 using SIMD instructions.

FreeBSD is not a primary target of xrdp. It is working on FreeBSD except for the drive redirection feature.

Other operating systems such as macOS are not supported so far, but we welcome your contributions.

Compiling

See also https://github.com/neutrinolabs/xrdp/wiki#building-from-sources

Prerequisites

To compile xrdp from the packaged sources, you need basic build tools - a compiler (gcc or clang) and the make program. Additionally, you would need openssl-devel, pam-devel, libX11-devel, libXfixes-devel, libXrandr-devel. More additional software would be needed depending on your configuration.

To compile xrdp from a checked out git repository, you would additionally need autoconf, automake, libtool and pkgconfig.

Get the source and build it

If compiling from the packaged source, unpack the tarball and change to the resulting directory.

If compiling from a checked out repository, please make sure you've got the submodules cloned too (use git clone --recursive https://github.com/neutrinolabs/xrdp)

Then run following commands to compile and install xrdp:

./bootstrap
./configure
make
sudo make install

If you want to use audio redirection, you need to build and install additional pulseaudio modules. The build instructions can be found at wiki.

Directory Structure

xrdp
├── common ······ common code
├── docs ········ documentation
├── fontdump ···· font dump for Windows
├── genkeymap ··· keymap generator
├── instfiles ··· installable data file
├── keygen ······ xrdp RSA key pair generator
├── libpainter ·· painter library
├── librfxcodec · RFX codec library
├── libxrdp ····· core RDP protocol implementation
├── m4 ·········· Autoconf macros
├── mc ·········· media center module
├── neutrinordp · RDP client module for proxying RDP connections using NeutrinoRDP
├── pkgconfig ··· pkg-config configuration
├── sesman ······ session manager for xrdp
├── tcutils ····· QT based utility program for thin clients
├── tests ······· tests for the code
├── vnc ········· VNC client module for xrdp
├── vrplayer ···· QT player redirecting video/audio to clients over xrdpvr channel
├── xrdp ········ main server code
├── xrdpapi ····· virtual channel API
├── xrdpvr ······ API for playing media over RDP
└── xup ········· X11rdp and xorgxrdp client module