diff --git a/server/proxy/cli/CMakeLists.txt b/server/proxy/cli/CMakeLists.txt index 15ee9a69b..7308809d3 100644 --- a/server/proxy/cli/CMakeLists.txt +++ b/server/proxy/cli/CMakeLists.txt @@ -44,3 +44,6 @@ if (WITH_DEBUG_SYMBOLS AND MSVC) endif() set_property(TARGET ${APP_NAME} PROPERTY FOLDER "Server/proxy") + +configure_file(${APP_NAME}.1.in ${CMAKE_CURRENT_BINARY_DIR}/${APP_NAME}.1) +install_freerdp_man(${CMAKE_CURRENT_BINARY_DIR}/${APP_NAME}.1 1) diff --git a/server/proxy/cli/freerdp-proxy.1.in b/server/proxy/cli/freerdp-proxy.1.in new file mode 100644 index 000000000..ee2825eac --- /dev/null +++ b/server/proxy/cli/freerdp-proxy.1.in @@ -0,0 +1,58 @@ +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.TH freerdp\-proxy 1 2023-12-14 "@FREERDP_VERSION_FULL@" "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\fP] +[\fB-v\fP] +[\fB--version\fP] +[\fB\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: +* Proxying outdated RDP servers behind a (more secure) proxy +* Protocol analysis +* MITM proxy for +.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\fP +Dump a template configuration to \fB\fP +.IP \fB\fP +Start the proxy with settings read from \fB\fP + +\fBWarning\fP: 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, \fBNLA\fP will fail for connections to the proxy. +To implement authentication a \fBproxy-module\fP can be implemented that can authenticate against some backend +and map connecting users and credentials to target server users and credentials. + +.SH EXAMPLES +freerdp-proxy /some/config/file + +freerdp-proxy --dump-config /some/config/file + +.SH EXIT STATUS +.TP +.B 0 +Successful program execution. +.TP +.B 1 +Otherwise. + +.SH SEE ALSO +wlog(7) + +.SH AUTHOR +FreeRDP