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