xref: /netbsd-src/crypto/external/bsd/openssh/dist/sftp-common.c (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /*	$NetBSD: sftp-common.c,v 1.5 2013/11/08 19:18:25 christos Exp $	*/
2 /* $OpenBSD: sftp-common.c,v 1.24 2013/05/17 00:13:14 djm Exp $ */
3 /*
4  * Copyright (c) 2001 Markus Friedl.  All rights reserved.
5  * Copyright (c) 2001 Damien Miller.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #include "includes.h"
29 __RCSID("$NetBSD: sftp-common.c,v 1.5 2013/11/08 19:18:25 christos Exp $");
30 #include <sys/types.h>
31 #include <sys/stat.h>
32 #include <sys/param.h>
33 
34 #include <grp.h>
35 #include <pwd.h>
36 #include <stdio.h>
37 #include <string.h>
38 #include <time.h>
39 #include <stdarg.h>
40 #include <unistd.h>
41 #include <util.h>
42 
43 #include "xmalloc.h"
44 #include "buffer.h"
45 #include "log.h"
46 
47 #include "sftp.h"
48 #include "sftp-common.h"
49 #include "fmt_scaled.h"
50 
51 /* Clear contents of attributes structure */
52 void
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
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
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 Attrib *
104 decode_attrib(Buffer *b)
105 {
106 	static Attrib a;
107 
108 	attrib_clear(&a);
109 	a.flags = buffer_get_int(b);
110 	if (a.flags & SSH2_FILEXFER_ATTR_SIZE)
111 		a.size = buffer_get_int64(b);
112 	if (a.flags & SSH2_FILEXFER_ATTR_UIDGID) {
113 		a.uid = buffer_get_int(b);
114 		a.gid = buffer_get_int(b);
115 	}
116 	if (a.flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
117 		a.perm = buffer_get_int(b);
118 	if (a.flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
119 		a.atime = buffer_get_int(b);
120 		a.mtime = buffer_get_int(b);
121 	}
122 	/* vendor-specific extensions */
123 	if (a.flags & SSH2_FILEXFER_ATTR_EXTENDED) {
124 		char *type, *data;
125 		int i, count;
126 
127 		count = buffer_get_int(b);
128 		for (i = 0; i < count; i++) {
129 			type = buffer_get_string(b, NULL);
130 			data = buffer_get_string(b, NULL);
131 			debug3("Got file attribute \"%s\"", type);
132 			free(type);
133 			free(data);
134 		}
135 	}
136 	return &a;
137 }
138 
139 /* Encode attributes to buffer */
140 void
141 encode_attrib(Buffer *b, const Attrib *a)
142 {
143 	buffer_put_int(b, a->flags);
144 	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
145 		buffer_put_int64(b, a->size);
146 	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
147 		buffer_put_int(b, a->uid);
148 		buffer_put_int(b, a->gid);
149 	}
150 	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
151 		buffer_put_int(b, a->perm);
152 	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
153 		buffer_put_int(b, a->atime);
154 		buffer_put_int(b, a->mtime);
155 	}
156 }
157 
158 /* Convert from SSH2_FX_ status to text error message */
159 const char *
160 fx2txt(int status)
161 {
162 	switch (status) {
163 	case SSH2_FX_OK:
164 		return("No error");
165 	case SSH2_FX_EOF:
166 		return("End of file");
167 	case SSH2_FX_NO_SUCH_FILE:
168 		return("No such file or directory");
169 	case SSH2_FX_PERMISSION_DENIED:
170 		return("Permission denied");
171 	case SSH2_FX_FAILURE:
172 		return("Failure");
173 	case SSH2_FX_BAD_MESSAGE:
174 		return("Bad message");
175 	case SSH2_FX_NO_CONNECTION:
176 		return("No connection");
177 	case SSH2_FX_CONNECTION_LOST:
178 		return("Connection lost");
179 	case SSH2_FX_OP_UNSUPPORTED:
180 		return("Operation unsupported");
181 	default:
182 		return("Unknown status");
183 	}
184 	/* NOTREACHED */
185 }
186 
187 /*
188  * drwxr-xr-x    5 markus   markus       1024 Jan 13 18:39 .ssh
189  */
190 char *
191 ls_file(const char *name, const struct stat *st, int remote, int si_units)
192 {
193 	int ulen, glen, sz = 0;
194 	struct tm *ltime = localtime(&st->st_mtime);
195 	const char *user, *group;
196 	char buf[1024], mode[11+1], tbuf[12+1], ubuf[11+1], gbuf[11+1];
197 	char sbuf[FMT_SCALED_STRSIZE];
198 
199 	strmode(st->st_mode, mode);
200 	if (!remote) {
201 		user = user_from_uid(st->st_uid, 0);
202 	} else {
203 		snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
204 		user = ubuf;
205 	}
206 	if (!remote) {
207 		group = group_from_gid(st->st_gid, 0);
208 	} else {
209 		snprintf(gbuf, sizeof gbuf, "%u", (u_int)st->st_gid);
210 		group = gbuf;
211 	}
212 	if (ltime != NULL) {
213 		if (time(NULL) - st->st_mtime < (365*24*60*60)/2)
214 			sz = strftime(tbuf, sizeof tbuf, "%b %e %H:%M", ltime);
215 		else
216 			sz = strftime(tbuf, sizeof tbuf, "%b %e  %Y", ltime);
217 	}
218 	if (sz == 0)
219 		tbuf[0] = '\0';
220 	ulen = MAX(strlen(user), 8);
221 	glen = MAX(strlen(group), 8);
222 	if (si_units) {
223 		fmt_scaled((long long)st->st_size, sbuf);
224 		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8s %s %s", mode,
225 		    (u_int)st->st_nlink, ulen, user, glen, group,
226 		    sbuf, tbuf, name);
227 	} else {
228 		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8llu %s %s", mode,
229 		    (u_int)st->st_nlink, ulen, user, glen, group,
230 		    (unsigned long long)st->st_size, tbuf, name);
231 	}
232 	return xstrdup(buf);
233 }
234