mcrcon/mcrcon.c

/*
 * Copyright (c) 2012-2024, Tiiffi <tiiffi at gmail>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *   1. The origin of this software must not be misrepresented; you must not
 *   claim that you wrote the original software. If you use this software
 *   in a product, an acknowledgment in the product documentation would be
 *   appreciated but is not required.
 *
 *   2. Altered source versions must be plainly marked as such, and must not be
 *   misrepresented as being the original software.
 *
 *   3. This notice may not be removed or altered from any source
 *   distribution.
 */

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <strings.h>
#include <signal.h>
#include <errno.h>
#include <unistd.h>


#ifdef _WIN32
	#include <winsock2.h>
    #include <windows.h>
    #include <ws2tcpip.h>
#else
    #include <sys/socket.h>
    #include <netdb.h>
#endif

#define VERSION "0.7.3"
#define IN_NAME "mcrcon"
#define VER_STR IN_NAME" "VERSION" (built: "__DATE__" "__TIME__")"

#define RCON_EXEC_COMMAND       2
#define RCON_AUTHENTICATE       3
#define RCON_RESPONSEVALUE      0
#define RCON_AUTH_RESPONSE      2
#define RCON_PID                0xBADC0DE

#define MAX_COMMAND_LENGTH 	4096
#define DATA_BUFFSIZE		MAX_COMMAND_LENGTH + 2 // plus two null terminators
#define MAX_PACKET_SIZE		4106 // id (4) + cmd (4) + DATA_BUFFSIZE
#define MIN_PACKET_SIZE		10   // id (4) + cmd (4) + two empty strings (2)

#define log_error(fmt, ...) fprintf(stderr, fmt,  ##__VA_ARGS__);

// rcon packet structure
typedef struct {
    int32_t size;
    int32_t id;
    int32_t cmd;
    uint8_t data[DATA_BUFFSIZE];
    // ignoring string2 for now
} rc_packet;

// ===================================
//  FUNCTION DEFINITIONS              
// ===================================

// Network related functions
#ifdef _WIN32
void        net_init_WSA(void);
#endif
void        net_close(int sd);
int         net_connect(const char *host, const char *port);
bool        net_send_packet(int sd, rc_packet *packet);
rc_packet*  net_recv_packet(int sd);

// Misc stuff
void        usage(void);
#ifndef _WIN32
void        print_color(int color);
#endif
int         get_line(char *buffer, int len);
int         run_terminal_mode(int sock);
int         run_commands(int argc, char *argv[]);

// Rcon protocol related functions
rc_packet*  packet_build(int id, int cmd, char s[static 1]);
void        packet_print(rc_packet *packet);
bool        rcon_auth(int sock, char *passwd);
int         rcon_command(int sock, char *command);

// =============================================
//  GLOBAL VARIABLES
// =============================================
static int  flag_raw_output = 0;
static int  flag_silent_mode = 0;
static int  flag_disable_colors = 0;
static int  flag_wait_seconds = 0;
static int  global_connection_alive = 1;
static bool global_valve_protocol = false;
static int  global_rsock;

#ifdef _WIN32
  // console coloring on windows
  HANDLE console_handle;
#endif

// safety stuff (windows is still misbehaving)
void exit_proc(void)
{
	if (global_rsock != -1)
		net_close(global_rsock);
}

// TODO: check exact windows and linux behaviour
void sighandler(int sig)
{
	if (sig == SIGINT)
		putchar('\n');

	global_connection_alive = 0;
	#ifndef _WIN32
	    exit(EXIT_SUCCESS);
	#endif
}

#define MAX_WAIT_TIME 600

unsigned int mcrcon_parse_seconds(char *str)
{
	char *end;
	long result = strtol(str, &end, 10);

	if (errno != 0) {
		log_error("-w invalid value.\nerror %d: %s\n", errno, strerror(errno));
		exit(EXIT_FAILURE);
	}

	if (end == str) {
		log_error("-w invalid value (not a number?)\n");
		exit(EXIT_FAILURE);
	}

	if (result <= 0 || result > MAX_WAIT_TIME) {
		log_error("-w value out of range.\nAcceptable value is 1 - %d (seconds).\n", MAX_WAIT_TIME);
		exit(EXIT_FAILURE);
	}

	return (unsigned int) result;
}

