[openssh.git] / sftp-common.c

/* $OpenBSD: sftp-common.c,v 1.17 2006/07/22 20:48:23 stevesk 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 <grp.h>
#include <pwd.h>
#include <string.h>
#include <time.h>

#include "buffer.h"
#include "bufaux.h"
#include "log.h"
#include "xmalloc.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 ulen, glen, sz = 0;
	struct passwd *pw;
	struct group *gr;
	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];

	strmode(st->st_mode, mode);
	if (!remote && (pw = getpwuid(st->st_uid)) != NULL) {
		user = pw->pw_name;
	} else {
		snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
		user = ubuf;
	}
	if (!remote && (gr = getgrgid(st->st_gid)) != NULL) {
		group = gr->gr_name;
	} 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);
	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
00146caa	1	/* $OpenBSD: sftp-common.c,v 1.17 2006/07/22 20:48:23 stevesk 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>
61e96248	31
16fbe330	32	#include <grp.h>
b1842393	33	#include <pwd.h>
00146caa	34	#include <string.h>
b0f6943a	35	#include <time.h>
16fbe330	36
61e96248	37	#include "buffer.h"
61e96248	38	#include "bufaux.h"
61e96248	39	#include "log.h"
	40	#include "xmalloc.h"
	41
	42	#include "sftp.h"
	43	#include "sftp-common.h"
	44
255cabd9	45	/* Clear contents of attributes structure */
61e96248	46	void
	47	attrib_clear(Attrib *a)
	48	{
	49	a->flags = 0;
	50	a->size = 0;
	51	a->uid = 0;
	52	a->gid = 0;
	53	a->perm = 0;
	54	a->atime = 0;
	55	a->mtime = 0;
	56	}
	57
255cabd9	58	/* Convert from struct stat to filexfer attribs */
61e96248	59	void
b6c7b7b7	60	stat_to_attrib(const struct stat st, Attrib a)
61e96248	61	{
	62	attrib_clear(a);
	63	a->flags = 0;
	64	a->flags \|= SSH2_FILEXFER_ATTR_SIZE;
	65	a->size = st->st_size;
	66	a->flags \|= SSH2_FILEXFER_ATTR_UIDGID;
	67	a->uid = st->st_uid;
	68	a->gid = st->st_gid;
	69	a->flags \|= SSH2_FILEXFER_ATTR_PERMISSIONS;
	70	a->perm = st->st_mode;
	71	a->flags \|= SSH2_FILEXFER_ATTR_ACMODTIME;
	72	a->atime = st->st_atime;
	73	a->mtime = st->st_mtime;
	74	}
	75
00b3ad3e	76	/* Convert from filexfer attribs to struct stat */
00b3ad3e	77	void
b6c7b7b7	78	attrib_to_stat(const Attrib a, struct stat st)
00b3ad3e	79	{
	80	memset(st, 0, sizeof(*st));
	81
	82	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
	83	st->st_size = a->size;
	84	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
	85	st->st_uid = a->uid;
	86	st->st_gid = a->gid;
	87	}
	88	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
	89	st->st_mode = a->perm;
	90	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
	91	st->st_atime = a->atime;
	92	st->st_mtime = a->mtime;
	93	}
	94	}
	95
