private void NegotiateDesktop()
{
this.c.SendByte((byte)(this.options.ShareDesktop ? 1 : 0));
var width = this.c.ReceiveUInt16BE();
VncStream.SanityCheck(width > 0 && width < 0x8000);
var height = this.c.ReceiveUInt16BE();
VncStream.SanityCheck(height > 0 && height < 0x8000);
VncPixelFormat pixelFormat;
try
{
pixelFormat = VncPixelFormat.Decode(this.c.Receive(VncPixelFormat.Size), 0);
}
catch (ArgumentException e)
{
throw new VncException(
"Unsupported pixel format.",
VncFailureReason.UnsupportedPixelFormat,
e);
}
var name = this.c.ReceiveString();
this.Framebuffer = new VncFramebuffer(name, width, height, pixelFormat);
}
void ThreadMain()
{
var requester = new Utility.PeriodicThread();
IsConnected = true; OnConnected();
try
{
requester.Start(() =>
{
SendFramebufferUpdateRequest(true);
return(true);
}, () => MaxUpdateRate, true);
while (true)
{
var command = _c.ReceiveByte();
switch (command)
{
case 0:
requester.Signal();
HandleFramebufferUpdate();
break;
case 1:
HandleSetColorMapEntries();
break;
case 2:
HandleBell();
break;
case 3:
HandleReceiveClipboardData();
break;
default:
VncStream.Require(false, "Unsupported command.",
VncFailureReason.UnrecognizedProtocolElement);
break;
}
}
}
catch (ObjectDisposedException)
{
}
catch (IOException)
{
}
catch (VncException)
{
}
requester.Stop();
_c.Stream = null;
IsConnected = false; OnClosed();
}
void NegotiateVersion()
{
_serverVersion = _c.ReceiveVersion();
VncStream.Require(_serverVersion >= new Version(3, 8),
"RFB 3.8 not supported by server.",
VncFailureReason.UnsupportedProtocolVersion);
_c.SendVersion(new Version(3, 8));
}
/// <summary>
/// Calculates a response for a password challenge, using a password.
/// </summary>
/// <param name="challenge">
/// The challenge received from the server.
/// </param>
/// <param name="password">
/// The password to encrypt the challenge with.
/// </param>
/// <param name="response">
/// The response to send back to the server.
/// </param>
public static void GetChallengeResponse(byte[] challenge, char[] password, byte[] response)
{
Throw.If.Null(password, "password");
var passwordBytes = VncStream.EncodeString(password, 0, password.Length);
using (new Utility.AutoClear(passwordBytes))
{
GetChallengeResponse(challenge, passwordBytes, response);
}
}
/// <inheritdoc/>
public virtual void GetChallengeResponse(byte[] challenge, char[] password, byte[] response)
{
if (password == null)
{
throw new ArgumentNullException(nameof(password));
}
var passwordBytes = VncStream.EncodeString(password, 0, password.Length);
using (new Utility.AutoClear(passwordBytes))
{
this.GetChallengeResponse(challenge, passwordBytes, response);
}
}
/// <summary>
/// Notifies the server that the local clipboard has changed.
/// If you are implementing clipboard integration, use this to set the remote clipboard.
/// </summary>
/// <param name="data">The contents of the local clipboard.</param>
public void SendLocalClipboardChange(string data)
{
Throw.If.Null(data, "data");
var bytes = VncStream.EncodeString(data);
var p = new byte[8 + bytes.Length];
p[0] = (byte)6;
VncUtility.EncodeUInt32BE(p, 4, (uint)bytes.Length);
Array.Copy(bytes, 0, p, 8, bytes.Length);
if (this.IsConnected)
{
this.c.Send(p);
}
}
/// <summary>
/// Notifies the server that the local clipboard has changed.
/// If you are implementing clipboard integration, use this to set the remote clipboard.
/// </summary>
/// <param name="data">The contents of the local clipboard.</param>
public void SendLocalClipboardChange(string data)
{
if (data == null)
{
throw new ArgumentNullException(nameof(data));
}
var bytes = VncStream.EncodeString(data);
var p = new byte[8 + bytes.Length];
p[0] = (byte)6;
VncUtility.EncodeUInt32BE(p, 4, (uint)bytes.Length);
Array.Copy(bytes, 0, p, 8, bytes.Length);
if (this.IsConnected)
{
this.c.Send(p);
}
}
private ResponseType HandleResponse(PeriodicThread requester = null)
{
var command = (ResponseType)this.c.ReceiveByte();
switch (command)
{
case ResponseType.FramebufferUpdate:
requester?.Signal();
if (!this.HandleFramebufferUpdate())
{
command = ResponseType.DesktopSize;
}
break;
case ResponseType.SetColorMapEntries:
this.HandleSetColorMapEntries();
break;
case ResponseType.Bell:
this.HandleBell();
break;
case ResponseType.ReceiveClipboardData:
this.HandleReceiveClipboardData();
break;
default:
VncStream.Require(
false,
"Unsupported command.",
VncFailureReason.UnrecognizedProtocolElement);
break;
}
return(command);
}
private bool HandleFramebufferUpdate()
{
this.c.ReceiveByte(); // padding
var numRects = this.c.ReceiveUInt16BE();
var rects = new List <VncRectangle>();
var encoding = VncEncoding.DesktopSize;
for (int i = 0; i < numRects; i++)
{
var r = this.c.ReceiveRectangle();
int x = r.X, y = r.Y, w = r.Width, h = r.Height;
VncStream.SanityCheck(w > 0 && w < 0x8000);
VncStream.SanityCheck(h > 0 && h < 0x8000);
int fbW = this.Framebuffer.Width, fbH = this.Framebuffer.Height, bpp = this.Framebuffer.PixelFormat.BytesPerPixel;
var inRange = w <= fbW && h <= fbH && x <= fbW - w && y <= fbH - h;
byte[] pixels;
encoding = (VncEncoding)this.c.ReceiveUInt32BE();
switch (encoding)
{
case VncEncoding.Hextile: // KVM seems to avoid this now that I support Zlib.
var background = new byte[bpp];
var foreground = new byte[bpp];
for (int ty = 0; ty < h; ty += 16)
{
int th = Math.Min(16, h - ty);
for (int tx = 0; tx < w; tx += 16)
{
int tw = Math.Min(16, w - tx);
var subencoding = this.c.ReceiveByte();
pixels = this.AllocateFramebufferScratch(tw * th * bpp);
if ((subencoding & 1) != 0)
{
// raw
this.c.Receive(pixels, 0, tw * th * bpp);
if (inRange)
{
lock (this.Framebuffer.SyncRoot)
{
this.CopyToFramebuffer(x + tx, y + ty, tw, th, pixels);
}
}
}
else
{
pixels = this.AllocateFramebufferScratch(tw * th * bpp);
if ((subencoding & 2) != 0)
{
background = this.c.Receive(bpp);
}
if ((subencoding & 4) != 0)
{
foreground = this.c.Receive(bpp);
}
int ptr = 0;
for (int pp = 0; pp < tw * th; pp++)
{
for (int pe = 0; pe < bpp; pe++)
{
pixels[ptr++] = background[pe];
}
}
int nsubrects = (subencoding & 8) != 0 ? this.c.ReceiveByte() : 0;
if (nsubrects > 0)
{
var subrectsColored = (subencoding & 16) != 0;
for (int subrect = 0; subrect < nsubrects; subrect++)
{
var color = subrectsColored ? this.c.Receive(bpp) : foreground;
var srxy = this.c.ReceiveByte();
var srwh = this.c.ReceiveByte();
int srx = (srxy >> 4) & 0xf, srw = ((srwh >> 4) & 0xf) + 1;
int sry = (srxy >> 0) & 0xf, srh = ((srwh >> 0) & 0xf) + 1;
if (srx + srw > tw || sry + srh > th)
{
continue;
}
for (int py = 0; py < srh; py++)
{
for (int px = 0; px < srw; px++)
{
int off = bpp * (((py + sry) * tw) + (px + srx));
for (int pe = 0; pe < bpp; pe++)
{
pixels[off + pe] = color[pe];
}
}
}
}
}
lock (this.Framebuffer.SyncRoot)
{
this.CopyToFramebuffer(x + tx, y + ty, tw, th, pixels);
}
}
}
}
break;
case VncEncoding.CopyRect:
var srcx = (int)this.c.ReceiveUInt16BE();
var srcy = (int)this.c.ReceiveUInt16BE();
if (srcx + w > fbW)
{
w = fbW - srcx;
}
if (srcy + h > fbH)
{
h = fbH - srcy;
}
if (w < 1 || h < 1)
{
continue;
}
pixels = this.AllocateFramebufferScratch(w * h * bpp);
lock (this.Framebuffer.SyncRoot)
{
this.CopyToGeneral(0, 0, w, h, pixels, srcx, srcy, fbW, fbH, this.Framebuffer.GetBuffer(), w, h);
this.CopyToFramebuffer(x, y, w, h, pixels);
}
break;
case VncEncoding.Raw:
pixels = this.AllocateFramebufferScratch(w * h * bpp);
this.c.Receive(pixels, 0, w * h * bpp);
if (inRange)
{
lock (this.Framebuffer.SyncRoot)
{
this.CopyToFramebuffer(x, y, w, h, pixels);
}
}
break;
case VncEncoding.Zlib:
int bytesDesired = w * h * bpp;
int size = (int)this.c.ReceiveUInt32BE();
VncStream.SanityCheck(size >= 0 && size < 0x10000000);
VncUtility.AllocateScratch(size, ref this.zlibScratch);
this.c.Receive(this.zlibScratch, 0, size);
pixels = Decompress(zlibScratch);
if (inRange)
{
lock (this.Framebuffer.SyncRoot)
{
this.CopyToFramebuffer(x, y, w, h, pixels);
}
}
break;
case VncEncoding.PseudoDesktopSize:
this.Framebuffer = new VncFramebuffer(this.Framebuffer.Name, w, h, this.Framebuffer.PixelFormat);
continue; // Don't call OnFramebufferChanged for this one.
default:
VncStream.Require(
false,
"Unsupported encoding.",
VncFailureReason.UnrecognizedProtocolElement);
break;
}
rects.Add(new VncRectangle(x, y, w, h));
}
if (rects.Count > 0)
{
this.OnFramebufferChanged(new FramebufferChangedEventArgs(rects));
}
return(encoding != VncEncoding.DesktopSize);
}
private void NegotiateSecurity()
{
int count = this.c.ReceiveByte();
if (count == 0)
{
string message = this.c.ReceiveString().Trim('\0');
VncStream.Require(false, message, VncFailureReason.ServerOfferedNoAuthenticationMethods);
}
var types = new List <AuthenticationMethod>();
for (int i = 0; i < count; i++)
{
types.Add((AuthenticationMethod)this.c.ReceiveByte());
}
if (types.Contains(AuthenticationMethod.None))
{
this.c.SendByte((byte)AuthenticationMethod.None);
}
else if (types.Contains(AuthenticationMethod.Password))
{
if (this.options.Password == null)
{
var callback = this.options.PasswordRequiredCallback;
if (callback != null)
{
this.options.Password = callback(this);
}
VncStream.Require(
this.options.Password != null,
"Password required.",
VncFailureReason.PasswordRequired);
}
this.c.SendByte((byte)AuthenticationMethod.Password);
var challenge = this.c.Receive(16);
var password = this.options.Password;
var response = new byte[16];
using (new Utility.AutoClear(challenge))
using (new Utility.AutoClear(response))
{
this.passwordChallenge.GetChallengeResponse(challenge, this.options.Password, response);
this.c.Send(response);
}
}
else
{
VncStream.Require(
false,
"No supported authentication methods.",
VncFailureReason.NoSupportedAuthenticationMethods);
}
uint status = this.c.ReceiveUInt32BE();
if (status != 0)
{
string message = this.c.ReceiveString().Trim('\0');
VncStream.Require(false, message, VncFailureReason.AuthenticationFailed);
}
}
void HandleFramebufferUpdate()
{
_c.ReceiveByte(); // padding
var numRects = _c.ReceiveUInt16BE();
var rects = new List <VncRectangle>();
for (int i = 0; i < numRects; i++)
{
var r = _c.ReceiveRectangle();
int x = r.X, y = r.Y, w = r.Width, h = r.Height;
VncStream.SanityCheck(w > 0 && w < 0x8000);
VncStream.SanityCheck(h > 0 && h < 0x8000);
int fbW = Framebuffer.Width, fbH = Framebuffer.Height, bpp = Framebuffer.PixelFormat.BytesPerPixel;
var inRange = w <= fbW && h <= fbH && x <= fbW - w && y <= fbH - h; byte[] pixels;
var encoding = (VncEncoding)_c.ReceiveUInt32BE();
switch (encoding)
{
case VncEncoding.Hextile: // KVM seems to avoid this now that I support Zlib.
var background = new byte[bpp];
var foreground = new byte[bpp];
for (int ty = 0; ty < h; ty += 16)
{
int th = Math.Min(16, h - ty);
for (int tx = 0; tx < w; tx += 16)
{
int tw = Math.Min(16, w - tx);
var subencoding = _c.ReceiveByte();
pixels = AllocateFramebufferScratch(tw * th * bpp);
if (0 != (subencoding & 1)) // raw
{
_c.Receive(pixels, 0, tw * th * bpp);
if (inRange)
{
lock (Framebuffer.SyncRoot) { CopyToFramebuffer(x + tx, y + ty, tw, th, pixels); }
}
}
else
{
pixels = AllocateFramebufferScratch(tw * th * bpp);
if (0 != (subencoding & 2))
{
background = _c.Receive(bpp);
}
if (0 != (subencoding & 4))
{
foreground = _c.Receive(bpp);
}
int ptr = 0;
for (int pp = 0; pp < tw * th; pp++)
{
for (int pe = 0; pe < bpp; pe++)
{
pixels[ptr++] = background[pe];
}
}
int nsubrects = 0 != (subencoding & 8) ? _c.ReceiveByte() : 0;
if (nsubrects > 0)
{
var subrectsColored = 0 != (subencoding & 16);
for (int subrect = 0; subrect < nsubrects; subrect++)
{
var color = subrectsColored ? _c.Receive(bpp) : foreground;
var srxy = _c.ReceiveByte(); var srwh = _c.ReceiveByte();
int srx = (srxy >> 4) & 0xf, srw = ((srwh >> 4) & 0xf) + 1;
int sry = (srxy >> 0) & 0xf, srh = ((srwh >> 0) & 0xf) + 1;
if (srx + srw > tw || sry + srh > th)
{
continue;
}
for (int py = 0; py < srh; py++)
{
for (int px = 0; px < srw; px++)
{
int off = bpp * ((py + sry) * tw + (px + srx));
for (int pe = 0; pe < bpp; pe++)
{
pixels[off + pe] = color[pe];
}
}
}
}
}
lock (Framebuffer.SyncRoot) { CopyToFramebuffer(x + tx, y + ty, tw, th, pixels); }
}
}
}
break;
case VncEncoding.CopyRect:
var srcx = (int)_c.ReceiveUInt16BE();
var srcy = (int)_c.ReceiveUInt16BE();
if (srcx + w > fbW)
{
w = fbW - srcx;
}
if (srcy + h > fbH)
{
h = fbH - srcy;
}
if (w < 1 || h < 1)
{
continue;
}
pixels = AllocateFramebufferScratch(w * h * bpp);
lock (Framebuffer.SyncRoot)
{
CopyToGeneral(0, 0, w, h, pixels, srcx, srcy, fbW, fbH, Framebuffer.GetBuffer(), w, h);
CopyToFramebuffer(x, y, w, h, pixels);
}
break;
case VncEncoding.Raw:
pixels = AllocateFramebufferScratch(w * h * bpp);
_c.Receive(pixels, 0, w * h * bpp);
if (inRange)
{
lock (Framebuffer.SyncRoot) { CopyToFramebuffer(x, y, w, h, pixels); }
}
break;
case VncEncoding.Zlib:
int bytesDesired = w * h * bpp;
int size = (int)_c.ReceiveUInt32BE(); VncStream.SanityCheck(size >= 0 && size < 0x10000000);
VncUtility.AllocateScratch(size, ref _zlibScratch);
_c.Receive(_zlibScratch, 0, size);
_zlibMemoryStream.Position = 0;
_zlibMemoryStream.Write(_zlibScratch, 0, size);
_zlibMemoryStream.SetLength(size);
_zlibMemoryStream.Position = 0;
if (_zlibInflater == null) // Zlib has a two-byte header.
{
VncStream.SanityCheck(size >= 2); _zlibMemoryStream.Position = 2;
_zlibInflater = new DeflateStream(_zlibMemoryStream, CompressionMode.Decompress, false);
}
pixels = AllocateFramebufferScratch(bytesDesired);
for (int j = 0; j < bytesDesired;)
{
int count = 0;
try
{
count = _zlibInflater.Read(pixels, j, bytesDesired - j);
}
catch (InvalidDataException)
{
VncStream.Require(false,
"Bad data compressed.",
VncFailureReason.UnrecognizedProtocolElement);
}
VncStream.Require(count > 0,
"No data compressed.",
VncFailureReason.UnrecognizedProtocolElement);
j += count;
}
if (inRange)
{
lock (Framebuffer.SyncRoot) { CopyToFramebuffer(x, y, w, h, pixels); }
}
break;
case VncEncoding.PseudoDesktopSize:
Framebuffer = new VncFramebuffer(Framebuffer.Name, w, h, Framebuffer.PixelFormat);
continue; // Don't call OnFramebufferChanged for this one.
default:
VncStream.Require(false,
"Unsupported encoding.",
VncFailureReason.UnrecognizedProtocolElement);
break;
}
rects.Add(new VncRectangle(x, y, w, h));
}
if (rects.Count > 0)
{
OnFramebufferChanged(new FramebufferChangedEventArgs(rects));
}
}
