etc/afpd/status.c

   1 /*
   2  * $Id: status.c,v 1.13.6.5 2004-06-09 01:31:14 bfernhomberg Exp $
   3  *
   4  * Copyright (c) 1990,1993 Regents of The University of Michigan.
   5  * All Rights Reserved.  See COPYRIGHT.
   6  */
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include "config.h"
  10 #endif /* HAVE_CONFIG_H */
  11
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <unistd.h>
  15 #include <string.h>
  16 #include <sys/types.h>
  17 #include <atalk/logger.h>
  18
  19 #ifdef BSD4_4
  20 #include <sys/param.h>
  21 #ifndef USE_GETHOSTID
  22 #include <sys/sysctl.h>
  23 #endif /* USE_GETHOSTID */
  24 #endif /* BSD4_4 */
  25
  26 #include <netatalk/at.h>
  27 #include <netatalk/endian.h>
  28 #include <atalk/dsi.h>
  29 #include <atalk/atp.h>
  30 #include <atalk/asp.h>
  31 #include <atalk/nbp.h>
  32 #include <atalk/unicode.h>
  33
  34 #include "globals.h"  /* includes <netdb.h> */
  35 #include "status.h"
  36 #include "afp_config.h"
  37 #include "icon.h"
  38
  39 static   int maxstatuslen = 0;
  40
  41 static void status_flags(char *data, const int notif, const int ipok,
  42                          const unsigned char passwdbits, const int dirsrvcs)
  43 {
  44     u_int16_t           status;
  45
  46     status = AFPSRVRINFO_COPY;
  47     if (passwdbits & PASSWD_SET) /* some uams may not allow this. */
  48         status |= AFPSRVRINFO_PASSWD;
  49     if (passwdbits & PASSWD_NOSAVE)
  50         status |= AFPSRVRINFO_NOSAVEPASSWD;
  51     status |= AFPSRVRINFO_SRVSIGNATURE;
  52     /* only advertise tcp/ip if we have a valid address */
  53     if (ipok)
  54         status |= AFPSRVRINFO_TCPIP;
  55     status |= AFPSRVRINFO_SRVMSGS;
  56     /* Allow the user to decide if we should support server notifications.
  57      * With this turned off, the clients will poll for directory changes every
  58      * 10 seconds.  This might be too costly to network resources, so make
  59      * this an optional thing.  Default will be to _not_ support server
  60      * notifications. */
  61     if (notif) {
  62         status |= AFPSRVRINFO_SRVNOTIFY;
  63     }
  64     status |= AFPSRVRINFO_FASTBOZO;
  65     status |= AFPSRVRINFO_SRVRDIR; /* AFP 3.1 specs says we need to specify this, but may set the count to 0 */
  66     /* We don't set the UTF8 name flag here, we don't know whether we have enough space ... */
  67
  68     status = htons(status);
  69     memcpy(data + AFPSTATUS_FLAGOFF, &status, sizeof(status));
  70 }
  71
  72 static int status_server(char *data, const char *server, const struct afp_options *options)
  73 {
  74     char                *start = data;
  75     char                *Obj, *Type, *Zone;
  76     char                buf[32];
  77     u_int16_t           status;
  78     size_t              len;
  79
  80     /* make room for all offsets before server name */
  81     data += AFPSTATUS_PRELEN;
  82
  83     /* extract the obj part of the server */
  84     Obj = (char *) server;
  85     nbp_name(server, &Obj, &Type, &Zone);
  86     if ((size_t)-1 == (len = convert_string(
  87                         options->unixcharset, options->maccharset,
  88                         Obj, strlen(Obj), buf, 31)) ) {
  89         len = MIN(strlen(Obj), 31);
  90         *data++ = len;
  91         memcpy( data, Obj, len );
  92         LOG ( log_error, logtype_afpd, "Could not set servername, using fallback");
  93     } else {
  94         *data++ = len;
  95         memcpy( data, buf, len );
  96     }
  97     if ((len + 1) & 1) /* pad server name and length byte to even boundary */
  98         len++;
  99     data += len;
 100
 101     /* make room for signature and net address offset. save location of
 102      * signature offset. we're also making room for directory names offset
 103      * and the utf-8 server name offset.
 104      *
 105      * NOTE: technically, we don't need to reserve space for the
 106      * signature and net address offsets if they're not going to be
 107      * used. as there are no offsets after them, it doesn't hurt to
 108      * have them specified though. so, we just do that to simplify
 109      * things.
 110      *
 111      * NOTE2: AFP3.1 Documentation states that the directory names offset
 112      * is a required feature, even though it can be set to zero.
 113      */
 114     len = data - start;
 115     status = htons(len + AFPSTATUS_POSTLEN);
 116     memcpy(start + AFPSTATUS_MACHOFF, &status, sizeof(status));
 117     return len; /* return the offset to beginning of signature offset */
 118 }
 119
 120 static void status_machine(char *data)
 121 {
 122     char                *start = data;
 123     u_int16_t           status;
 124     int                 len;
 125 #ifdef AFS
 126     const char          *machine = "afs";
 127 #else /* !AFS */
 128     const char          *machine = "Macintosh"; /* shot in the dark, let's see if this changes OSX behaviour, it shouldn't */
 129 #endif /* AFS */
 130
 131     memcpy(&status, start + AFPSTATUS_MACHOFF, sizeof(status));
 132     data += ntohs( status );
 133     len = strlen( machine );
 134     *data++ = len;
 135     memcpy( data, machine, len );
 136     data += len;
 137     status = htons(data - start);
 138     memcpy(start + AFPSTATUS_VERSOFF, &status, sizeof(status));
 139 }
 140
 141 /* --------------------------------
 142  * it turns out that a server signature screws up separate
 143  * servers running on the same machine. to work around that,
 144  * i add in an increment.
 145  * Not great, server signature are config dependent but well.
 146  */
 147
 148 static int           Id = 0;
 149
 150 /* server signature is a 16-byte quantity */
 151 static u_int16_t status_signature(char *data, int *servoffset, DSI *dsi,
 152                                   const struct afp_options *options)
 153 {
 154     char                 *status;
 155     char                 *usersign;
 156     int                  i;
 157     u_int16_t            offset, sigoff;
 158     long                 hostid;
 159 #ifdef BSD4_4
 160     int                  mib[2];
 161     size_t               len;
 162 #endif /* BSD4_4 */
 163
 164     status = data;
 165
 166     /* get server signature offset */
 167     memcpy(&offset, data + *servoffset, sizeof(offset));
 168     sigoff = offset = ntohs(offset);
 169
 170     /* jump to server signature offset */
 171     data += offset;
 172
 173     /* Signature type is user string */
 174     if (strncmp(options->signature, "user", 4) == 0) {
 175         if (strlen(options->signature) <= 5) {
 176             LOG(log_warning, logtype_afpd, "Signature %s id not valid. Switching back to hostid.",
 177                             options->signature);
 178             goto server_signature_hostid;
 179     }
 180     usersign = options->signature + 5;
 181         if (strlen(usersign) < 3)
 182             LOG(log_warning, logtype_afpd, "Signature %s is very short !",
 183                             options->signature);
 184
 185         memset(data, 0, 16);
 186         strncpy(data, usersign, 16);
 187         data += 16;
 188         goto server_signature_done;
 189     } /* signature = user */
 190
 191     /* If signature type is a standard hostid... */
 192 server_signature_hostid:
 193     /* 16-byte signature consists of copies of the hostid */
 194 #if defined(BSD4_4) && defined(USE_GETHOSTID)
 195     mib[0] = CTL_KERN;
 196     mib[1] = KERN_HOSTID;
 197     len = sizeof(hostid);
 198     sysctl(mib, 2, &hostid, &len, NULL, 0);
 199 #else /* BSD4_4 && USE_GETHOSTID */
 200     hostid = gethostid();
 201 #endif /* BSD4_4 && USE_GETHOSTID */
 202     if (!hostid) {
 203         if (dsi)
 204             hostid = dsi->server.sin_addr.s_addr;
 205         else {
 206             struct hostent *host;
 207
 208             if ((host = gethostbyname(options->hostname)))
 209                 hostid = ((struct in_addr *) host->h_addr)->s_addr;
 210         }
 211     }
 212
 213     /* it turns out that a server signature screws up separate
 214      * servers running on the same machine. to work around that,
 215      * i add in an increment */
 216     hostid += Id;
 217     Id++;
 218     for (i = 0; i < 16; i += sizeof(hostid)) {
 219         memcpy(data, &hostid, sizeof(hostid));
 220         data += sizeof(hostid);
 221      }
 222
 223 server_signature_done:
 224     /* calculate net address offset */
 225     *servoffset += sizeof(offset);
 226     offset = htons(data - status);
 227     memcpy(status + *servoffset, &offset, sizeof(offset));
 228     return sigoff;
 229 }
 230
 231 static int status_netaddress(char *data, int *servoffset,
 232                              const ASP asp, const DSI *dsi,
 233                              const char *fqdn)
 234 {
 235     char               *begin;
 236     u_int16_t          offset;
 237
 238     begin = data;
 239
 240     /* get net address offset */
 241     memcpy(&offset, data + *servoffset, sizeof(offset));
 242     data += ntohs(offset);
 243
 244     /* format:
 245        Address count (byte)
 246        len (byte = sizeof(length + address type + address)
 247        address type (byte, ip address = 0x01, ip + port = 0x02,
 248                            ddp address = 0x03, fqdn = 0x04)
 249        address (up to 254 bytes, ip = 4, ip + port = 6, ddp = 4)
 250        */
 251
 252     /* number of addresses. this currently screws up if we have a dsi
 253        connection, but we don't have the ip address. to get around this,
 254        we turn off the status flag for tcp/ip. */
 255     *data++ = ((fqdn && dsi)? 1 : 0) + (dsi ? 1 : 0) + (asp ? 1 : 0);
 256
 257     /* ip address */
 258     if (dsi) {
 259         const struct sockaddr_in *inaddr = &dsi->server;
 260
 261         if (inaddr->sin_port == htons(DSI_AFPOVERTCP_PORT)) {
 262             *data++ = 6; /* length */
 263             *data++ = 0x01; /* basic ip address */
 264             memcpy(data, &inaddr->sin_addr.s_addr,
 265                    sizeof(inaddr->sin_addr.s_addr));
 266             data += sizeof(inaddr->sin_addr.s_addr);
 267         } else {
 268             /* ip address + port */
 269             *data++ = 8;
 270             *data++ = 0x02; /* ip address with port */
 271             memcpy(data, &inaddr->sin_addr.s_addr,
 272                    sizeof(inaddr->sin_addr.s_addr));
 273             data += sizeof(inaddr->sin_addr.s_addr);
 274             memcpy(data, &inaddr->sin_port, sizeof(inaddr->sin_port));
 275             data += sizeof(inaddr->sin_port);
 276         }
 277     }
 278
 279     /* handle DNS names */
 280     if (fqdn && dsi) {
 281         int len = strlen(fqdn);
 282         *data++ = len +2;
 283         *data++ = 0x04;
 284         memcpy(data, fqdn, len);
 285         data += len;
 286     }
 287
 288 #ifndef NO_DDP
 289     if (asp) {
 290         const struct sockaddr_at *ddpaddr = atp_sockaddr(asp->asp_atp);
 291
 292         /* ddp address */
 293         *data++ = 6;
 294         *data++ = 0x03; /* ddp address */
 295         memcpy(data, &ddpaddr->sat_addr.s_net, sizeof(ddpaddr->sat_addr.s_net));
 296         data += sizeof(ddpaddr->sat_addr.s_net);
 297         memcpy(data, &ddpaddr->sat_addr.s_node,
 298                sizeof(ddpaddr->sat_addr.s_node));
 299         data += sizeof(ddpaddr->sat_addr.s_node);
 300         memcpy(data, &ddpaddr->sat_port, sizeof(ddpaddr->sat_port));
 301         data += sizeof(ddpaddr->sat_port);
 302     }
 303 #endif /* ! NO_DDP */
 304
 305     /* calculate/store Directory Services Names offset */
 306     offset = htons(data - begin);
 307     *servoffset += sizeof(offset);
 308     memcpy(begin + *servoffset, &offset, sizeof(offset));
 309
 310     /* return length of buffer */
 311     return (data - begin);
 312 }
 313
 314 static int status_directorynames(char *data, int *diroffset,
 315                                  const DSI *dsi,
 316                                  const struct afp_options *options)
 317 {
 318     char *begin = data;
 319     u_int16_t offset;
 320     memcpy(&offset, data + *diroffset, sizeof(offset));
 321     offset = ntohs(offset);
 322     data += offset;
 323
 324     /* I can not find documentation of any other purpose for the
 325      * DirectoryNames field.
 326      */
 327     /*
 328      * Try to synthesize a principal:
 329      * service '/' fqdn '@' realm
 330      */
 331     if (options->k5service && options->k5realm && options->fqdn) {
 332         /* should k5princ be utf8 encoded? */
 333         u_int8_t len;
 334         char *p = strchr( options->fqdn, ':' );
 335         if (p)
 336             *p = '\0';
 337         len = strlen( options->k5service )
 338                         + strlen( options->fqdn )
 339                         + strlen( options->k5realm );
 340         len+=2; /* '/' and '@' */
 341         if ( len+2 > maxstatuslen - offset) {
 342             *data++ = 0;
 343         }
 344         else {
 345             *data++ = 1; /* DirectoryNamesCount */
 346             *data++ = len;
 347             snprintf( data, len + 1, "%s/%s@%s", options->k5service,
 348                                 options->fqdn, options->k5realm );
 349             data += len;
 350             if (p)
 351                 *p = ':';
 352        }
 353     } else {
 354         *data++ = 0;
 355     }
 356
 357     /* Calculate and store offset for UTF8ServerName */
 358     *diroffset += sizeof(u_int16_t);
 359     offset = htons(data - begin);
 360     memcpy(begin + *diroffset, &offset, sizeof(u_int16_t));
 361
 362     /* return length of buffer */
 363     return (data - begin);
 364 }
 365
 366 static int status_utf8servername(char *data, int *nameoffset,
 367                                  const DSI *dsi,
 368                                  const struct afp_options *options)
 369 {
 370     char *Obj, *Type, *Zone;
 371     u_int16_t namelen;
 372     size_t len;
 373     char *begin = data;
 374     u_int16_t offset, status;
 375
 376     memcpy(&offset, data + *nameoffset, sizeof(offset));
 377     offset = ntohs(offset);
 378     data += offset;
 379
 380     /* FIXME:
 381      * What is the valid character range for an nbpname?
 382      *
 383      * Apple's server likes to use the non-qualified hostname
 384      * This obviously won't work very well if multiple servers are running
 385      * on the box.
 386      */
 387
 388     /* extract the obj part of the server */
 389     Obj = (char *) (options->server ? options->server : options->hostname);
 390     nbp_name(options->server ? options->server : options->hostname, &Obj, &Type, &Zone);
 391
 392     if ((size_t) -1 == (len = convert_string (
 393                                         options->unixcharset, CH_UTF8_MAC,
 394                                         Obj, strlen(Obj), data+sizeof(namelen), maxstatuslen-offset )) ) {
 395         LOG ( log_error, logtype_afpd, "Could not set utf8 servername");
 396
 397         /* set offset to 0 */
 398         memset(begin + *nameoffset, 0, sizeof(offset));
 399     }
 400     else {
 401         namelen = htons(len);
 402         memcpy( data, &namelen, sizeof(namelen));
 403         data += sizeof(namelen);
 404         data += len;
 405         offset = htons(offset);
 406         memcpy(begin + *nameoffset, &offset, sizeof(u_int16_t));
 407
 408         /* Now set the flag ... */
 409         memcpy(&status, begin + AFPSTATUS_FLAGOFF, sizeof(status));
 410         status = ntohs(status);
 411         status |= AFPSRVRINFO_SRVUTF8;
 412         status = htons(status);
 413         memcpy(begin + AFPSTATUS_FLAGOFF, &status, sizeof(status));
 414     }
 415
 416     /* return length of buffer */
 417     return (data - begin);
 418
 419 }
 420
 421 /* returns actual offset to signature */
 422 static void status_icon(char *data, const unsigned char *icondata,
 423                         const int iconlen, const int sigoffset)
 424 {
 425     char                *start = data;
 426     char                *sigdata = data + sigoffset;
 427     u_int16_t           ret, status;
 428
 429     memcpy(&status, start + AFPSTATUS_ICONOFF, sizeof(status));
 430     if ( icondata == NULL ) {
 431         ret = status;
 432         memset(start + AFPSTATUS_ICONOFF, 0, sizeof(status));
 433     } else {
 434         data += ntohs( status );
 435         memcpy( data, icondata, iconlen);
 436         data += iconlen;
 437         ret = htons(data - start);
 438     }
 439
 440     /* put in signature offset */
 441     if (sigoffset)
 442         memcpy(sigdata, &ret, sizeof(ret));
 443 }
 444
 445 /* ---------------------
 446 */
 447 void status_reset()
 448 {
 449     Id = 0;
 450 }
 451
 452 /* ---------------------
 453 */
 454 void status_init(AFPConfig *aspconfig, AFPConfig *dsiconfig,
 455                  const struct afp_options *options)
 456 {
 457     ASP asp;
 458     DSI *dsi;
 459     char *status = NULL;
 460     int statuslen, c, sigoff;
 461
 462     if (!(aspconfig || dsiconfig) || !options)
 463         return;
 464
 465     if (aspconfig) {
 466         asp = aspconfig->obj.handle;
 467         status = aspconfig->status;
 468         maxstatuslen=sizeof(aspconfig->status);
 469     } else
 470         asp = NULL;
 471
 472     if (dsiconfig) {
 473         dsi = dsiconfig->obj.handle;
 474         if (!aspconfig)
 475             status = dsiconfig->status;
 476             maxstatuslen=sizeof(dsiconfig->status);
 477     } else
 478         dsi = NULL;
 479
 480     /*
 481      * These routines must be called in order -- earlier calls
 482      * set the offsets for later calls.
 483      *
 484      * using structs is a bad idea, but that's what the original code
 485      * does. solaris, in fact, will segfault with them. so, now
 486      * we just use the powers of #defines and memcpy.
 487      *
 488      * reply block layout (offsets are 16-bit quantities):
 489      * machine type offset -> AFP version count offset ->
 490      * UAM count offset -> vol icon/mask offset -> flags ->
 491      *
 492      * server name [padded to even boundary] -> signature offset ->
 493      * network address offset ->
 494      *
 495      * at the appropriate offsets:
 496      * machine type, afp versions, uams, server signature
 497      * (16-bytes), network addresses, volume icon/mask
 498      */
 499
 500     status_flags(status, options->server_notif, options->fqdn ||
 501                  (dsiconfig && dsi->server.sin_addr.s_addr),
 502                  options->passwdbits,
 503                  (options->k5service && options->k5realm && options->fqdn));
 504     /* returns offset to signature offset */
 505     c = status_server(status, options->server ? options->server :
 506                       options->hostname, options);
 507     status_machine(status);
 508     status_versions(status);
 509     status_uams(status, options->uamlist);
 510     if (options->flags & OPTION_CUSTOMICON)
 511         status_icon(status, icon, sizeof(icon), c);
 512     else
 513         status_icon(status, apple_atalk_icon, sizeof(apple_atalk_icon), c);
 514
 515     sigoff = status_signature(status, &c, dsi, options);
 516     /* c now contains the offset where the netaddress offset lives */
 517
 518     status_netaddress(status, &c, asp, dsi, options->fqdn);
 519     /* c now contains the offset where the Directory Names Count offset lives */
 520
 521     statuslen = status_directorynames(status, &c, dsi, options);
 522     /* c now contains the offset where the UTF-8 ServerName offset lives */
 523
 524     if ( statuslen < maxstatuslen)
 525         statuslen = status_utf8servername(status, &c, dsi, options);
 526
 527 #ifndef NO_DDP
 528     if (aspconfig) {
 529         asp_setstatus(asp, status, statuslen);
 530         aspconfig->signature = status + sigoff;
 531         aspconfig->statuslen = statuslen;
 532     }
 533 #endif /* ! NO_DDP */
 534
 535     if (dsiconfig) {
 536         if (aspconfig) { /* copy to dsiconfig */
 537             memcpy(dsiconfig->status, status, ATP_MAXDATA);
 538             status = dsiconfig->status;
 539         }
 540
 541         if ((options->flags & OPTION_CUSTOMICON) == 0) {
 542             status_icon(status, apple_tcp_icon, sizeof(apple_tcp_icon), 0);
 543         }
 544         dsi_setstatus(dsi, status, statuslen);
 545         dsiconfig->signature = status + sigoff;
 546         dsiconfig->statuslen = statuslen;
 547     }
 548 }
 549
 550 /* this is the same as asp/dsi_getstatus */
 551 int afp_getsrvrinfo(obj, ibuf, ibuflen, rbuf, rbuflen )
 552 AFPObj      *obj;
 553 char    *ibuf, *rbuf;
 554 int             ibuflen, *rbuflen;
 555 {
 556     AFPConfig *config = obj->config;
 557
 558     memcpy(rbuf, config->status, config->statuslen);
 559     *rbuflen = config->statuslen;
 560     return AFP_OK;
 561 }