xenadmin/CommandLib/thinCLIProtocol.cs
Konstantina Chremmou 5614dafbe6 CA-329742, CA-330301: Logging simplification.
Signed-off-by: Konstantina Chremmou <konstantina.chremmou@citrix.com>
2019-11-13 12:31:44 +00:00

617 lines
26 KiB
C#

/* Copyright (c) Citrix Systems, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms,
* with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
using System;
using System.Collections.Generic;
using System.Text;
using System.Security.Cryptography.X509Certificates;
using System.Net.Security;
using System.IO;
using System.Net.Sockets;
using System.Security.Authentication;
namespace CommandLib
{
public class Config
{
public string hostname = ""; // no default hostname
public string username = "root";
public string password = "";
public int port = 443;
public int block_size = 65536;
public bool nossl = false;
public bool debug = false;
}
public delegate void delegateGlobalError(String s);
public delegate void delegateGlobalUsage();
public delegate void delegateGlobalDebug(String s, thinCLIProtocol tCLIprotocol);
public delegate void delegateConsoleWrite(String s);
public delegate void delegateConsoleWriteLine(String s);
public delegate string delegateConsoleReadLine();
public delegate void delegateExit(int i);
public delegate void delegateProgress(int i);
public class thinCLIProtocol
{
public delegateGlobalError dGlobalError;
public delegateGlobalUsage dGlobalUsage;
public delegateGlobalDebug dGlobalDebug;
public delegateConsoleWrite dConsoleWrite;
public delegateConsoleWriteLine dConsoleWriteLine;
public delegateConsoleReadLine dConsoleReadLine;
public delegateProgress dProgress;
public delegateExit dExit;
public Config conf;
public string magic_string = "XenSource thin CLI protocol";
public int major = 0;
public int minor = 1;
public bool dropOut;
public thinCLIProtocol(delegateGlobalError dGlobalError,
delegateGlobalUsage dGlobalUsage,
delegateGlobalDebug dGlobalDebug,
delegateConsoleWrite dConsoleWrite,
delegateConsoleWriteLine dConsoleWriteLine,
delegateConsoleReadLine dConsoleReadLine,
delegateExit dExit,
delegateProgress dProgress,
Config conf)
{
this.dGlobalError = dGlobalError;
this.dGlobalUsage = dGlobalUsage;
this.dGlobalDebug = dGlobalDebug;
this.dConsoleWrite = dConsoleWrite;
this.dConsoleWriteLine = dConsoleWriteLine;
this.dConsoleReadLine = dConsoleReadLine;
this.dExit = dExit;
this.dProgress = dProgress;
this.conf = conf;
dropOut = false;
}
}
public class Transport{
// The following method is invoked by the RemoteCertificateValidationDelegate.
private static bool ValidateServerCertificate(
object sender,
X509Certificate certificate,
X509Chain chain,
SslPolicyErrors sslPolicyErrors)
{
// Do allow this client to communicate with unauthenticated servers.
return true;
}
public static Stream connect(thinCLIProtocol tCLIprotocol, String hostname, int port)
{
if (port != 443){
TcpClient client = new TcpClient(hostname, port);
Stream stream = client.GetStream();
return stream;
} else {
TcpClient client = new TcpClient(hostname, port);
// Create an SSL stream that will close the client's stream.
SslStream sslStream = new SslStream(
client.GetStream(),
false,
new RemoteCertificateValidationCallback(ValidateServerCertificate),
null
);
try
{
sslStream.AuthenticateAsClient("", null, SslProtocols.Tls | SslProtocols.Tls11 | SslProtocols.Tls12, true);
}
catch (AuthenticationException e){
if (tCLIprotocol.conf.debug) throw e;
tCLIprotocol.dGlobalError("Authentication failed - closing the connection.");
client.Close();
return null;
} catch (Exception e) {
if (tCLIprotocol.conf.debug) throw e;
tCLIprotocol.dGlobalError("Exception during SSL auth - closing the connection.");
client.Close();
return null;
}
return sslStream;
}
}
}
public class HTTP{
public static string readLine(Stream stream){
StringBuilder messageData = new StringBuilder();
do {
int i = stream.ReadByte();
if (i == -1)
{
throw new EndOfStreamException();
}
else
{
char b = (char)i;
messageData.Append(b);
if (b == '\n') break;
}
} while (true);
return messageData.ToString();
}
public static void writeLine(Stream stream, string line){
byte[] message = Encoding.UTF8.GetBytes(string.Format("{0}\r\n", line));
stream.Write(message, 0, message.Length);
stream.Flush();
}
public static int getResultCode(string line){
string[] bits = line.Split(new char[] {' '});
if (bits.Length < 2) return 0;
return Int32.Parse(bits[1]);
}
public static Stream doRPC(String method, Uri uri, thinCLIProtocol tCLIprotocol, params string[] headers)
{
Stream http = Transport.connect(tCLIprotocol, uri.Host, uri.Port);
String startLine = string.Format("{0} {1} HTTP/1.0", method, uri.PathAndQuery);
writeLine(http, startLine);
foreach (string h in headers)
writeLine(http, h);
writeLine(http, "");
String response = readLine(http);
int code = getResultCode(response);
switch (code)
{
case 200:
break;
case 302:
string url = "";
while (true)
{
response = readLine(http);
if (response.StartsWith("Location: "))
url = response.Substring(10);
if (response.Equals("\r\n") || response.Equals("")) break;
}
Uri redirect = new Uri(url.Trim());
tCLIprotocol.conf.hostname = redirect.Host;
http.Close();
return doRPC(method, redirect, tCLIprotocol, headers);
default:
tCLIprotocol.dGlobalError(string.Format("Received error code {0} from the server doing an HTTP {1}", code, method));
http.Close();
return null;
}
while (true)
{
response = readLine(http);
if (response.Equals("\r\n") || response.Equals("")) break;
}
// Stream should be positioned after the headers
return http;
}
}
public class Types{
public static uint unmarshal_int32(Stream stream){
uint a = (uint)stream.ReadByte();
uint b = (uint)stream.ReadByte();
uint c = (uint)stream.ReadByte();
uint d = (uint)stream.ReadByte();
//Console.WriteLine("a = " + a + " b = " + b + " c = " + c + " d = " + d);
return (a << 0) | (b << 8) | (c << 16) | (d << 24);
}
public static void marshal_int32(Stream stream, uint x){
uint mask = 0xff;
stream.WriteByte((byte) ((x >> 0) & mask));
stream.WriteByte((byte) ((x >> 8) & mask));
stream.WriteByte((byte) ((x >> 16) & mask));
stream.WriteByte((byte) ((x >> 24) & mask));
}
public static int unmarshal_int(Stream stream){
return (int)unmarshal_int32(stream);
}
public static void marshal_int(Stream stream, int x){
marshal_int32(stream, (uint)x);
}
public static byte[] unmarshal_n(Stream stream, uint n){
byte[] buffer = new byte[n];
int toread = (int)n;
int offset = 0;
while (toread > 0){
int nread = stream.Read(buffer, offset, toread);
offset= nread; toread -= nread;
}
return buffer;
}
public static string unmarshal_string(Stream stream){
uint length = unmarshal_int32(stream);
byte[] buffer = unmarshal_n(stream, length);
Decoder decoder = Encoding.UTF8.GetDecoder();
char[] chars = new char[decoder.GetCharCount(buffer, 0, (int)length)];
decoder.GetChars(buffer, 0, (int)length, chars, 0);
return new string(chars);
}
public static void marshal_string(Stream stream, string x){
marshal_int(stream, x.Length);
char[] c = x.ToCharArray();
Encoder encoder = Encoding.UTF8.GetEncoder();
byte[] bytes = new byte[encoder.GetByteCount(c, 0, c.Length, true)];
encoder.GetBytes(c, 0, c.Length, bytes, 0, true);
stream.Write(bytes, 0, bytes.Length);
}
}
public class Messages
{
public enum tag
{
Print = 0, Load = 1, HttpGet = 12, HttpPut = 13, Prompt = 3, Exit = 4,
Error = 14, OK = 5, Failed = 6, Chunk = 7, End = 8, Command = 9, Response = 10,
Blob = 11, Debug = 15, PrintStderr = 16
};
public static tag unmarshal_tag(Stream stream)
{
int x = Types.unmarshal_int(stream);
return (tag)x;
}
public static void marshal_tag(Stream stream, tag tag)
{
Types.marshal_int(stream, (int)tag);
}
public static void marshal_response(Stream stream, tag t)
{
Types.marshal_int(stream, 4 + 4);
marshal_tag(stream, tag.Response);
marshal_tag(stream, t);
}
public static void protocol_failure(string msg, tag t, thinCLIProtocol tCLIprotocol)
{
tCLIprotocol.dGlobalError("Protocol failure: Reading " + msg + ": unexpected tag: " + t);
tCLIprotocol.dExit(1);
}
public static void load(Stream stream, string filename, thinCLIProtocol tCLIprotocol)
{
try
{
using (FileStream fs = new FileStream(filename, FileMode.Open, FileAccess.Read))
{
FileInfo fi = new FileInfo(filename);
// Immediately report our success in opening the file
marshal_response(stream, tag.OK);
// The server doesn't like multiple chunks but this is fine for
// Zurich/Geneva imports
Types.marshal_int(stream, 4 + 4 + 4);
marshal_tag(stream, tag.Blob);
marshal_tag(stream, tag.Chunk);
Types.marshal_int32(stream, (uint)fi.Length);
byte[] block = new byte[tCLIprotocol.conf.block_size];
while (true)
{
int n = fs.Read(block, 0, block.Length);
if (n == 0)
{
Types.marshal_int(stream, 4 + 4);
marshal_tag(stream, tag.Blob);
marshal_tag(stream, tag.End);
break;
}
stream.Write(block, 0, n);
tCLIprotocol.dProgress(n);
}
}
}
catch (DirectoryNotFoundException)
{
marshal_response(stream, tag.Failed);
}
catch (FileNotFoundException)
{
marshal_response(stream, tag.Failed);
}
}
public static void http_put(Stream stream, string filename, Uri uri, thinCLIProtocol tCLIprotocol)
{
try
{
using (FileStream fs = new FileStream(filename, FileMode.Open, FileAccess.Read))
{
using (Stream http = HTTP.doRPC("PUT", uri, tCLIprotocol,
string.Format("Content-Length: {0}", fs.Length)))
{
if (http == null)
{
marshal_response(stream, tag.Failed);
return;
}
byte[] block = new byte[tCLIprotocol.conf.block_size];
while (true)
{
int n = fs.Read(block, 0, block.Length);
if (n == 0) break;
http.Write(block, 0, n);
}
marshal_response(stream, tag.OK);
}
}
}
catch (FileNotFoundException)
{
tCLIprotocol.dGlobalError("File not found");
marshal_response(stream, tag.Failed);
}
catch (Exception e)
{
tCLIprotocol.dGlobalError(string.Format("Received exception: {0}", e.Message));
marshal_response(stream, tag.Failed);
}
}
public static void http_get(Stream stream, string filename, Uri uri, thinCLIProtocol tCLIprotocol)
{
try
{
if (File.Exists(filename))
throw new Exception(string.Format("The file '{0}' already exists", filename));
using (FileStream fs = new FileStream(filename, FileMode.Create, FileAccess.Write))
{
using (Stream http = HTTP.doRPC("GET", uri, tCLIprotocol))
{
if (http == null)
{
tCLIprotocol.dGlobalError("Server rejected request");
marshal_response(stream, tag.Failed);
return;
}
byte[] block = new byte[tCLIprotocol.conf.block_size];
while (true)
{
int n = http.Read(block, 0, block.Length);
if (n == 0) break;
fs.Write(block, 0, n);
}
marshal_response(stream, tag.OK);
}
}
}
catch (Exception e)
{
tCLIprotocol.dGlobalError("Received exception: " + e.Message);
tCLIprotocol.dGlobalError("Unable to write output file: " + filename);
marshal_response(stream, tag.Failed);
}
}
public static void version_handshake(Stream stream, thinCLIProtocol tCLIprotocol)
{
/* Check for the initial magic string */
byte[] magic = Types.unmarshal_n(stream, (uint)tCLIprotocol.magic_string.Length);
for (int i = 0; i < tCLIprotocol.magic_string.Length; i++)
{
if (magic[i] != tCLIprotocol.magic_string[i])
{
tCLIprotocol.dGlobalError("Failed to find a server on " + tCLIprotocol.conf.hostname + ":" + tCLIprotocol.conf.port);
tCLIprotocol.dGlobalUsage();
tCLIprotocol.dExit(1);
}
}
/* Read the remote version numbers */
int remote_major = Types.unmarshal_int(stream);
int remote_minor = Types.unmarshal_int(stream);
tCLIprotocol.dGlobalDebug("Remote host has version " + remote_major + "." + remote_minor, tCLIprotocol);
tCLIprotocol.dGlobalDebug("Client has version " + tCLIprotocol.major + "." + tCLIprotocol.minor, tCLIprotocol);
if (tCLIprotocol.major != remote_major)
{
tCLIprotocol.dGlobalError("Protocol version mismatch talking to server on " + tCLIprotocol.conf.hostname + ":" + tCLIprotocol.conf.port);
tCLIprotocol.dGlobalUsage();
tCLIprotocol.dExit(1);
}
/* Tell the server our version numbers */
for (int i = 0; i < tCLIprotocol.magic_string.Length; i++)
{
stream.WriteByte((byte)tCLIprotocol.magic_string[i]);
}
Types.marshal_int(stream, tCLIprotocol.major);
Types.marshal_int(stream, tCLIprotocol.minor);
}
public static void performCommand(string Body, thinCLIProtocol tCLIprotocol)
{
string body = Body;
body += "username=" + tCLIprotocol.conf.username + "\n";
body += "password=" + tCLIprotocol.conf.password + "\n";
if (body.Length != 0)
{
body = body.Substring(0, body.Length - 1); // strip last "\n"
}
string header = "POST /cli HTTP/1.0\r\n";
string content_length = "content-length: " + Encoding.UTF8.GetBytes(body).Length + "\r\n";
string tosend = header + content_length + "\r\n" + body;
try
{
Stream stream = Transport.connect(tCLIprotocol, tCLIprotocol.conf.hostname, tCLIprotocol.conf.port);
if (stream == null)
{
// The SSL functions already tell us what happened
tCLIprotocol.dExit(1);
}
byte[] message = Encoding.UTF8.GetBytes(tosend);
stream.Write(message, 0, message.Length);
stream.Flush();
Messages.version_handshake(stream, tCLIprotocol);
interpreter(stream, tCLIprotocol);
}
catch (SocketException)
{
tCLIprotocol.dGlobalError("Connection to " + tCLIprotocol.conf.hostname + ":" + tCLIprotocol.conf.port + " refused.");
tCLIprotocol.dExit(1);
}
catch (Exception e)
{
if (tCLIprotocol.conf.debug) throw e;
tCLIprotocol.dGlobalError("Caught exception: " + e.Message);
tCLIprotocol.dExit(1);
}
}
public static void interpreter(Stream stream, thinCLIProtocol tCLIprotocol)
{
string filename = "";
string path = "";
string msg = "";
while (!tCLIprotocol.dropOut)
{
Types.unmarshal_int32(stream); // total message length (unused here)
Messages.tag t = Messages.unmarshal_tag(stream);
switch (t)
{
case Messages.tag.Command:
t = Messages.unmarshal_tag(stream);
switch (t)
{
case Messages.tag.Print:
msg = Types.unmarshal_string(stream);
tCLIprotocol.dGlobalDebug("Read: Print: " + msg, tCLIprotocol);
tCLIprotocol.dConsoleWriteLine(msg);
break;
case Messages.tag.PrintStderr:
msg = Types.unmarshal_string(stream);
tCLIprotocol.dGlobalDebug("Read: PrintStderr: " + msg, tCLIprotocol);
tCLIprotocol.dConsoleWriteLine(msg);
break;
case Messages.tag.Debug:
msg = Types.unmarshal_string(stream);
tCLIprotocol.dGlobalDebug("Read: Debug: " + msg, tCLIprotocol);
tCLIprotocol.dConsoleWriteLine(msg);
break;
case Messages.tag.Exit:
int code = Types.unmarshal_int(stream);
tCLIprotocol.dGlobalDebug("Read: Command Exit " + code, tCLIprotocol);
tCLIprotocol.dExit(code);
break;
case Messages.tag.Error:
tCLIprotocol.dGlobalDebug("Read: Command Error", tCLIprotocol);
string err_code = Types.unmarshal_string(stream);
tCLIprotocol.dConsoleWriteLine("Error code: " + err_code);
tCLIprotocol.dConsoleWrite("Error params: ");
int length = Types.unmarshal_int(stream);
for (int i = 0; i < length; i++)
{
string param = Types.unmarshal_string(stream);
tCLIprotocol.dConsoleWrite(param);
if (i != (length - 1)) tCLIprotocol.dConsoleWrite(", ");
}
tCLIprotocol.dConsoleWriteLine("");
break;
case Messages.tag.Prompt:
tCLIprotocol.dGlobalDebug("Read: Command Prompt", tCLIprotocol);
string response = tCLIprotocol.dConsoleReadLine();
tCLIprotocol.dConsoleWriteLine("Read "+response);
/* NB, 4+4+4 here for the blob, chunk and string length, put in by the marshal_string
function. A franken-marshal. */
Types.marshal_int(stream, 4 + 4 + 4); // length
Messages.marshal_tag(stream, Messages.tag.Blob);
Messages.marshal_tag(stream, Messages.tag.Chunk);
Types.marshal_string(stream, response);
Types.marshal_int(stream, 4 + 4); // length
Messages.marshal_tag(stream, Messages.tag.Blob);
Messages.marshal_tag(stream, Messages.tag.End);
break;
case Messages.tag.Load:
filename = Types.unmarshal_string(stream);
tCLIprotocol.dGlobalDebug("Read: Load " + filename, tCLIprotocol);
Messages.load(stream, filename, tCLIprotocol);
break;
case Messages.tag.HttpPut:
filename = Types.unmarshal_string(stream);
path = Types.unmarshal_string(stream);
Uri uri = ParseUri(path, tCLIprotocol);
tCLIprotocol.dGlobalDebug("Read: HttpPut " + filename + " -> " + uri, tCLIprotocol);
Messages.http_put(stream, filename, uri, tCLIprotocol);
break;
case Messages.tag.HttpGet:
filename = Types.unmarshal_string(stream);
path = Types.unmarshal_string(stream);
uri = ParseUri(path, tCLIprotocol);
tCLIprotocol.dGlobalDebug("Read: HttpGet " + filename + " -> " + uri, tCLIprotocol);
Messages.http_get(stream, filename, uri, tCLIprotocol);
break;
default:
Messages.protocol_failure("Command", t, tCLIprotocol);
break;
}
break;
default:
Messages.protocol_failure("Message", t, tCLIprotocol);
break;
}
}
}
private static Uri ParseUri(string path, thinCLIProtocol tcli)
{
// The server sometimes sends us a relative path (e.g. for VM import)
// and sometimes an absolute URI (https://host/path). Construct the absolute URI
// based on what we're given. The same hack exists in the server code...
// See CA-10942.
if (path.StartsWith("/"))
{
string[] bits = path.Split('?');
UriBuilder uriBuilder = new UriBuilder();
uriBuilder.Scheme = "https";
uriBuilder.Host = tcli.conf.hostname;
uriBuilder.Port = tcli.conf.port;
uriBuilder.Path = bits[0];
if (bits.Length > 1)
uriBuilder.Query = bits[1];
return uriBuilder.Uri;
}
else
{
return new Uri(path);
}
}
}
}