[openssh.git] / sftp-common.c

/* $OpenBSD: sftp-common.c,v 1.23 2010/01/15 09:24:23 markus Exp $ */
/*
 * Copyright (c) 2001 Markus Friedl.  All rights reserved.
 * Copyright (c) 2001 Damien Miller.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "includes.h"

#include <sys/types.h>
#include <sys/stat.h>
#include <sys/param.h>

#include <grp.h>
#include <pwd.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#include <stdarg.h>
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

#include "xmalloc.h"
#include "buffer.h"
#include "log.h"

#include "sftp.h"
#include "sftp-common.h"

/* Clear contents of attributes structure */
void
attrib_clear(Attrib *a)
{
	a->flags = 0;
	a->size = 0;
	a->uid = 0;
	a->gid = 0;
	a->perm = 0;
	a->atime = 0;
	a->mtime = 0;
}

/* Convert from struct stat to filexfer attribs */
void
stat_to_attrib(const struct stat *st, Attrib *a)
{
	attrib_clear(a);
	a->flags = 0;
	a->flags |= SSH2_FILEXFER_ATTR_SIZE;
	a->size = st->st_size;
	a->flags |= SSH2_FILEXFER_ATTR_UIDGID;
	a->uid = st->st_uid;
	a->gid = st->st_gid;
	a->flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
	a->perm = st->st_mode;
	a->flags |= SSH2_FILEXFER_ATTR_ACMODTIME;
	a->atime = st->st_atime;
	a->mtime = st->st_mtime;
}

/* Convert from filexfer attribs to struct stat */
void
attrib_to_stat(const Attrib *a, struct stat *st)
{
	memset(st, 0, sizeof(*st));

	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
		st->st_size = a->size;
	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
		st->st_uid = a->uid;
		st->st_gid = a->gid;
	}
	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
		st->st_mode = a->perm;
	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
		st->st_atime = a->atime;
		st->st_mtime = a->mtime;
	}
}

/* Decode attributes in buffer */
Attrib *
decode_attrib(Buffer *b)
{
	static Attrib a;

	attrib_clear(&a);
	a.flags = buffer_get_int(b);
	if (a.flags & SSH2_FILEXFER_ATTR_SIZE)
		a.size = buffer_get_int64(b);
	if (a.flags & SSH2_FILEXFER_ATTR_UIDGID) {
		a.uid = buffer_get_int(b);
		a.gid = buffer_get_int(b);
	}
	if (a.flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
		a.perm = buffer_get_int(b);
	if (a.flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
		a.atime = buffer_get_int(b);
		a.mtime = buffer_get_int(b);
	}
	/* vendor-specific extensions */
	if (a.flags & SSH2_FILEXFER_ATTR_EXTENDED) {
		char *type, *data;
		int i, count;

		count = buffer_get_int(b);
		for (i = 0; i < count; i++) {
			type = buffer_get_string(b, NULL);
			data = buffer_get_string(b, NULL);
			debug3("Got file attribute \"%s\"", type);
			xfree(type);
			xfree(data);
		}
	}
	return &a;
}

/* Encode attributes to buffer */
void
encode_attrib(Buffer *b, const Attrib *a)
{
	buffer_put_int(b, a->flags);
	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
		buffer_put_int64(b, a->size);
	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
		buffer_put_int(b, a->uid);
		buffer_put_int(b, a->gid);
	}
	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
		buffer_put_int(b, a->perm);
	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
		buffer_put_int(b, a->atime);
		buffer_put_int(b, a->mtime);
	}
}

/* Convert from SSH2_FX_ status to text error message */
const char *
fx2txt(int status)
{
	switch (status) {
	case SSH2_FX_OK:
		return("No error");
	case SSH2_FX_EOF:
		return("End of file");
	case SSH2_FX_NO_SUCH_FILE:
		return("No such file or directory");
	case SSH2_FX_PERMISSION_DENIED:
		return("Permission denied");
	case SSH2_FX_FAILURE:
		return("Failure");
	case SSH2_FX_BAD_MESSAGE:
		return("Bad message");
	case SSH2_FX_NO_CONNECTION:
		return("No connection");
	case SSH2_FX_CONNECTION_LOST:
		return("Connection lost");
	case SSH2_FX_OP_UNSUPPORTED:
		return("Operation unsupported");
	default:
		return("Unknown status");
	}
	/* NOTREACHED */
}

/*
 * drwxr-xr-x    5 markus   markus       1024 Jan 13 18:39 .ssh
 */
