1 /* $OpenBSD: sftp-common.c,v 1.36 2026/02/11 17:05:32 dtucker Exp $ */
2 /*
3 * Copyright (c) 2001 Markus Friedl. All rights reserved.
4 * Copyright (c) 2001 Damien Miller. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27 #include "includes.h"
28
29 #include <sys/types.h>
30 #include <sys/stat.h>
31
32 #include <grp.h>
33 #include <pwd.h>
34 #include <stdio.h>
35 #include <string.h>
36 #include <stdarg.h>
37 #include <stdlib.h>
38 #include <time.h>
39 #include <unistd.h>
40 #include <util.h>
41
42 #include "xmalloc.h"
43 #include "ssherr.h"
44 #include "sshbuf.h"
45 #include "log.h"
46 #include "misc.h"
47
48 #include "sftp.h"
49 #include "sftp-common.h"
50
51 /* Clear contents of attributes structure */
52 void
attrib_clear(Attrib * a)53 attrib_clear(Attrib *a)
54 {
55 a->flags = 0;
56 a->size = 0;
57 a->uid = 0;
58 a->gid = 0;
59 a->perm = 0;
60 a->atime = 0;
61 a->mtime = 0;
62 }
63
64 /* Convert from struct stat to filexfer attribs */
65 void
stat_to_attrib(const struct stat * st,Attrib * a)66 stat_to_attrib(const struct stat *st, Attrib *a)
67 {
68 attrib_clear(a);
69 a->flags = 0;
70 a->flags |= SSH2_FILEXFER_ATTR_SIZE;
71 a->size = st->st_size;
72 a->flags |= SSH2_FILEXFER_ATTR_UIDGID;
73 a->uid = st->st_uid;
74 a->gid = st->st_gid;
75 a->flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
76 a->perm = st->st_mode;
77 a->flags |= SSH2_FILEXFER_ATTR_ACMODTIME;
78 a->atime = st->st_atime;
79 a->mtime = st->st_mtime;
80 }
81
82 /* Convert from filexfer attribs to struct stat */
83 void
attrib_to_stat(const Attrib * a,struct stat * st)84 attrib_to_stat(const Attrib *a, struct stat *st)
85 {
86 memset(st, 0, sizeof(*st));
87
88 if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
89 st->st_size = a->size;
90 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
91 st->st_uid = a->uid;
92 st->st_gid = a->gid;
93 }
94 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
95 st->st_mode = a->perm;
96 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
97 st->st_atime = a->atime;
98 st->st_mtime = a->mtime;
99 }
100 }
101
102 /* Decode attributes in buffer */
103 int
decode_attrib(struct sshbuf * b,Attrib * a)104 decode_attrib(struct sshbuf *b, Attrib *a)
105 {
106 int r;
107
108 attrib_clear(a);
109 if ((r = sshbuf_get_u32(b, &a->flags)) != 0)
110 return r;
111 if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
112 if ((r = sshbuf_get_u64(b, &a->size)) != 0)
113 return r;
114 }
115 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
116 if ((r = sshbuf_get_u32(b, &a->uid)) != 0 ||
117 (r = sshbuf_get_u32(b, &a->gid)) != 0)
118 return r;
119 }
120 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
121 if ((r = sshbuf_get_u32(b, &a->perm)) != 0)
122 return r;
123 }
124 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
125 if ((r = sshbuf_get_u32(b, &a->atime)) != 0 ||
126 (r = sshbuf_get_u32(b, &a->mtime)) != 0)
127 return r;
128 }
129 /* vendor-specific extensions */
130 if (a->flags & SSH2_FILEXFER_ATTR_EXTENDED) {
131 char *type;
132 u_char *data;
133 size_t dlen;
134 u_int i, count;
135
136 if ((r = sshbuf_get_u32(b, &count)) != 0)
137 return r;
138 if (count > 0x100000)
139 return SSH_ERR_INVALID_FORMAT;
140 for (i = 0; i < count; i++) {
141 if ((r = sshbuf_get_cstring(b, &type, NULL)) != 0 ||
142 (r = sshbuf_get_string(b, &data, &dlen)) != 0)
143 return r;
144 debug3("Got file attribute \"%.100s\" len %zu",
145 type, dlen);
146 free(type);
147 free(data);
148 }
149 }
150 return 0;
151 }
152
153 /* Encode attributes to buffer */
154 int
encode_attrib(struct sshbuf * b,const Attrib * a)155 encode_attrib(struct sshbuf *b, const Attrib *a)
156 {
157 int r;
158
159 if ((r = sshbuf_put_u32(b, a->flags)) != 0)
160 return r;
161 if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
162 if ((r = sshbuf_put_u64(b, a->size)) != 0)
163 return r;
164 }
165 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
166 if ((r = sshbuf_put_u32(b, a->uid)) != 0 ||
167 (r = sshbuf_put_u32(b, a->gid)) != 0)
168 return r;
169 }
170 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
171 if ((r = sshbuf_put_u32(b, a->perm)) != 0)
172 return r;
173 }
174 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
175 if ((r = sshbuf_put_u32(b, a->atime)) != 0 ||
176 (r = sshbuf_put_u32(b, a->mtime)) != 0)
177 return r;
178 }
179 return 0;
180 }
181
182 /* Convert from SSH2_FX_ status to text error message */
183 const char *
fx2txt(int status)184 fx2txt(int status)
185 {
186 switch (status) {
187 case SSH2_FX_OK:
188 return("No error");
189 case SSH2_FX_EOF:
190 return("End of file");
191 case SSH2_FX_NO_SUCH_FILE:
192 return("No such file or directory");
193 case SSH2_FX_PERMISSION_DENIED:
194 return("Permission denied");
195 case SSH2_FX_FAILURE:
196 return("Failure");
197 case SSH2_FX_BAD_MESSAGE:
198 return("Bad message");
199 case SSH2_FX_NO_CONNECTION:
200 return("No connection");
201 case SSH2_FX_CONNECTION_LOST:
202 return("Connection lost");
203 case SSH2_FX_OP_UNSUPPORTED:
204 return("Operation unsupported");
205 default:
206 return("Unknown status");
207 }
208 /* NOTREACHED */
209 }
210
211 /*
212 * drwxr-xr-x 5 markus markus 1024 Jan 13 18:39 .ssh
213 */
214 char *
ls_file(const char * name,const struct stat * st,int remote,int si_units,const char * user,const char * group)215 ls_file(const char *name, const struct stat *st, int remote, int si_units,
216 const char *user, const char *group)
217 {
218 int ulen, glen, sz = 0;
219 struct tm *ltime = localtime(&st->st_mtime);
220 char buf[1024], lc[8], mode[11+1], tbuf[12+1], ubuf[11+1], gbuf[11+1];
221 char sbuf[FMT_SCALED_STRSIZE];
222 time_t now;
223
224 strmode(st->st_mode, mode);
225 if (remote) {
226 if (user == NULL) {
227 snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
228 user = ubuf;
229 }
230 if (group == NULL) {
231 snprintf(gbuf, sizeof gbuf, "%u", (u_int)st->st_gid);
232 group = gbuf;
233 }
234 strlcpy(lc, "?", sizeof(lc));
235 } else {
236 user = user_from_uid(st->st_uid, 0);
237 group = group_from_gid(st->st_gid, 0);
238 snprintf(lc, sizeof(lc), "%u", (u_int)st->st_nlink);
239 }
240 if (ltime != NULL) {
241 now = time(NULL);
242 if (now - (365*24*60*60)/2 < st->st_mtime &&
243 now >= st->st_mtime)
244 sz = strftime(tbuf, sizeof tbuf, "%b %e %H:%M", ltime);
245 else
246 sz = strftime(tbuf, sizeof tbuf, "%b %e %Y", ltime);
247 }
248 if (sz == 0)
249 tbuf[0] = '\0';
250 ulen = MAXIMUM(strlen(user), 8);
251 glen = MAXIMUM(strlen(group), 8);
252 if (si_units) {
253 fmt_scaled((long long)st->st_size, sbuf);
254 snprintf(buf, sizeof buf, "%s %3s %-*s %-*s %8s %s %s",
255 mode, lc, ulen, user, glen, group,
256 sbuf, tbuf, name);
257 } else {
258 snprintf(buf, sizeof buf, "%s %3s %-*s %-*s %8llu %s %s",
259 mode, lc, ulen, user, glen, group,
260 (unsigned long long)st->st_size, tbuf, name);
261 }
262 return xstrdup(buf);
263 }
264