int main(int argc, char *argv[])
{
	int terminal_mode = 0;

	char *host = getenv("MCRCON_HOST");
	char *pass = getenv("MCRCON_PASS");
	char *port = getenv("MCRCON_PORT");
	
	if (!port) port = "25575";
	if (!host) host = "localhost";

	// disable output buffering (https://github.com/Tiiffi/mcrcon/pull/39)
	setvbuf(stdout, NULL, _IONBF, 0);
	setvbuf(stderr, NULL, _IONBF, 0);

	if(argc < 1 && pass == NULL) usage();

	// default getopt error handler enabled
	opterr = 1;
	int opt;
	while ((opt = getopt(argc, argv, "vrtcshw:H:p:P:")) != -1)
	{
		switch (opt) {
			case 'H': host = optarg;                 break;
			case 'P': port = optarg;                 break;
			case 'p': pass = optarg;                 break;
			case 'c': flag_disable_colors = 1;       break;
			case 's': flag_silent_mode = 1;          break;
			case 'i': /* reserved for interp mode */ break;
			case 't': terminal_mode = 1;             break;
			case 'r': flag_raw_output = 1;           break;
			case 'w':
				flag_wait_seconds = mcrcon_parse_seconds(optarg);
			break;

			case 'v':
				puts(VER_STR);
				puts("Bug reports:\n\ttiiffi+mcrcon at gmail\n\thttps://github.com/Tiiffi/mcrcon/issues/");
				exit(EXIT_SUCCESS);

			case 'h': usage(); break;
			case '?':
			default:
				puts("Try 'mcrcon -h' or 'man mcrcon' for help.");
				exit(EXIT_FAILURE);
		}
	}

	if (pass == NULL) {
		puts("You must give password (-p password).\nTry 'mcrcon -h' or 'man mcrcon' for help.");
		exit(EXIT_FAILURE);
	}

	if(optind == argc && terminal_mode == 0) {
		terminal_mode = 1;
	}

	// safety features to prevent "IO: Connection reset" bug on the server side
	atexit(&exit_proc);
	signal(SIGABRT, &sighandler);
	signal(SIGTERM, &sighandler);
	signal(SIGINT, &sighandler);

	#ifdef _WIN32
		net_init_WSA();
		console_handle = GetStdHandle(STD_OUTPUT_HANDLE);
		if (console_handle == INVALID_HANDLE_VALUE)
			console_handle = NULL;
	#endif

	// open socket
	global_rsock = net_connect(host, port);

	int exit_code = EXIT_SUCCESS;

	// auth & commands
	if (rcon_auth(global_rsock, pass)) {
		if (terminal_mode) exit_code = run_terminal_mode(global_rsock);
		else exit_code = run_commands(argc, argv);
	}
	else { // auth failed
		log_error("Authentication failed!\n");
		exit_code = EXIT_FAILURE;
	}

	exit(exit_code);
}

void usage(void)
{
	puts(
		"Usage: "IN_NAME" [OPTIONS] [COMMANDS]\n\n"
		"Send rcon commands to Minecraft server.\n\n"
		"Options:\n"
		"  -H\t\tServer address (default: localhost)\n"
		"  -P\t\tPort (default: 25575)\n"
		"  -p\t\tRcon password\n"
		"  -t\t\tTerminal mode\n"
		"  -s\t\tSilent mode\n"
		"  -c\t\tDisable colors\n"
		"  -r\t\tOutput raw packets\n"
		"  -w\t\tWait for specified duration (seconds) between each command (1 - 600s)\n"
		"  -h\t\tPrint usage\n"
		"  -v\t\tVersion information\n\n"
		"Server address, port and password can be set with following environment variables:\n"
		"  MCRCON_HOST\n"
		"  MCRCON_PORT\n"
		"  MCRCON_PASS\n"
	);

	puts (
		"- mcrcon will start in terminal mode if no commands are given\n"
		"- Command-line options will override environment variables\n"
		"- Rcon commands with spaces must be enclosed in quotes\n"
	);
	puts("Example:\n\t"IN_NAME" -H my.minecraft.server -p password -w 5 \"say Server is restarting!\" save-all stop\n");

	#ifdef _WIN32
	    puts("Press enter to exit.");
	    getchar();
	#endif

	exit(EXIT_SUCCESS);
}

