crypto/openssh/sftp-common.c

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