sftp-common.c revision 323134
1/* $OpenBSD: sftp-common.c,v 1.29 2016/09/12 01:22:38 deraadt 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__RCSID("$FreeBSD: stable/11/crypto/openssh/sftp-common.c 323134 2017-09-02 21:58:42Z des $");
29
30#include <sys/types.h>
31#include <sys/stat.h>
32
33#include <grp.h>
34#include <pwd.h>
35#include <stdio.h>
36#include <stdlib.h>
37#include <string.h>
38#include <time.h>
39#include <stdarg.h>
40#ifdef HAVE_UTIL_H
41#include <util.h>
42#endif
43
44#include "xmalloc.h"
45#include "ssherr.h"
46#include "sshbuf.h"
47#include "log.h"
48#include "misc.h"
49
50#include "sftp.h"
51#include "sftp-common.h"
52
53/* Clear contents of attributes structure */
54void
55attrib_clear(Attrib *a)
56{
57	a->flags = 0;
58	a->size = 0;
59	a->uid = 0;
60	a->gid = 0;
61	a->perm = 0;
62	a->atime = 0;
63	a->mtime = 0;
64}
65
66/* Convert from struct stat to filexfer attribs */
67void
68stat_to_attrib(const struct stat *st, Attrib *a)
69{
70	attrib_clear(a);
71	a->flags = 0;
72	a->flags |= SSH2_FILEXFER_ATTR_SIZE;
73	a->size = st->st_size;
74	a->flags |= SSH2_FILEXFER_ATTR_UIDGID;
75	a->uid = st->st_uid;
76	a->gid = st->st_gid;
77	a->flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
78	a->perm = st->st_mode;
79	a->flags |= SSH2_FILEXFER_ATTR_ACMODTIME;
80	a->atime = st->st_atime;
81	a->mtime = st->st_mtime;
82}
83
84/* Convert from filexfer attribs to struct stat */
85void
86attrib_to_stat(const Attrib *a, struct stat *st)
87{
88	memset(st, 0, sizeof(*st));
89
90	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
91		st->st_size = a->size;
92	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
93		st->st_uid = a->uid;
94		st->st_gid = a->gid;
95	}
96	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
97		st->st_mode = a->perm;
98	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
99		st->st_atime = a->atime;
100		st->st_mtime = a->mtime;
101	}
102}
103
104/* Decode attributes in buffer */
105int
106decode_attrib(struct sshbuf *b, Attrib *a)
107{
108	int r;
109
110	attrib_clear(a);
111	if ((r = sshbuf_get_u32(b, &a->flags)) != 0)
112		return r;
113	if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
114		if ((r = sshbuf_get_u64(b, &a->size)) != 0)
115			return r;
116	}
117	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
118		if ((r = sshbuf_get_u32(b, &a->uid)) != 0 ||
119		    (r = sshbuf_get_u32(b, &a->gid)) != 0)
120			return r;
121	}
122	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
123		if ((r = sshbuf_get_u32(b, &a->perm)) != 0)
124			return r;
125	}
126	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
127		if ((r = sshbuf_get_u32(b, &a->atime)) != 0 ||
128		    (r = sshbuf_get_u32(b, &a->mtime)) != 0)
129			return r;
130	}
131	/* vendor-specific extensions */
132	if (a->flags & SSH2_FILEXFER_ATTR_EXTENDED) {
133		char *type;
134		u_char *data;
135		size_t dlen;
136		u_int i, count;
137
138		if ((r = sshbuf_get_u32(b, &count)) != 0)
139			fatal("%s: buffer error: %s", __func__, ssh_err(r));
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 */
154int
155encode_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 */
183const char *
184fx2txt(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 */
214char *
215ls_file(const char *name, const struct stat *st, int remote, int si_units)
216{
217	int ulen, glen, sz = 0;
218	struct tm *ltime = localtime(&st->st_mtime);
219	const char *user, *group;
220	char buf[1024], 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		user = user_from_uid(st->st_uid, 0);
227	} else {
228		snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
229		user = ubuf;
230	}
231	if (!remote) {
232		group = group_from_gid(st->st_gid, 0);
233	} else {
234		snprintf(gbuf, sizeof gbuf, "%u", (u_int)st->st_gid);
235		group = gbuf;
236	}
237	if (ltime != NULL) {
238		now = time(NULL);
239		if (now - (365*24*60*60)/2 < st->st_mtime &&
240		    now >= st->st_mtime)
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';
247	ulen = MAXIMUM(strlen(user), 8);
248	glen = MAXIMUM(strlen(group), 8);
249	if (si_units) {
250		fmt_scaled((long long)st->st_size, sbuf);
251		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8s %s %s", mode,
252		    (u_int)st->st_nlink, ulen, user, glen, group,
253		    sbuf, tbuf, name);
254	} else {
255		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8llu %s %s", mode,
256		    (u_int)st->st_nlink, ulen, user, glen, group,
257		    (unsigned long long)st->st_size, tbuf, name);
258	}
259	return xstrdup(buf);
260}
261