char *
ls_file(const char *name, const struct stat *st, int remote, int si_units)
{
	int ulen, glen, sz = 0;
	struct tm *ltime = localtime(&st->st_mtime);
	char *user, *group;
	char buf[1024], mode[11+1], tbuf[12+1], ubuf[11+1], gbuf[11+1];
	char sbuf[FMT_SCALED_STRSIZE];

	strmode(st->st_mode, mode);
	if (!remote) {
		user = user_from_uid(st->st_uid, 0);
	} else {
		snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
		user = ubuf;
	}
	if (!remote) {
		group = group_from_gid(st->st_gid, 0);
	} else {
		snprintf(gbuf, sizeof gbuf, "%u", (u_int)st->st_gid);
		group = gbuf;
	}
	if (ltime != NULL) {
		if (time(NULL) - st->st_mtime < (365*24*60*60)/2)
			sz = strftime(tbuf, sizeof tbuf, "%b %e %H:%M", ltime);
		else
			sz = strftime(tbuf, sizeof tbuf, "%b %e  %Y", ltime);
	}
	if (sz == 0)
		tbuf[0] = '\0';
	ulen = MAX(strlen(user), 8);
	glen = MAX(strlen(group), 8);
	if (si_units) {
		fmt_scaled((long long)st->st_size, sbuf);
		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8s %s %s", mode,
		    (u_int)st->st_nlink, ulen, user, glen, group,
		    sbuf, tbuf, name);
	} else {
		snprintf(buf, sizeof buf, "%s %3u %-*s %-*s %8llu %s %s", mode,
		    (u_int)st->st_nlink, ulen, user, glen, group,
		    (unsigned long long)st->st_size, tbuf, name);
	}
	return xstrdup(buf);
}
Commit	Line	Data
e5271db2	1	/* $OpenBSD: sftp-common.c,v 1.23 2010/01/15 09:24:23 markus Exp $ */
61e96248	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"
4095f623	28
	29	#include <sys/types.h>
	30	#include <sys/stat.h>
536c14e8	31	#include <sys/param.h>
61e96248	32
16fbe330	33	#include <grp.h>
b1842393	34	#include <pwd.h>
cf851879	35	#include <stdio.h>
00146caa	36	#include <string.h>
b0f6943a	37	#include <time.h>
31652869	38	#include <stdarg.h>
c1e654ec	39	#ifdef HAVE_UTIL_H
29793ade	40	#include <util.h>
c1e654ec	41	#endif
16fbe330	42
31652869	43	#include "xmalloc.h"
61e96248	44	#include "buffer.h"
61e96248	45	#include "log.h"
61e96248	46
	47	#include "sftp.h"
	48	#include "sftp-common.h"
	49
255cabd9	50	/* Clear contents of attributes structure */
61e96248	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
255cabd9	63	/* Convert from struct stat to filexfer attribs */
61e96248	64	void
b6c7b7b7	65	stat_to_attrib(const struct stat st, Attrib a)
61e96248	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
00b3ad3e	81	/* Convert from filexfer attribs to struct stat */
00b3ad3e	82	void
b6c7b7b7	83	attrib_to_stat(const Attrib a, struct stat st)
00b3ad3e	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
255cabd9	101	/* Decode attributes in buffer */
61e96248	102	Attrib *
	103	decode_attrib(Buffer *b)
	104	{
	105	static Attrib a;
9906a836	106
61e96248	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;
9906a836	125
61e96248	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
255cabd9	138	/* Encode attributes to buffer */
61e96248	139	void
b6c7b7b7	140	encode_attrib(Buffer b, const Attrib a)
61e96248	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
255cabd9	157	/* Convert from SSH2_FX_ status to text error message */
61e96248	158	const char *
	159	fx2txt(int status)
	160	{
	161	switch (status) {
	162	case SSH2_FX_OK:
0426a3b4	163	return("No error");
61e96248	164	case SSH2_FX_EOF:
0426a3b4	165	return("End of file");
61e96248	166	case SSH2_FX_NO_SUCH_FILE:
0426a3b4	167	return("No such file or directory");
61e96248	168	case SSH2_FX_PERMISSION_DENIED:
0426a3b4	169	return("Permission denied");
61e96248	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");
947b64c7	182	}
61e96248	183	/* NOTREACHED */
61e96248	184	}
00b3ad3e	185
	186	/*
	187	* drwxr-xr-x 5 markus markus 1024 Jan 13 18:39 .ssh
	188	*/
	189	char *
29793ade	190	ls_file(const char name, const struct stat st, int remote, int si_units)
00b3ad3e	191	{
00b3ad3e	192	int ulen, glen, sz = 0;
00b3ad3e	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];
29793ade	196	char sbuf[FMT_SCALED_STRSIZE];
00b3ad3e	197
00b3ad3e	198	strmode(st->st_mode, mode);
6d588777	199	if (!remote) {
6d588777	200	user = user_from_uid(st->st_uid, 0);
00b3ad3e	201	} else {
	202	snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
	203	user = ubuf;
	204	}
6d588777	205	if (!remote) {
6d588777	206	group = group_from_gid(st->st_gid, 0);
00b3ad3e	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 < (3652460*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);
29793ade	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	}
00b3ad3e	231	return xstrdup(buf);
00b3ad3e	232	}