.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH freerdp-proxy 1 2023-12-14 "3.31.1" "FreeRDP"
.SH NAME
freerdp-proxy \- A server binary allowing MITM proxying of RDP connections
.SH SYNOPSIS
.B freerdp-proxy
[\fB-h\fP]
[\fB--help\fP]
[\fB--buildconfig\fP]
[\fB--dump-config\fP \fB<config file>\fP]
[\fB-v\fP]
[\fB--version\fP]
[\fB<config file>\fP]
.SH DESCRIPTION
.B freerdp-proxy
can be used to proxy a RDP connection between a target server and connecting clients.
Possible usage scenarios are:
.IP Proxying
Connect outdated/insecure RDP servers from behind a (more secure) proxy
.IP Analysis
Allow detailed protocol analysis of (many) unknown protocol features (channels)
.IP Inspection
MITM proxy for session inspection and recording

.SH OPTIONS
.IP -h,--help
Display a help text explaining usage.
.IP --buildconfig
Print the build configuration of the proxy and exit.
.IP -v,--version
Print the version of the proxy and exit.
.IP --dump-config \fB[<config-ini-file>|stdout|stderr]\fP
Dump a template configuration to \fB<config-ini-file>\fP or to \fBstdout\fP or \fBstderr\fP
.IP \fB<config-ini-file>\fP
Start the proxy with settings read from \fB<config-ini-file>\fP

.SH WARNING
The proxy does not support authentication out of the box but acts simply as intermediary.
Only \fBRDP\fP and \fBTLS\fP security modes are supported for pass through connections.
User and password are transmitted in plain text from client to the proxy in these modes.
With \fBNLA\fP the credentials never leave the connecting client and only the \fBNTLM\fP hashes are compared.

To implement proper authentication a \fBproxy-module\fP can be implemented that may authenticate against some backend
and map connecting users and credentials to target server users and credentials.

.SH TEST SETUP

A simple test setup of freerdp-proxy might look like this:
.IP SAM file configured in configuration for authentication of connecting clients
.IP User/Domain/Password hard coded in configuration to authenticate to a target machine
.IP Alternatively a Smartcard key and certificate to authenticate to a target machine

This setup is designed for testing purposes only and does not do any authentication mapping of connecting users to
target machine users, so any allowed connecting user will use the same credentials on the target.

.SH EXAMPLES
freerdp-proxy /some/config/file

freerdp-proxy --dump-config /some/config/file

.SH PREPARATIONS

1. generate certificates for proxy 

\fBwinpr-makecert -rdp -path . proxy\fP

2. generate proxy configuration

\fBfreerdp-proxy --dump-config proxy.ini\fP

3. edit configurartion and:

  * provide (preferably absolute) paths for \fBCertificateFile\fP and \fBPrivateKeyFile\fP generated previously
  * remove the \fBCertificateContents\fP and \fBPrivateKeyContents\fP
  * Adjust the \fB[Server]\fP settings \fBHost\fP and \fBPort\fP to bind a specific port on a network interface
  * Adjust the \fB[Target]\fP \fBHost\fP and \fBPort\fP settings to the \fBRDP\fP target server
  * Adjust (or remove if unuse) the \fBPlugins\fP settings

3. start proxy server

 \fBfreerdp-proxy proxy.ini\fP

.SH EXIT STATUS
.TP
.B 0
Successful program execution.
.TP
.B 1
Otherwise.

.SH SEE ALSO
wlog(7)

.SH AUTHOR
FreeRDP <team@freerdp.com>