sunrpc/clnt_perr.c

   1 /*
   2  * clnt_perror.c
   3  *
   4  * Copyright (C) 1984, Sun Microsystems, Inc.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above
  13  *       copyright notice, this list of conditions and the following
  14  *       disclaimer in the documentation and/or other materials
  15  *       provided with the distribution.
  16  *     * Neither the name of Sun Microsystems, Inc. nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  *   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  27  *   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  29  *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  30  *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 #include <stdio.h>
  34 #include <string.h>
  35 #include <libintl.h>
  36 #include <rpc/rpc.h>
  37
  38 #ifdef USE_IN_LIBIO
  39 # include <wchar.h>
  40 # include <libio/iolibio.h>
  41 #endif
  42
  43 static char *auth_errmsg (enum auth_stat stat) internal_function;
  44
  45 #ifdef _RPC_THREAD_SAFE_
  46 /*
  47  * Making buf a preprocessor macro requires renaming the local
  48  * buf variable in a few functions.  Overriding a global variable
  49  * with a local variable of the same name is a bad idea, anyway.
  50  */
  51 #define buf RPC_THREAD_VARIABLE(clnt_perr_buf_s)
  52 #else
  53 static char *buf;
  54 #endif
  55
  56 /*
  57  * Print reply error info
  58  */
  59 char *
  60 clnt_sperror (CLIENT * rpch, const char *msg)
  61 {
  62   struct rpc_err e;
  63   CLNT_GETERR (rpch, &e);
  64
  65   const char *errstr = clnt_sperrno (e.re_status);
  66
  67   char chrbuf[1024];
  68   char *str;
  69   char *tmpstr;
  70   int res;
  71   switch (e.re_status)
  72     {
  73     case RPC_SUCCESS:
  74     case RPC_CANTENCODEARGS:
  75     case RPC_CANTDECODERES:
  76     case RPC_TIMEDOUT:
  77     case RPC_PROGUNAVAIL:
  78     case RPC_PROCUNAVAIL:
  79     case RPC_CANTDECODEARGS:
  80     case RPC_SYSTEMERROR:
  81     case RPC_UNKNOWNHOST:
  82     case RPC_UNKNOWNPROTO:
  83     case RPC_PMAPFAILURE:
  84     case RPC_PROGNOTREGISTERED:
  85     case RPC_FAILED:
  86       res = __asprintf (&str, "%s: %s\n", msg, errstr);
  87       break;
  88
  89     case RPC_CANTSEND:
  90     case RPC_CANTRECV:
  91       res = __asprintf (&str, "%s: %s; errno = %s\n",
  92                         msg, errstr, __strerror_r (e.re_errno,
  93                                                    chrbuf, sizeof chrbuf));
  94       break;
  95
  96     case RPC_VERSMISMATCH:
  97       res = __asprintf (&str,
  98                         _("%s: %s; low version = %lu, high version = %lu"),
  99                         msg, errstr, e.re_vers.low, e.re_vers.high);
 100       break;
 101
 102     case RPC_AUTHERROR:
 103       tmpstr = auth_errmsg (e.re_why);
 104       if (tmpstr != NULL)
 105         res = __asprintf (&str, _("%s: %s; why = %s\n"), msg, errstr, tmpstr);
 106       else
 107         res = __asprintf (&str, _("\
 108 %s: %s; why = (unknown authentication error - %d)\n"),
 109                           msg, errstr, (int) e.re_why);
 110       break;
 111
 112     case RPC_PROGVERSMISMATCH:
 113       res = __asprintf (&str,
 114                         _("%s: %s; low version = %lu, high version = %lu"),
 115                         msg, errstr, e.re_vers.low, e.re_vers.high);
 116       break;
 117
 118     default:                    /* unknown */
 119       res = __asprintf (&str, "%s: %s; s1 = %lu, s2 = %lu",
 120                         msg, errstr, e.re_lb.s1, e.re_lb.s2);
 121       break;
 122     }
 123
 124   if (res < 0)
 125     return NULL;
 126
 127   char *oldbuf = buf;
 128   buf = str;
 129   free (oldbuf);
 130
 131   return str;
 132 }
 133 libc_hidden_def (clnt_sperror)
 134
 135 void
 136 clnt_perror (CLIENT * rpch, const char *msg)
 137 {
 138   (void) __fxprintf (NULL, "%s", clnt_sperror (rpch, msg));
 139 }
 140 libc_hidden_def (clnt_perror)
 141
 142
 143 struct rpc_errtab
 144 {
 145   enum clnt_stat status;
 146   unsigned int message_off;
 147 };
 148
 149 static const char rpc_errstr[] =
 150 {
 151 #define RPC_SUCCESS_IDX         0
 152   N_("RPC: Success")
 153   "\0"
 154 #define RPC_CANTENCODEARGS_IDX  (RPC_SUCCESS_IDX + sizeof "RPC: Success")
 155   N_("RPC: Can't encode arguments")
 156   "\0"
 157 #define RPC_CANTDECODERES_IDX   (RPC_CANTENCODEARGS_IDX \
 158                                  + sizeof "RPC: Can't encode arguments")
 159   N_("RPC: Can't decode result")
 160   "\0"
 161 #define RPC_CANTSEND_IDX        (RPC_CANTDECODERES_IDX \
 162                                  + sizeof "RPC: Can't decode result")
 163   N_("RPC: Unable to send")
 164   "\0"
 165 #define RPC_CANTRECV_IDX        (RPC_CANTSEND_IDX \
 166                                  + sizeof "RPC: Unable to send")
 167   N_("RPC: Unable to receive")
 168   "\0"
 169 #define RPC_TIMEDOUT_IDX        (RPC_CANTRECV_IDX \
 170                                  + sizeof "RPC: Unable to receive")
 171   N_("RPC: Timed out")
 172   "\0"
 173 #define RPC_VERSMISMATCH_IDX    (RPC_TIMEDOUT_IDX \
 174                                  + sizeof "RPC: Timed out")
 175   N_("RPC: Incompatible versions of RPC")
 176   "\0"
 177 #define RPC_AUTHERROR_IDX       (RPC_VERSMISMATCH_IDX \
 178                                  + sizeof "RPC: Incompatible versions of RPC")
 179   N_("RPC: Authentication error")
 180   "\0"
 181 #define RPC_PROGUNAVAIL_IDX             (RPC_AUTHERROR_IDX \
 182                                  + sizeof "RPC: Authentication error")
 183   N_("RPC: Program unavailable")
 184   "\0"
 185 #define RPC_PROGVERSMISMATCH_IDX (RPC_PROGUNAVAIL_IDX \
 186                                   + sizeof "RPC: Program unavailable")
 187   N_("RPC: Program/version mismatch")
 188   "\0"
 189 #define RPC_PROCUNAVAIL_IDX     (RPC_PROGVERSMISMATCH_IDX \
 190                                  + sizeof "RPC: Program/version mismatch")
 191   N_("RPC: Procedure unavailable")
 192   "\0"
 193 #define RPC_CANTDECODEARGS_IDX  (RPC_PROCUNAVAIL_IDX \
 194                                  + sizeof "RPC: Procedure unavailable")
 195   N_("RPC: Server can't decode arguments")
 196   "\0"
 197 #define RPC_SYSTEMERROR_IDX     (RPC_CANTDECODEARGS_IDX \
 198                                  + sizeof "RPC: Server can't decode arguments")
 199   N_("RPC: Remote system error")
 200   "\0"
 201 #define RPC_UNKNOWNHOST_IDX     (RPC_SYSTEMERROR_IDX \
 202                                  + sizeof "RPC: Remote system error")
 203   N_("RPC: Unknown host")
 204   "\0"
 205 #define RPC_UNKNOWNPROTO_IDX    (RPC_UNKNOWNHOST_IDX \
 206                                  + sizeof "RPC: Unknown host")
 207   N_("RPC: Unknown protocol")
 208   "\0"
 209 #define RPC_PMAPFAILURE_IDX     (RPC_UNKNOWNPROTO_IDX \
 210                                  + sizeof "RPC: Unknown protocol")
 211   N_("RPC: Port mapper failure")
 212   "\0"
 213 #define RPC_PROGNOTREGISTERED_IDX (RPC_PMAPFAILURE_IDX \
 214                                    + sizeof "RPC: Port mapper failure")
 215   N_("RPC: Program not registered")
 216   "\0"
 217 #define RPC_FAILED_IDX          (RPC_PROGNOTREGISTERED_IDX \
 218                                  + sizeof "RPC: Program not registered")
 219   N_("RPC: Failed (unspecified error)")
 220 };
 221
 222 static const struct rpc_errtab rpc_errlist[] =
 223 {
 224   { RPC_SUCCESS, RPC_SUCCESS_IDX },
 225   { RPC_CANTENCODEARGS, RPC_CANTENCODEARGS_IDX },
 226   { RPC_CANTDECODERES, RPC_CANTDECODERES_IDX },
 227   { RPC_CANTSEND, RPC_CANTSEND_IDX },
 228   { RPC_CANTRECV, RPC_CANTRECV_IDX },
 229   { RPC_TIMEDOUT, RPC_TIMEDOUT_IDX },
 230   { RPC_VERSMISMATCH, RPC_VERSMISMATCH_IDX },
 231   { RPC_AUTHERROR, RPC_AUTHERROR_IDX },
 232   { RPC_PROGUNAVAIL, RPC_PROGUNAVAIL_IDX },
 233   { RPC_PROGVERSMISMATCH, RPC_PROGVERSMISMATCH_IDX },
 234   { RPC_PROCUNAVAIL, RPC_PROCUNAVAIL_IDX },
 235   { RPC_CANTDECODEARGS, RPC_CANTDECODEARGS_IDX },
 236   { RPC_SYSTEMERROR, RPC_SYSTEMERROR_IDX },
 237   { RPC_UNKNOWNHOST, RPC_UNKNOWNHOST_IDX },
 238   { RPC_UNKNOWNPROTO, RPC_UNKNOWNPROTO_IDX },
 239   { RPC_PMAPFAILURE, RPC_PMAPFAILURE_IDX },
 240   { RPC_PROGNOTREGISTERED, RPC_PROGNOTREGISTERED_IDX },
 241   { RPC_FAILED, RPC_FAILED_IDX }
 242 };
 243
 244
 245 /*
 246  * This interface for use by clntrpc
 247  */
 248 char *
 249 clnt_sperrno (enum clnt_stat stat)
 250 {
 251   size_t i;
 252
 253   for (i = 0; i < sizeof (rpc_errlist) / sizeof (struct rpc_errtab); i++)
 254     {
 255       if (rpc_errlist[i].status == stat)
 256         {
 257           return _(rpc_errstr + rpc_errlist[i].message_off);
 258         }
 259     }
 260   return _("RPC: (unknown error code)");
 261 }
 262 libc_hidden_def (clnt_sperrno)
 263
 264 void
 265 clnt_perrno (enum clnt_stat num)
 266 {
 267   (void) __fxprintf (NULL, "%s", clnt_sperrno (num));
 268 }
 269
 270
 271 char *
 272 clnt_spcreateerror (const char *msg)
 273 {
 274   struct rpc_createerr *ce = &get_rpc_createerr ();
 275
 276   char chrbuf[1024];
 277   const char *connector = "";
 278   const char *errstr = "";
 279   switch (ce->cf_stat)
 280     {
 281     case RPC_PMAPFAILURE:
 282       connector = " - ";
 283       errstr = clnt_sperrno (ce->cf_error.re_status);
 284       break;
 285
 286     case RPC_SYSTEMERROR:
 287       connector = " - ";
 288       errstr = __strerror_r (ce->cf_error.re_errno, chrbuf, sizeof chrbuf);
 289       break;
 290
 291     default:
 292       break;
 293     }
 294
 295   char *str;
 296   if (__asprintf (&str, "%s: %s%s%s\n",
 297                   msg, clnt_sperrno (ce->cf_stat), connector, errstr) < 0)
 298     return NULL;
 299
 300   char *oldbuf = buf;
 301   buf = str;
 302   free (oldbuf);
 303
 304   return str;
 305 }
 306 libc_hidden_def (clnt_spcreateerror)
 307
 308 void
 309 clnt_pcreateerror (const char *msg)
 310 {
 311   (void) __fxprintf (NULL, "%s", clnt_spcreateerror (msg));
 312 }
 313
 314 struct auth_errtab
 315 {
 316   enum auth_stat status;
 317   unsigned int message_off;
 318 };
 319
 320 static const char auth_errstr[] =
 321 {
 322 #define AUTH_OK_IDX             0
 323    N_("Authentication OK")
 324    "\0"
 325 #define AUTH_BADCRED_IDX        (AUTH_OK_IDX + sizeof "Authentication OK")
 326    N_("Invalid client credential")
 327    "\0"
 328 #define AUTH_REJECTEDCRED_IDX   (AUTH_BADCRED_IDX \
 329                                  + sizeof "Invalid client credential")
 330    N_("Server rejected credential")
 331    "\0"
 332 #define AUTH_BADVERF_IDX        (AUTH_REJECTEDCRED_IDX \
 333                                  + sizeof "Server rejected credential")
 334    N_("Invalid client verifier")
 335    "\0"
 336 #define AUTH_REJECTEDVERF_IDX   (AUTH_BADVERF_IDX \
 337                                  + sizeof "Invalid client verifier")
 338    N_("Server rejected verifier")
 339    "\0"
 340 #define AUTH_TOOWEAK_IDX        (AUTH_REJECTEDVERF_IDX \
 341                                  + sizeof "Server rejected verifier")
 342    N_("Client credential too weak")
 343    "\0"
 344 #define AUTH_INVALIDRESP_IDX    (AUTH_TOOWEAK_IDX \
 345                                  + sizeof "Client credential too weak")
 346    N_("Invalid server verifier")
 347    "\0"
 348 #define AUTH_FAILED_IDX         (AUTH_INVALIDRESP_IDX \
 349                                  + sizeof "Invalid server verifier")
 350    N_("Failed (unspecified error)")
 351 };
 352
 353 static const struct auth_errtab auth_errlist[] =
 354 {
 355   { AUTH_OK, AUTH_OK_IDX },
 356   { AUTH_BADCRED, AUTH_BADCRED_IDX },
 357   { AUTH_REJECTEDCRED, AUTH_REJECTEDCRED_IDX },
 358   { AUTH_BADVERF, AUTH_BADVERF_IDX },
 359   { AUTH_REJECTEDVERF, AUTH_REJECTEDVERF_IDX },
 360   { AUTH_TOOWEAK, AUTH_TOOWEAK_IDX },
 361   { AUTH_INVALIDRESP, AUTH_INVALIDRESP_IDX },
 362   { AUTH_FAILED, AUTH_FAILED_IDX }
 363 };
 364
 365 static char *
 366 internal_function
 367 auth_errmsg (enum auth_stat stat)
 368 {
 369   size_t i;
 370
 371   for (i = 0; i < sizeof (auth_errlist) / sizeof (struct auth_errtab); i++)
 372     {
 373       if (auth_errlist[i].status == stat)
 374         {
 375           return _(auth_errstr + auth_errlist[i].message_off);
 376         }
 377     }
 378   return NULL;
 379 }
 380
 381
 382 libc_freeres_fn (free_mem)
 383 {
 384   /* Not libc_freeres_ptr, since buf is a macro.  */
 385   free (buf);
 386 }