#ifdef _WIN32
void net_init_WSA(void)
{
	WSADATA wsadata;

	// Request winsock 2.2 for now.
	// Should be compatible down to Win XP.
	WORD version = MAKEWORD(2, 2);

	int err = WSAStartup(version, &wsadata);
	if (err != 0) {
		log_error("WSAStartup failed. Error: %d.\n", err);
		exit(EXIT_FAILURE);
	}
}
#endif

// socket close and cleanup
void net_close(int sd)
{
	#ifdef _WIN32
		closesocket(sd);
		WSACleanup();
	#else
		close(sd);
	#endif
}

// http://man7.org/linux/man-pages/man3/getaddrinfo.3.html
// https://bugs.chromium.org/p/chromium/issues/detail?id=44489
int net_connect(const char *host, const char *port)
{
	int sd;

	struct addrinfo hints;
	struct addrinfo *server_info, *p;

	memset(&hints, 0, sizeof hints);
	hints.ai_family = AF_UNSPEC;
	hints.ai_socktype = SOCK_STREAM;
	hints.ai_protocol = IPPROTO_TCP;

	#ifdef _WIN32
	  net_init_WSA();
	#endif

	int ret = getaddrinfo(host, port, &hints, &server_info);
	if (ret != 0) {
		log_error("Name resolution failed.\n");
		#ifdef _WIN32
			log_error("Error %d: %s", ret, gai_strerror(ret));
		#else
			log_error("Error %d: %s\n", ret, gai_strerror(ret));
		#endif

		exit(EXIT_FAILURE);
	}

	// Go through the hosts and try to connect
	for (p = server_info; p != NULL; p = p->ai_next) {
		sd = socket(p->ai_family, p->ai_socktype, p->ai_protocol);

		if (sd == -1)
			continue;

		ret = connect(sd, p->ai_addr, p->ai_addrlen);
		if (ret == -1) {
			net_close(sd);
			continue;
		}
		// Get out of the loop when connect is successful
		break;
	}

	if (p == NULL) {
		/* TODO (Tiiffi): Check why windows does not report errors */
		log_error("Connection failed.\n");
		#ifndef _WIN32
			log_error("Error %d: %s\n", errno, strerror(errno));
		#endif

		freeaddrinfo(server_info);
		exit(EXIT_FAILURE);
	}

	freeaddrinfo(server_info);
	return sd;
}

bool net_send_packet(int sd, rc_packet *packet)
{
	size_t sent = 0;
	size_t size = packet->size + sizeof(int32_t);
	size_t left = size;

	char *p = (char *) packet;

	while (sent < size) {
		ssize_t result = send(sd, p + sent, left, 0);

		if (result == -1) return false;

		sent += result;
		left -= sent;
	}

	return true;
}

rc_packet *net_recv_packet(int sd)
{
	int32_t psize;
	static rc_packet packet = {0};

	ssize_t ret = recv(sd, (char *) &psize, sizeof(psize), 0);

	if (ret == 0) {
		log_error("Connection lost.\n");
		global_connection_alive = 0;
		return NULL;
	}

	if (ret != sizeof(psize)) {
		log_error("Error: recv() failed.\n");
		global_connection_alive = 0;
		return NULL;
	}

	if (psize < MIN_PACKET_SIZE || psize > MAX_PACKET_SIZE) {
		log_error("Error: Invalid packet size (%d).\n", psize);
		global_connection_alive = 0;
		return NULL;
	}

	packet.size = psize;
	char *p = (char *) &packet;

	int received = 0;
	while (received < psize) {
		ret = recv(sd, p + sizeof(int32_t) + received, psize - received, 0);
		if (ret == 0) {
			log_error("Connection lost.\n");
			global_connection_alive = 0;
			return NULL;
		}

		received += ret;
	}

	return &packet;
}