255cabd9	96	/* Decode attributes in buffer */
61e96248	97	Attrib *
	98	decode_attrib(Buffer *b)
	99	{
	100	static Attrib a;
9906a836	101
61e96248	102	attrib_clear(&a);
	103	a.flags = buffer_get_int(b);
	104	if (a.flags & SSH2_FILEXFER_ATTR_SIZE)
	105	a.size = buffer_get_int64(b);
	106	if (a.flags & SSH2_FILEXFER_ATTR_UIDGID) {
	107	a.uid = buffer_get_int(b);
	108	a.gid = buffer_get_int(b);
	109	}
	110	if (a.flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
	111	a.perm = buffer_get_int(b);
	112	if (a.flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
	113	a.atime = buffer_get_int(b);
	114	a.mtime = buffer_get_int(b);
	115	}
	116	/* vendor-specific extensions */
	117	if (a.flags & SSH2_FILEXFER_ATTR_EXTENDED) {
	118	char type, data;
	119	int i, count;
9906a836	120
61e96248	121	count = buffer_get_int(b);
	122	for (i = 0; i < count; i++) {
	123	type = buffer_get_string(b, NULL);
	124	data = buffer_get_string(b, NULL);
	125	debug3("Got file attribute \"%s\"", type);
	126	xfree(type);
	127	xfree(data);
	128	}
	129	}
	130	return &a;
	131	}
	132
255cabd9	133	/* Encode attributes to buffer */
61e96248	134	void
b6c7b7b7	135	encode_attrib(Buffer b, const Attrib a)
61e96248	136	{
	137	buffer_put_int(b, a->flags);
	138	if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
	139	buffer_put_int64(b, a->size);
	140	if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
	141	buffer_put_int(b, a->uid);
	142	buffer_put_int(b, a->gid);
	143	}
	144	if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
	145	buffer_put_int(b, a->perm);
	146	if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
	147	buffer_put_int(b, a->atime);
	148	buffer_put_int(b, a->mtime);
	149	}
	150	}
	151
255cabd9	152	/* Convert from SSH2_FX_ status to text error message */
61e96248	153	const char *
	154	fx2txt(int status)
	155	{
	156	switch (status) {
	157	case SSH2_FX_OK:
0426a3b4	158	return("No error");
61e96248	159	case SSH2_FX_EOF:
0426a3b4	160	return("End of file");
61e96248	161	case SSH2_FX_NO_SUCH_FILE:
0426a3b4	162	return("No such file or directory");
61e96248	163	case SSH2_FX_PERMISSION_DENIED:
0426a3b4	164	return("Permission denied");
61e96248	165	case SSH2_FX_FAILURE:
	166	return("Failure");
	167	case SSH2_FX_BAD_MESSAGE:
	168	return("Bad message");
	169	case SSH2_FX_NO_CONNECTION:
	170	return("No connection");
	171	case SSH2_FX_CONNECTION_LOST:
	172	return("Connection lost");
	173	case SSH2_FX_OP_UNSUPPORTED:
	174	return("Operation unsupported");
	175	default:
	176	return("Unknown status");
947b64c7	177	}
61e96248	178	/* NOTREACHED */
61e96248	179	}
00b3ad3e	180
	181	/*
	182	* drwxr-xr-x 5 markus markus 1024 Jan 13 18:39 .ssh
	183	*/
	184	char *
b6c7b7b7	185	ls_file(const char name, const struct stat st, int remote)
00b3ad3e	186	{
	187	int ulen, glen, sz = 0;
	188	struct passwd *pw;
	189	struct group *gr;
	190	struct tm *ltime = localtime(&st->st_mtime);
	191	char user, group;
	192	char buf[1024], mode[11+1], tbuf[12+1], ubuf[11+1], gbuf[11+1];
	193
	194	strmode(st->st_mode, mode);
	195	if (!remote && (pw = getpwuid(st->st_uid)) != NULL) {
	196	user = pw->pw_name;
	197	} else {
	198	snprintf(ubuf, sizeof ubuf, "%u", (u_int)st->st_uid);
	199	user = ubuf;
	200	}
	201	if (!remote && (gr = getgrgid(st->st_gid)) != NULL) {
	202	group = gr->gr_name;
	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 < (3652460*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);
b9ed513a	217	snprintf(buf, sizeof buf, "%s %3u %-s %-s %8llu %s %s", mode,
b9ed513a	218	(u_int)st->st_nlink, ulen, user, glen, group,
c9826b28	219	(unsigned long long)st->st_size, tbuf, name);
00b3ad3e	220	return xstrdup(buf);
00b3ad3e	221	}