[openssh-commits] [openssh] 01/01: upstream: sftp-server: support home-directory request

[git+noreply at mindrot.org]

This is an automated email from the git hooks/post-receive script.

djm pushed a commit to branch master
in repository openssh.

commit 730a80609472ee0451c99482d75c9c41f3ebc42d
Author: djm at openbsd.org <djm at openbsd.org>
Date:   Fri Aug 12 05:20:28 2022 +0000

    upstream: sftp-server: support home-directory request
    
    Add support to the sftp-server for the home-directory extension defined
    in draft-ietf-secsh-filexfer-extensions-00. This overlaps a bit with the
    existing expand-path at openssh.com, but uses a more official protocol name,
    and so is a bit more likely to be implemented by non-OpenSSH clients.
    
    From Mike Frysinger, ok dtucker@
    
    OpenBSD-Commit-ID: bfc580d05cc0c817831ae7ecbac4a481c23566ab
---
 PROTOCOL      | 22 +++++++++++++++++++++-
 sftp-server.c | 31 ++++++++++++++++++++++++++++++-
 2 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/PROTOCOL b/PROTOCOL
index f4735795..28ad9e0b 100644
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -615,6 +615,26 @@ This request is identical to the "copy-data" request documented in:
 
 https://tools.ietf.org/html/draft-ietf-secsh-filexfer-extensions-00#section-7
 
+4.11. sftp: Extension request "home-directory"
+
+This request asks the server to expand the specified user's home directory.
+An empty username implies the current user.  This can be used by the client
+to expand ~/ type paths locally.
+
+	byte		SSH_FXP_EXTENDED
+	uint32		id
+	string		"home-directory"
+	string		username
+
+This extension is advertised in the SSH_FXP_VERSION hello with version
+"1".
+
+This provides similar information as the "expand-path at openssh.com" extension.
+
+This request is identical to the "home-directory" request documented in:
+
+https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-extensions-00#section-5
+
 5. Miscellaneous changes
 
 5.1 Public key format
@@ -651,4 +671,4 @@ master instance and later clients.
 OpenSSH extends the usual agent protocol. These changes are documented
 in the PROTOCOL.agent file.
 
-$OpenBSD: PROTOCOL,v 1.45 2022/04/08 05:43:39 dtucker Exp $
+$OpenBSD: PROTOCOL,v 1.46 2022/08/12 05:20:28 djm Exp $
diff --git a/sftp-server.c b/sftp-server.c
index 3dd19d4c..85f4345e 100644
--- a/sftp-server.c
+++ b/sftp-server.c
@@ -1,4 +1,4 @@
-/* $OpenBSD: sftp-server.c,v 1.140 2022/03/31 03:05:49 djm Exp $ */
+/* $OpenBSD: sftp-server.c,v 1.141 2022/08/12 05:20:28 djm Exp $ */
 /*
  * Copyright (c) 2000-2004 Markus Friedl.  All rights reserved.
  *
@@ -121,6 +121,7 @@ static void process_extended_lsetstat(u_int32_t id);
 static void process_extended_limits(u_int32_t id);
 static void process_extended_expand(u_int32_t id);
 static void process_extended_copy_data(u_int32_t id);
+static void process_extended_home_directory(u_int32_t id);
 static void process_extended(u_int32_t id);
 
 struct sftp_handler {
@@ -167,6 +168,8 @@ static const struct sftp_handler extended_handlers[] = {
 	{ "expand-path", "expand-path at openssh.com", 0,
 	    process_extended_expand, 0 },
 	{ "copy-data", "copy-data", 0, process_extended_copy_data, 1 },
+	{ "home-directory", "home-directory", 0,
+	    process_extended_home_directory, 0 },
 	{ NULL, NULL, 0, NULL, 0 }
 };
 
@@ -724,6 +727,7 @@ process_init(void)
 	compose_extension(msg, "limits at openssh.com", "1");
 	compose_extension(msg, "expand-path at openssh.com", "1");
 	compose_extension(msg, "copy-data", "1");
+	compose_extension(msg, "home-directory", "1");
 
 	send_msg(msg);
 	sshbuf_free(msg);
@@ -1684,6 +1688,31 @@ process_extended_copy_data(u_int32_t id)
 	send_status(id, status);
 }
 
+static void
+process_extended_home_directory(u_int32_t id)
+{
+	char *username;
+	struct passwd *user_pw;
+	int r;
+	Stat s;
+
+	if ((r = sshbuf_get_cstring(iqueue, &username, NULL)) != 0)
+		fatal_fr(r, "parse");
+
+	debug3("request %u: home-directory \"%s\"", id, username);
+	if ((user_pw = getpwnam(username)) == NULL) {
+		send_status(id, errno_to_portable(errno));
+		goto out;
+	}
+
+	verbose("home-directory \"%s\"", pw->pw_dir);
+	attrib_clear(&s.attrib);
+	s.name = s.long_name = pw->pw_dir;
+	send_names(id, 1, &s);
+ out:
+	free(username);
+}
+
 static void
 process_extended(u_int32_t id)
 {

-- 
To stop receiving notification emails like this one, please contact
djm at mindrot.org.