FreeRDP User Manual - FOSS
Contents
1. 5 6 Clipboard redirection 5 7 Audio Playback eros monnaie Ee RS 5 8 5 9 Registry Settings 6 1 6 2 6 3 Audio Recording reg File Format Client Settings Server Settings Multitouch pur ata duce ee at A done AA REG DWORD Integer 6 1 2 REG_SZ String mater on bebe dae dbs 6 13 REG BINARY Binary Data 19 20 23 24 26 26 26 28 28 28 29 29 29 30 Chapter 1 Introduction 1 1 References FreeRDP Developer Manual FreeRDP Configuration Manual FreeRDP Testing Manual 1 2 Help FreeRDP A Free Remote Desktop Protocol Implementation See www freerdp com for more information Usage xfreerdp file options v lt server gt port Syntax flag enables flag option lt value gt specifies option with value toggle toggle enables or disables toggle where is a synonym of Ihttps github com awakecoding FreeRDP Manuals blob master Configuration FreeRDP Developer Manual pdf raw true 2https github com awakecoding FreeRDP Manuals blob master Configuration FreeRDP Configuration Manual pdf raw true Shttps github com awakecoding FreeRDP Manuals blob master Testing FreeRDP Testing Manual pdf raw true v lt server gt port Server hostname port lt number gt Server port w lt width gt Width h lt height gt Height size lt width gt x lt height gt Screen2. Id Name 0xE0010404 0xE0010411 0xE0010412 0xE0010804 0xE0020404 0xE0020804 0xE0030404 0xE0030804 0xE0040404 0xE0050404 0xE0050804 0xE0060404 0xE0070404 0xE0080404 0xE0090404 0xE00E0804 0xE00F0404 Chinese Traditional Phonetic Japanese Input System MS IME2002 Korean Input System TME 2000 Chinese Simplified Chinese Traditiona Chinese Simplified Chinese Traditional Chinese Simplified Chinese Traditional Chinese Traditional Chinese Simplified Chinese Traditional Chinese Traditional Chinese Traditional Chinese Traditional Chinese Traditional Chinese Traditional QuanPin 1 ChangJie ShuangPin Quick ZhengMa Big5 Code Array NeiMa DaYi Unicode New Phonetic New ChangJie Microsoft Pinyin IME 3 0 2 Alphanumeric 25 Chapter 5 Redirection 5 1 Drive Redirection To redirect all drives use drives xfreerdp v rdp contoso com drives On Windows each drive has a letter and is redirected individually On Linux the root directory is redirected which is equivalent to redirecting all drives To redirect the user home directory as a drive use home drive xfreerdp v rdp contoso com home drive 9 This is convenient if the user JohnDoe wants to redirect only home JohnDoe instead of the root directory 5 2 Serial Redirection To redirect a serial dev
3. Disabling it is a good idea 3 5 Themes Enabled by default disable with themes Rich themes usually reguire operations with bitmaps while a classic theme can often be drawn with simple and efficient operations using plain colors Disabling themes is worth it if you can stand the look amp feel 17 Type the name of a program folder document or Internet resource and Windows will o pen it for you a Cancel Browse 3 6 Wallpaper Enabled by default disable with wallpaper The wallpaper may look pretty but it is a large image that compresses less efficiently than a plain color background Disabling it reduce rendering time for the background which is particularly noticeable at connection time and when minimizing windows 18 Chapter 4 Input Keyboard mapping is done on the remote end so the local keyboard layout is ignored Instead a Windows keyboard layout id is provided at connection time to tell the server which keyboard layout to use FreeRDP accepts either the numerical keyboard id or the full name of the corresponding keyboard layout xfreerdp v rdp contoso com kbd US xfreerdp v rdp contoso com kbd 0x409 xfreerdp v rdp contoso com kbd Canadian Multilingual Standard xfreerdp v rdp contoso com kbd 0x11009 v Canadian Multilingual Standard US Canadian French Show the Language bar 6 16 PM 11 03 2013 pa faa CP Figure 4 1 Language Bar If no keyboard layout is specifie
4. Fullscreen Boolean Toggle Fullscreen mode f ColorDepth Integer Default color depth bpp KeyboardType Integer Default keyboard type kbd type KeyboardSubType Integer Default keyboard subtype kbd subtype KeyboardFunctionKeys Integer Default keyboard function keys kbd fn key KeyboardLayout Integer Default keyboard layout id kbd ExtSecurity Boolean Extended security sec ext NlaSecurity Boolean Toggle NLA security sec nla TlsSecurity Boolean Toggle TLS security sec tls RdpSecurity Boolean Toggle Standard RDP security sec rdp MstscCookieMode Boolean Toggle connection cookie truncation to 9 characters CookieMaxLength Integer Maximum connection cookie length for truncation BitmapCache Boolean Toggle bitmap cache bitmap cache OffscreenBitmapCache Boolean Toggle offscreen bitmap cache offscreen cache OffscreenBitmapCacheSize Integer Offscreen bitmap cache size OffscreenBitmapCacheEntries Integer Offscreen bitmap cache entry count GlyphCache Boolean Toggle glyph cache glyph cache HKEY_LOCAL_MACHINE SOFTWARE FreeRDP Client BitmapCacheV2 Value Type Description NumCells Integer Number of cells in bitmap cache Cell0ONumEntries Integer Number of entries in bitmap cache cell 0 34 Cell0Persistent CelllNumEntries Cell 1 Persistent Cell2NumEntries Cell2Persistent Cell3NumEntries Cell3Persistent Cell4NumEntries Cell4Persistent AllowCacheWaitingList Boolean Integer Boolean
5. Network connection type clipboard default off Redirect clipboard fonts default off Smooth fonts cleartype aero default off Desktop composition window drag default off Full window drag menu anims default off Menu animations themes default on Themes wallpaper default on Wallpaper gdi lt sw hw gt GDI rendering r x RemoteFX rfx mode lt imagelvideo gt RemoteFX mode frame ack lt number gt Frame acknowledgement nsc NSCodec jpeg JPEG codec jpeg quality lt percentage gt JPEG quality nego default on protocol security negotiation sec lt rdp tls nlalext gt force specific protocol security sec rdp default on rdp protocol security sec tls default on tls protocol security sec nla default on nla protocol security sec ext default off nla extended protocol security cert name lt name gt certificate name cert ignore ignore certificate pcb lt blob gt Preconnection Blob pcid lt id gt Preconnection Id vmconnect lt vmid gt Hyper V console use port 2179 disable negotiation authentication default on authentication hack encryption default on encryption hack grab keyboard default on grab keyboard mouse motion default on mouse motion parent window lt window id gt Parent window id bitmap cache default on bitmap cache offscreen cache default on offscreen bitmap cache glyph cache default on glyph cache codec cache lt rfx nsc jpeg gt bitmap c
6. size Fullscreen mode bpp lt depth gt Session bpp color depth kbd 0x lt layout id gt or lt layout name gt Keyboard layout kbd list List keyboard layouts kbd type lt type id gt Keyboard type kbd subtype lt subtype id gt Keyboard subtype kbd fn key lt function key count gt Keyboard function key count admin Admin or console session multimon Multi monitor workarea Work area t lt title gt Window title decorations default off Window decorations a Addin vc Static virtual channel dvc Dynamic virtual channel u lt domain gt lt user gt or lt user gt lt domain gt Username p lt password gt Password d lt domain gt Domain g lt gateway gt port Gateway Hostname gu lt domain gt lt user gt or lt user gt lt domain gt Gateway username gp lt password gt Gateway password gd lt domain gt Gateway domain app lt alias gt or lt executable path gt Remote application program app name lt app name gt Remote application name for user interface app icon lt icon path gt Remote application icon for user interface app cmd lt parameters gt Remote application command line parameters app file lt file name gt File to open with remote application app guid lt app guid gt Remote application GUID compression default off Compression shell Alternate shell shell dir Shell working directory audio mode Audio output mode mic Audio input microphone network
7. xfreerdp u JohnDoe d CONTOSO p Password123 v rdp contoso com The domain name can also be passed in the username using the same notation accepted by mstsc xfreerdp u CONTOSO JohnDoe p Password123 v rdp contoso com While the above notation is shorter it has an unpractical side effect the backslash is often but not always interpreted as an escape character To avoid the problem make sure the shell does not interpret the backslash as an escape character xfreerdp u CONTOSO JohnDoe p Password123 v rdp contoso com xfreerdp u CONTOSO JohnDoe p Password123 v rdp contoso com 11 From experience most Linux shells will reguire such handling of the backslash character However there are certain cases like the Eclipse launcher which do not reguire it Alternatively the User Principal Name UPN notation can be used xfreerdp u JohnDoe CONTOSO p Password123 v rdp contoso com This notation does not have the drawbacks of the backslash character but introduces a potential conflict with usernames containing the symbol and no domain name This is freguently the case with the new Windows 8 Microsoft Accounts a k a Windows Live Accounts which correspond to an email address To work work around the ambiguity precede the user name john doe live com with a backslash xfreerdp u john doe live com p Password123 v rdp contoso com Be careful to properly handle the backslash character as previously instruc
8. 04 Keyboar dsubType dwor d 00000000 KeyboardFunctionKeys dwor d 00000000 Keyboar dL ayout dwor d 00000409 ki ity dword 00000000 dword 00000001 dwor d 00000001 Rdpsecur ity dwor d 00000001 mstscCookiemode dwor d 00000000 CookiemaxLength dwor d 00000000 Bitmapcache dword 00000001 offscreenBitmapcache dword 00000001 offscreenBitmapcachesize dword 00000000 offscreenBitmapcacheentries dword 00000000 4 Figure 6 1 FreeRDP Windows Registry Settings Most settings are found under AKEY_LOCAL_ MACHINE Softwarel FreeRDP 31 and HKEY LOCAL MACHINE Software WinPR On Windows use regedit exe to edit the registry settings On other operating systems WinPR looks for a file called etc winpr HKLM reg This file is in the reg file format and can be edited manually with a text editor On Windows reg files can be obtained by exporting a section of the registry in regedit exe To do so right click the key in the left pane and select Export The resulting reg file is shown in the above screenshot This textual file can then serve as a template for non Windows usage On non Windows systems the etc winpr folder usually needs to be created manually It is recommended to restrict permissions to this folder due to the sensitive nature of certain configuration settings Current FreeRDP registry settings are all under HKEY LOCAL MACHINE the registry hive meant for system wide configuration In the
9. FreeRDP User Manual Marc Andr Moreau Awake Coding Consulting Inc Contents 1 Introduction 3 1 1 References vut Bee AA AM la mars 3 1 99 Elp is see eee ge he ed ee ace A doi A Aten ee one 3 1 3 Command Line Interface 6 RA Syntaks uaa a UE ee ae HN Did heu 6 1 4 1 Alternate Syntax 8 1 4 2 Deprecated Options 8 143 Common Pitfalls 42 6 3 225 PER pe eas 9 LA Rational nta ep i A des ae A ed 10 2 Authentication 11 2 1 Credentials Prompt 12 2 1 1 Protocol Security 12 Old Authentication 13 Network Level Authentication NLA 14 3 Performance Flags 15 31 Smooth Fonts aa aoa ae She ae ee due ae ae 15 3 2 Desktop Composition 16 3 3 Full Window Dragging 16 3 4 Menu Animations 17 2 9 Themes 0 ok a dau gaie hh bd 17 3 61 Wallpaper st 4 eine en a Ge 18 4 Input 4 1 Keyboard Layouts 4 2 Keyboard Layout Variants 4 3 Keyboard Input Method Editors IMEs Redirection 5 1 Drive Redirection 5 2 Serial Redirection 5 8 Parallel Redirection 5 4 Smartcard Redirection 5 5 Printer Redirection
10. I without being authenticated a distributed denial of service attack could be performed by simply launching multiple unauthenticated connections This is exactly why it is no longer possible to obtain such a GUI prior to authentication with newer security levels E CONTOSOVohnDoe CCS Windows Server 2008 Enterprise Figure 2 1 Winlogon GUI 13 Network Level Authentication NLA Network Level Authentication NLA is reguired by default with servers starting with Windows Vista With NLA authentication is the very first thing that occurs over the wire such that the server will only allocate resources and present a graphical interface to authenticated clients It is also much more secure and provides strong defense mechanisms against Man in the Middle MITM attacks When NLA is negotiated the complete credentials are needed at connection time which is why FreeRDP will prompt for the missing information xfreerdp u JohnDoe d CONTOSO v rdp contoso com connected to rdp contoso com Password 14 Chapter 3 Performance Flags The RDP performance flags are used by the client to tweak certain remote graphical operations affecting the user experience A good example is the wallpaper drawing it reguires sending a lot of data as opposed to filling it with black Using the wallpaper is fast enough on the LAN but it may negatively affect performance over a slower connection such as over a cellular network The same pr
11. Integer Boolean Integer Boolean Integer Boolean Boolean Toggle persistence Number of entries Toggle persistence Number of entries Toggle persistence Number of entries Toggle persistence Number of entries in bitmap cache cell in bitmap cache cell in bitmap cache cell for bitmap cache cel in bitmap cache cell for bitmap cache cell for bitmap cache cell 1 for bitmap cache cell 2 3 13 4 Toggle persistence for bitmap cache cell 4 Allow bitmap cache waiting list HKEY_LOCAL_MACHINE SOFTWARE FreeRDP Client GlyphCache Value Type Description SupportLevel Integer Glyph cache support level CacheONumEntries Integer Number of entries in glyph cache cell 0 Cache0MaxCellSize Integer Glyph cache cell 0 maximum size CachelNumEntries Integer Number of entries in glyph cache cell 1 CachelMaxCellSize Integer Glyph cache cell 1 maximum size Cache2NumEntries Integer Number of entries in glyph cache cell 2 Cache2MaxCellSize Integer Glyph cache cell 2 maximum size Cache3NumEntries Integer Number of entries in glyph cache cell 3 Cache3MaxCellSize Integer Glyph cache cell 3 maximum size Cache4NumEntries Integer Number of entries in glyph cache cell 4 Cache4MaxCellSize Integer Glyph cache cell 4 maximum size Cache5NumEntries Integer Number of entries in glyph cache cell 5 Cache5MaxCellSize Integer Glyph cache cell 5 maximum size Cache6NumEntries Integer Nu
12. Keyboard Layout Variants Id Name 0x00010401 Arabic 102 0x00010402 Bulgarian Latin 0x00010405 Czech QWERTY 0x00010407 German IBM 0x00010408 Greek 220 0x00010409 United States Dvorak 0x0001040A Spanish Variation 0x0001040E Hungarian 101 key 0x00010410 Italian 142 0x00010415 Polish 214 0x00010416 Portuguese Brazilian ABNT2 0x00010419 Russian Typewriter 0x0001041B Slovak QWERTY 0x0001041E Thai Pattachote 0x0001041F Turkish F 23 0x00010426 0x00010427 0x0001042B 0x00010439 0x0001043A 0x0001043B 0x00010445 0x0001045A 0x00010465 0x0001080C 0x0001083B 0x00011009 0x00011809 0x00020401 0x00020405 0x00020408 0x00020409 0x0002041E 0x0002083B 0x00030408 0x00030409 0x0003041E 0x00040408 0x00040409 0x00050408 0x00050409 0x00060408 0xB0000407 Latvian QWERTY Lithuanian Armenian Western Hindi Traditional Maltese 48 key Sami Extended Norway Bengali Inscript Syriac Phonetic Divehi Typewriter Belgian Comma Finnish with Sami Canadian Multilingual Standard Gaelic Arabic 102 AZERTY Czech Programmers Greek 319 United States International Thai Kedmanee non ShiftLock Sami Extended Finland Sweden Greek 220 Latin United States Dvorak for left hand Thai Pattachote non ShiftLock Greek 319 Latin United States Dvorak for right hand Greek Latin US English Table for IBM Arabic 238_L Greek Polytonic German Neo 4 3 Keyboard Input Method Editors IMEs 24
13. ch Folders i gt X 19 Fe Iv Enable bidirectional support Address 3 Printers and Faxes TO Enable printer pooing V O EPSON TM TEBIII Receipt Add Printer a Offline Not Available a Pomo WA EET B ol OA sem Figure 5 1 FreeRDP Serial Redirection 27 5 3 Parallel Redirection To be expanded 5 4 Smartcard Redirection To be expanded 5 5 Printer Redirection To redirect all printers use printer xfreerdp v rdp contoso com printer On Linux and UNIX systems CUPS is the printing backend used An easy way to test printing without a physical printer is to install CUPS PDF a simple CUPS pdf printer Under normal circumstances if your printer is properly configured with CUPS on the client it should be picked up by FreeRDP and redirected properly If you are looking for recommendations on a printer which works well with major operating systems Windows Linux Mac OS X the HP LaserJet Pro P1606dn is a good choice ene Freno printing Test Select Per A add Printer BB CutePDF Writer E Canon P500 Series Printer EPSON TM T8II Receip CUPS POF redirected 2 TS Fax Sms Few OPmiotie Preferences Lossien Fra Porter Figure 5 2 FreeRDP Printer Redirection Thttp www cups pdf de 28 5 6 Clipboard redirection To enable clipboard redirection use clipboard xfreerdp v rdp contoso com clipboard While clipboard redirection is supported in remote d
14. d FreeRDP selects a keyboard layout based on local system settings The Microsoft RDP server only accepts the keyboard layout on session creation if you are reconnecting to an existing session you will need to log out first 19 The list of keyboard layout ids can be shown by using kbd list xfreerdp kbd list Keyboard Layouts 0x00000401 Arabic 101 0x00000402 Bulgarian 0x00000404 Chinese Traditional US Keyboard 0x00000405 Czech 0x00000406 Danish 0x00000407 German 0x00000408 Greek 0x00000409 US One can search for his own keyboard layout by combining the above command with grep xfreerdp kbd list grep Canadian Ox00000C0C Canadian French legacy 0x00001009 Canadian French 0x00011009 Canadian Multilingual Standard 4 1 Keyboard Layouts Id Name 0x00000401 Arabic 101 0x00000402 Bulgarian 0x00000404 Chinese Traditional US Keyboard 0x00000405 Czech 0x00000406 Danish 0x00000407 German 0x00000408 Greek 0x00000409 US 0x0000040A Spanish 0x0000040B Finnish 0x0000040C French 20 0x0000040D 0x0000040E 0x0000040F 0x00000410 0x00000411 0x00000412 0x00000413 0x00000414 0x00000415 0x00000416 0x00000418 0x00000419 0x0000041A 0x0000041B 0x0000041C 0x0000041D 0x0000041E 0x0000041F 0x00000420 0x00000422 0x00000423 0x00000424 0x00000425 0x00000426 0x00000427 0x00000429 0x0000042 A 0x0000042B 0x0000042C 0x0000042F 0x00000437 Hebrew Hungarian Icelandic Italian Japanese Kor
15. ean Dutch Norwegian Polish Programmers Portuguese Brazilian ABNT Romanian Russian Croatian Slovak Albanian Swedish Thai Kedmanee Turkish Q Urdu Ukrainian Belarusian Slovenian Estonian Latvian Lithuanian IBM Farsi Vietnamese Armenian Eastern Azeri Latin FYRO Macedonian Georgian 21 0x00000438 0x00000439 0x0000043A 0x0000043B 0x0000043F 0x00000440 0x00000444 0x00000445 0x00000446 0x00000447 0x00000449 0x0000044 A 0x0000044B 0x0000044C 0x0000044E 0x00000450 0x00000452 0x0000045A 0x00000461 0x00000463 0x00000465 0x0000046E 0x00000481 0x00000804 0x00000807 0x00000809 0x0000080 A 0x0000080C 0x00000813 0x00000816 0x0000081A Faeroese Devanagari INSCRIPT Maltese 47 key Norwegian with Sami Kazakh Kyrgyz Cyrillic Tatar Bengali Punjabi Gujarati Tamil Telugu Kannada Malayalam Marathi Mongolian Cyrillic United Kingdom Extended Syriac Nepali Pashto Divehi Phonetic Luxembourgish Maori Chinese Simplified US Keyboard Swiss German United Kingdom Latin American Belgian French Belgian Period Portuguese Serbian Latin 22 0x0000082C 0x0000083B 0x00000843 0x0000085D 0x00000C0C 0x00000C1A 0x00001009 0x0000100C 0x0000141A 0x00001809 0x0000201 A Azeri Cyrillic Swedish with Sami Uzbek Cyrillic Inuktitut Latin Canadian French legacy Serbian Cyrillic Canadian French Swiss French Bosnian Irish Bosnian Cyrillic 4 2
16. enabling the wallpaper can be done with wallpaper or with wallpaper 1 4 1 Alternate Syntax The alternate syntax produces longer command lines on average but may be more accessible to users who prefer a posix style syntax If this is your case here is how the alternative syntax works flag enables flag option lt value gt specifies option with value enable toggle disable toggle enables or disables toggle Performing syntaxic substitutions on our example the command line becomes xfreerdp f bpp 32 v rdp contoso com enable wallpaper disable themes The same command in the windows style syntax uses 57 characters while the posix style syntax uses 75 characters In this specific case the windows style syntax is approximately 25 shorter than the posix style syntax 1 4 2 Deprecated Options If the deprecated command line options are used FreeRDP warns the user about the deprecation of these options and provides mapping from the old options to the new ones simplifying migration xfreerdp f a 32 enable wallpaper disable themes rdp contoso com WARNING Using deprecated command line interface a 32 gt bpp 32 f gt f rdp contoso com gt v rdp contoso com 1 4 3 Common Pitfalls Supporting two syntaxes along with automated detection of the deprecated options comes with certain pitfalls for the user There are currently three possible cases for parsing the command line New opti
17. erdp f bpp 32 enable wallpaper disable themes v rdp contoso com With the new set of options never forget to use v for the target server otherwise your command line will be interpreted as using the deprecated interface 1 4 4 Rationale One may ask why oh why Well here s why The first easy answer is out of the box compatibility with mstsc but there s a lot more to it than just that One of the most annoying aspect of the posix style syntax is that it uses the minus sign to enable an option preventing unambiguous usage of the same symbol to mean disable Certain programs using a posix style syntax do accept but you need to know which options can be toggled in such a manner beforehand This can easily lead to confusion because one cannot know just by looking at the syntax if the minus sign is used to enable or disable an option as knowledge of the option type is reguired to make the distinction In order to unambiguously make use of the minus as a way to toggle options we need to use a symbol other than minus to enable options Since the windows style syntax uses the slash symbol instead this problem is solved The toggle options are very freguently used in FreeRDP which is why it makes sense to use a syntax that keeps them short and readable When you type options like disable themes multiple times a day and your command lines contain many such options it is hard to argue against us
18. esktop mode it is not yet supported with RemoteApp due to certain technical challenges 5 7 Audio Playback To enable sound redirection use sound xfreerdp v rdp contoso com sound To select a specific sound subsystem use the sys parameter xfreerdp v rdp contoso com sound sys alsa xfreerdp v rdp contoso com sound sys pulse If you experience occasional sound skipping you may try adjusting the sound latency with the latency parameter xfreerdp v rdp contoso com sound latency 400 A short latency will give better audio and video synchronization but will have a shorter buffering time which makes sound skipping more likely 5 8 Audio Recording To enable audio input recording use microphone xfreerdp v rdp contoso com microphone To select a specific sound subsystem use the sys parameter xfreerdp v rdp contoso com microphone sys alsa xfreerdp v rdp contoso com microphone sys pulse 29 5 9 Multitouch Input Multitouch redirection was introduced in RDP8 and is therefore only supported with Windows 8 and Windows Server 2012 servers If you have a multitouch display you can enable true multitouch redirection using multitouch xfreerdp v rdp contoso com multitouch RDP8 multitouch is meant for direct touch devices like multitouch displays and not dependent touch devices like multitouch trackpads Figure 5 3 FreeRDP Multitouch Input 30 Chapter 6 Registry Settings FreeRDP supports configurat
19. future user specific settings may be added under HKEY LOCAL USERS but this has not been done yet sudo mkdir etc winpr sudo nano etc winpr HKLM reg GNU nano 2 2 6 File etc winpr HKLM reg n dows Registry Editor Version 5 00 HKEY_LOCAL_MACHINE SOFTWARE FreeRDP Client DesktopWidth dword 00000400 DesktopHeight dword 00000300 Fullscreen dword 00000000 ColorDepth dword 00000020 KeyboardType dword 00000004 KeyboardSubType dword 00000000 KeyboardFunctionKeys dword 00000000 KeyboardLayout dword 00000409 ExtSecurity dword 00000000 NlaSecurity word 00000001 TlsSecurity word 00000001 RdpSecurity dword 00000001 MstscCookieMode dword 00000000 CookieMaxLength dword 00000000 l BitmapCache dword 00000001 OffscreenBitmapCache dword 00000001 Of fscreenBitmapCacheSize dword 00000000 Of fscreenBitmapCacheEntries dword 00000000 Get Help MO WriteOut Read File Prev Page MX Cut Text Cur Pos A iA M Exit M Justify M Where Is Next Page MY UnCut Textil To Spell Figure 6 2 FreeRDP Linux Registry Settings 32 6 1 reg File Format The reg file format is normally used for exporting and exporting registry settings and is well described in the Microsoft Knowledge Base Article 3105161 It begins with a line containing the file format name and version number followed by an empty line Windows Registry Editor Version 5 00 Registry keys correspond to the folders in t
20. he registry hierarchy A key can have subkeys or values Each value in the registry is strongly typed Common types are REG DWORD REG BINARY and REG SZ Here is a sample reg file containing a test key with a subkey and values of type REG DWORD REG BINARY and REG SZ Windows Registry Editor Version 5 00 HKEY LOCAL MACHINENSOFTWAREVFreeRDPYTest DwordValue dword 0000007b StringValue this is a string HKEY_LOCAL_MACHINE SOFTWARE FreeRDP Test Subkey BinaryValue hex aa bb cc dd ee ff 6 1 1 REG DWORD Integer REG_DWORD is a double word or a 32 bit unsigned integer It is used for numbers and also for boolean values If the value is to be interpreted as boolean 0 is considered FALSE and non zero is considered TRUE REG_DWORD values are formatted as 8 hexadecimal characters so make sure to write a value in base 16 and not in base 10 when editing manually In this case 0000007b is hexadecimal for 123 in decimal 6 1 2 REG SZ String REG SZisa text string Windows exports unicode strings as REG BINARY 6 1 3 REG BINARY Binary Data REG BINARY is either raw data or a unicode string It is exported as a list of hexadecimal values separated by commas Thttp support microsoft com kb 310516 33 6 2 Client Settings HKEY_LOCAL_MACHINE SOFTWARE FreeRDP Client Value Type Description DesktopWidth Integer Default desktop width w DesktopHeight Integer Default desktop height h
21. ice you must first identify the corresponding device file If you are using a USB to serial adapter the device usually shows up as dev ttyUSBO In most cases the device representing the serial device will not be usable with user permissions You can either chown or chmod the device or do it cleanly with udev rules xfreerdp serial C0M3 dev ttyUSBO v rdp contoso com 26 It might be confusing at first but the redirected serial ports will not appear in the device manager Instead open a command prompt and type gt change port guery AUX DosDevices COM1 COM1 Device Serial0 COM2 Device Seriali COM3 Device RdpDrPort COM3 2 tsclient COM3 GLOBALROOT In this above listing dev ttyUSBO is redirected as COM3 You need to manually map the remote COM port to a local COM port net use COMx tsclient COMy Where x is a COM port available on the server and y is a COM port available on the client FreeRDP 192 168 3 70 BY EPSON TM TSBIII Receipt Properties General Sharing Ports Advanced Security Utity Version EPSON TM TEBII Receipt Print to the following port s Documents will print to the first free checked port O COM2 Serial Port O coma Serial Port O COMA Serial Port O FILE Printto File ee O 15033 Inactive TS Port EPSON TM T88lll Receipt O esp COM1 E Printers and Faxes File Edt View Favorites Tools Help jopet __DektePot__ _ ConigwePot Oek Q P A sear
22. inciple applies for themes fonts menu animations window dragging etc 3 1 Smooth Fonts Disabled by default enable with fonts Regular RDP fonts are drawn and encoded separately from images sent over the wire but they have the drawback of not being very crisp and clear Enabling smooth fonts means you get easier to read and clearer characters ClearType but they are sent as images which may be slower 15 This text is not smooth 3 2 Desktop Composition Disabled by default enable with aero This should not be confused with the desktop composition extension that redirects compositing calls for local rendering a feature not supported by FreeRDP This flag will only work in the few cases where compositing can be rendered over RemoteFX As for now this is only possible with Windows 7 SP1 on Hyper V on Windows Server 2008 R2 SP1 with RemoteFX 3D 3 3 Full Window Dragging Disabled by default enable with window drag Dragging a window around is particularly intensive as it causes a lot of graphical updates each time you move the window by one pixel there is a large area of the screen that needs to be updated To work around this problem the server can draw the outline of the window as you drag it and only draw the full window once you are done dragging it 16 3 4 Menu Animations Disabled by default enable with menu anims Just like window dragging menu animations may cause a lot of successive graphical updates
23. ing the notation One other strong aspect of the windows style syntax is the usage of the colon as an option value separator instead of a space While this may reguire some adaptation for some users it reduces the potential for ambiguity in the case of values that are lists Most of the time windows style syntaxes encode lists as comma separated values list item1 item2 item3 With regular posix style syntax the same list would be encoded this way list itemi item2 item3 In the case of FreeRDP lists are encoded in the same way regardless of the syntax in use even if this diverges slightly from standard practice list item1 item2 item3 The comma separated list is used because it provides unambiguous encoding of a list otherwise there is no way of knowing where the list ends which is which the regular posix style syntax makes use of as the end of list delimiter The old set of FreeRDP options historically made use of this list encoding and it definitely won t be missed by many users If even after reading this you can t get used to the windows style syntax simply make use of the posix style syntax 10 Chapter 2 Authentication Sample Values e User JohnDoe e Domain CONTOSO e Password Password123 e Server rdp contoso com There simplest unambiguous way of passing credentials at the command line is with u d and p The domain name is only needed if you connect using domain credentials
24. ion through registry keys using the WinPR Registry API On Windows the native Windows registry is used On other platforms WinPR uses a simple reg file g Registry Editor File Edit View Favorites Help a 3 Computer D Ji HKEY_CLASSES_ROOT b J HKEY_CURRENT_USER a J HKEV LOCAL MACHINE gt J BCD00000000 pj HARDWARE gt SAM AD SECURITY 4 0 SOFTWARE b B ATI Technologies d CBSTEST b Je Classes Ji Clients A FreeRDP M Client A Server gt Ja Intel B Microsoft b B Mozilla b M mozilla org gt MozillaPlugins gt J ODBC gt Je Policies B RegisteredApplicatior b Sonic gt J WOW6432Node m CookieMaxLength DesktopHeight no DesktopWidth ExtSecurity Fullscreen KeyboardFunctionKeys KeyboardType MstscCookieMode NlaSecurity OffscreenBitmapCache OffscreenBitmapCacheEntries fro OffscreenBitmapCacheSize RdpSecurity 9 TlsSecurity Type Data REG_SZ value not set REG_DWORD 0x00000001 1 REG_DWORD 000000020 32 REG_DWORD 0x00000000 0 REG_DWORD 0x00000300 768 REG_DWORD 0x00000400 1024 REG DWORD 0x00000000 0 REG DWORD 0x00000000 0 REG DWORD 0x00000000 0 REG DWORD 0x00000409 1033 File Edit Format View Help windows Registry Editor Version 5 00 HKEY_LOCAL_MACHINE SOFTWARE FreeRDP Client pesktopwidth dword 00000400 DesktopHei ght dwor d 00000300 Fullscreen dwor d 00000000 color Depth dwor d 00000020 a ape tae 000000
25. mber of entries in glyph cache cell 6 Cache6MaxCellSize Integer Glyph cache cell 6 maximum size Cache7NumEntries Integer Number of entries in glyph cache cell 7 Cache7MaxCellSize Integer Glyph cache cell 7 maximum size 35 Cache8NumEntries Cache8MaxCellSize Cache9NumEntries Cache9MaxCellSize FragCacheNumEntries FragCacheMaxCellSize Integer Integer Integer Integer Integer Integer Number of entries in glyph cache cell 8 Glyph cache cell 8 maximum size umber of entries in glyph cache cell 9 lyph cache cell 9 maximum size umber of entries in glyph fragment cache N G N G lyph fragment cache cell maximum size HKEY_LOCAL_MACHINE SOFTWARE FreeRDP Client PointerCache Value Type Description LargePointer Boolean Large pointer support ColorPointer Boolean Color pointer support PointerCacheSize Integer Pointer cache size 6 3 Server Settings HKEY_LOCAL MACHINE SOFTWARE FreeRDP Server Value Type Description ExtSecurity Boolean Extended security NlaSecurity Boolean Toggle NLA security TlsSecurity Boolean Toggle TLS security RdpSecurity Boolean Toggle Standard RDP security CertificateFile String Absolute path to x509 certificate file PrivateKeyFile String Absolute path to x509 key file 36
26. nching mstsc with the option On top of this basic set of options FreeRDP provides a large selection of extended options to fit all needs possible The result is a compatible and consistent RDP implementation which is much more flexible and extensible than the original This is why FreeRDP is used on Windows where mstsc is already available for free 1 4 Syntax FreeRDP supports two command line syntaxes the default windows style syntax and the alternative posix style syntax This is made possible by a generic and highly reusable command line parsing engine that is part of WinPR On average the windows style syntax provides shorter command lines than the posix style syntax However many users tend to prefer the posix style syntax and may strongly dislike the windows style syntax which is why both syntaxes are supported For the purpose of documenting FreeRDP the windows style syntax is preferred over the posix style syntax There are three types of options possible flag enables flag option lt value gt specifies option with value toggle toggle enables or disables toggle where is a synonym of MSTSC lt connection file gt v lt server port gt admin f ullscreen w lt width gt h lt height gt public span multimon migrate edit connection file connection file Specifies the name of an RDP file for the connection v lt server port gt Specifies the remote com
27. odec cache fast path default on fast path input output async input default off asynchronous input async update default off asynchronous update version print version help print help Examples xfreerdp connection rdp p Pwd123 xfreerdp u CONTOSO JohnDoe p Pwd123 v rdp contoso com xfreerdp u JohnDoe p Pwd123 w 1366 h 768 v 192 168 1 100 4489 xfreerdp u JohnDoe p Pwd123 vmconnect C824F53E 95D2 46C6 9A18 23A5BB403532 v 192 168 1 Clipboard Redirection clipboard Drive Redirection a drive home home Smartcard Redirection a smartcard lt device gt Printer Redirection a printer lt device gt lt driver gt Serial Port Redirection a serial lt device gt Parallel Port Redirection a parallel lt device gt Printer Redirection a printer lt device gt lt driver gt Audio Input Redirection dvc audin sys alsa Audio Output Redirection vc rdpsnd sys alsa Multimedia Redirection dvc tsmf sys alsa USB Device Redirection dvc urbdrc id dev 054c 0268 1 3 Command Line Interface As of FreeRDP 1 1 the command line interface supports two syntaxes and a completely redesigned set of command line options Since this is a major change backwards compatibility is still provided for the now deprecated old command line interface FreeRDP uses the same command line syntax and options as mstsc as a basis allowing a consistent interface between RDP implementations The mstsc help can be obtained by lau
28. ons windows style syntax New options posix style syntax Old options posix style syntax The way parsing works is that FreeRDP attempts parsing the command line according to the three possible cases and counts the number of accepted options The command line is then parsed again for real based on these results Since the old options had restrictions on the positions of certain arguments like the target server that are not present this difference is also used to facilitate proper detection of the syntax and options in use Since the command line is parsed according to only one syntax and option set at a time one cannot mix syntaxes and options that belong to different cases The following example shows incorrect mixing of the command line syntaxes that will lead to incorrect parsing of some of the options xfreerdp f bpp 32 v rdp contoso com wallpaper themes A valid command line for the above example needs to be either one of the following xfreerdp f bpp 32 v rdp contoso com wallpaper themes xfreerdp f bpp 32 v rdp contoso com enable wallpaper disable themes Another common mistake made by users migrating from the old options is to put the target server name as the last argument without an option name xfreerdp f bpp 32 enable wallpaper disable themes rdp contoso com WARNING Using deprecated command line interface f gt f rdp contoso com gt v rdp contoso com The correct command would be xfre
29. puter to which you want to connect admin Connects you to the session for administering a server f Starts Remote Desktop in full screen mode w lt width gt Specifies the width of the Remote Desktop window h lt height gt Specifies the height of the Remote Desktop window public Runs Remote Desktop in public mode span Matches the remote desktop width and height with the local virtual desktop spanning across multiple monitors if necessary To span across monitors the monitors must be arranged to form a rectangle multimon Configures the remote desktop session monitor layout to be identical to the current client side configuration edit Opens the specified RDP connection file for editing migrate Migrates legacy connection files that were created with Client Connection Manager to new RDP connection files Figure 1 1 mstsc help If we observe the following command line xfreerdp f bpp 32 v rdp contoso com wallpaper themes f is a flag which enables the fullscreen mode bpp 32 is the bpp option that specifies the color depth with a value of 32 v rdp contoso com is the v option for the target server with rdp contoso com as its value wallpaper is an option that enables the wallpaper toggle option themes is an option that disables the themes toggle option Enabling a toggle option can be done with both and for the sake of simplicity This means that
30. ted Passwords entered as command line arguments could potentially be seen by other users on the same system so they are automatically hidden awake workstation ps aux grep freerdp awake 22506 0 0 0 1 2502620 10236 s002 S 11 10pm 0 01 00 xfreerdp u Jc 2 1 Credentials Prompt If you omit entering credentials at the command line FreeRDP may prompt you for credentials depending on the negotiated protocol security level 2 1 1 Protocol Security RDP protocol security is confusing for many users because it strongly affects the way credentials can be prompted There are three main security levels that can be negotiated e RDP Security old encryption old authentication e TLS Security TLS encryption old authentication e NLA Security TLS encryption NLA authentication 12 Old Authentication The old RDP authentication mechanism is very simple the server presents the client with the Winlogon GUI and the user can either automatically or manually enter the credentials If you enter credentials prior to connecting to a server with the old authentication they will be automatically on connection saving you the trouble of typing them manually Old RDP authentication may be practical in the sense that you can get a remote Winlogon GUI without being authenticated on the server This is however a design flaw which makes the RDP server vulnerable to a DDOS attack since significant resources need to be allocated for the Winlogon GU
Download Pdf Manuals
Related Search