README 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  1. Ultr@VNC 1.0.0 RC19 Java Viewer
  2. ===================================
  3. Copyright (C) 2002-2005 Ultr@VNC Team. All Rights Reserved.
  4. Copyright (C) 2004 Kenn Min Chong, John Witchel. All Rights Reserved.
  5. Copyright (C) 2004 Alban Chazot. All Rights Reserved.
  6. Copyright (C) 2001,2002 HorizonLive.com, Inc. All Rights Reserved.
  7. Copyright (C) 2001,2002 Constantin Kaplinsky. All Rights Reserved.
  8. Copyright (C) 1999 AT&T Laboratories Cambridge. All Rights Reserved.
  9. This software is distributed under the GNU General Public Licence as
  10. published by the Free Software Foundation. See the file LICENCE.TXT for the
  11. conditions under which this software is made available. VNC also contains
  12. code from other sources. See the Acknowledgements section below, and the
  13. individual files for details of the conditions under which they are made
  14. available.
  15. ****************************************************************************
  16. This JavaViewer supports Ultr@VNC FileTransfer ( >= RC19 protocole version)
  17. as well as Ultr@VNC MS Logon.
  18. So even from a Unix or Mac machine you can use a simple Web browser and do
  19. some FileTransfer with the UltraVNC Win32 Server, as well as taking advantage
  20. of the more secure MSLogon authentication method.
  21. When loaded in the WebBrowser (browsing http://YourUltraServerIP:5800), the
  22. user is prompted to accept or reject the Ultr@VNC JavaViewer applet signed
  23. certificate. It is necessary as this new JavaViewer does some FileTransfer
  24. and consequently needs to access the user's local drives.
  25. WARNING: This JavaViewer Applet can't be loaded using the default MS IE JVM
  26. as it doesn't support Swing. You must install a Java JVM (v1.3 or >).
  27. What still needs to be implemented as soon as possible (that is already in
  28. the Win32 Viewer):
  29. - Add files datetime and size in the files lists
  30. - Add files multi-selection for transfer
  31. - Add a "Parent Directory" button the the files panels.
  32. - Directory transfer
  33. - Delta transfer
  34. - ...
  35. NEW: added support for more color modes, usefull on slow connections:
  36. 64 Colors, 8 Colors, 2 B/W, 8 and 4 Grey Scale colors.
  37. Compiling and Running the JavaViewer
  38. ====================================
  39. ** To compile the JavaViewer
  40. 1. Edit the "mk.bat" file and replace the path "c:\soft" with the
  41. path where your Java sdk stands.
  42. 2. Save and execute your mk.bat
  43. 3. If you want to sign the generated applet so it can be embedded into
  44. Ultra winvnc.exe and injected into web browsers on connections to port 5800,
  45. use the keytool.exe and jarsigner.exe programs that can be found in the
  46. Java sdk.
  47. 4. To replace the winvnc JavaViewer applet with your modifed
  48. and signed applet, copy the generated .class files and the vncviewer.jar
  49. file into winvnc\res directory and recompile WinVNC.
  50. ** To run this JavaViewer as a Java application, you must have the Java
  51. Runtime installed.
  52. 1. Edit the "run.bat" file and replace the path "c:\Ultravnc\JavaViewer"
  53. with the path where you've copied the JavaViewer, then replace "127.0.0.1"
  54. with the IP adress or network name of the machine where WinVNC server is
  55. running.
  56. 2. Save and Execute run.bat
  57. => If the path and adress you've written are correct, you should be prompted
  58. for the VNC password. If MS Logon is required on the server, you will also be
  59. prompted for Windows Username.
  60. Under Linux and Mac, you can also make a batchfile that executes this command:
  61. java.exe -cp **YourJavaViewerFullPath** VncViewer HOST **YourServerIP** PORT 5900
  62. As soon as this new JavaViewer reaches the "beta" stage we'll put the source
  63. code in Ultr@VNC CVS repository. For now, the source code is available on demand
  64. only. If you know Java, have time and want to improve the Ultr@VNC project, your
  65. help would be greatly appreciated.
  66. Compiling from the sources
  67. ==========================
  68. To compile all the .java files to .class files, simply do:
  69. % make all
  70. This will also generate a JAR (Java archive) file containing all the classes.
  71. Copy all the .class files, the .jar file and the .vnc files to an
  72. installation directory (e.g. /usr/local/vnc/classes):
  73. % cp *.class *.jar *.vnc /usr/local/vnc/classes
  74. Make sure that the vncserver script is configured to point to the
  75. installation directory.
  76. Configuration
  77. =============
  78. Ultr@VNC Java viewer supports a number of parameters allowing you to
  79. customize its behaviour. Most parameter names copy settings available from
  80. the Options frame in the Java viewer. Both parameter names and their values
  81. are case-insensitive, with one exception for the "PASSWORD" parameter. Here
  82. is the full list of parameters supported in Ultr@VNC Java viewer:
  83. --> "HOST" (no GUI equivalent)
  84. Value: host name or IP address of the VNC server.
  85. Default: in applet mode, the host from which the applet was loaded.
  86. This parameter tells the viewer which server to connect to. Normally,
  87. it's not needed, because default Java security policy allow connections
  88. from applets to the only one host anyway, and that is the host from which
  89. the applet was loaded.
  90. --> "PORT" (no GUI equivalent)
  91. Value: TCP port number on the VNC server.
  92. Default: none.
  93. This parameter is required in all cases. Note that this port is not the
  94. one used for HTTP connection from the browser, it is the port used for
  95. RFB connection. Usually, VNC servers use ports 58xx for HTTP connections,
  96. and ports 59xx for RFB connections. Thus, most likely, this parameter
  97. should be set to something like 5900, 5901 etc.
  98. --> "PASSWORD"
  99. Value: session password in plan text.
  100. Default: none, ask user.
  101. DO NOT EVER USE THIS PARAMETER, unless you really know what you are
  102. doing. It's extremely dangerous from the security point of view. When
  103. this parameter is set, the viewer won't ever ask for a password.
  104. --> "ENCPASSWORD"
  105. Value: encrypted session password in hex-ascii.
  106. Default: none, ask user.
  107. The same as the "PASSWORD" parameter but DES-encrypted using a fixed key.
  108. Its value should be represented in hex-ascii e.g. "494015f9a35e8b22".
  109. This parameter has higher priority over the "PASSWORD" parameter. DO NOT
  110. EVER USE THIS PARAMETER, unless you really know what you are doing. It's
  111. extremely dangerous from the security point of view, and encryption does
  112. not actually help here since the decryption key is always known.
  113. --> "Encoding"
  114. Values: "Raw", "RRE", "CoRRE", "Hextile", "Zlib", "Tight".
  115. Default: "Tight".
  116. The preferred encoding. "Hextile" is a good choice for fast networks,
  117. while "Tight" is better suited for low-bandwidth connections. From the
  118. other side, the "Tight" decoder in Ultr@VNC Java viewer seems to be more
  119. efficient than "Hextile" decoder so it's possible that this default
  120. setting can be ok for fast networks too.
  121. --> "Compression level"
  122. Values: "Default", "1", "2", "3", "4", "5", "6", "7", "8", "9".
  123. Default: "Default". ;-)
  124. Use specified compression level for "Tight" and "Zlib" encodings. Level 1
  125. uses minimum of CPU time on the server but achieves weak compression
  126. ratios. Level 9 offers best compression but may be slow in terms of CPU
  127. time consumption on the server side. Use high levels with very slow
  128. network connections, and low levels when working over higher-speed
  129. networks. The "Default" value means that the server's default compression
  130. level should be used.
  131. --> "JPEG image quality"
  132. Values: "JPEG off", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9".
  133. Default: "6".
  134. Use the specified image quality level in "Tight" encoding. Quality level
  135. 0 denotes bad image quality but very impressive compression ratios, while
  136. level 9 offers very good image quality at lower compression ratios. If
  137. the value is "JPEG off", the server will not use lossy JPEG compression
  138. in "Tight" encoding.
  139. --> "Cursor shape updates"
  140. Values: "Enable", "Ignore", "Disable".
  141. Default: "Enable".
  142. Cursor shape updates is a protocol extension used to handle remote cursor
  143. movements locally on the client side, saving bandwidth and eliminating
  144. delays in mouse pointer movement. Note that current implementation of
  145. cursor shape updates does not allow a client to track mouse cursor
  146. position at the server side. This means that clients would not see mouse
  147. cursor movements if mouse was moved either locally on the server, or by
  148. another remote VNC client. Set this parameter to "Disable" if you always
  149. want to see real cursor position on the remote side. Setting this option
  150. to "Ignore" is similar to "Enable" but the remote cursor will not be
  151. visible at all. This can be a reasonable setting if you don't care about
  152. cursor shape and don't want to see two mouse cursors, one above another.
  153. --> "Use CopyRect"
  154. Values: "Yes", "No".
  155. Default: "Yes".
  156. The "CopyRect" encoding saves bandwidth and drawing time when parts of
  157. the remote screen are moving around. Most likely, you don't want to
  158. change this setting.
  159. --> "Restricted colors"
  160. Values: "Yes", "No".
  161. Default: "No".
  162. If set to "No", then 24-bit color format is used to represent pixel data.
  163. If set to "Yes", then only 8 bits are used to represent each pixel. 8-bit
  164. color format can save bandwidth, but colors may look very inaccurate.
  165. --> "Mouse buttons 2 and 3"
  166. Values: "Normal", "Reversed".
  167. Default: "Normal".
  168. If set to "Reversed", then right mouse button (button 2) will act as it
  169. was middle mouse button (button 3), and vice versa.
  170. --> "View only"
  171. Values: "Yes", "No".
  172. Default: "No".
  173. If set to "Yes", then all keyboard and mouse events in the desktop window
  174. will be silently ignored and will not be passed to the remote side.
  175. --> "Share desktop"
  176. Values: "Yes", "No".
  177. Default: "Yes".
  178. Share the connection with other clients on the same VNC server. The exact
  179. behaviour in each case depends on the server configuration.
  180. --> "Open new window" (no GUI equivalent, applicable only in the applet mode)
  181. Values: "Yes", "No".
  182. Default: "No".
  183. Operate in a separate window. This makes possible resizing the desktop,
  184. and adds scroll bars when necessary. If the server supports variable
  185. desktop size, the window will resize automatically when remote desktop
  186. size changes.
  187. --> "Show controls" (no GUI equivalent)
  188. Values: "Yes", "No".
  189. Default: "Yes".
  190. Set to "No" if you want to get rid of that button panel at the top.
  191. --> "Show offline desktop" (no GUI equivalent)
  192. Values: "Yes", "No".
  193. Default: "No".
  194. If set to "Yes", the viewer would continue to display desktop even
  195. if the remote side has closed the connection. In this case, if the
  196. button panel is enabled, then the "Disconnect" button would be
  197. changed to "Hide desktop" after the connection is lost.
  198. --> "Defer screen updates" (no GUI equivalent)
  199. Value: time in milliseconds.
  200. Default: "20".
  201. When updating the desktop contents after receiving an update from server,
  202. schedule repaint within the specified number of milliseconds. Small delay
  203. helps to coalesce several small updates into one drawing operation,
  204. improving CPU usage. Set this parameter to 0 to disable deferred updates.
  205. --> "Defer cursor updates" (no GUI equivalent)
  206. Value: time in milliseconds.
  207. Default: "10".
  208. When updating the desktop after moving the mouse, schedule repaint within
  209. the specified number of milliseconds. This setting makes sense only when
  210. "Cursor shape updates" parameter is set to "Enable". Small delay helps to
  211. coalesce several small updates into one drawing operation, improving CPU
  212. usage. Set this parameter to 0 to disable deferred cursor updates.
  213. --> "Defer update requests" (no GUI equivalent)
  214. Value: time in milliseconds.
  215. Default: "50".
  216. After processing an update received from server, wait for the specified
  217. number of milliseconds before requesting next screen update. Such delay
  218. will end immediately on every mouse or keyboard event if not in the "view
  219. only" mode. Small delay helps the server to coalesce several small
  220. updates into one framebuffer update, improving both bandwidth and CPU
  221. usage. Increasing the parameter value does not affect responsiveness on
  222. mouse and keyboard events, but causes delays in updating the screen when
  223. there is no mouse and keyboard activity on the client side.
  224. RECORDING VNC SESSIONS
  225. ======================
  226. Current version of the Ultr@VNC Java viewer is able to record VNC (RFB)
  227. sessions in files for later playback. The data format in saved session files
  228. is compatible with the rfbproxy program written by Tim Waugh. Most important
  229. thing about session recording is that it's supported only if Java security
  230. manager allows access to local filesystem. Typically, it would not work for
  231. unsigned applets. To use this feature, either use Ultr@VNC Java viewer as a
  232. standalone application (Java Runtime Environment or Java Development Kit
  233. should be installed), or as a signed applet. The code checks if it's possible
  234. to support session recording, and if everything's fine, the new "Record"
  235. button should appear in the button panel. Pressing this button opens new
  236. window which controls session recording. The GUI is pretty self-explained.
  237. Other important facts about session recording:
  238. --> All sessions are recorded in the 24-bit color format. If you use
  239. restricted colors (8-bit format), it will be temporarly switched to
  240. 24-bit mode during session recording.
  241. --> All sessions are recorded with cursor shape updates turned off. This is
  242. necessary to represent remote cursor movements in recorded sessions.
  243. --> Closing and re-opening the recording control window does not affect the
  244. recording. It's not necessary to keep that window open during recording a
  245. session.
  246. --> Avoid using Zlib encoding when recording sessions. It's ok if you started
  247. recording BEFORE the connection to the VNC server has been established,
  248. but if you started recording during an active session, all Zlib sessions
  249. will be saved Raw-encoded (that is, without compression at all). Zlib
  250. decoding depends on the pixel data received earlier, thus saving the data
  251. received from the server at an arbitrary moment is not sufficient to
  252. decompress it correctly. And there is no way to say Zlib decoder to reset
  253. decompressor's state -- that's a limitation of the Zlib encoder. The
  254. viewer could re-compress raw pixel data again before saving Zlib-encoded
  255. sessions, but unfortunately Java API does not allow to flush zlib data
  256. streams making it impossible to save Zlib-encoded RFB pixel data without
  257. using native code.
  258. --> Usually, Tight encoding is the most suitable one for session recording,
  259. but some of the issues described above for the Zlib encoding affect the
  260. Tight encoding as well. Unlike Zlib sessions, Tight-encoded sessions are
  261. always saved Tight-encoded, but the viewer has to re-compress parts of
  262. data to synchronize encoder's and decoder's zlib streams. And, due to
  263. Java zlib API limitations, zlib streams' states have to be reset on each
  264. compressed rectangle, causing compression ratios to be lower than in the
  265. original VNC session. If you want to achieve the best possible
  266. performance, turn recording on BEFORE connecting to the VNC server,
  267. otherwise CPU usage and compression ratios may be notably less efficient.
  268. HINTS
  269. =====
  270. --> To refresh remote desktop in the view-only mode, press "r" or "R"
  271. on the keyboard.
  272. ACKNOWLEDGEMENTS
  273. ================
  274. This distribution contains Java DES software by Dave Zimmerman
  275. <dzimm@widget.com> and Jef Poskanzer <jef@acme.com>. This is:
  276. Copyright (c) 1996 Widget Workshop, Inc. All Rights Reserved.
  277. Permission to use, copy, modify, and distribute this software and its
  278. documentation for NON-COMMERCIAL or COMMERCIAL purposes and without fee
  279. is hereby granted, provided that this copyright notice is kept intact.
  280. WIDGET WORKSHOP MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE
  281. SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT
  282. NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  283. PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WIDGET WORKSHOP SHALL NOT BE
  284. LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING,
  285. MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
  286. THIS SOFTWARE IS NOT DESIGNED OR INTENDED FOR USE OR RESALE AS ON-LINE
  287. CONTROL EQUIPMENT IN HAZARDOUS ENVIRONMENTS REQUIRING FAIL-SAFE
  288. PERFORMANCE, SUCH AS IN THE OPERATION OF NUCLEAR FACILITIES, AIRCRAFT
  289. NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL, DIRECT LIFE
  290. SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH THE FAILURE OF THE
  291. SOFTWARE COULD LEAD DIRECTLY TO DEATH, PERSONAL INJURY, OR SEVERE
  292. PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH RISK ACTIVITIES"). WIDGET
  293. WORKSHOP SPECIFICALLY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY OF
  294. FITNESS FOR HIGH RISK ACTIVITIES.
  295. Copyright (C) 1996 by Jef Poskanzer <jef@acme.com>. All rights
  296. reserved.
  297. Redistribution and use in source and binary forms, with or without
  298. modification, are permitted provided that the following conditions
  299. are met:
  300. 1. Redistributions of source code must retain the above copyright
  301. notice, this list of conditions and the following disclaimer.
  302. 2. Redistributions in binary form must reproduce the above copyright
  303. notice, this list of conditions and the following disclaimer in the
  304. documentation and/or other materials provided with the distribution.
  305. THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  306. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  307. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  308. PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
  309. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  310. CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  311. SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  312. BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  313. WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  314. OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  315. ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  316. Visit the ACME Labs Java page for up-to-date versions of this and other
  317. fine Java utilities: http://www.acme.com/java/