From nobody Fri May 10 19:55:28 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; arc=pass (i=1 dmarc=pass fromdomain=selinc.com); dmarc=pass(p=reject dis=none) header.from=selinc.com ARC-Seal: i=2; a=rsa-sha256; t=1711640521; cv=pass; d=zohomail.com; s=zohoarc; b=FKk4ZaYm0uzGSIBG1LoN8Vzf7/BLfe87ctWFGAsWQpi/h0/l2C5NETQjnl1nM/2HmLcSSnPxaJYyfMm3jrSOWST3h4xx/Ickj03KoZLcvg7MspnpuDlUbsxQNPq+1/7z0MFzMG/T0MB99cPOUx2Qz8ESng5hjjYc+xA29SoTf3w= ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1711640521; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=qXi/j4+ThDv9uFRSo28+/p24QiKZ3x42mM82KZoDShM=; b=JqBeSL+ChQT2Lmlfwu2lWlOGHlpdyMSTSGkWTiEvnGyP5xjNVGj+eXrlD47FNpPowbJOFQdBEAzDGQUrJ98SzPLPIPvPnFF0KyklDPYSL/aDYcZQW8qesx07VD21wkVa4YASoged2RcK6q0bgYj7xEqV8J1otZP/VSuoXAvDLpg= ARC-Authentication-Results: i=2; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; arc=pass (i=1 dmarc=pass fromdomain=selinc.com); dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1711640521824635.8596650173064; Thu, 28 Mar 2024 08:42:01 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rprsa-0002tl-LO; Thu, 28 Mar 2024 11:41:24 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rprsW-0002t9-VY for qemu-devel@nongnu.org; Thu, 28 Mar 2024 11:41:21 -0400 Received: from mx0b-000e8d01.pphosted.com ([148.163.143.141]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rprsU-0007Vf-Ek for qemu-devel@nongnu.org; Thu, 28 Mar 2024 11:41:20 -0400 Received: from pps.filterd (m0136176.ppops.net [127.0.0.1]) by mx0b-000e8d01.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 42SCP10E015533; Thu, 28 Mar 2024 08:41:17 -0700 Received: from nam11-co1-obe.outbound.protection.outlook.com (mail-co1nam11lp2169.outbound.protection.outlook.com [104.47.56.169]) by mx0b-000e8d01.pphosted.com (PPS) with ESMTPS id 3x4xnh0h9p-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 28 Mar 2024 08:41:16 -0700 (PDT) Received: from CH2PR15CA0030.namprd15.prod.outlook.com (2603:10b6:610:51::40) by SN7PR22MB3929.namprd22.prod.outlook.com (2603:10b6:806:32c::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7409.32; Thu, 28 Mar 2024 15:41:12 +0000 Received: from CH3PEPF00000012.namprd21.prod.outlook.com (2603:10b6:610:51:cafe::48) by CH2PR15CA0030.outlook.office365.com (2603:10b6:610:51::40) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7409.13 via Frontend Transport; Thu, 28 Mar 2024 15:41:11 +0000 Received: from email.selinc.com (74.117.212.83) by CH3PEPF00000012.mail.protection.outlook.com (10.167.244.117) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7452.0 via Frontend Transport; Thu, 28 Mar 2024 15:41:11 +0000 Received: from AIDALEUCPC3.ad.selinc.com (10.100.90.200) by wpul-exchange1.ad.selinc.com (10.53.14.22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.9; Thu, 28 Mar 2024 08:41:08 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=selinc.com; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=sel1; bh=qXi/j4+ThDv9uFRSo28+/p24QiKZ3x42mM82KZoDShM=; b=Sizjy/vtDgAH L1cer5rSQXnjsdGfHHs2No9gftYrVTFTnX0NfSGG54qI74W2FM3o/QXvV7cZyDku PAErLNA1AelXQMY6scoX8Q9AeCh8ubk8Tv7FT4z9845RGQQiKYV0u+Z0CO2iBZdD kTWI6z2rcxeA1hC8pg5ba6Lcor/p060tp8Ny1YsjGmDkZMhbDdUGh4JdjtjL/VA1 5GjbRJHBaLBaBqntWsffUCImSnlK8qUKqUz8Erj51bvu4178R0RU9o6Pj0NX/dEv JIrD0M8Cbe1/zptzMlisoq+EZH7vNwCsG2u2NhDO8xPwpUMaRFijlHwl9EeXNZtd rQbwmJ9TWw== ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=g/YvR22sqM6rNe9OA+o0R8Jso4S47yHOFmac+jnmFwbqWbcx/JCZxxO57uWNweT6bo4YQCw1C6/5JNLRZcJ4KNqxfiThBKv0vG7a7ye+4FFNdMaPrc4YJIcj/Q7Zo/cVq540RKhYzMK03/oH002xX7MakcjOpSAdyKcQUigiddC0ef0H4+2TqYO7qITYc+P6rjG1FTogqnhAXr80DkWN+EjFFvhEccGSDVJC9ytnjL2+SN/2iuQ3lolNe9X/aacCLfx9ehia/GA55MA8CmfeO/EznzmQIpsidD29NOqtyByi0hWmcV7b0ZkI77/zkxhTXeMNUkI7g6OF2tRbP4G8qg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=qXi/j4+ThDv9uFRSo28+/p24QiKZ3x42mM82KZoDShM=; b=YUqsKxIjA41sy8XnDAKZskjCA7W3PZoKzCCFEWXmFqjVgK6YqXTwUi5W5SfXamJRvimSs8Hoq7sx9zuFog0Su0Hl5GXHmKRFNF9lMjyXlI4QtT6Iy1C9NluLUMBeeTy3GRkIfuRtfgMNdS6amp11hoCLBjP+6fSMXGk8gNpG8b9/JgH3aTQ+TmuTD8vX5BUnTOA9OgJ1JmlIyoK80v/jjGbEU+Y11rodWZKTm2JxJw11wbW/NbL3yPPxhFghZU6k6thnfhzdCgArxhG6TvUU/tNydBSiJGguwz2YFw92WwEjTAdAhWXPlAzxmVsJvCUgutslm3RwMw14469n4Nai2w== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 74.117.212.83) smtp.rcpttodomain=nongnu.org smtp.mailfrom=selinc.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=selinc.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=selinc.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=qXi/j4+ThDv9uFRSo28+/p24QiKZ3x42mM82KZoDShM=; b=fSM0qNIUrpT0HoLS4gdeOfXevEDJ783zIWi3ix7cFMS2jbE+3dQZLFVFyxr63e4Ii7EZrvwSn6TWniB+NTtyokcNQ99L5R0gVRmsht7Ly0KvVRwUWqcHB2O45DbKMIy004KvBbTuD4XucysXbVK2Bx4siRFj3u3HwRlkaI0hOtGsNlCA19ICuJVsAkz6VcNuG8KIq6dirz8VqVbNJKD1m1wEvsHI5uGLq3QUIbRcJsQyEcApvAEqez+8dFjIHL6bXC/Ylr0+3u2DS/hz0q8VvFX6CQ/voBTBsYGX4eWTUXaHcOd+ZZzdo4Q7cK6vpEZkuCV7C4ze37Qf+rHQlS01KA== X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 74.117.212.83) smtp.mailfrom=selinc.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=selinc.com; Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: Pass (protection.outlook.com: domain of selinc.com designates 74.117.212.83 as permitted sender) receiver=protection.outlook.com; client-ip=74.117.212.83; helo=email.selinc.com; pr=C From: To: CC: , aidaleuc Subject: [PATCH v5 1/2] Refactor common functions between POSIX and Windows implementation Date: Thu, 28 Mar 2024 09:40:48 -0600 Message-ID: <20240328154049.3090753-2-aidan_leuck@selinc.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240328154049.3090753-1-aidan_leuck@selinc.com> References: <20240328154049.3090753-1-aidan_leuck@selinc.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Originating-IP: [10.100.90.200] X-ClientProxiedBy: wpul-exchange1.ad.selinc.com (10.53.14.22) To wpul-exchange1.ad.selinc.com (10.53.14.22) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH3PEPF00000012:EE_|SN7PR22MB3929:EE_ X-MS-Office365-Filtering-Correlation-Id: c7a3c9c8-3804-462c-9fb5-08dc4f3d7ea6 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: SpaLRmEod4aWgq3fwCOnhSTouuzUYDHbI7FVaA8W/2EIuYz/4YAxvcfH+NNdFMZYOhtJzlNxuRSXl2Kw1pu4pKMVe1SU9obiII4JfwB+umPRNKR43Pjt3xu22Gdi54bsx9nhT5YoEh6KdLdPFRD+mLc30Rg4vU9yYg1J4NWgiG/fTblyp+rVXhU6jZgiPi1oGK+CO6ByLR05jsTOX+Q5u0k919W+W5DeQBl/CaNnTnOsQt76DYMcy5O8xj4z48XSjBmizJZhnmIIboRV4wpnO7xlolzhZFFfgNYUiU2E31Fg0/NAog+sxxCU6gAs60FgZEx0UpG5nMIUv5iSvAEHF3lnfsz5sCkfUwLwWvr+hY8rsfNVXqCyVJJoNSrGDoIL9ASNPEUU+StfZCrX/06sq99CtjQ8r0zUY9qjwwlGuHKEPu93kaG7Gpoz3d1GwvC7ytgAXFk0qCD4VqajZFY1CagCiFq0+fWQMVJU+eIaL7mN8NyyGFB00UtzYr9i6UnuFVl2C+7UbIZbP2kWQkpEqPNrx66ubavjXiY7fE59BjKoOE8C9ri/fBlQEFmduko6mIblriXVdYd1gJP+UTlMB/xIXGnH2KbM7Gmcp7K7yYvVCRSbAlxgAeRLPhmTq/zqiwx8pMfB3oixCEgdulVa6ZvtZqQywqBqRBrIIMHjpbJeNmqOB+ieQ5AAPQnQsjNoVpAyRZxXqXL4sYwRjcIbWt1LSkBEVrETuBxX6ojSXsGlz+CkxNSWKCpH66XUlq5R X-Forefront-Antispam-Report: CIP:74.117.212.83; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:email.selinc.com; PTR:wpul-exchange1.selinc.com; CAT:NONE; SFS:(13230031)(36860700004)(82310400014)(376005)(1800799015); DIR:OUT; SFP:1102; X-OriginatorOrg: selinc.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Mar 2024 15:41:11.4810 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: c7a3c9c8-3804-462c-9fb5-08dc4f3d7ea6 X-MS-Exchange-CrossTenant-Id: 12381f30-10fe-4e2c-aa3a-5e03ebeb59ec X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=12381f30-10fe-4e2c-aa3a-5e03ebeb59ec; Ip=[74.117.212.83]; Helo=[email.selinc.com] X-MS-Exchange-CrossTenant-AuthSource: CH3PEPF00000012.namprd21.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN7PR22MB3929 X-Proofpoint-GUID: 1jdtSE1KWWYd5srUTc6HhjgaF6cvTdv0 X-Proofpoint-ORIG-GUID: 1jdtSE1KWWYd5srUTc6HhjgaF6cvTdv0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 spamscore=0 mlxlogscore=999 clxscore=1015 impostorscore=0 bulkscore=0 lowpriorityscore=0 suspectscore=0 mlxscore=0 malwarescore=0 priorityscore=1501 adultscore=0 phishscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.19.0-2403210001 definitions=main-2403280108 Received-SPF: pass client-ip=148.163.143.141; envelope-from=prvs=881719a93e=aidan_leuck@selinc.com; helo=mx0b-000e8d01.pphosted.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @selinc.com) X-ZM-MESSAGEID: 1711640523360100007 Content-Type: text/plain; charset="utf-8" From: aidaleuc Signed-off-by: aidaleuc Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- qga/commands-common-ssh.c | 50 ++++++++++++++++++++++++++++++++++++++ qga/commands-common-ssh.h | 10 ++++++++ qga/commands-posix-ssh.c | 51 +++------------------------------------ qga/meson.build | 1 + 4 files changed, 64 insertions(+), 48 deletions(-) create mode 100644 qga/commands-common-ssh.c create mode 100644 qga/commands-common-ssh.h diff --git a/qga/commands-common-ssh.c b/qga/commands-common-ssh.c new file mode 100644 index 0000000000..537869fb98 --- /dev/null +++ b/qga/commands-common-ssh.c @@ -0,0 +1,50 @@ +/* + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "commands-common-ssh.h" + +GStrv read_authkeys(const char *path, Error **errp) +{ + g_autoptr(GError) err =3D NULL; + g_autofree char *contents =3D NULL; + + if (!g_file_get_contents(path, &contents, NULL, &err)) { + error_setg(errp, "failed to read '%s': %s", path, err->message); + return NULL; + } + + return g_strsplit(contents, "\n", -1); +} + +bool check_openssh_pub_keys(strList *keys, size_t *nkeys, Error **errp) +{ + size_t n =3D 0; + strList *k; + + for (k =3D keys; k !=3D NULL; k =3D k->next) { + if (!check_openssh_pub_key(k->value, errp)) { + return false; + } + n++; + } + + if (nkeys) { + *nkeys =3D n; + } + return true; +} + +bool check_openssh_pub_key(const char *key, Error **errp) +{ + /* simple sanity-check, we may want more? */ + if (!key || key[0] =3D=3D '#' || strchr(key, '\n')) { + error_setg(errp, "invalid OpenSSH public key: '%s'", key); + return false; + } + + return true; +} diff --git a/qga/commands-common-ssh.h b/qga/commands-common-ssh.h new file mode 100644 index 0000000000..14d955fa84 --- /dev/null +++ b/qga/commands-common-ssh.h @@ -0,0 +1,10 @@ +/* + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#include "qapi/qapi-builtin-types.h" + +GStrv read_authkeys(const char *path, Error **errp); +bool check_openssh_pub_keys(strList *keys, size_t *nkeys, Error **errp); +bool check_openssh_pub_key(const char *key, Error **errp); diff --git a/qga/commands-posix-ssh.c b/qga/commands-posix-ssh.c index 236f80de44..c82ccfe629 100644 --- a/qga/commands-posix-ssh.c +++ b/qga/commands-posix-ssh.c @@ -9,12 +9,13 @@ #include #include =20 +#include "commands-common-ssh.h" #include "qapi/error.h" #include "qga-qapi-commands.h" =20 #ifdef QGA_BUILD_UNIT_TEST -static struct passwd * -test_get_passwd_entry(const gchar *user_name, GError **error) + static struct passwd * + test_get_passwd_entry(const gchar *user_name, GError **error) { struct passwd *p; int ret; @@ -80,37 +81,6 @@ mkdir_for_user(const char *path, const struct passwd *p, return true; } =20 -static bool -check_openssh_pub_key(const char *key, Error **errp) -{ - /* simple sanity-check, we may want more? */ - if (!key || key[0] =3D=3D '#' || strchr(key, '\n')) { - error_setg(errp, "invalid OpenSSH public key: '%s'", key); - return false; - } - - return true; -} - -static bool -check_openssh_pub_keys(strList *keys, size_t *nkeys, Error **errp) -{ - size_t n =3D 0; - strList *k; - - for (k =3D keys; k !=3D NULL; k =3D k->next) { - if (!check_openssh_pub_key(k->value, errp)) { - return false; - } - n++; - } - - if (nkeys) { - *nkeys =3D n; - } - return true; -} - static bool write_authkeys(const char *path, const GStrv keys, const struct passwd *p, Error **errp) @@ -139,21 +109,6 @@ write_authkeys(const char *path, const GStrv keys, return true; } =20 -static GStrv -read_authkeys(const char *path, Error **errp) -{ - g_autoptr(GError) err =3D NULL; - g_autofree char *contents =3D NULL; - - if (!g_file_get_contents(path, &contents, NULL, &err)) { - error_setg(errp, "failed to read '%s': %s", path, err->message); - return NULL; - } - - return g_strsplit(contents, "\n", -1); - -} - void qmp_guest_ssh_add_authorized_keys(const char *username, strList *keys, bool has_reset, bool reset, diff --git a/qga/meson.build b/qga/meson.build index 1c3d2a3d1b..4c3899751b 100644 --- a/qga/meson.build +++ b/qga/meson.build @@ -66,6 +66,7 @@ qga_ss.add(files( 'guest-agent-command-state.c', 'main.c', 'cutils.c', + 'commands-common-ssh.c' )) if host_os =3D=3D 'windows' qga_ss.add(files( --=20 2.44.0 From nobody Fri May 10 19:55:28 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; arc=pass (i=1 dmarc=pass fromdomain=selinc.com); dmarc=pass(p=reject dis=none) header.from=selinc.com ARC-Seal: i=2; a=rsa-sha256; t=1711640520; cv=pass; d=zohomail.com; s=zohoarc; b=eFljB3EeNRJ0knDOCQ+IijaJNoNnqKEtm03MkOs/mDcG0YZyObXmbEKEHXE5j7Cf3gUWL7ov3x0IjVgxFC8uSfXIFz9c4ZVoCSh3b/TQlQculOOiPG4iButbQm5VqNgtd+8RUEXxysPTM1MqOrzufg9hp2TOBXZt30Tj10DoOys= ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1711640520; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=PHaBpN1zTFDSQ2w3bjwOlW3vQPzvbCXCnWUMOapRjAQ=; b=eNG/fVmNfHMsmPM5/7Pm6DYVdeWLc44Vg2lRU6FCv+2r5hN3ky48C+urHi2RKdId7XEzrAW2NECUpkTov0CtrMgbjd3btNeIOSXWsDZ81AJghFXkv8nR7RozkpjWAJlFAZVMk/yBRJM4Ci3yDYHoibuXQPk0HoMNZ11scmwavsQ= ARC-Authentication-Results: i=2; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; arc=pass (i=1 dmarc=pass fromdomain=selinc.com); dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1711640520564825.5084195784531; Thu, 28 Mar 2024 08:42:00 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rprsd-0002v1-0a; Thu, 28 Mar 2024 11:41:27 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rprsa-0002u5-U8 for qemu-devel@nongnu.org; Thu, 28 Mar 2024 11:41:24 -0400 Received: from mx0b-000e8d01.pphosted.com ([148.163.143.141]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rprsX-0007WU-N0 for qemu-devel@nongnu.org; Thu, 28 Mar 2024 11:41:24 -0400 Received: from pps.filterd (m0136175.ppops.net [127.0.0.1]) by mx0b-000e8d01.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 42SD03nh032148; Thu, 28 Mar 2024 08:41:20 -0700 Received: from nam12-bn8-obe.outbound.protection.outlook.com (mail-bn8nam12lp2169.outbound.protection.outlook.com [104.47.55.169]) by mx0b-000e8d01.pphosted.com (PPS) with ESMTPS id 3x4xnhrhah-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 28 Mar 2024 08:41:20 -0700 (PDT) Received: from CH2PR15CA0020.namprd15.prod.outlook.com (2603:10b6:610:51::30) by BY1PR22MB4064.namprd22.prod.outlook.com (2603:10b6:a03:533::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7409.31; Thu, 28 Mar 2024 15:41:15 +0000 Received: from CH3PEPF00000012.namprd21.prod.outlook.com (2603:10b6:610:51:cafe::68) by CH2PR15CA0020.outlook.office365.com (2603:10b6:610:51::30) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7409.13 via Frontend Transport; Thu, 28 Mar 2024 15:41:14 +0000 Received: from email.selinc.com (74.117.212.83) by CH3PEPF00000012.mail.protection.outlook.com (10.167.244.117) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7452.0 via Frontend Transport; Thu, 28 Mar 2024 15:41:14 +0000 Received: from AIDALEUCPC3.ad.selinc.com (10.100.90.200) by wpul-exchange1.ad.selinc.com (10.53.14.22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.9; Thu, 28 Mar 2024 08:41:13 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=selinc.com; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=sel1; bh=PHaBpN1zTFDSQ2w3bjwOlW3vQPzvbCXCnWUMOapRjAQ=; b=BFpxcbOsgl0v JR3Io3vNRq8gYDHjFNqgHVHCh2Fsm39Jt+dLU50PFNkeqwkSItESyCDeXrYUhLtz t49oyttGtPUwpKaEWTskkUkP/e63ubZ82E5U+SDl2GnxHr+yntEjHZOgs+8m3GcQ S0aLBay1CRcrgTH45Zaba6Lc3+8glbgI9p2HADfn5ktRvNLTmwie5rDY5MPXnnXX gB/VJDVS+zwGHPZoqQPQZMkj2bOLHrkyyfVnbkI2IXRok6I8cxMCPKhLbAiMavvB ubEkQ8SN40dfL5NsawE2L3AxIc6HLgFh/qQqRqDXWfCZLeYOlwnJGyVk4G2dWdwD TnVZKw340Q== ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=NM6z6RGmuvj+2T1ZYdjKwHWJMiP8kn0GTkt5dS3zPQPxnSPvu7U0bVF08EI687zPXUKykrUOFpyxnL62XhvCWkhCNua0vqrxWP1XbYdKzwa1N6PXnDigu9DMgmqRDaBUfXuZbMjUFeNkRSrR7q++2qQCwWyya1PYEzLjZi7TdrZ3n8xccmppMydyok6aMVWjVoU0sEfSrj+DHHT49YqW91mMnjhf84hPZr8yTKVjCLGprb9jH/j2cjUO7eOChJcPwyVJt0V+UR2bSdAaWqHPhgjxJgWnhFrvBkVT/iMJHXz1VFRydP8PkW0olyDuwisJubTJTsnJfLt9bBN1Ojezng== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=PHaBpN1zTFDSQ2w3bjwOlW3vQPzvbCXCnWUMOapRjAQ=; b=bzBx1OZQkw/gcTqdQu0n2LTYmWoUlNCSq9Di+ond7AfQpR51DbJtJ59YWL1XZD+Rzn+269U9kE6HnGhFRTETH0WLeFA4AzQbwfnLi2wXkRS1B27CY/mOJaOkA3X1D18/Ws9xEI34Rj8IzPNzazV03qaxVC3xHltapySkivnKYXAnXZCuF6kPVNRD2Hwwn7MfBGUJMSHU4dOq+JcYayEzS1qib6eWzy5fOsJeVJNgG1mCsnGa5RuuQLf1ByLbwOL5Q9pDHg2dSA+fzwyuVYj6FSrmYWI/1wUvI5caRSRgpyCx9vLn/TIQjMJowVBQblN4QDF6Wzqz+KM8XBolp4vxWw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 74.117.212.83) smtp.rcpttodomain=nongnu.org smtp.mailfrom=selinc.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=selinc.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=selinc.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=PHaBpN1zTFDSQ2w3bjwOlW3vQPzvbCXCnWUMOapRjAQ=; b=M1iuTMM0qDb7sfIP026HuX5bd7uHZoDAcW8w8YTwOmw3+pkj89FmyCwaT1wIVSJZAIrCErI59xkuuHW8R6NXofMlysa9FDxYOpR7jrPapVU6HdLaMlN/DcZXlA2cu5Sk7AK1Sy9KGYu2U4VgdKL/bCHvwJH482XK9kU5pOEa6ISsBZ/uhc5P4LZ9DbvoQmwuFB16da5iOHZ2Ta73qTuxGOGFOG9eWYbypHYC4C0cGh3N/90MRXrSFhCRuXgl/3UBiDXk+HETy6DmwLERYNYiLFmNbpQDAXsUb0cnLwNP6nZPW0E3CVN038eb+tKTpQryteEwpQ1GuDrUJktXc8nyRA== X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 74.117.212.83) smtp.mailfrom=selinc.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=selinc.com; Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: Pass (protection.outlook.com: domain of selinc.com designates 74.117.212.83 as permitted sender) receiver=protection.outlook.com; client-ip=74.117.212.83; helo=email.selinc.com; pr=C From: To: CC: , aidaleuc Subject: [PATCH v5 2/2] Implement SSH commands in QEMU GA for Windows Date: Thu, 28 Mar 2024 09:40:49 -0600 Message-ID: <20240328154049.3090753-3-aidan_leuck@selinc.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240328154049.3090753-1-aidan_leuck@selinc.com> References: <20240328154049.3090753-1-aidan_leuck@selinc.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Originating-IP: [10.100.90.200] X-ClientProxiedBy: wpul-exchange1.ad.selinc.com (10.53.14.22) To wpul-exchange1.ad.selinc.com (10.53.14.22) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH3PEPF00000012:EE_|BY1PR22MB4064:EE_ X-MS-Office365-Filtering-Correlation-Id: 23f59bac-3686-4931-4d34-08dc4f3d809b X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: X36EK0FDpfJPrDEVnQ/Ku9MGjqL7MrDPS/UwvwdHUmYthvgiWs+Wqogt7Rc8uslSzPPqf+sPX4MC7/9MMHtqB5uJQ4lHxrsRHjrWI+dKCAERdqcbBm5+0cJDy0/cBHgZ/aw1x8mriAIYkQeIzNasMK5qVKeDLc0sQfgpaVpdvgPZDB2sMNFcSVGbz0l9lKhmZMRnbLKhiC16xqZNHEGwdRLzOCKWvkNZZHQxXgn/q6h1TKW8rTe/NECByAogm4jHJMAeiLRDGwODt0qwiEAaLZbC9JML7zR4vOoXW7jRyJy/JeK6PlWjArn5QRkemrohsN3fLbGeYvxU8DI+UplVzlLmwB/whIL/16PQ6DyGNPrR97l0SI9PEPU69StkDMFfgL8yi2GaY8oqCXFdNqeiEsZrr4mxso5jf7+Aou0ptH2Lli7z/2aobjUqQOFu49SiRWoUsmM47kQIfKAT2oSF/Gn3c0Tq/2dd3Si1kmUeNi9okhAJM8yRRapEfISd1E4W25irIxY3sv9wGLDu3D6apotqCy1yvzVmuaWO7Q+S95bsd/hhlI9xYZ4lG3ZFvdd6hyvj6K8sDaoXozqs6ol4x7aM0p+B049FqcHpi7IpvmMcdFzABnafeKCvdqMDd40ZLUhIwKVbrJnd06CE2N+q6GWj38HYEl4ZJJGfn/Evr0uSXo6LLNd/NFGhkFCm6TXe8F3uUNcduMeiSrJkKO6m6YgulHmtDPlYC4XjMaGFfePcl8p/hm9ZW3ZBEMiAHmwF X-Forefront-Antispam-Report: CIP:74.117.212.83; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:email.selinc.com; PTR:wpul-exchange1.selinc.com; CAT:NONE; SFS:(13230031)(376005)(82310400014)(36860700004)(1800799015); DIR:OUT; SFP:1102; X-OriginatorOrg: selinc.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Mar 2024 15:41:14.7466 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 23f59bac-3686-4931-4d34-08dc4f3d809b X-MS-Exchange-CrossTenant-Id: 12381f30-10fe-4e2c-aa3a-5e03ebeb59ec X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=12381f30-10fe-4e2c-aa3a-5e03ebeb59ec; Ip=[74.117.212.83]; Helo=[email.selinc.com] X-MS-Exchange-CrossTenant-AuthSource: CH3PEPF00000012.namprd21.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY1PR22MB4064 X-Proofpoint-GUID: KSQ_n1kCHejJMC3iHBB3j1ZhPEWCEIns X-Proofpoint-ORIG-GUID: KSQ_n1kCHejJMC3iHBB3j1ZhPEWCEIns X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 suspectscore=0 adultscore=0 spamscore=0 clxscore=1015 mlxscore=0 priorityscore=1501 mlxlogscore=999 impostorscore=0 malwarescore=0 lowpriorityscore=0 phishscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.19.0-2403210001 definitions=main-2403280108 Received-SPF: pass client-ip=148.163.143.141; envelope-from=prvs=881719a93e=aidan_leuck@selinc.com; helo=mx0b-000e8d01.pphosted.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @selinc.com) X-ZM-MESSAGEID: 1711640521427100001 Content-Type: text/plain; charset="utf-8" From: aidaleuc Signed-off-by: aidaleuc --- qga/commands-windows-ssh.c | 789 +++++++++++++++++++++++++++++++++++++ qga/commands-windows-ssh.h | 26 ++ qga/meson.build | 5 +- qga/qapi-schema.json | 17 +- 4 files changed, 826 insertions(+), 11 deletions(-) create mode 100644 qga/commands-windows-ssh.c create mode 100644 qga/commands-windows-ssh.h diff --git a/qga/commands-windows-ssh.c b/qga/commands-windows-ssh.c new file mode 100644 index 0000000000..bfd944f0a4 --- /dev/null +++ b/qga/commands-windows-ssh.c @@ -0,0 +1,789 @@ +/* + * QEMU Guest Agent win32-specific command implementations for SSH keys. + * The implementation is opinionated and expects the SSH implementation to + * be OpenSSH. + * + * Copyright Schweitzer Engineering Laboratories. 2024 + * + * Authors: + * Aidan Leuck + * + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include +#include + +#include "commands-common-ssh.h" +#include "commands-windows-ssh.h" +#include "guest-agent-core.h" +#include "limits.h" +#include "lmaccess.h" +#include "lmapibuf.h" +#include "lmerr.h" +#include "qapi/error.h" + +#include "qga-qapi-commands.h" +#include "sddl.h" +#include "shlobj.h" +#include "userenv.h" + +#define AUTHORIZED_KEY_FILE "authorized_keys" +#define AUTHORIZED_KEY_FILE_ADMIN "administrators_authorized_keys" +#define LOCAL_SYSTEM_SID "S-1-5-18" +#define ADMIN_SID "S-1-5-32-544" +#define WORLD_SID "S-1-1-0" + +/* + * Frees userInfo structure. This implements the g_auto cleanup + * for the structure. + */ +void free_userInfo(PWindowsUserInfo info) +{ + g_free(info->sshDirectory); + g_free(info->authorizedKeyFile); + LocalFree(info->SSID); + g_free(info->username); + g_free(info); +} + +/* + * Gets the admin SSH folder for OpenSSH. OpenSSH does not store + * the authorized_key file in the users home directory for security reason= s and + * instead stores it at %PROGRAMDATA%/ssh. This function returns the path = to + * that directory on the users machine + * + * parameters: + * errp -> error structure to set when an error occurs + * returns: The path to the ssh folder in %PROGRAMDATA% or NULL if an error + * occurred. + */ +static char *get_admin_ssh_folder(Error **errp) +{ + /* Allocate memory for the program data path */ + g_autofree char *programDataPath =3D NULL; + char *authkeys_path =3D NULL; + PWSTR pgDataW =3D NULL; + g_autoptr(GError) gerr =3D NULL; + + /* Get the KnownFolderPath on the machine. */ + HRESULT folderResult =3D + SHGetKnownFolderPath(&FOLDERID_ProgramData, 0, NULL, &pgDataW); + if (folderResult !=3D S_OK) { + error_setg(errp, "Failed to retrieve ProgramData folder"); + return NULL; + } + + /* Convert from a wide string back to a standard character string. */ + programDataPath =3D g_utf16_to_utf8(pgDataW, -1, NULL, NULL, &gerr); + CoTaskMemFree(pgDataW); + if (!programDataPath) { + error_setg(errp, + "Failed converting ProgramData folder path to UTF-16 %s= ", + gerr->message); + return NULL; + } + + /* Build the path to the file. */ + authkeys_path =3D g_build_filename(programDataPath, "ssh", NULL); + return authkeys_path; +} + +/* + * Gets the path to the SSH folder for the specified user. If the user is = an + * admin it returns the ssh folder located at %PROGRAMDATA%/ssh. If the us= er is + * not an admin it returns %USERPROFILE%/.ssh + * + * parameters: + * username -> Username to get the SSH folder for + * isAdmin -> Whether the user is an admin or not + * errp -> Error structure to set any errors that occur. + * returns: path to the ssh folder as a string. + */ +static char *get_ssh_folder(const char *username, const bool isAdmin, + Error **errp) +{ + DWORD maxSize =3D MAX_PATH; + g_autofree char *profilesDir =3D g_new0(char, maxSize); + + if (isAdmin) { + return get_admin_ssh_folder(errp); + } + + /* If not an Admin the SSH key is in the user directory. */ + /* Get the user profile directory on the machine. */ + BOOL ret =3D GetProfilesDirectory(profilesDir, &maxSize); + if (!ret) { + error_setg_win32(errp, GetLastError(), + "failed to retrieve profiles directory"); + return NULL; + } + + /* Builds the filename */ + return g_build_filename(profilesDir, username, ".ssh", NULL); +} + +/* + * Creates an entry for the everyone group. This is used when the user is = an + * Administrator This is consistent with the folder permissions that OpenS= SH + * creates when it is installed. Anyone can read the file, but only + * Administrators and SYSTEM can modify the file. + * + * parameters: + * userInfo -> Information about the current user + * pACL -> Pointer to an ACL structure + * errp -> Error structure to set any errors that occur + * returns: 1 on success, 0 otherwise + */ +static bool create_acl_admin(PWindowsUserInfo userInfo, PACL *pACL, + Error **errp) +{ + PSID everyonePSID =3D NULL; + + const int aclSize =3D 1; + EXPLICIT_ACCESS eAccess[1]; + + /* + * Create an entry for everyone (so they can at least read the folder). + * This is consistent with other folders located in %PROGRAMDATA% + */ + bool converted =3D ConvertStringSidToSid(WORLD_SID, &everyonePSID); + if (!converted) { + error_setg_win32(errp, GetLastError(), "failed to retrieve Admin S= ID"); + goto error; + } + + /* Set permissions for everyone group (they can only read the files) */ + eAccess[0].grfAccessPermissions =3D GENERIC_READ; + eAccess[0].grfAccessMode =3D SET_ACCESS; + eAccess[0].grfInheritance =3D NO_INHERITANCE; + eAccess[0].Trustee.TrusteeForm =3D TRUSTEE_IS_SID; + eAccess[0].Trustee.TrusteeType =3D TRUSTEE_IS_GROUP; + eAccess[0].Trustee.ptstrName =3D (LPTSTR)everyonePSID; + + /* Put the entries in an ACL object. */ + PACL pNewACL =3D NULL; + DWORD setResult; + + /* + * If we are given a pointer that is already initialized, then we can = merge + * the existing entries instead of overwriting them. + */ + if (*pACL) { + setResult =3D SetEntriesInAcl(aclSize, eAccess, *pACL, &pNewACL); + } else { + setResult =3D SetEntriesInAcl(aclSize, eAccess, NULL, &pNewACL); + } + + if (setResult !=3D ERROR_SUCCESS) { + error_setg_win32(errp, GetLastError(), + "failed to set ACL entries for admin user %s %lu", + userInfo->username, setResult); + goto error; + } + + LocalFree(everyonePSID); + + /* + * Free the old memory since we are going to overwrite the users + * pointer + */ + LocalFree(*pACL); + *pACL =3D pNewACL; + + return true; + +error: + LocalFree(everyonePSID); + return false; +} + +/* + * Creates an entry for the user so they can access the ssh folder in their + * userprofile. + * + * parameters: + * userInfo -> Information about the current user + * pACL -> Pointer to an ACL structure + * errp -> Error structure to set any errors that occur + * returns -> 1 on success, 0 otherwise + */ +static bool create_acl_user(PWindowsUserInfo userInfo, PACL *pACL, Error *= *errp) +{ + const int aclSize =3D 1; + PACL newACL =3D NULL; + EXPLICIT_ACCESS eAccess[1]; + PSID userPSID =3D NULL; + + /* Get a pointer to the internal SID object in Windows */ + bool converted =3D ConvertStringSidToSid(userInfo->SSID, &userPSID); + if (!converted) { + error_setg_win32(errp, GetLastError(), "failed to retrieve user %s= SID", + userInfo->username); + goto error; + } + + /* Set the permissions for the user. */ + eAccess[0].grfAccessPermissions =3D GENERIC_ALL; + eAccess[0].grfAccessMode =3D SET_ACCESS; + eAccess[0].grfInheritance =3D NO_INHERITANCE; + eAccess[0].Trustee.TrusteeForm =3D TRUSTEE_IS_SID; + eAccess[0].Trustee.TrusteeType =3D TRUSTEE_IS_USER; + eAccess[0].Trustee.ptstrName =3D (LPTSTR)userPSID; + + /* Set the ACL entries */ + DWORD setResult; + + /* + * If we are given a pointer that is already initialized, then we can = merge + * the existing entries instead of overwriting them. + */ + if (*pACL) { + setResult =3D SetEntriesInAcl(aclSize, eAccess, *pACL, &newACL); + } else { + setResult =3D SetEntriesInAcl(aclSize, eAccess, NULL, &newACL); + } + + if (setResult !=3D ERROR_SUCCESS) { + error_setg_win32(errp, GetLastError(), + "failed to set ACL entries for user %s %lu", + userInfo->username, setResult); + goto error; + } + + /* Free any old memory since we are going to overwrite the users point= er. */ + LocalFree(*pACL); + *pACL =3D newACL; + + LocalFree(userPSID); + return true; +error: + LocalFree(userPSID); + return false; +} + +/* + * Creates a base ACL for both normal users and admins to share + * pACL -> Pointer to an ACL structure + * errp -> Error structure to set any errors that occur + * returns: 1 on success, 0 otherwise + */ +static bool create_acl_base(PACL *pACL, Error **errp) +{ + PSID adminGroupPSID =3D NULL; + PSID systemPSID =3D NULL; + + const int aclSize =3D 2; + EXPLICIT_ACCESS eAccess[2]; + + /* Create an entry for the system user. */ + const char *systemSID =3D LOCAL_SYSTEM_SID; + bool converted =3D ConvertStringSidToSid(systemSID, &systemPSID); + if (!converted) { + error_setg_win32(errp, GetLastError(), "failed to retrieve system = SID"); + goto error; + } + + /* set permissions for system user */ + eAccess[0].grfAccessPermissions =3D GENERIC_ALL; + eAccess[0].grfAccessMode =3D SET_ACCESS; + eAccess[0].grfInheritance =3D NO_INHERITANCE; + eAccess[0].Trustee.TrusteeForm =3D TRUSTEE_IS_SID; + eAccess[0].Trustee.TrusteeType =3D TRUSTEE_IS_USER; + eAccess[0].Trustee.ptstrName =3D (LPTSTR)systemPSID; + + /* Create an entry for the admin user. */ + const char *adminSID =3D ADMIN_SID; + converted =3D ConvertStringSidToSid(adminSID, &adminGroupPSID); + if (!converted) { + error_setg_win32(errp, GetLastError(), "failed to retrieve Admin S= ID"); + goto error; + } + + /* Set permissions for admin group. */ + eAccess[1].grfAccessPermissions =3D GENERIC_ALL; + eAccess[1].grfAccessMode =3D SET_ACCESS; + eAccess[1].grfInheritance =3D NO_INHERITANCE; + eAccess[1].Trustee.TrusteeForm =3D TRUSTEE_IS_SID; + eAccess[1].Trustee.TrusteeType =3D TRUSTEE_IS_GROUP; + eAccess[1].Trustee.ptstrName =3D (LPTSTR)adminGroupPSID; + + /* Put the entries in an ACL object. */ + PACL pNewACL =3D NULL; + DWORD setResult; + + /* + *If we are given a pointer that is already initialized, then we can m= erge + *the existing entries instead of overwriting them. + */ + if (*pACL) { + setResult =3D SetEntriesInAcl(aclSize, eAccess, *pACL, &pNewACL); + } else { + setResult =3D SetEntriesInAcl(aclSize, eAccess, NULL, &pNewACL); + } + + if (setResult !=3D ERROR_SUCCESS) { + error_setg_win32(errp, GetLastError(), + "failed to set base ACL entries for system user a= nd " + "admin group %lu", + setResult); + goto error; + } + + LocalFree(adminGroupPSID); + LocalFree(systemPSID); + + /* Free any old memory since we are going to overwrite the users point= er. */ + LocalFree(*pACL); + + *pACL =3D pNewACL; + + return true; + +error: + LocalFree(adminGroupPSID); + LocalFree(systemPSID); + return false; +} + +/* + * Sets the access control on the authorized_keys file and any ssh folders= that + * need to be created. For administrators the required permissions on the + * file/folders are that only administrators and the LocalSystem account c= an + * access the folders. For normal user accounts only the specified user, + * LocalSystem and Administrators can have access to the key. + * + * parameters: + * userInfo -> pointer to structure that contains information about the us= er + * PACL -> pointer to an access control structure that will be set upon + * successful completion of the function. + * errp -> error structure that will be set upon error. + * returns: 1 upon success 0 upon failure. + */ +static bool create_acl(PWindowsUserInfo userInfo, PACL *pACL, Error **errp) +{ + /* + * Creates a base ACL that both admins and users will share + * This adds the Administrators group and the SYSTEM group + */ + if (!create_acl_base(pACL, errp)) { + return false; + } + + /* + * If the user is not an admin give the user creating the key permissi= on to + * access the file. + */ + if (!userInfo->isAdmin) { + if (!create_acl_user(userInfo, pACL, errp)) { + return false; + } + + return true; + } + + /* If the user is an admin allow everyone to read the keys */ + if (!create_acl_admin(userInfo, pACL, errp)) { + return false; + } + + return true; +} +/* + * Create the SSH directory for the user and d sets appropriate permission= s. + * In general the directory will be %PROGRAMDATA%/ssh if the user is an ad= min. + * %USERPOFILE%/.ssh if not an admin + * + * parameters: + * userInfo -> Contains information about the user + * errp -> Structure that will contain errors if the function fails. + * returns: zero upon failure, 1 upon success + */ +static bool create_ssh_directory(WindowsUserInfo *userInfo, Error **errp) +{ + PACL pNewACL =3D NULL; + g_autofree PSECURITY_DESCRIPTOR pSD =3D NULL; + + /* Gets the appropriate ACL for the user */ + if (!create_acl(userInfo, &pNewACL, errp)) { + goto error; + } + + /* Allocate memory for a security descriptor */ + pSD =3D g_malloc(SECURITY_DESCRIPTOR_MIN_LENGTH); + if (!InitializeSecurityDescriptor(pSD, SECURITY_DESCRIPTOR_REVISION)) { + error_setg_win32(errp, GetLastError(), + "Failed to initialize security descriptor"); + goto error; + } + + /* Associate the security descriptor with the ACL permissions. */ + if (!SetSecurityDescriptorDacl(pSD, TRUE, pNewACL, FALSE)) { + error_setg_win32(errp, GetLastError(), + "Failed to set security descriptor ACL"); + goto error; + } + + /* Set the security attributes on the folder */ + SECURITY_ATTRIBUTES sAttr; + sAttr.bInheritHandle =3D FALSE; + sAttr.nLength =3D sizeof(SECURITY_ATTRIBUTES); + sAttr.lpSecurityDescriptor =3D pSD; + + /* Create the directory with the created permissions */ + BOOL created =3D CreateDirectory(userInfo->sshDirectory, &sAttr); + if (!created) { + error_setg_win32(errp, GetLastError(), "failed to create directory= %s", + userInfo->sshDirectory); + goto error; + } + + /* Free memory */ + LocalFree(pNewACL); + return true; +error: + LocalFree(pNewACL); + return false; +} + +/* + * Sets permissions on the authorized_key_file that is created. + * + * parameters: userInfo -> Information about the user + * errp -> error structure that will contain errors upon failure + * returns: 1 upon success, zero upon failure. + */ +static bool set_file_permissions(PWindowsUserInfo userInfo, Error **errp) +{ + PACL pACL =3D NULL; + PSID userPSID; + + /* Creates the access control structure */ + if (!create_acl(userInfo, &pACL, errp)) { + goto error; + } + + /* Get the PSID structure for the user based off the string SID. */ + bool converted =3D ConvertStringSidToSid(userInfo->SSID, &userPSID); + if (!converted) { + error_setg_win32(errp, GetLastError(), "failed to retrieve user %s= SID", + userInfo->username); + goto error; + } + + /* Set the ACL on the file. */ + if (SetNamedSecurityInfo(userInfo->authorizedKeyFile, SE_FILE_OBJECT, + DACL_SECURITY_INFORMATION, userPSID, NULL, pA= CL, + NULL) !=3D ERROR_SUCCESS) { + error_setg_win32(errp, GetLastError(), + "failed to set file security for file %s", + userInfo->authorizedKeyFile); + goto error; + } + + LocalFree(pACL); + LocalFree(userPSID); + return true; + +error: + LocalFree(pACL); + LocalFree(userPSID); + + return false; +} + +/* + * Writes the specified keys to the authenticated keys file. + * parameters: + * userInfo: Information about the user we are writing the authkeys file t= o. + * authkeys: Array of keys to write to disk + * errp: Error structure that will contain any errors if they occur. + * returns: 1 if successful, 0 otherwise. + */ +static bool write_authkeys(WindowsUserInfo *userInfo, GStrv authkeys, + Error **errp) +{ + g_autofree char *contents =3D NULL; + g_autoptr(GError) err =3D NULL; + + contents =3D g_strjoinv("\n", authkeys); + + if (!g_file_set_contents(userInfo->authorizedKeyFile, contents, -1, &e= rr)) { + error_setg(errp, "failed to write to '%s': %s", + userInfo->authorizedKeyFile, err->message); + return false; + } + + if (!set_file_permissions(userInfo, errp)) { + return false; + } + + return true; +} + +/* + * Retrieves information about a Windows user by their username + * + * parameters: + * userInfo -> Double pointer to a WindowsUserInfo structure. Upon success= , it + * will be allocated with information about the user and need to be freed. + * username -> Name of the user to lookup. + * errp -> Contains any errors that occur. + * returns: 1 upon success, 0 upon failure. + */ +static bool get_user_info(PWindowsUserInfo *userInfo, const char *username, + Error **errp) +{ + DWORD infoLevel =3D 4; + LPUSER_INFO_4 uBuf =3D NULL; + g_autofree wchar_t *wideUserName =3D NULL; + g_autoptr(GError) gerr =3D NULL; + PSID psid =3D NULL; + + /* + * Converts a string to a Windows wide string since the GetNetUserInfo + * function requires it. + */ + wideUserName =3D g_utf8_to_utf16(username, -1, NULL, NULL, &gerr); + if (!wideUserName) { + goto error; + } + + /* allocate data */ + PWindowsUserInfo uData =3D g_new0(WindowsUserInfo, 1); + + /* Set pointer so it can be cleaned up by the callee, even upon error.= */ + *userInfo =3D uData; + + /* Find the information */ + NET_API_STATUS result =3D + NetUserGetInfo(NULL, wideUserName, infoLevel, (LPBYTE *)&uBuf); + if (result !=3D NERR_Success) { + /* Give a friendlier error message if the user was not found. */ + if (result =3D=3D NERR_UserNotFound) { + error_setg(errp, "User %s was not found", username); + goto error; + } + + error_setg(errp, + "Received unexpected error when asking for user info: E= rror " + "Code %lu", + result); + goto error; + } + + /* Get information from the buffer returned by NetUserGetInfo. */ + uData->username =3D g_strdup(username); + uData->isAdmin =3D uBuf->usri4_priv =3D=3D USER_PRIV_ADMIN; + psid =3D uBuf->usri4_user_sid; + + char *sidStr =3D NULL; + + /* + * We store the string representation of the SID not SID structure in + * memory. Callees wanting to use the SID structure should call + * ConvertStringSidToSID. + */ + if (!ConvertSidToStringSid(psid, &sidStr)) { + error_setg_win32(errp, GetLastError(), + "failed to get SID string for user %s", username); + goto error; + } + + /* Store the SSID */ + uData->SSID =3D sidStr; + + /* Get the SSH folder for the user. */ + char *sshFolder =3D get_ssh_folder(username, uData->isAdmin, errp); + if (sshFolder =3D=3D NULL) { + goto error; + } + + /* Get the authorized key file path */ + const char *authorizedKeyFile =3D + uData->isAdmin ? AUTHORIZED_KEY_FILE_ADMIN : AUTHORIZED_KEY_FILE; + char *authorizedKeyPath =3D + g_build_filename(sshFolder, authorizedKeyFile, NULL); + uData->sshDirectory =3D sshFolder; + uData->authorizedKeyFile =3D authorizedKeyPath; + + /* Free */ + NetApiBufferFree(uBuf); + return true; +error: + if (uBuf) { + NetApiBufferFree(uBuf); + } + + return false; +} + +/* + * Gets the list of authorized keys for a user. + * + * parameters: + * username -> Username to retrieve the keys for. + * errp -> Error structure that will display any errors through QMP. + * returns: List of keys associated with the user. + */ +GuestAuthorizedKeys *qmp_guest_ssh_get_authorized_keys(const char *usernam= e, + Error **errp) +{ + GuestAuthorizedKeys *keys =3D NULL; + g_auto(GStrv) authKeys =3D NULL; + g_autoptr(GuestAuthorizedKeys) ret =3D NULL; + g_auto(PWindowsUserInfo) userInfo =3D NULL; + + /* Gets user information */ + if (!get_user_info(&userInfo, username, errp)) { + return NULL; + } + + /* Reads authkeys for the user */ + authKeys =3D read_authkeys(userInfo->authorizedKeyFile, errp); + if (authKeys =3D=3D NULL) { + return NULL; + } + + /* Set the GuestAuthorizedKey struct with keys from the file */ + ret =3D g_new0(GuestAuthorizedKeys, 1); + for (int i =3D 0; authKeys[i] !=3D NULL; i++) { + g_strstrip(authKeys[i]); + if (!authKeys[i][0] || authKeys[i][0] =3D=3D '#') { + continue; + } + + QAPI_LIST_PREPEND(ret->keys, g_strdup(authKeys[i])); + } + + /* + * Steal the pointer because it is up for the callee to deallocate the + * memory. + */ + keys =3D g_steal_pointer(&ret); + return keys; +} + +/* + * Adds an ssh key for a user. + * + * parameters: + * username -> User to add the SSH key to + * strList -> Array of keys to add to the list + * has_reset -> Whether the keys have been reset + * reset -> Boolean to reset the keys (If this is set the existing list wi= ll be + * cleared) and the other key reset. errp -> Pointer to an error structure= that + * will get returned over QMP if anything goes wrong. + */ +void qmp_guest_ssh_add_authorized_keys(const char *username, strList *keys, + bool has_reset, bool reset, Error *= *errp) +{ + g_auto(PWindowsUserInfo) userInfo =3D NULL; + g_auto(GStrv) authkeys =3D NULL; + strList *k; + size_t nkeys, nauthkeys; + + /* Make sure the keys given are valid */ + if (!check_openssh_pub_keys(keys, &nkeys, errp)) { + return; + } + + /* Gets user information */ + if (!get_user_info(&userInfo, username, errp)) { + return; + } + + /* Determine whether we should reset the keys */ + reset =3D has_reset && reset; + if (!reset) { + /* Read existing keys into memory */ + authkeys =3D read_authkeys(userInfo->authorizedKeyFile, NULL); + } + + /* Check that the SSH key directory exists for the user. */ + if (!g_file_test(userInfo->sshDirectory, G_FILE_TEST_IS_DIR)) { + BOOL success =3D create_ssh_directory(userInfo, errp); + if (!success) { + return; + } + } + + /* Reallocates the buffer to fit the new keys. */ + nauthkeys =3D authkeys ? g_strv_length(authkeys) : 0; + authkeys =3D g_realloc_n(authkeys, nauthkeys + nkeys + 1, sizeof(char = *)); + + /* zero out the memory for the reallocated buffer */ + memset(authkeys + nauthkeys, 0, (nkeys + 1) * sizeof(char *)); + + /* Adds the keys */ + for (k =3D keys; k !=3D NULL; k =3D k->next) { + /* Check that the key doesn't already exist */ + if (g_strv_contains((const gchar *const *)authkeys, k->value)) { + continue; + } + + authkeys[nauthkeys++] =3D g_strdup(k->value); + } + + /* Write the authkeys to the file. */ + write_authkeys(userInfo, authkeys, errp); +} + +/* + * Removes an SSH key for a user + * + * parameters: + * username -> Username to remove the key from + * strList -> List of strings to remove + * errp -> Contains any errors that occur. + */ +void qmp_guest_ssh_remove_authorized_keys(const char *username, strList *k= eys, + Error **errp) +{ + g_auto(PWindowsUserInfo) userInfo =3D NULL; + g_autofree struct passwd *p =3D NULL; + g_autofree GStrv new_keys =3D NULL; /* do not own the strings */ + g_auto(GStrv) authkeys =3D NULL; + GStrv a; + size_t nkeys =3D 0; + + /* Validates the keys passed in by the user */ + if (!check_openssh_pub_keys(keys, NULL, errp)) { + return; + } + + /* Gets user information */ + if (!get_user_info(&userInfo, username, errp)) { + return; + } + + /* Reads the authkeys for the user */ + authkeys =3D read_authkeys(userInfo->authorizedKeyFile, errp); + if (authkeys =3D=3D NULL) { + return; + } + + /* Create a new buffer to hold the keys */ + new_keys =3D g_new0(char *, g_strv_length(authkeys) + 1); + for (a =3D authkeys; *a !=3D NULL; a++) { + strList *k; + + /* Filters out keys that are equal to ones the user specified. */ + for (k =3D keys; k !=3D NULL; k =3D k->next) { + if (g_str_equal(k->value, *a)) { + break; + } + } + + if (k !=3D NULL) { + continue; + } + + new_keys[nkeys++] =3D *a; + } + + /* Write the new authkeys to the file. */ + write_authkeys(userInfo, new_keys, errp); +} diff --git a/qga/commands-windows-ssh.h b/qga/commands-windows-ssh.h new file mode 100644 index 0000000000..40ac67c4d9 --- /dev/null +++ b/qga/commands-windows-ssh.h @@ -0,0 +1,26 @@ +/* + * Header file for commands-windows-ssh.c + * + * Copyright Schweitzer Engineering Laboratories. 2024 + * + * Authors: + * Aidan Leuck + * + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#include +#include +typedef struct WindowsUserInfo { + char *sshDirectory; + char *authorizedKeyFile; + char *username; + char *SSID; + bool isAdmin; +} WindowsUserInfo; + +typedef WindowsUserInfo *PWindowsUserInfo; + +void free_userInfo(PWindowsUserInfo info); +G_DEFINE_AUTO_CLEANUP_FREE_FUNC(PWindowsUserInfo, free_userInfo, NULL); diff --git a/qga/meson.build b/qga/meson.build index 4c3899751b..d5de492da3 100644 --- a/qga/meson.build +++ b/qga/meson.build @@ -73,7 +73,8 @@ if host_os =3D=3D 'windows' 'channel-win32.c', 'commands-win32.c', 'service-win32.c', - 'vss-win32.c' + 'vss-win32.c', + 'commands-windows-ssh.c' )) else qga_ss.add(files( @@ -94,7 +95,7 @@ gen_tlb =3D [] qga_libs =3D [] if host_os =3D=3D 'windows' qga_libs +=3D ['-lws2_32', '-lwinmm', '-lpowrprof', '-lwtsapi32', '-lwin= inet', '-liphlpapi', '-lnetapi32', - '-lsetupapi', '-lcfgmgr32'] + '-lsetupapi', '-lcfgmgr32', '-luserenv'] if have_qga_vss qga_libs +=3D ['-lole32', '-loleaut32', '-lshlwapi', '-lstdc++', '-Wl,= --enable-stdcall-fixup'] subdir('vss-win32') diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 9554b566a7..a64a6d91cf 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -1562,9 +1562,8 @@ { 'struct': 'GuestAuthorizedKeys', 'data': { 'keys': ['str'] - }, - 'if': 'CONFIG_POSIX' } - + } +} =20 ## # @guest-ssh-get-authorized-keys: @@ -1580,8 +1579,8 @@ ## { 'command': 'guest-ssh-get-authorized-keys', 'data': { 'username': 'str' }, - 'returns': 'GuestAuthorizedKeys', - 'if': 'CONFIG_POSIX' } + 'returns': 'GuestAuthorizedKeys' +} =20 ## # @guest-ssh-add-authorized-keys: @@ -1599,8 +1598,8 @@ # Since: 5.2 ## { 'command': 'guest-ssh-add-authorized-keys', - 'data': { 'username': 'str', 'keys': ['str'], '*reset': 'bool' }, - 'if': 'CONFIG_POSIX' } + 'data': { 'username': 'str', 'keys': ['str'], '*reset': 'bool' } +} =20 ## # @guest-ssh-remove-authorized-keys: @@ -1617,8 +1616,8 @@ # Since: 5.2 ## { 'command': 'guest-ssh-remove-authorized-keys', - 'data': { 'username': 'str', 'keys': ['str'] }, - 'if': 'CONFIG_POSIX' } + 'data': { 'username': 'str', 'keys': ['str'] } +} =20 ## # @GuestDiskStats: --=20 2.44.0