Annotation of src/usr.bin/ssh/sftp-common.c, Revision 1.34
1.34 ! djm 1: /* $OpenBSD: sftp-common.c,v 1.33 2022/09/19 10:41:58 djm Exp $ */
1.1 djm 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:
1.11 stevesk 27: #include <sys/types.h>
28: #include <sys/stat.h>
1.14 stevesk 29:
30: #include <grp.h>
1.15 stevesk 31: #include <pwd.h>
1.19 stevesk 32: #include <stdio.h>
1.17 stevesk 33: #include <string.h>
1.16 stevesk 34: #include <time.h>
1.20 deraadt 35: #include <stdarg.h>
1.25 dtucker 36: #include <stdlib.h>
1.21 djm 37: #include <util.h>
1.1 djm 38:
1.20 deraadt 39: #include "xmalloc.h"
1.27 djm 40: #include "ssherr.h"
41: #include "sshbuf.h"
1.1 djm 42: #include "log.h"
1.29 deraadt 43: #include "misc.h"
1.1 djm 44:
45: #include "sftp.h"
46: #include "sftp-common.h"
47:
1.3 markus 48: /* Clear contents of attributes structure */
1.1 djm 49: void
50: attrib_clear(Attrib *a)
51: {
52: a->flags = 0;
53: a->size = 0;
54: a->uid = 0;
55: a->gid = 0;
56: a->perm = 0;
57: a->atime = 0;
58: a->mtime = 0;
59: }
60:
1.3 markus 61: /* Convert from struct stat to filexfer attribs */
1.1 djm 62: void
1.10 jakob 63: stat_to_attrib(const struct stat *st, Attrib *a)
1.1 djm 64: {
65: attrib_clear(a);
66: a->flags = 0;
67: a->flags |= SSH2_FILEXFER_ATTR_SIZE;
68: a->size = st->st_size;
69: a->flags |= SSH2_FILEXFER_ATTR_UIDGID;
70: a->uid = st->st_uid;
71: a->gid = st->st_gid;
72: a->flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
73: a->perm = st->st_mode;
74: a->flags |= SSH2_FILEXFER_ATTR_ACMODTIME;
75: a->atime = st->st_atime;
76: a->mtime = st->st_mtime;
77: }
78:
1.7 djm 79: /* Convert from filexfer attribs to struct stat */
80: void
1.10 jakob 81: attrib_to_stat(const Attrib *a, struct stat *st)
1.7 djm 82: {
83: memset(st, 0, sizeof(*st));
84:
85: if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
86: st->st_size = a->size;
87: if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
88: st->st_uid = a->uid;
89: st->st_gid = a->gid;
90: }
91: if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
92: st->st_mode = a->perm;
93: if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
94: st->st_atime = a->atime;
95: st->st_mtime = a->mtime;
96: }
97: }
98:
1.3 markus 99: /* Decode attributes in buffer */
1.27 djm 100: int
101: decode_attrib(struct sshbuf *b, Attrib *a)
1.1 djm 102: {
1.27 djm 103: int r;
1.6 deraadt 104:
1.27 djm 105: attrib_clear(a);
106: if ((r = sshbuf_get_u32(b, &a->flags)) != 0)
107: return r;
108: if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
109: if ((r = sshbuf_get_u64(b, &a->size)) != 0)
110: return r;
111: }
112: if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
113: if ((r = sshbuf_get_u32(b, &a->uid)) != 0 ||
114: (r = sshbuf_get_u32(b, &a->gid)) != 0)
115: return r;
116: }
117: if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
118: if ((r = sshbuf_get_u32(b, &a->perm)) != 0)
119: return r;
120: }
121: if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
122: if ((r = sshbuf_get_u32(b, &a->atime)) != 0 ||
123: (r = sshbuf_get_u32(b, &a->mtime)) != 0)
124: return r;
1.1 djm 125: }
126: /* vendor-specific extensions */
1.27 djm 127: if (a->flags & SSH2_FILEXFER_ATTR_EXTENDED) {
128: char *type;
129: u_char *data;
130: size_t dlen;
131: u_int i, count;
1.6 deraadt 132:
1.27 djm 133: if ((r = sshbuf_get_u32(b, &count)) != 0)
1.32 djm 134: return r;
1.34 ! djm 135: if (count > 0x100000)
! 136: return SSH_ERR_INVALID_FORMAT;
1.1 djm 137: for (i = 0; i < count; i++) {
1.27 djm 138: if ((r = sshbuf_get_cstring(b, &type, NULL)) != 0 ||
139: (r = sshbuf_get_string(b, &data, &dlen)) != 0)
140: return r;
141: debug3("Got file attribute \"%.100s\" len %zu",
142: type, dlen);
1.24 djm 143: free(type);
144: free(data);
1.1 djm 145: }
146: }
1.27 djm 147: return 0;
1.1 djm 148: }
149:
1.3 markus 150: /* Encode attributes to buffer */
1.27 djm 151: int
152: encode_attrib(struct sshbuf *b, const Attrib *a)
1.1 djm 153: {
1.27 djm 154: int r;
155:
156: if ((r = sshbuf_put_u32(b, a->flags)) != 0)
157: return r;
158: if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
159: if ((r = sshbuf_put_u64(b, a->size)) != 0)
160: return r;
161: }
1.1 djm 162: if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
1.27 djm 163: if ((r = sshbuf_put_u32(b, a->uid)) != 0 ||
164: (r = sshbuf_put_u32(b, a->gid)) != 0)
165: return r;
166: }
167: if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
168: if ((r = sshbuf_put_u32(b, a->perm)) != 0)
169: return r;
1.1 djm 170: }
171: if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
1.27 djm 172: if ((r = sshbuf_put_u32(b, a->atime)) != 0 ||
173: (r = sshbuf_put_u32(b, a->mtime)) != 0)
174: return r;
1.1 djm 175: }
1.27 djm 176: return 0;
1.1 djm 177: }
178:
1.3 markus 179: /* Convert from SSH2_FX_ status to text error message */
1.1 djm 180: const char *
181: fx2txt(int status)
182: {
183: switch (status) {
184: case SSH2_FX_OK:
1.2 markus 185: return("No error");
1.1 djm 186: case SSH2_FX_EOF:
1.2 markus 187: return("End of file");
1.1 djm 188: case SSH2_FX_NO_SUCH_FILE:
1.2 markus 189: return("No such file or directory");
1.1 djm 190: case SSH2_FX_PERMISSION_DENIED:
1.2 markus 191: return("Permission denied");
1.1 djm 192: case SSH2_FX_FAILURE:
193: return("Failure");
194: case SSH2_FX_BAD_MESSAGE:
195: return("Bad message");
196: case SSH2_FX_NO_CONNECTION:
197: return("No connection");
198: case SSH2_FX_CONNECTION_LOST:
199: return("Connection lost");
200: case SSH2_FX_OP_UNSUPPORTED:
201: return("Operation unsupported");
202: default:
203: return("Unknown status");
1.5 deraadt 204: }
1.1 djm 205: /* NOTREACHED */
1.7 djm 206: }
207:
208: /*
209: * drwxr-xr-x 5 markus markus 1024 Jan 13 18:39 .ssh
210: */
211: char *
1.33 djm 212: ls_file(const char *name, const struct stat *st, int remote, int si_units,
213: const char *user, const char *group)
1.7 djm 214: {
215: int ulen, glen, sz = 0;
216: struct tm *ltime = localtime(&st->st_mtime);
1.30 djm 217: char buf[1024], lc[8], mode[11+1], tbuf[12+1], ubuf[11+1], gbuf[11+1];
1.21 djm 218: char sbuf[FMT_SCALED_STRSIZE];
1.26 guenther 219: time_t now;
1.7 djm 220:
221: strmode(st->st_mode, mode);
1.30 djm 222: if (remote) {
1.33 djm 223: if (user == NULL) {
224: snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
225: user = ubuf;
226: }
227: if (group == NULL) {
228: snprintf(gbuf, sizeof gbuf, "%u", (u_int)st->st_gid);
229: group = gbuf;
230: }
1.30 djm 231: strlcpy(lc, "?", sizeof(lc));
232: } else {
233: user = user_from_uid(st->st_uid, 0);
234: group = group_from_gid(st->st_gid, 0);
235: snprintf(lc, sizeof(lc), "%u", (u_int)st->st_nlink);
1.7 djm 236: }
237: if (ltime != NULL) {
1.26 guenther 238: now = time(NULL);
239: if (now - (365*24*60*60)/2 < st->st_mtime &&
240: now >= st->st_mtime)
1.7 djm 241: sz = strftime(tbuf, sizeof tbuf, "%b %e %H:%M", ltime);
242: else
243: sz = strftime(tbuf, sizeof tbuf, "%b %e %Y", ltime);
244: }
245: if (sz == 0)
246: tbuf[0] = '\0';
1.29 deraadt 247: ulen = MAXIMUM(strlen(user), 8);
248: glen = MAXIMUM(strlen(group), 8);
1.21 djm 249: if (si_units) {
250: fmt_scaled((long long)st->st_size, sbuf);
1.30 djm 251: snprintf(buf, sizeof buf, "%s %3s %-*s %-*s %8s %s %s",
252: mode, lc, ulen, user, glen, group,
1.21 djm 253: sbuf, tbuf, name);
254: } else {
1.30 djm 255: snprintf(buf, sizeof buf, "%s %3s %-*s %-*s %8llu %s %s",
256: mode, lc, ulen, user, glen, group,
1.21 djm 257: (unsigned long long)st->st_size, tbuf, name);
258: }
1.7 djm 259: return xstrdup(buf);
1.1 djm 260: }