freerdp/libfreerdp/core/errconnect.c

/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Error Connect
 *
 * Copyright 2015 Armin Novak <armin.novak@thincast.com>
 * Copyright 2015 Thincast Technologies GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdio.h>

#include <freerdp/log.h>

#include "errinfo.h"

#define TAG FREERDP_TAG("core")

#define ERRCONNECT_DEFINE(_code, category)                                              \
	{                                                                                   \
		ERRCONNECT_##_code, "ERRCONNECT_" #_code, ERRCONNECT_##_code##_STRING, category \
	}

/* Protocol-independent codes */

#define ERRCONNECT_PRE_CONNECT_FAILED_STRING \
	"A configuration error prevented a connection to be established."

#define ERRCONNECT_CONNECT_UNDEFINED_STRING "A undefined connection error occurred."

#define ERRCONNECT_POST_CONNECT_FAILED_STRING \
	"The connection attempt was aborted due to post connect configuration errors."

#define ERRCONNECT_DNS_ERROR_STRING "The DNS entry could not be resolved."

#define ERRCONNECT_DNS_NAME_NOT_FOUND_STRING "The DNS host name was not found."

#define ERRCONNECT_CONNECT_FAILED_STRING "The connection failed."

#define ERRCONNECT_MCS_CONNECT_INITIAL_ERROR_STRING "The connection failed at initial MCS connect"

#define ERRCONNECT_TLS_CONNECT_FAILED_STRING "The connection failed at TLS connect."

#define ERRCONNECT_AUTHENTICATION_FAILED_STRING "An authentication failure aborted the connection."

#define ERRCONNECT_INSUFFICIENT_PRIVILEGES_STRING \
	"Insufficient privileges to establish a connection."

#define ERRCONNECT_CONNECT_CANCELLED_STRING "The connection was cancelled."

#define ERRCONNECT_SECURITY_NEGO_CONNECT_FAILED_STRING \
	"The connection failed at negotiating security settings."

#define ERRCONNECT_CONNECT_TRANSPORT_FAILED_STRING "The connection transport layer failed."

#define ERRCONNECT_PASSWORD_EXPIRED_STRING "The password has expired and must be changed."

#define ERRCONNECT_PASSWORD_CERTAINLY_EXPIRED_STRING \
	"The password has certainly expired and must be changed."

#define ERRCONNECT_CLIENT_REVOKED_STRING "The client has been revoked."

#define ERRCONNECT_KDC_UNREACHABLE_STRING "The KDC is unreachable."

#define ERRCONNECT_ACCOUNT_DISABLED_STRING "The account is disabled."

#define ERRCONNECT_PASSWORD_MUST_CHANGE_STRING "The password must be changed."

#define ERRCONNECT_LOGON_FAILURE_STRING "Logon failed."

#define ERRCONNECT_WRONG_PASSWORD_STRING "Wrong password supplied."

#define ERRCONNECT_ACCESS_DENIED_STRING "Access denied."

#define ERRCONNECT_ACCOUNT_RESTRICTION_STRING "Account restriction."

#define ERRCONNECT_ACCOUNT_LOCKED_OUT_STRING "Account locked out."

#define ERRCONNECT_ACCOUNT_EXPIRED_STRING "Account expired."

#define ERRCONNECT_LOGON_TYPE_NOT_GRANTED_STRING "Logon type not granted."

#define ERRCONNECT_NO_OR_MISSING_CREDENTIALS_STRING "Credentials invalid or missing."

/* Special codes */
#define ERRCONNECT_SUCCESS_STRING "Success."
#define ERRCONNECT_NONE_STRING ""