void print_color(int color)
{
	// sh compatible color array
	#ifndef _WIN32
	char *colors[] = {
		"\033[0;30m",   /* 00 BLACK     0x30 */
		"\033[0;34m",   /* 01 BLUE      0x31 */
		"\033[0;32m",   /* 02 GREEN     0x32 */
		"\033[0;36m",   /* 03 CYAN      0x33 */
		"\033[0;31m",   /* 04 RED       0x34 */
		"\033[0;35m",   /* 05 PURPLE    0x35 */
		"\033[0;33m",   /* 06 GOLD      0x36 */
		"\033[0;37m",   /* 07 GREY      0x37 */
		"\033[0;1;30m", /* 08 DGREY     0x38 */
		"\033[0;1;34m", /* 09 LBLUE     0x39 */
		"\033[0;1;32m", /* 10 LGREEN    0x61 */
		"\033[0;1;36m", /* 11 LCYAN     0x62 */
		"\033[0;1;31m", /* 12 LRED      0x63 */
		"\033[0;1;35m", /* 13 LPURPLE   0x64 */
		"\033[0;1;33m", /* 14 YELLOW    0x65 */
		"\033[0;1;37m", /* 15 WHITE     0x66 */
		"\033[4m"       /* 16 UNDERLINE 0x6e */
	};

	if (color == 0 || color == 0x72) {
		fputs("\033[0m", stdout); // cancel color
	}
	else
	#endif
	{
		if (color >= 0x61 && color <= 0x66) color -= 0x57;
		else if (color >= 0x30 && color <= 0x39)
			color -= 0x30;
		else if (color == 0x6e)
			color = 16;
		else return;

		#ifndef _WIN32
			fputs(colors[color], stdout);
		#else
			SetConsoleTextAttribute(console_handle, color);
		#endif
	}
}

// this hacky mess might use some optimizing
void packet_print(rc_packet *packet)
{
	uint8_t *data = packet->data;

	if (flag_raw_output == 1) {
		for (int i = 0; data[i] != 0; ++i) {
			putchar(data[i]);
		}
		return;
	}

	int i;
	int default_color = 0;

	#ifdef _WIN32
		CONSOLE_SCREEN_BUFFER_INFO console_info;
		if (GetConsoleScreenBufferInfo(console_handle, &console_info) != 0) {
			default_color = console_info.wAttributes + 0x30;
		} else default_color = 0x37;
	#endif

	// colors enabled so try to handle the bukkit colors for terminal
	if (flag_disable_colors == 0) {
		for (i = 0; data[i] != 0; ++i) {
			if (data[i] == 0x0A) print_color(default_color);
			else if(data[i] == 0xc2 && data[i + 1] == 0xa7) {
				i += 2;
				print_color(data[i]);
				continue;
			}
			putchar(data[i]);
		}
		print_color(default_color); // cancel coloring
	}
	// strip colors
	else {
		for (i = 0; data[i] != 0; ++i) {
			if (data[i] == 0xc2 && data[i + 1] == 0xa7) {
				i += 2;
				continue;
			}	
			putchar(data[i]);
		}
	}

	// print newline if string has no newline
	if (data[i - 1] != 10 && data[i - 1] != 13) {
		putchar('\n');
	}
}

rc_packet *packet_build(int id, int cmd, char s[static 1])
{
	static rc_packet packet = {0};

	// NOTE(Tiiffi): Issue report states that maximum command packet size is 1460 bytes:
	//				 https://github.com/Tiiffi/mcrcon/issues/45#issuecomment-1000940814
	//				 https://mctools.readthedocs.io/en/master/rcon.html
	//				 Have to do some testing to confirm!

	int len = strlen(s);
	if (len > MAX_COMMAND_LENGTH) {
		log_error("Warning: Command string too long (%d). Maximum allowed: %d.\n", len, MAX_COMMAND_LENGTH);
		return NULL;
	}

	packet.size = sizeof packet.id + sizeof packet.cmd + len + 2;
	packet.id = id;
	packet.cmd = cmd;
	if (packet.size > 0) memcpy(packet.data, s, len);
	packet.data[len] = 0;
	packet.data[len + 1] = 0;

	return &packet;
}

bool rcon_auth(int sock, char *passwd)
{
	rc_packet *packet = packet_build(RCON_PID, RCON_AUTHENTICATE, passwd);
	if (packet == NULL)
		return 0;

	if (!net_send_packet(sock, packet)) {
		return 0; // send failed
	}

receive:
	packet = net_recv_packet(sock);
	if (packet == NULL)
		return 0;

	/* Valve rcon sends empty "RCON_RESPONSEVALUE" packet before real auth response
	 * so we have to check packet type and try again if necessary.
	 */
	if (packet->cmd != RCON_AUTH_RESPONSE) {
		global_valve_protocol = true;
		goto receive;
	}

	// return true if authentication OK
	return packet->id == -1 ? false : true;
}

