sunrpc/clnt_perr.c

   1 /*
   2  * clnt_perror.c
   3  *
   4  * Copyright (c) 2010, Oracle America, 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 the "Oracle America, 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_nolink (clnt_sperror, GLIBC_2_0)
 134
 135 void
 136 clnt_perror (CLIENT * rpch, const char *msg)
 137 {
 138   (void) __fxprintf (NULL, "%s", clnt_sperror (rpch, msg));
 139 }
 140 #ifdef EXPORT_RPC_SYMBOLS
 141 libc_hidden_def (clnt_perror)
 142 #else
 143 libc_hidden_nolink (clnt_perror, GLIBC_2_0)
 144 #endif
 145
 146
 147 struct rpc_errtab
 148 {
 149   enum clnt_stat status;
 150   unsigned int message_off;
 151 };
 152
 153 static const char rpc_errstr[] =
 154 {
 155 #define RPC_SUCCESS_IDX         0
 156   N_("RPC: Success")
 157   "\0"
 158 #define RPC_CANTENCODEARGS_IDX  (RPC_SUCCESS_IDX + sizeof "RPC: Success")
 159   N_("RPC: Can't encode arguments")
 160   "\0"
 161 #define RPC_CANTDECODERES_IDX   (RPC_CANTENCODEARGS_IDX \
 162                                  + sizeof "RPC: Can't encode arguments")
 163   N_("RPC: Can't decode result")
 164   "\0"
 165 #define RPC_CANTSEND_IDX        (RPC_CANTDECODERES_IDX \
 166                                  + sizeof "RPC: Can't decode result")
 167   N_("RPC: Unable to send")
 168   "\0"
 169 #define RPC_CANTRECV_IDX        (RPC_CANTSEND_IDX \
 170                                  + sizeof "RPC: Unable to send")
 171   N_("RPC: Unable to receive")
 172   "\0"
 173 #define RPC_TIMEDOUT_IDX        (RPC_CANTRECV_IDX \
 174                                  + sizeof "RPC: Unable to receive")
 175   N_("RPC: Timed out")
 176   "\0"
 177 #define RPC_VERSMISMATCH_IDX    (RPC_TIMEDOUT_IDX \
 178                                  + sizeof "RPC: Timed out")
 179   N_("RPC: Incompatible versions of RPC")
 180   "\0"
 181 #define RPC_AUTHERROR_IDX       (RPC_VERSMISMATCH_IDX \
 182                                  + sizeof "RPC: Incompatible versions of RPC")
 183   N_("RPC: Authentication error")
 184   "\0"
 185 #define RPC_PROGUNAVAIL_IDX             (RPC_AUTHERROR_IDX \
 186                                  + sizeof "RPC: Authentication error")
 187   N_("RPC: Program unavailable")
 188   "\0"
 189 #define RPC_PROGVERSMISMATCH_IDX (RPC_PROGUNAVAIL_IDX \
 190                                   + sizeof "RPC: Program unavailable")
 191   N_("RPC: Program/version mismatch")
 192   "\0"
 193 #define RPC_PROCUNAVAIL_IDX     (RPC_PROGVERSMISMATCH_IDX \
 194                                  + sizeof "RPC: Program/version mismatch")
 195   N_("RPC: Procedure unavailable")
 196   "\0"
 197 #define RPC_CANTDECODEARGS_IDX  (RPC_PROCUNAVAIL_IDX \
 198                                  + sizeof "RPC: Procedure unavailable")
 199   N_("RPC: Server can't decode arguments")
 200   "\0"
 201 #define RPC_SYSTEMERROR_IDX     (RPC_CANTDECODEARGS_IDX \
 202                                  + sizeof "RPC: Server can't decode arguments")
 203   N_("RPC: Remote system error")
 204   "\0"
 205 #define RPC_UNKNOWNHOST_IDX     (RPC_SYSTEMERROR_IDX \
 206                                  + sizeof "RPC: Remote system error")
 207   N_("RPC: Unknown host")
 208   "\0"
 209 #define RPC_UNKNOWNPROTO_IDX    (RPC_UNKNOWNHOST_IDX \
 210                                  + sizeof "RPC: Unknown host")
 211   N_("RPC: Unknown protocol")
 212   "\0"
 213 #define RPC_PMAPFAILURE_IDX     (RPC_UNKNOWNPROTO_IDX \
 214                                  + sizeof "RPC: Unknown protocol")
 215   N_("RPC: Port mapper failure")
 216   "\0"
 217 #define RPC_PROGNOTREGISTERED_IDX (RPC_PMAPFAILURE_IDX \
 218                                    + sizeof "RPC: Port mapper failure")
 219   N_("RPC: Program not registered")
 220   "\0"
 221 #define RPC_FAILED_IDX          (RPC_PROGNOTREGISTERED_IDX \
 222                                  + sizeof "RPC: Program not registered")
 223   N_("RPC: Failed (unspecified error)")
 224 };
 225
 226 static const struct rpc_errtab rpc_errlist[] =
 227 {
 228   { RPC_SUCCESS, RPC_SUCCESS_IDX },
 229   { RPC_CANTENCODEARGS, RPC_CANTENCODEARGS_IDX },
 230   { RPC_CANTDECODERES, RPC_CANTDECODERES_IDX },
 231   { RPC_CANTSEND, RPC_CANTSEND_IDX },
 232   { RPC_CANTRECV, RPC_CANTRECV_IDX },
 233   { RPC_TIMEDOUT, RPC_TIMEDOUT_IDX },
 234   { RPC_VERSMISMATCH, RPC_VERSMISMATCH_IDX },
 235   { RPC_AUTHERROR, RPC_AUTHERROR_IDX },
 236   { RPC_PROGUNAVAIL, RPC_PROGUNAVAIL_IDX },
 237   { RPC_PROGVERSMISMATCH, RPC_PROGVERSMISMATCH_IDX },
 238   { RPC_PROCUNAVAIL, RPC_PROCUNAVAIL_IDX },
 239   { RPC_CANTDECODEARGS, RPC_CANTDECODEARGS_IDX },
 240   { RPC_SYSTEMERROR, RPC_SYSTEMERROR_IDX },
 241   { RPC_UNKNOWNHOST, RPC_UNKNOWNHOST_IDX },
 242   { RPC_UNKNOWNPROTO, RPC_UNKNOWNPROTO_IDX },
 243   { RPC_PMAPFAILURE, RPC_PMAPFAILURE_IDX },
 244   { RPC_PROGNOTREGISTERED, RPC_PROGNOTREGISTERED_IDX },
 245   { RPC_FAILED, RPC_FAILED_IDX }
 246 };
 247
 248
 249 /*
 250  * This interface for use by clntrpc
 251  */
 252 char *
 253 clnt_sperrno (enum clnt_stat stat)
 254 {
 255   size_t i;
 256
 257   for (i = 0; i < sizeof (rpc_errlist) / sizeof (struct rpc_errtab); i++)
 258     {
 259       if (rpc_errlist[i].status == stat)
 260         {
 261           return _(rpc_errstr + rpc_errlist[i].message_off);
 262         }
 263     }
 264   return _("RPC: (unknown error code)");
 265 }
 266 libc_hidden_def (clnt_sperrno)
 267
 268 void
 269 clnt_perrno (enum clnt_stat num)
 270 {
 271   (void) __fxprintf (NULL, "%s", clnt_sperrno (num));
 272 }
 273 #ifdef EXPORT_RPC_SYMBOLS
 274 libc_hidden_def (clnt_perrno)
 275 #else
 276 libc_hidden_nolink (clnt_perrno, GLIBC_2_0)
 277 #endif
 278
 279 char *
 280 clnt_spcreateerror (const char *msg)
 281 {
 282   struct rpc_createerr *ce = &get_rpc_createerr ();
 283
 284   char chrbuf[1024];
 285   const char *connector = "";
 286   const char *errstr = "";
 287   switch (ce->cf_stat)
 288     {
 289     case RPC_PMAPFAILURE:
 290       connector = " - ";
 291       errstr = clnt_sperrno (ce->cf_error.re_status);
 292       break;
 293
 294     case RPC_SYSTEMERROR:
 295       connector = " - ";
 296       errstr = __strerror_r (ce->cf_error.re_errno, chrbuf, sizeof chrbuf);
 297       break;
 298
 299     default:
 300       break;
 301     }
 302
 303   char *str;
 304   if (__asprintf (&str, "%s: %s%s%s\n",
 305                   msg, clnt_sperrno (ce->cf_stat), connector, errstr) < 0)
 306     return NULL;
 307
 308   char *oldbuf = buf;
 309   buf = str;
 310   free (oldbuf);
 311
 312   return str;
 313 }
 314 libc_hidden_nolink (clnt_spcreateerror, GLIBC_2_0)
 315
 316 void
 317 clnt_pcreateerror (const char *msg)
 318 {
 319   (void) __fxprintf (NULL, "%s", clnt_spcreateerror (msg));
 320 }
 321 #ifdef EXPORT_RPC_SYMBOLS
 322 libc_hidden_def (clnt_pcreateerror)
 323 #else
 324 libc_hidden_nolink (clnt_pcreateerror, GLIBC_2_0)
 325 #endif
 326
 327 struct auth_errtab
 328 {
 329   enum auth_stat status;
 330   unsigned int message_off;
 331 };
 332
 333 static const char auth_errstr[] =
 334 {
 335 #define AUTH_OK_IDX             0
 336    N_("Authentication OK")
 337    "\0"
 338 #define AUTH_BADCRED_IDX        (AUTH_OK_IDX + sizeof "Authentication OK")
 339    N_("Invalid client credential")
 340    "\0"
 341 #define AUTH_REJECTEDCRED_IDX   (AUTH_BADCRED_IDX \
 342                                  + sizeof "Invalid client credential")
 343    N_("Server rejected credential")
 344    "\0"
 345 #define AUTH_BADVERF_IDX        (AUTH_REJECTEDCRED_IDX \
 346                                  + sizeof "Server rejected credential")
 347    N_("Invalid client verifier")
 348    "\0"
 349 #define AUTH_REJECTEDVERF_IDX   (AUTH_BADVERF_IDX \
 350                                  + sizeof "Invalid client verifier")
 351    N_("Server rejected verifier")
 352    "\0"
 353 #define AUTH_TOOWEAK_IDX        (AUTH_REJECTEDVERF_IDX \
 354                                  + sizeof "Server rejected verifier")
 355    N_("Client credential too weak")
 356    "\0"
 357 #define AUTH_INVALIDRESP_IDX    (AUTH_TOOWEAK_IDX \
 358                                  + sizeof "Client credential too weak")
 359    N_("Invalid server verifier")
 360    "\0"
 361 #define AUTH_FAILED_IDX         (AUTH_INVALIDRESP_IDX \
 362                                  + sizeof "Invalid server verifier")
 363    N_("Failed (unspecified error)")
 364 };
 365
 366 static const struct auth_errtab auth_errlist[] =
 367 {
 368   { AUTH_OK, AUTH_OK_IDX },
 369   { AUTH_BADCRED, AUTH_BADCRED_IDX },
 370   { AUTH_REJECTEDCRED, AUTH_REJECTEDCRED_IDX },
 371   { AUTH_BADVERF, AUTH_BADVERF_IDX },
 372   { AUTH_REJECTEDVERF, AUTH_REJECTEDVERF_IDX },
 373   { AUTH_TOOWEAK, AUTH_TOOWEAK_IDX },
 374   { AUTH_INVALIDRESP, AUTH_INVALIDRESP_IDX },
 375   { AUTH_FAILED, AUTH_FAILED_IDX }
 376 };
 377
 378 static char *
 379 internal_function
 380 auth_errmsg (enum auth_stat stat)
 381 {
 382   size_t i;
 383
 384   for (i = 0; i < sizeof (auth_errlist) / sizeof (struct auth_errtab); i++)
 385     {
 386       if (auth_errlist[i].status == stat)
 387         {
 388           return _(auth_errstr + auth_errlist[i].message_off);
 389         }
 390     }
 391   return NULL;
 392 }
 393
 394
 395 libc_freeres_fn (free_mem)
 396 {
 397   /* Not libc_freeres_ptr, since buf is a macro.  */
 398   free (buf);
 399 }