blob: 3a70c52dd3ddaa709d0221dd8ee749721c4abade [file] [log] [blame]
deraadt@openbsd.org9136ec12016-09-12 01:22:38 +00001/* $OpenBSD: sftp-common.c,v 1.29 2016/09/12 01:22:38 deraadt Exp $ */
Damien Miller33804262001-02-04 23:20:18 +11002/*
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"
Damien Millerf17883e2006-03-15 11:45:54 +110028
29#include <sys/types.h>
30#include <sys/stat.h>
Damien Miller33804262001-02-04 23:20:18 +110031
Damien Miller427a1d52006-07-10 20:20:33 +100032#include <grp.h>
Damien Miller9f2abc42006-07-10 20:53:08 +100033#include <pwd.h>
Damien Millera7a73ee2006-08-05 11:37:59 +100034#include <stdio.h>
Damien Miller0600c702013-11-21 13:55:43 +110035#include <stdlib.h>
Damien Millere3476ed2006-07-24 14:13:33 +100036#include <string.h>
Damien Miller5598b4f2006-07-24 14:09:40 +100037#include <time.h>
Damien Millerd7834352006-08-05 12:39:39 +100038#include <stdarg.h>
Darren Tucker096630d2010-01-13 23:00:38 +110039#ifdef HAVE_UTIL_H
Darren Tucker2901e2d2010-01-13 22:44:06 +110040#include <util.h>
Darren Tucker096630d2010-01-13 23:00:38 +110041#endif
Damien Miller427a1d52006-07-10 20:20:33 +100042
Damien Miller33804262001-02-04 23:20:18 +110043#include "xmalloc.h"
djm@openbsd.org7d845f42015-01-14 13:54:13 +000044#include "ssherr.h"
45#include "sshbuf.h"
Damien Millerd7834352006-08-05 12:39:39 +100046#include "log.h"
deraadt@openbsd.org9136ec12016-09-12 01:22:38 +000047#include "misc.h"
Damien Miller33804262001-02-04 23:20:18 +110048
49#include "sftp.h"
50#include "sftp-common.h"
51
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000052/* Clear contents of attributes structure */
Damien Miller33804262001-02-04 23:20:18 +110053void
54attrib_clear(Attrib *a)
55{
56 a->flags = 0;
57 a->size = 0;
58 a->uid = 0;
59 a->gid = 0;
60 a->perm = 0;
61 a->atime = 0;
62 a->mtime = 0;
63}
64
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000065/* Convert from struct stat to filexfer attribs */
Damien Miller33804262001-02-04 23:20:18 +110066void
Damien Millerf58b58c2003-11-17 21:18:23 +110067stat_to_attrib(const struct stat *st, Attrib *a)
Damien Miller33804262001-02-04 23:20:18 +110068{
69 attrib_clear(a);
70 a->flags = 0;
71 a->flags |= SSH2_FILEXFER_ATTR_SIZE;
72 a->size = st->st_size;
73 a->flags |= SSH2_FILEXFER_ATTR_UIDGID;
74 a->uid = st->st_uid;
75 a->gid = st->st_gid;
76 a->flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
77 a->perm = st->st_mode;
78 a->flags |= SSH2_FILEXFER_ATTR_ACMODTIME;
79 a->atime = st->st_atime;
80 a->mtime = st->st_mtime;
81}
82
Damien Millere1a49812002-09-12 09:54:25 +100083/* Convert from filexfer attribs to struct stat */
84void
Damien Millerf58b58c2003-11-17 21:18:23 +110085attrib_to_stat(const Attrib *a, struct stat *st)
Damien Millere1a49812002-09-12 09:54:25 +100086{
87 memset(st, 0, sizeof(*st));
88
89 if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
90 st->st_size = a->size;
91 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
92 st->st_uid = a->uid;
93 st->st_gid = a->gid;
94 }
95 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
96 st->st_mode = a->perm;
97 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
98 st->st_atime = a->atime;
99 st->st_mtime = a->mtime;
100 }
101}
102
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000103/* Decode attributes in buffer */
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000104int
105decode_attrib(struct sshbuf *b, Attrib *a)
Damien Miller33804262001-02-04 23:20:18 +1100106{
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000107 int r;
Ben Lindstromb1f483f2002-06-23 21:27:18 +0000108
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000109 attrib_clear(a);
110 if ((r = sshbuf_get_u32(b, &a->flags)) != 0)
111 return r;
112 if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
113 if ((r = sshbuf_get_u64(b, &a->size)) != 0)
114 return r;
Damien Miller33804262001-02-04 23:20:18 +1100115 }
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000116 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
117 if ((r = sshbuf_get_u32(b, &a->uid)) != 0 ||
118 (r = sshbuf_get_u32(b, &a->gid)) != 0)
119 return r;
120 }
121 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
122 if ((r = sshbuf_get_u32(b, &a->perm)) != 0)
123 return r;
124 }
125 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
126 if ((r = sshbuf_get_u32(b, &a->atime)) != 0 ||
127 (r = sshbuf_get_u32(b, &a->mtime)) != 0)
128 return r;
Damien Miller33804262001-02-04 23:20:18 +1100129 }
130 /* vendor-specific extensions */
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000131 if (a->flags & SSH2_FILEXFER_ATTR_EXTENDED) {
132 char *type;
133 u_char *data;
134 size_t dlen;
135 u_int i, count;
Ben Lindstromb1f483f2002-06-23 21:27:18 +0000136
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000137 if ((r = sshbuf_get_u32(b, &count)) != 0)
138 fatal("%s: buffer error: %s", __func__, ssh_err(r));
Damien Miller33804262001-02-04 23:20:18 +1100139 for (i = 0; i < count; i++) {
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000140 if ((r = sshbuf_get_cstring(b, &type, NULL)) != 0 ||
141 (r = sshbuf_get_string(b, &data, &dlen)) != 0)
142 return r;
143 debug3("Got file attribute \"%.100s\" len %zu",
144 type, dlen);
Darren Tuckera627d422013-06-02 07:31:17 +1000145 free(type);
146 free(data);
Damien Miller33804262001-02-04 23:20:18 +1100147 }
148 }
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000149 return 0;
Damien Miller33804262001-02-04 23:20:18 +1100150}
151
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000152/* Encode attributes to buffer */
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000153int
154encode_attrib(struct sshbuf *b, const Attrib *a)
Damien Miller33804262001-02-04 23:20:18 +1100155{
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000156 int r;
157
158 if ((r = sshbuf_put_u32(b, a->flags)) != 0)
159 return r;
160 if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
161 if ((r = sshbuf_put_u64(b, a->size)) != 0)
162 return r;
163 }
Damien Miller33804262001-02-04 23:20:18 +1100164 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000165 if ((r = sshbuf_put_u32(b, a->uid)) != 0 ||
166 (r = sshbuf_put_u32(b, a->gid)) != 0)
167 return r;
Damien Miller33804262001-02-04 23:20:18 +1100168 }
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000169 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
170 if ((r = sshbuf_put_u32(b, a->perm)) != 0)
171 return r;
172 }
Damien Miller33804262001-02-04 23:20:18 +1100173 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000174 if ((r = sshbuf_put_u32(b, a->atime)) != 0 ||
175 (r = sshbuf_put_u32(b, a->mtime)) != 0)
176 return r;
Damien Miller33804262001-02-04 23:20:18 +1100177 }
djm@openbsd.org7d845f42015-01-14 13:54:13 +0000178 return 0;
Damien Miller33804262001-02-04 23:20:18 +1100179}
180
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000181/* Convert from SSH2_FX_ status to text error message */
Damien Miller33804262001-02-04 23:20:18 +1100182const char *
183fx2txt(int status)
184{
185 switch (status) {
186 case SSH2_FX_OK:
Damien Millerd7686fd2001-02-10 00:40:03 +1100187 return("No error");
Damien Miller33804262001-02-04 23:20:18 +1100188 case SSH2_FX_EOF:
Damien Millerd7686fd2001-02-10 00:40:03 +1100189 return("End of file");
Damien Miller33804262001-02-04 23:20:18 +1100190 case SSH2_FX_NO_SUCH_FILE:
Damien Millerd7686fd2001-02-10 00:40:03 +1100191 return("No such file or directory");
Damien Miller33804262001-02-04 23:20:18 +1100192 case SSH2_FX_PERMISSION_DENIED:
Damien Millerd7686fd2001-02-10 00:40:03 +1100193 return("Permission denied");
Damien Miller33804262001-02-04 23:20:18 +1100194 case SSH2_FX_FAILURE:
195 return("Failure");
196 case SSH2_FX_BAD_MESSAGE:
197 return("Bad message");
198 case SSH2_FX_NO_CONNECTION:
199 return("No connection");
200 case SSH2_FX_CONNECTION_LOST:
201 return("Connection lost");
202 case SSH2_FX_OP_UNSUPPORTED:
203 return("Operation unsupported");
204 default:
205 return("Unknown status");
Ben Lindstromd05487d2001-12-06 17:50:03 +0000206 }
Damien Miller33804262001-02-04 23:20:18 +1100207 /* NOTREACHED */
208}
Damien Millere1a49812002-09-12 09:54:25 +1000209
210/*
211 * drwxr-xr-x 5 markus markus 1024 Jan 13 18:39 .ssh
212 */
213char *
Darren Tucker2901e2d2010-01-13 22:44:06 +1100214ls_file(const char *name, const struct stat *st, int remote, int si_units)
Damien Millere1a49812002-09-12 09:54:25 +1000215{
216 int ulen, glen, sz = 0;
Damien Millere1a49812002-09-12 09:54:25 +1000217 struct tm *ltime = localtime(&st->st_mtime);
218 char *user, *group;
219 char buf[1024], mode[11+1], tbuf[12+1], ubuf[11+1], gbuf[11+1];
Darren Tucker2901e2d2010-01-13 22:44:06 +1100220 char sbuf[FMT_SCALED_STRSIZE];
Damien Millere00e4132014-01-10 10:40:45 +1100221 time_t now;
Damien Millere1a49812002-09-12 09:54:25 +1000222
223 strmode(st->st_mode, mode);
Darren Tuckera788de22010-01-15 11:45:33 +1100224 if (!remote) {
225 user = user_from_uid(st->st_uid, 0);
Damien Millere1a49812002-09-12 09:54:25 +1000226 } else {
227 snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
228 user = ubuf;
229 }
Darren Tuckera788de22010-01-15 11:45:33 +1100230 if (!remote) {
231 group = group_from_gid(st->st_gid, 0);
Damien Millere1a49812002-09-12 09:54:25 +1000232 } else {
233 snprintf(gbuf, sizeof gbuf, "%u", (u_int)st->st_gid);
234 group = gbuf;
235 }
236 if (ltime != NULL) {
Damien Millere00e4132014-01-10 10:40:45 +1100237 now = time(NULL);
238 if (now - (365*24*60*60)/2 < st->st_mtime &&
239 now >= st->st_mtime)
Damien Millere1a49812002-09-12 09:54:25 +1000240 sz = strftime(tbuf, sizeof tbuf, "%b %e %H:%M", ltime);
241 else
242 sz = strftime(tbuf, sizeof tbuf, "%b %e %Y", ltime);
243 }
244 if (sz == 0)
245 tbuf[0] = '\0';
deraadt@openbsd.org9136ec12016-09-12 01:22:38 +0000246 ulen = MAXIMUM(strlen(user), 8);
247 glen = MAXIMUM(strlen(group), 8);
Darren Tucker2901e2d2010-01-13 22:44:06 +1100248 if (si_units) {
249 fmt_scaled((long long)st->st_size, sbuf);
250 snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8s %s %s", mode,
251 (u_int)st->st_nlink, ulen, user, glen, group,
252 sbuf, tbuf, name);
253 } else {
254 snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8llu %s %s", mode,
255 (u_int)st->st_nlink, ulen, user, glen, group,
256 (unsigned long long)st->st_size, tbuf, name);
257 }
Damien Millere1a49812002-09-12 09:54:25 +1000258 return xstrdup(buf);
259}