// TODO: Create function that sends two packets in one send() call
//       This is important so multipacket guard packet is sent right after real packet
int rcon_command(int sock, char *command)
{
	rc_packet *packet = packet_build(RCON_PID, RCON_EXEC_COMMAND, command);
	if (packet == NULL) {
		log_error("Error: packet build() failed!\n");
		return 0;
	}

	if (!net_send_packet(sock, packet)) {
		log_error("Error: net_send_packet() failed!\n");
		return 0;
	}

	// CAUTION: lets set this always true for testing
	global_valve_protocol = true;

	// Workaround to handle valve multipacket responses
	// This one does not require using select()
	if (global_valve_protocol) {
		packet = packet_build(0xBADA55, 0xBADA55, "");
		if (packet == NULL) {
			log_error("Error: packet build() failed!\n");
			return 0;
		}

		if (!net_send_packet(sock, packet)) {
			log_error("Error: net_send_packet() failed!\n");
			return 0;
		}
	}

	// initialize stuff for select()
	fd_set read_fds;
	FD_ZERO(&read_fds);
	FD_SET(sock, &read_fds);

	struct timeval timeout = {0};
	timeout.tv_sec = 1;
	timeout.tv_usec = 0;

	int incoming = 0;

	do {
		packet = net_recv_packet(sock);
		if (packet == NULL) {
			log_error("Error: net_recv_packet() failed!\n");
			return 0;
		}

		// Check for packet id and multipacket guard id
		if (packet->id != RCON_PID && packet->id != 0xBADA55) {
			log_error("Error: invalid packet id!\n");
			return 0;
		}

		// Break out if valve multipacket guard detected
		if (global_valve_protocol) {
			if (packet->id == 0xBADA55) break;
		}

		if (!flag_silent_mode) {
			if (packet->size > 10)
			packet_print(packet);
		}

		// NOTE: Workaround to prevent waiting for timeout.
		//       This is not reliable way to detect last packet
		if (global_valve_protocol == false && packet->size < MAX_PACKET_SIZE)
			break;

		int result = select(sock + 1, &read_fds, NULL, NULL, &timeout);
		if (result == -1) {
			log_error("Error: select() failed!\n");
			return 0;
		}
		incoming = (result > 0 && FD_ISSET(sock, &read_fds));
	}
	while(incoming);

	return 1;
}

int run_commands(int argc, char *argv[])
{
	int i = optind;

	for (;;) {
		if (!rcon_command(global_rsock, argv[i]))
			return EXIT_FAILURE;

		i++;

		if (i >= argc)
			return EXIT_SUCCESS;

		if (flag_wait_seconds > 0) {
			#ifdef _WIN32
				Sleep(flag_wait_seconds * 1000);
			#else
				sleep(flag_wait_seconds);
			#endif
		}
	}
}

// terminal mode
int run_terminal_mode(int sock)
{
	char command[MAX_COMMAND_LENGTH] = {0};

	puts("Logged in.\nType 'Q' or press Ctrl-D / Ctrl-C to disconnect.");

	while (global_connection_alive) {
		putchar('>');

		int len = get_line(command, MAX_COMMAND_LENGTH);
		if (len < 1) continue; 
	
		if (strcasecmp(command, "Q") == 0) break;

		if (len > 0 && global_connection_alive) {
			if (!rcon_command(sock, command)) {
				return EXIT_FAILURE;
			}
		}

		/* Special case for "stop" command to prevent server-side bug.
		 * https://bugs.mojang.com/browse/MC-154617
		 * 
		 * NOTE: This is hacky workaround which should be handled better to
		 *       ensure compatibility with other servers using source RCON.
		 * NOTE: strcasecmp() is POSIX function.
		 */
		if (strcasecmp(command, "stop") == 0) {
			break;
		}
	}

	return EXIT_SUCCESS;
}

// gets line from stdin and deals with rubbish left in the input buffer
int get_line(char *buffer, int bsize)
{
	char *ret = fgets(buffer, bsize, stdin);
	if (ret == NULL) {
		if (ferror(stdin)) {
			log_error("Error %d: %s\n", errno, strerror(errno));
			exit(EXIT_FAILURE);
		}
		putchar('\n');
		exit(EXIT_SUCCESS);
	}

	// remove unwanted characters from the buffer
	buffer[strcspn(buffer, "\r\n")] = '\0';

	int len = strlen(buffer);

	// clean input buffer if needed 
	if (len == bsize - 1) {
		int ch;
		while ((ch = getchar()) != '\n' && ch != EOF);
	}

	return len;
}