sunrpc/clnt_perr.c

   1 /* @(#)clnt_perror.c    2.1 88/07/29 4.0 RPCSRC */
   2 /*
   3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   4  * unrestricted use provided that this legend is included on all tape
   5  * media and as a part of the software program in whole or part.  Users
   6  * may copy or modify Sun RPC without charge, but are not authorized
   7  * to license or distribute it to anyone else except as part of a product or
   8  * program developed by the user.
   9  *
  10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13  *
  14  * Sun RPC is provided with no support and without any obligation on the
  15  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16  * modification or enhancement.
  17  *
  18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20  * OR ANY PART THEREOF.
  21  *
  22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23  * or profits or other special, indirect and consequential damages, even if
  24  * Sun has been advised of the possibility of such damages.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30 #if !defined(lint) && defined(SCCSIDS)
  31 static char sccsid[] = "@(#)clnt_perror.c 1.15 87/10/07 Copyr 1984 Sun Micro";
  32 #endif
  33
  34 /*
  35  * clnt_perror.c
  36  *
  37  * Copyright (C) 1984, Sun Microsystems, Inc.
  38  *
  39  */
  40 #include <stdio.h>
  41 #include <string.h>
  42 #include <rpc/types.h>
  43 #include <rpc/auth.h>
  44 #include <rpc/clnt.h>
  45
  46 #ifdef USE_IN_LIBIO
  47 # include <libio/iolibio.h>
  48 # define fputs(s, f) _IO_fputs (s, f)
  49 #endif
  50
  51 static char *auth_errmsg (enum auth_stat stat) internal_function;
  52
  53 static char *buf;
  54
  55 static char *
  56 _buf (void)
  57 {
  58   if (buf == NULL)
  59     buf = (char *) malloc (256);
  60   return buf;
  61 }
  62
  63 /*
  64  * Print reply error info
  65  */
  66 char *
  67 clnt_sperror (CLIENT * rpch, const char *msg)
  68 {
  69   char buf[1024];
  70   struct rpc_err e;
  71   char *err;
  72   char *str = _buf ();
  73   char *strstart = str;
  74   int len;
  75
  76   if (str == NULL)
  77     return NULL;
  78   CLNT_GETERR (rpch, &e);
  79
  80   len = sprintf (str, "%s: ", msg);
  81   str += len;
  82
  83   str = stpcpy (str, clnt_sperrno (e.re_status));
  84
  85   switch (e.re_status)
  86     {
  87     case RPC_SUCCESS:
  88     case RPC_CANTENCODEARGS:
  89     case RPC_CANTDECODERES:
  90     case RPC_TIMEDOUT:
  91     case RPC_PROGUNAVAIL:
  92     case RPC_PROCUNAVAIL:
  93     case RPC_CANTDECODEARGS:
  94     case RPC_SYSTEMERROR:
  95     case RPC_UNKNOWNHOST:
  96     case RPC_UNKNOWNPROTO:
  97     case RPC_PMAPFAILURE:
  98     case RPC_PROGNOTREGISTERED:
  99     case RPC_FAILED:
 100       break;
 101
 102     case RPC_CANTSEND:
 103     case RPC_CANTRECV:
 104       len = sprintf (str, "; errno = %s", __strerror_r (e.re_errno,
 105                                                         buf, sizeof buf));
 106       str += len;
 107       break;
 108
 109     case RPC_VERSMISMATCH:
 110       len= sprintf (str, _("; low version = %lu, high version = %lu"),
 111                     e.re_vers.low, e.re_vers.high);
 112       str += len;
 113       break;
 114
 115     case RPC_AUTHERROR:
 116       err = auth_errmsg (e.re_why);
 117       str = stpcpy (str, _ ("; why = "));
 118       if (err != NULL)
 119         {
 120           str = stpcpy (str, err);
 121         }
 122       else
 123         {
 124           len = sprintf (str, _("(unknown authentication error - %d)"),
 125                          (int) e.re_why);
 126           str += len;
 127         }
 128       break;
 129
 130     case RPC_PROGVERSMISMATCH:
 131       len = sprintf (str, _("; low version = %lu, high version = %lu"),
 132                      e.re_vers.low, e.re_vers.high);
 133       str += len;
 134       break;
 135
 136     default:                    /* unknown */
 137       len = sprintf (str, "; s1 = %lu, s2 = %lu", e.re_lb.s1, e.re_lb.s2);
 138       str += len;
 139       break;
 140     }
 141   *str = '\n';
 142   *++str = '\0';
 143   return (strstart);
 144 }
 145
 146 void
 147 clnt_perror (CLIENT * rpch, const char *msg)
 148 {
 149   (void) fputs (clnt_sperror (rpch, msg), stderr);
 150 }
 151
 152
 153 struct rpc_errtab
 154 {
 155   enum clnt_stat status;
 156   unsigned int message_off;
 157 };
 158
 159 static const char rpc_errstr[] =
 160 {
 161 #define RPC_SUCCESS_IDX         0
 162   N_("RPC: Success")
 163   "\0"
 164 #define RPC_CANTENCODEARGS_IDX  (RPC_SUCCESS_IDX + sizeof "RPC: Success")
 165   N_("RPC: Can't encode arguments")
 166   "\0"
 167 #define RPC_CANTDECODERES_IDX   (RPC_CANTENCODEARGS_IDX \
 168                                  + sizeof "RPC: Can't encode arguments")
 169   N_("RPC: Can't decode result")
 170   "\0"
 171 #define RPC_CANTSEND_IDX        (RPC_CANTDECODERES_IDX \
 172                                  + sizeof "RPC: Can't decode result")
 173   N_("RPC: Unable to send")
 174   "\0"
 175 #define RPC_CANTRECV_IDX        (RPC_CANTSEND_IDX \
 176                                  + sizeof "RPC: Unable to send")
 177   N_("RPC: Unable to receive")
 178   "\0"
 179 #define RPC_TIMEDOUT_IDX        (RPC_CANTRECV_IDX \
 180                                  + sizeof "RPC: Unable to receive")
 181   N_("RPC: Timed out")
 182   "\0"
 183 #define RPC_VERSMISMATCH_IDX    (RPC_TIMEDOUT_IDX \
 184                                  + sizeof "RPC: Timed out")
 185   N_("RPC: Incompatible versions of RPC")
 186   "\0"
 187 #define RPC_AUTHERROR_IDX       (RPC_VERSMISMATCH_IDX \
 188                                  + sizeof "RPC: Incompatible versions of RPC")
 189   N_("RPC: Authentication error")
 190   "\0"
 191 #define RPC_PROGUNAVAIL_IDX             (RPC_AUTHERROR_IDX \
 192                                  + sizeof "RPC: Authentication error")
 193   N_("RPC: Program unavailable")
 194   "\0"
 195 #define RPC_PROGVERSMISMATCH_IDX (RPC_PROGUNAVAIL_IDX \
 196                                   + sizeof "RPC: Program unavailable")
 197   N_("RPC: Program/version mismatch")
 198   "\0"
 199 #define RPC_PROCUNAVAIL_IDX     (RPC_PROGVERSMISMATCH_IDX \
 200                                  + sizeof "RPC: Program/version mismatch")
 201   N_("RPC: Procedure unavailable")
 202   "\0"
 203 #define RPC_CANTDECODEARGS_IDX  (RPC_PROCUNAVAIL_IDX \
 204                                  + sizeof "RPC: Procedure unavailable")
 205   N_("RPC: Server can't decode arguments")
 206   "\0"
 207 #define RPC_SYSTEMERROR_IDX     (RPC_CANTDECODEARGS_IDX \
 208                                  + sizeof "RPC: Server can't decode arguments")
 209   N_("RPC: Remote system error")
 210   "\0"
 211 #define RPC_UNKNOWNHOST_IDX     (RPC_SYSTEMERROR_IDX \
 212                                  + sizeof "RPC: Remote system error")
 213   N_("RPC: Unknown host")
 214   "\0"
 215 #define RPC_UNKNOWNPROTO_IDX    (RPC_UNKNOWNHOST_IDX \
 216                                  + sizeof "RPC: Unknown host")
 217   N_("RPC: Unknown protocol")
 218   "\0"
 219 #define RPC_PMAPFAILURE_IDX     (RPC_UNKNOWNPROTO_IDX \
 220                                  + sizeof "RPC: Unknown protocol")
 221   N_("RPC: Port mapper failure")
 222   "\0"
 223 #define RPC_PROGNOTREGISTERED_IDX (RPC_PMAPFAILURE_IDX \
 224                                    + sizeof "RPC: Port mapper failure")
 225   N_("RPC: Program not registered")
 226   "\0"
 227 #define RPC_FAILED_IDX          (RPC_PROGNOTREGISTERED_IDX \
 228                                  + sizeof "RPC: Program not registered")
 229   N_("RPC: Failed (unspecified error)")
 230 };
 231
 232 static const struct rpc_errtab rpc_errlist[] =
 233 {
 234   { RPC_SUCCESS, RPC_SUCCESS_IDX },
 235   { RPC_CANTENCODEARGS, RPC_CANTENCODEARGS_IDX },
 236   { RPC_CANTDECODERES, RPC_CANTDECODERES_IDX },
 237   { RPC_CANTSEND, RPC_CANTSEND_IDX },
 238   { RPC_CANTRECV, RPC_CANTRECV_IDX },
 239   { RPC_TIMEDOUT, RPC_TIMEDOUT_IDX },
 240   { RPC_VERSMISMATCH, RPC_VERSMISMATCH_IDX },
 241   { RPC_AUTHERROR, RPC_AUTHERROR_IDX },
 242   { RPC_PROGUNAVAIL, RPC_PROGUNAVAIL_IDX },
 243   { RPC_PROGVERSMISMATCH, RPC_PROGVERSMISMATCH },
 244   { RPC_PROCUNAVAIL, RPC_PROCUNAVAIL_IDX },
 245   { RPC_CANTDECODEARGS, RPC_CANTDECODEARGS_IDX },
 246   { RPC_SYSTEMERROR, RPC_SYSTEMERROR_IDX },
 247   { RPC_UNKNOWNHOST, RPC_UNKNOWNHOST_IDX },
 248   { RPC_UNKNOWNPROTO, RPC_UNKNOWNPROTO_IDX },
 249   { RPC_PMAPFAILURE, RPC_PMAPFAILURE_IDX },
 250   { RPC_PROGNOTREGISTERED, RPC_PROGNOTREGISTERED_IDX },
 251   { RPC_FAILED, RPC_FAILED_IDX }
 252 };
 253
 254
 255 /*
 256  * This interface for use by clntrpc
 257  */
 258 char *
 259 clnt_sperrno (enum clnt_stat stat)
 260 {
 261   size_t i;
 262
 263   for (i = 0; i < sizeof (rpc_errlist) / sizeof (struct rpc_errtab); i++)
 264     {
 265       if (rpc_errlist[i].status == stat)
 266         {
 267           return _(rpc_errstr + rpc_errlist[i].message_off);
 268         }
 269     }
 270   return _("RPC: (unknown error code)");
 271 }
 272
 273 void
 274 clnt_perrno (enum clnt_stat num)
 275 {
 276   (void) fputs (clnt_sperrno (num), stderr);
 277 }
 278
 279
 280 char *
 281 clnt_spcreateerror (const char *msg)
 282 {
 283   char buf[1024];
 284   char *str = _buf ();
 285   char *cp;
 286   int len;
 287
 288   if (str == NULL)
 289     return NULL;
 290   len = sprintf (str, "%s: ", msg);
 291   cp = str + len;
 292   cp = stpcpy (cp, clnt_sperrno (rpc_createerr.cf_stat));
 293   switch (rpc_createerr.cf_stat)
 294     {
 295     case RPC_PMAPFAILURE:
 296       cp = stpcpy (stpcpy (cp, " - "),
 297                    clnt_sperrno (rpc_createerr.cf_error.re_status));
 298       break;
 299
 300     case RPC_SYSTEMERROR:
 301       cp = stpcpy (stpcpy (cp, " - "),
 302                    __strerror_r (rpc_createerr.cf_error.re_errno,
 303                                  buf, sizeof buf));
 304       break;
 305     default:
 306       break;
 307     }
 308   *cp = '\n';
 309   *++cp = '\0';
 310   return str;
 311 }
 312
 313 void
 314 clnt_pcreateerror (const char *msg)
 315 {
 316   (void) fputs (clnt_spcreateerror (msg), stderr);
 317 }
 318
 319 struct auth_errtab
 320 {
 321   enum auth_stat status;
 322   unsigned int message_off;
 323 };
 324
 325 static const char auth_errstr[] =
 326 {
 327 #define AUTH_OK_IDX             0
 328    N_("Authentication OK")
 329    "\0"
 330 #define AUTH_BADCRED_IDX        (AUTH_OK_IDX + sizeof "Authentication OK")
 331    N_("Invalid client credential")
 332    "\0"
 333 #define AUTH_REJECTEDCRED_IDX   (AUTH_BADCRED_IDX \
 334                                  + sizeof "Invalid client credential")
 335    N_("Server rejected credential")
 336    "\0"
 337 #define AUTH_BADVERF_IDX        (AUTH_REJECTEDCRED_IDX \
 338                                  + sizeof "Server rejected credential")
 339    N_("Invalid client verifier")
 340    "\0"
 341 #define AUTH_REJECTEDVERF_IDX   (AUTH_BADVERF_IDX \
 342                                  + sizeof "Invalid client verifier")
 343    N_("Server rejected verifier")
 344    "\0"
 345 #define AUTH_TOOWEAK_IDX        (AUTH_REJECTEDVERF_IDX \
 346                                  + sizeof "Server rejected verifier")
 347    N_("Client credential too weak")
 348    "\0"
 349 #define AUTH_INVALIDRESP_IDX    (AUTH_TOOWEAK_IDX \
 350                                  + sizeof "Client credential too weak")
 351    N_("Invalid server verifier")
 352    "\0"
 353 #define AUTH_FAILED_IDX         (AUTH_INVALIDRESP_IDX \
 354                                  + sizeof "Invalid server verifier")
 355    N_("Failed (unspecified error)")
 356 };
 357
 358 static const struct auth_errtab auth_errlist[] =
 359 {
 360   { AUTH_OK, AUTH_OK_IDX },
 361   { AUTH_BADCRED, AUTH_BADCRED_IDX },
 362   { AUTH_REJECTEDCRED, AUTH_REJECTEDCRED_IDX },
 363   { AUTH_BADVERF, AUTH_BADVERF_IDX },
 364   { AUTH_REJECTEDVERF, AUTH_REJECTEDVERF_IDX },
 365   { AUTH_TOOWEAK, AUTH_TOOWEAK_IDX },
 366   { AUTH_INVALIDRESP, AUTH_INVALIDRESP_IDX },
 367   { AUTH_FAILED, AUTH_FAILED_IDX }
 368 };
 369
 370 static char *
 371 internal_function
 372 auth_errmsg (enum auth_stat stat)
 373 {
 374   size_t i;
 375
 376   for (i = 0; i < sizeof (auth_errlist) / sizeof (struct auth_errtab); i++)
 377     {
 378       if (auth_errlist[i].status == stat)
 379         {
 380           return _(auth_errstr + auth_errlist[i].message_off);
 381         }
 382     }
 383   return NULL;
 384 }