[openssh.git] / sftp-common.c

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