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 <libintl.h>
  43 #include <rpc/rpc.h>
  44
  45 #ifdef USE_IN_LIBIO
  46 # include <libio/iolibio.h>
  47 # define fputs(s, f) _IO_fputs (s, f)
  48 #endif
  49
  50 static char *auth_errmsg (enum auth_stat stat) internal_function;
  51
  52 #ifdef _RPC_THREAD_SAFE_
  53 /*
  54  * Making buf a preprocessor macro requires renaming the local
  55  * buf variable in a few functions.  Overriding a global variable
  56  * with a local variable of the same name is a bad idea, anyway.
  57  */
  58 #define buf ((char *)RPC_THREAD_VARIABLE(clnt_perr_buf_s))
  59 #else
  60 static char *buf;
  61 #endif
  62
  63 static char *
  64 _buf (void)
  65 {
  66   if (buf == NULL)
  67     buf = (char *) malloc (256);
  68   return buf;
  69 }
  70
  71 /*
  72  * Print reply error info
  73  */
  74 char *
  75 clnt_sperror (CLIENT * rpch, const char *msg)
  76 {
  77   char chrbuf[1024];
  78   struct rpc_err e;
  79   char *err;
  80   char *str = _buf ();
  81   char *strstart = str;
  82   int len;
  83
  84   if (str == NULL)
  85     return NULL;
  86   CLNT_GETERR (rpch, &e);
  87
  88   len = sprintf (str, "%s: ", msg);
  89   str += len;
  90
  91   str = stpcpy (str, clnt_sperrno (e.re_status));
  92
  93   switch (e.re_status)
  94     {
  95     case RPC_SUCCESS:
  96     case RPC_CANTENCODEARGS:
  97     case RPC_CANTDECODERES:
  98     case RPC_TIMEDOUT:
  99     case RPC_PROGUNAVAIL:
 100     case RPC_PROCUNAVAIL:
 101     case RPC_CANTDECODEARGS:
 102     case RPC_SYSTEMERROR:
 103     case RPC_UNKNOWNHOST:
 104     case RPC_UNKNOWNPROTO:
 105     case RPC_PMAPFAILURE:
 106     case RPC_PROGNOTREGISTERED:
 107     case RPC_FAILED:
 108       break;
 109
 110     case RPC_CANTSEND:
 111     case RPC_CANTRECV:
 112       len = sprintf (str, "; errno = %s", __strerror_r (e.re_errno,
 113                                                         chrbuf, sizeof chrbuf));
 114       str += len;
 115       break;
 116
 117     case RPC_VERSMISMATCH:
 118       len= sprintf (str, _("; low version = %lu, high version = %lu"),
 119                     e.re_vers.low, e.re_vers.high);
 120       str += len;
 121       break;
 122
 123     case RPC_AUTHERROR:
 124       err = auth_errmsg (e.re_why);
 125       str = stpcpy (str, _ ("; why = "));
 126       if (err != NULL)
 127         {
 128           str = stpcpy (str, err);
 129         }
 130       else
 131         {
 132           len = sprintf (str, _("(unknown authentication error - %d)"),
 133                          (int) e.re_why);
 134           str += len;
 135         }
 136       break;
 137
 138     case RPC_PROGVERSMISMATCH:
 139       len = sprintf (str, _("; low version = %lu, high version = %lu"),
 140                      e.re_vers.low, e.re_vers.high);
 141       str += len;
 142       break;
 143
 144     default:                    /* unknown */
 145       len = sprintf (str, "; s1 = %lu, s2 = %lu", e.re_lb.s1, e.re_lb.s2);
 146       str += len;
 147       break;
 148     }
 149   *str = '\n';
 150   *++str = '\0';
 151   return (strstart);
 152 }
 153
 154 void
 155 clnt_perror (CLIENT * rpch, const char *msg)
 156 {
 157   (void) fputs (clnt_sperror (rpch, msg), stderr);
 158 }
 159
 160
 161 struct rpc_errtab
 162 {
 163   enum clnt_stat status;
 164   unsigned int message_off;
 165 };
 166
 167 static const char rpc_errstr[] =
 168 {
 169 #define RPC_SUCCESS_IDX         0
 170   N_("RPC: Success")
 171   "\0"
 172 #define RPC_CANTENCODEARGS_IDX  (RPC_SUCCESS_IDX + sizeof "RPC: Success")
 173   N_("RPC: Can't encode arguments")
 174   "\0"
 175 #define RPC_CANTDECODERES_IDX   (RPC_CANTENCODEARGS_IDX \
 176                                  + sizeof "RPC: Can't encode arguments")
 177   N_("RPC: Can't decode result")
 178   "\0"
 179 #define RPC_CANTSEND_IDX        (RPC_CANTDECODERES_IDX \
 180                                  + sizeof "RPC: Can't decode result")
 181   N_("RPC: Unable to send")
 182   "\0"
 183 #define RPC_CANTRECV_IDX        (RPC_CANTSEND_IDX \
 184                                  + sizeof "RPC: Unable to send")
 185   N_("RPC: Unable to receive")
 186   "\0"
 187 #define RPC_TIMEDOUT_IDX        (RPC_CANTRECV_IDX \
 188                                  + sizeof "RPC: Unable to receive")
 189   N_("RPC: Timed out")
 190   "\0"
 191 #define RPC_VERSMISMATCH_IDX    (RPC_TIMEDOUT_IDX \
 192                                  + sizeof "RPC: Timed out")
 193   N_("RPC: Incompatible versions of RPC")
 194   "\0"
 195 #define RPC_AUTHERROR_IDX       (RPC_VERSMISMATCH_IDX \
 196                                  + sizeof "RPC: Incompatible versions of RPC")
 197   N_("RPC: Authentication error")
 198   "\0"
 199 #define RPC_PROGUNAVAIL_IDX             (RPC_AUTHERROR_IDX \
 200                                  + sizeof "RPC: Authentication error")
 201   N_("RPC: Program unavailable")
 202   "\0"
 203 #define RPC_PROGVERSMISMATCH_IDX (RPC_PROGUNAVAIL_IDX \
 204                                   + sizeof "RPC: Program unavailable")
 205   N_("RPC: Program/version mismatch")
 206   "\0"
 207 #define RPC_PROCUNAVAIL_IDX     (RPC_PROGVERSMISMATCH_IDX \
 208                                  + sizeof "RPC: Program/version mismatch")
 209   N_("RPC: Procedure unavailable")
 210   "\0"
 211 #define RPC_CANTDECODEARGS_IDX  (RPC_PROCUNAVAIL_IDX \
 212                                  + sizeof "RPC: Procedure unavailable")
 213   N_("RPC: Server can't decode arguments")
 214   "\0"
 215 #define RPC_SYSTEMERROR_IDX     (RPC_CANTDECODEARGS_IDX \
 216                                  + sizeof "RPC: Server can't decode arguments")
 217   N_("RPC: Remote system error")
 218   "\0"
 219 #define RPC_UNKNOWNHOST_IDX     (RPC_SYSTEMERROR_IDX \
 220                                  + sizeof "RPC: Remote system error")
 221   N_("RPC: Unknown host")
 222   "\0"
 223 #define RPC_UNKNOWNPROTO_IDX    (RPC_UNKNOWNHOST_IDX \
 224                                  + sizeof "RPC: Unknown host")
 225   N_("RPC: Unknown protocol")
 226   "\0"
 227 #define RPC_PMAPFAILURE_IDX     (RPC_UNKNOWNPROTO_IDX \
 228                                  + sizeof "RPC: Unknown protocol")
 229   N_("RPC: Port mapper failure")
 230   "\0"
 231 #define RPC_PROGNOTREGISTERED_IDX (RPC_PMAPFAILURE_IDX \
 232                                    + sizeof "RPC: Port mapper failure")
 233   N_("RPC: Program not registered")
 234   "\0"
 235 #define RPC_FAILED_IDX          (RPC_PROGNOTREGISTERED_IDX \
 236                                  + sizeof "RPC: Program not registered")
 237   N_("RPC: Failed (unspecified error)")
 238 };
 239
 240 static const struct rpc_errtab rpc_errlist[] =
 241 {
 242   { RPC_SUCCESS, RPC_SUCCESS_IDX },
 243   { RPC_CANTENCODEARGS, RPC_CANTENCODEARGS_IDX },
 244   { RPC_CANTDECODERES, RPC_CANTDECODERES_IDX },
 245   { RPC_CANTSEND, RPC_CANTSEND_IDX },
 246   { RPC_CANTRECV, RPC_CANTRECV_IDX },
 247   { RPC_TIMEDOUT, RPC_TIMEDOUT_IDX },
 248   { RPC_VERSMISMATCH, RPC_VERSMISMATCH_IDX },
 249   { RPC_AUTHERROR, RPC_AUTHERROR_IDX },
 250   { RPC_PROGUNAVAIL, RPC_PROGUNAVAIL_IDX },
 251   { RPC_PROGVERSMISMATCH, RPC_PROGVERSMISMATCH_IDX },
 252   { RPC_PROCUNAVAIL, RPC_PROCUNAVAIL_IDX },
 253   { RPC_CANTDECODEARGS, RPC_CANTDECODEARGS_IDX },
 254   { RPC_SYSTEMERROR, RPC_SYSTEMERROR_IDX },
 255   { RPC_UNKNOWNHOST, RPC_UNKNOWNHOST_IDX },
 256   { RPC_UNKNOWNPROTO, RPC_UNKNOWNPROTO_IDX },
 257   { RPC_PMAPFAILURE, RPC_PMAPFAILURE_IDX },
 258   { RPC_PROGNOTREGISTERED, RPC_PROGNOTREGISTERED_IDX },
 259   { RPC_FAILED, RPC_FAILED_IDX }
 260 };
 261
 262
 263 /*
 264  * This interface for use by clntrpc
 265  */
 266 char *
 267 clnt_sperrno (enum clnt_stat stat)
 268 {
 269   size_t i;
 270
 271   for (i = 0; i < sizeof (rpc_errlist) / sizeof (struct rpc_errtab); i++)
 272     {
 273       if (rpc_errlist[i].status == stat)
 274         {
 275           return _(rpc_errstr + rpc_errlist[i].message_off);
 276         }
 277     }
 278   return _("RPC: (unknown error code)");
 279 }
 280
 281 void
 282 clnt_perrno (enum clnt_stat num)
 283 {
 284   (void) fputs (clnt_sperrno (num), stderr);
 285 }
 286
 287
 288 char *
 289 clnt_spcreateerror (const char *msg)
 290 {
 291   char chrbuf[1024];
 292   char *str = _buf ();
 293   char *cp;
 294   int len;
 295   struct rpc_createerr *ce;
 296
 297   if (str == NULL)
 298     return NULL;
 299   ce = &get_rpc_createerr ();
 300   len = sprintf (str, "%s: ", msg);
 301   cp = str + len;
 302   cp = stpcpy (cp, clnt_sperrno (ce->cf_stat));
 303   switch (ce->cf_stat)
 304     {
 305     case RPC_PMAPFAILURE:
 306       cp = stpcpy (stpcpy (cp, " - "),
 307                    clnt_sperrno (ce->cf_error.re_status));
 308       break;
 309
 310     case RPC_SYSTEMERROR:
 311       cp = stpcpy (stpcpy (cp, " - "),
 312                    __strerror_r (ce->cf_error.re_errno,
 313                                  chrbuf, sizeof chrbuf));
 314       break;
 315     default:
 316       break;
 317     }
 318   *cp = '\n';
 319   *++cp = '\0';
 320   return str;
 321 }
 322
 323 void
 324 clnt_pcreateerror (const char *msg)
 325 {
 326   (void) fputs (clnt_spcreateerror (msg), stderr);
 327 }
 328
 329 struct auth_errtab
 330 {
 331   enum auth_stat status;
 332   unsigned int message_off;
 333 };
 334
 335 static const char auth_errstr[] =
 336 {
 337 #define AUTH_OK_IDX             0
 338    N_("Authentication OK")
 339    "\0"
 340 #define AUTH_BADCRED_IDX        (AUTH_OK_IDX + sizeof "Authentication OK")
 341    N_("Invalid client credential")
 342    "\0"
 343 #define AUTH_REJECTEDCRED_IDX   (AUTH_BADCRED_IDX \
 344                                  + sizeof "Invalid client credential")
 345    N_("Server rejected credential")
 346    "\0"
 347 #define AUTH_BADVERF_IDX        (AUTH_REJECTEDCRED_IDX \
 348                                  + sizeof "Server rejected credential")
 349    N_("Invalid client verifier")
 350    "\0"
 351 #define AUTH_REJECTEDVERF_IDX   (AUTH_BADVERF_IDX \
 352                                  + sizeof "Invalid client verifier")
 353    N_("Server rejected verifier")
 354    "\0"
 355 #define AUTH_TOOWEAK_IDX        (AUTH_REJECTEDVERF_IDX \
 356                                  + sizeof "Server rejected verifier")
 357    N_("Client credential too weak")
 358    "\0"
 359 #define AUTH_INVALIDRESP_IDX    (AUTH_TOOWEAK_IDX \
 360                                  + sizeof "Client credential too weak")
 361    N_("Invalid server verifier")
 362    "\0"
 363 #define AUTH_FAILED_IDX         (AUTH_INVALIDRESP_IDX \
 364                                  + sizeof "Invalid server verifier")
 365    N_("Failed (unspecified error)")
 366 };
 367
 368 static const struct auth_errtab auth_errlist[] =
 369 {
 370   { AUTH_OK, AUTH_OK_IDX },
 371   { AUTH_BADCRED, AUTH_BADCRED_IDX },
 372   { AUTH_REJECTEDCRED, AUTH_REJECTEDCRED_IDX },
 373   { AUTH_BADVERF, AUTH_BADVERF_IDX },
 374   { AUTH_REJECTEDVERF, AUTH_REJECTEDVERF_IDX },
 375   { AUTH_TOOWEAK, AUTH_TOOWEAK_IDX },
 376   { AUTH_INVALIDRESP, AUTH_INVALIDRESP_IDX },
 377   { AUTH_FAILED, AUTH_FAILED_IDX }
 378 };
 379
 380 static char *
 381 internal_function
 382 auth_errmsg (enum auth_stat stat)
 383 {
 384   size_t i;
 385
 386   for (i = 0; i < sizeof (auth_errlist) / sizeof (struct auth_errtab); i++)
 387     {
 388       if (auth_errlist[i].status == stat)
 389         {
 390           return _(auth_errstr + auth_errlist[i].message_off);
 391         }
 392     }
 393   return NULL;
 394 }
 395
 396
 397 static void __attribute__ ((unused))
 398 free_mem (void)
 399 {
 400   free (buf);
 401 }
 402 text_set_element (__libc_subfreeres, free_mem);