static const ERRINFO ERRCONNECT_CODES[] = {
	ERRCONNECT_DEFINE(SUCCESS, CAT_NONE),

	ERRCONNECT_DEFINE(PRE_CONNECT_FAILED, CAT_CONFIG),
	ERRCONNECT_DEFINE(CONNECT_UNDEFINED, CAT_USE),
	ERRCONNECT_DEFINE(POST_CONNECT_FAILED, CAT_CONFIG),
	ERRCONNECT_DEFINE(DNS_ERROR, CAT_USE),
	ERRCONNECT_DEFINE(DNS_NAME_NOT_FOUND, CAT_CONFIG),
	ERRCONNECT_DEFINE(CONNECT_FAILED, CAT_USE),
	ERRCONNECT_DEFINE(MCS_CONNECT_INITIAL_ERROR, CAT_PROTOCOL),
	ERRCONNECT_DEFINE(TLS_CONNECT_FAILED, CAT_USE),
	ERRCONNECT_DEFINE(AUTHENTICATION_FAILED, CAT_USE),
	ERRCONNECT_DEFINE(INSUFFICIENT_PRIVILEGES, CAT_ADMIN),
	ERRCONNECT_DEFINE(CONNECT_CANCELLED, CAT_USE),
	ERRCONNECT_DEFINE(SECURITY_NEGO_CONNECT_FAILED, CAT_USE),
	ERRCONNECT_DEFINE(CONNECT_TRANSPORT_FAILED, CAT_USE),
	ERRCONNECT_DEFINE(PASSWORD_EXPIRED, CAT_ADMIN),
	ERRCONNECT_DEFINE(PASSWORD_CERTAINLY_EXPIRED, CAT_ADMIN),
	ERRCONNECT_DEFINE(CLIENT_REVOKED, CAT_ADMIN),
	ERRCONNECT_DEFINE(KDC_UNREACHABLE, CAT_ADMIN),
	ERRCONNECT_DEFINE(ACCOUNT_DISABLED, CAT_ADMIN),
	ERRCONNECT_DEFINE(PASSWORD_MUST_CHANGE, CAT_ADMIN),
	ERRCONNECT_DEFINE(LOGON_FAILURE, CAT_USE),
	ERRCONNECT_DEFINE(WRONG_PASSWORD, CAT_USE),
	ERRCONNECT_DEFINE(ACCESS_DENIED, CAT_ADMIN),
	ERRCONNECT_DEFINE(ACCOUNT_RESTRICTION, CAT_ADMIN),
	ERRCONNECT_DEFINE(ACCOUNT_LOCKED_OUT, CAT_ADMIN),
	ERRCONNECT_DEFINE(ACCOUNT_EXPIRED, CAT_ADMIN),
	ERRCONNECT_DEFINE(LOGON_TYPE_NOT_GRANTED, CAT_ADMIN),
	ERRCONNECT_DEFINE(NO_OR_MISSING_CREDENTIALS, CAT_USE),

	ERRCONNECT_DEFINE(NONE, CAT_NONE)
};

const char* freerdp_get_error_connect_string(UINT32 code)
{
	const ERRINFO* errInfo;
	errInfo = &ERRCONNECT_CODES[0];

	while (errInfo->code != ERRCONNECT_NONE)
	{
		if (code == errInfo->code)
		{
			return errInfo->info;
		}

		errInfo++;
	}

	return "ERRCONNECT_UNKNOWN";
}

const char* freerdp_get_error_connect_category(UINT32 code)
{
	const ERRINFO* errInfo;
	errInfo = &ERRCONNECT_CODES[0];

	while (errInfo->code != ERRCONNECT_NONE)
	{
		if (code == errInfo->code)
		{
			return errInfo->category;
		}

		errInfo++;
	}

	return "ERRCONNECT_UNKNOWN";
}

const char* freerdp_get_error_connect_name(UINT32 code)
{
	const ERRINFO* errInfo;
	errInfo = &ERRCONNECT_CODES[0];

	while (errInfo->code != ERRCONNECT_NONE)
	{
		if (code == errInfo->code)
		{
			return errInfo->name;
		}

		errInfo++;
	}

	return "ERRCONNECT_UNKNOWN";
}