xref: /openbsd/usr.bin/ssh/sftp-common.c (revision 898184e3)
1 /* $OpenBSD: sftp-common.c,v 1.23 2010/01/15 09:24:23 markus 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 <sys/types.h>
28 #include <sys/stat.h>
29 #include <sys/param.h>
30 
31 #include <grp.h>
32 #include <pwd.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <time.h>
36 #include <stdarg.h>
37 #include <util.h>
38 
39 #include "xmalloc.h"
40 #include "buffer.h"
41 #include "log.h"
42 
43 #include "sftp.h"
44 #include "sftp-common.h"
45 
46 /* Clear contents of attributes structure */
47 void
48 attrib_clear(Attrib *a)
49 {
50 	a->flags = 0;
51 	a->size = 0;
52 	a->uid = 0;
53 	a->gid = 0;
54 	a->perm = 0;
55 	a->atime = 0;
56 	a->mtime = 0;
57 }
58 
59 /* Convert from struct stat to filexfer attribs */
60 void
61 stat_to_attrib(const struct stat *st, Attrib *a)
62 {
63 	attrib_clear(a);
64 	a->flags = 0;
65 	a->flags |= SSH2_FILEXFER_ATTR_SIZE;
66 	a->size = st->st_size;
67 	a->flags |= SSH2_FILEXFER_ATTR_UIDGID;
68 	a->uid = st->st_uid;
69 	a->gid = st->st_gid;
70 	a->flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
71 	a->perm = st->st_mode;
72 	a->flags |= SSH2_FILEXFER_ATTR_ACMODTIME;
73 	a->atime = st->st_atime;
74 	a->mtime = st->st_mtime;
75 }
76 
77 /* Convert from filexfer attribs to struct stat */
78 void
79 attrib_to_stat(const Attrib *a, struct stat *st)
80 {
81 	memset(st, 0, sizeof(*st));
82 
83 	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
84 		st->st_size = a->size;
85 	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
86 		st->st_uid = a->uid;
87 		st->st_gid = a->gid;
88 	}
89 	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
90 		st->st_mode = a->perm;
91 	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
92 		st->st_atime = a->atime;
93 		st->st_mtime = a->mtime;
94 	}
95 }
96 
97 /* Decode attributes in buffer */
98 Attrib *
99 decode_attrib(Buffer *b)
100 {
101 	static Attrib a;
102 
103 	attrib_clear(&a);
104 	a.flags = buffer_get_int(b);
105 	if (a.flags & SSH2_FILEXFER_ATTR_SIZE)
106 		a.size = buffer_get_int64(b);
107 	if (a.flags & SSH2_FILEXFER_ATTR_UIDGID) {
108 		a.uid = buffer_get_int(b);
109 		a.gid = buffer_get_int(b);
110 	}
111 	if (a.flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
112 		a.perm = buffer_get_int(b);
113 	if (a.flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
114 		a.atime = buffer_get_int(b);
115 		a.mtime = buffer_get_int(b);
116 	}
117 	/* vendor-specific extensions */
118 	if (a.flags & SSH2_FILEXFER_ATTR_EXTENDED) {
119 		char *type, *data;
120 		int i, count;
121 
122 		count = buffer_get_int(b);
123 		for (i = 0; i < count; i++) {
124 			type = buffer_get_string(b, NULL);
125 			data = buffer_get_string(b, NULL);
126 			debug3("Got file attribute \"%s\"", type);
127 			xfree(type);
128 			xfree(data);
129 		}
130 	}
131 	return &a;
132 }
133 
134 /* Encode attributes to buffer */
135 void
136 encode_attrib(Buffer *b, const Attrib *a)
137 {
138 	buffer_put_int(b, a->flags);
139 	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
140 		buffer_put_int64(b, a->size);
141 	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
142 		buffer_put_int(b, a->uid);
143 		buffer_put_int(b, a->gid);
144 	}
145 	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
146 		buffer_put_int(b, a->perm);
147 	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
148 		buffer_put_int(b, a->atime);
149 		buffer_put_int(b, a->mtime);
150 	}
151 }
152 
153 /* Convert from SSH2_FX_ status to text error message */
154 const char *
155 fx2txt(int status)
156 {
157 	switch (status) {
158 	case SSH2_FX_OK:
159 		return("No error");
160 	case SSH2_FX_EOF:
161 		return("End of file");
162 	case SSH2_FX_NO_SUCH_FILE:
163 		return("No such file or directory");
164 	case SSH2_FX_PERMISSION_DENIED:
165 		return("Permission denied");
166 	case SSH2_FX_FAILURE:
167 		return("Failure");
168 	case SSH2_FX_BAD_MESSAGE:
169 		return("Bad message");
170 	case SSH2_FX_NO_CONNECTION:
171 		return("No connection");
172 	case SSH2_FX_CONNECTION_LOST:
173 		return("Connection lost");
174 	case SSH2_FX_OP_UNSUPPORTED:
175 		return("Operation unsupported");
176 	default:
177 		return("Unknown status");
178 	}
179 	/* NOTREACHED */
180 }
181 
182 /*
183  * drwxr-xr-x    5 markus   markus       1024 Jan 13 18:39 .ssh
184  */
185 char *
186 ls_file(const char *name, const struct stat *st, int remote, int si_units)
187 {
188 	int ulen, glen, sz = 0;
189 	struct tm *ltime = localtime(&st->st_mtime);
190 	char *user, *group;
191 	char buf[1024], mode[11+1], tbuf[12+1], ubuf[11+1], gbuf[11+1];
192 	char sbuf[FMT_SCALED_STRSIZE];
193 
194 	strmode(st->st_mode, mode);
195 	if (!remote) {
196 		user = user_from_uid(st->st_uid, 0);
197 	} else {
198 		snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
199 		user = ubuf;
200 	}
201 	if (!remote) {
202 		group = group_from_gid(st->st_gid, 0);
203 	} else {
204 		snprintf(gbuf, sizeof gbuf, "%u", (u_int)st->st_gid);
205 		group = gbuf;
206 	}
207 	if (ltime != NULL) {
208 		if (time(NULL) - st->st_mtime < (365*24*60*60)/2)
209 			sz = strftime(tbuf, sizeof tbuf, "%b %e %H:%M", ltime);
210 		else
211 			sz = strftime(tbuf, sizeof tbuf, "%b %e  %Y", ltime);
212 	}
213 	if (sz == 0)
214 		tbuf[0] = '\0';
215 	ulen = MAX(strlen(user), 8);
216 	glen = MAX(strlen(group), 8);
217 	if (si_units) {
218 		fmt_scaled((long long)st->st_size, sbuf);
219 		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8s %s %s", mode,
220 		    (u_int)st->st_nlink, ulen, user, glen, group,
221 		    sbuf, tbuf, name);
222 	} else {
223 		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8llu %s %s", mode,
224 		    (u_int)st->st_nlink, ulen, user, glen, group,
225 		    (unsigned long long)st->st_size, tbuf, name);
226 	}
227 	return xstrdup(buf);
228 }
229