lib/krb5/warn.c

   1 /*
   2  * Copyright (c) 1997 - 2001 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #include "krb5_locl.h"
  35 #include <err.h>
  36
  37 static krb5_error_code _warnerr(krb5_context context, int do_errtext,
  38          krb5_error_code code, int level, const char *fmt, va_list ap)
  39         __attribute__((__format__(__printf__, 5, 0)));
  40
  41 static krb5_error_code
  42 _warnerr(krb5_context context, int do_errtext,
  43          krb5_error_code code, int level, const char *fmt, va_list ap)
  44 {
  45     char xfmt[7] = "";
  46     const char *args[2], **arg;
  47     char *msg = NULL;
  48     const char *err_str = NULL;
  49
  50     args[0] = args[1] = NULL;
  51     arg = args;
  52     if(fmt){
  53         strlcat(xfmt, "%s", sizeof(xfmt));
  54         if(do_errtext)
  55             strlcat(xfmt, ": ", sizeof(xfmt));
  56         vasprintf(&msg, fmt, ap);
  57         if(msg == NULL)
  58             return ENOMEM;
  59         *arg++ = msg;
  60     }
  61     if(context && do_errtext){
  62         const char *err_msg;
  63
  64         strlcat(xfmt, "%s", sizeof(xfmt));
  65
  66         err_str = krb5_get_error_message(context, code);
  67         if (err_str != NULL) {
  68             *arg = err_str;
  69         } else {
  70             *arg= "<unknown error>";
  71         }
  72     }
  73
  74     if(context && context->warn_dest)
  75         krb5_log(context, context->warn_dest, level, xfmt, args[0], args[1]);
  76     else
  77         warnx(xfmt, args[0], args[1]);
  78     free(msg);
  79     krb5_free_error_message(context, err_str);
  80     return 0;
  81 }
  82
  83 #define FUNC(ETEXT, CODE, LEVEL)                                        \
  84     krb5_error_code ret;                                                \
  85     va_list ap;                                                         \
  86     va_start(ap, fmt);                                                  \
  87     ret = _warnerr(context, ETEXT, CODE, LEVEL, fmt, ap);               \
  88     va_end(ap);
  89
  90 #undef __attribute__
  91 #define __attribute__(X)
  92
  93 /**
  94  * Log a warning to the log, default stderr, include the error from
  95  * the last failure.
  96  *
  97  * @param context A Kerberos 5 context.
  98  * @param code error code of the last error
  99  * @param fmt message to print
 100  * @param ap arguments
 101  *
 102  * @ingroup krb5_error
 103  */
 104
 105 krb5_error_code KRB5_LIB_FUNCTION
 106 krb5_vwarn(krb5_context context, krb5_error_code code,
 107            const char *fmt, va_list ap)
 108      __attribute__ ((format (printf, 3, 0)))
 109 {
 110     return _warnerr(context, 1, code, 1, fmt, ap);
 111 }
 112
 113 /**
 114  * Log a warning to the log, default stderr, include the error from
 115  * the last failure.
 116  *
 117  * @param context A Kerberos 5 context.
 118  * @param code error code of the last error
 119  * @param fmt message to print
 120  *
 121  * @ingroup krb5_error
 122  */
 123
 124 krb5_error_code KRB5_LIB_FUNCTION
 125 krb5_warn(krb5_context context, krb5_error_code code, const char *fmt, ...)
 126      __attribute__ ((format (printf, 3, 4)))
 127 {
 128     FUNC(1, code, 1);
 129     return ret;
 130 }
 131
 132 /**
 133  * Log a warning to the log, default stderr.
 134  *
 135  * @param context A Kerberos 5 context.
 136  * @param fmt message to print
 137  * @param ap arguments
 138  *
 139  * @ingroup krb5_error
 140  */
 141
 142 krb5_error_code KRB5_LIB_FUNCTION
 143 krb5_vwarnx(krb5_context context, const char *fmt, va_list ap)
 144      __attribute__ ((format (printf, 2, 0)))
 145 {
 146     return _warnerr(context, 0, 0, 1, fmt, ap);
 147 }
 148
 149 /**
 150  * Log a warning to the log, default stderr.
 151  *
 152  * @param context A Kerberos 5 context.
 153  * @param fmt message to print
 154  *
 155  * @ingroup krb5_error
 156  */
 157
 158 krb5_error_code KRB5_LIB_FUNCTION
 159 krb5_warnx(krb5_context context, const char *fmt, ...)
 160      __attribute__ ((format (printf, 2, 3)))
 161 {
 162     FUNC(0, 0, 1);
 163     return ret;
 164 }
 165
 166 /**
 167  * Log a warning to the log, default stderr, include bthe error from
 168  * the last failure and then exit.
 169  *
 170  * @param context A Kerberos 5 context
 171  * @param eval the exit code to exit with
 172  * @param code error code of the last error
 173  * @param fmt message to print
 174  * @param ap arguments
 175  *
 176  * @ingroup krb5_error
 177  */
 178
 179 krb5_error_code KRB5_LIB_FUNCTION
 180 krb5_verr(krb5_context context, int eval, krb5_error_code code,
 181           const char *fmt, va_list ap)
 182      __attribute__ ((noreturn, format (printf, 4, 0)))
 183 {
 184     _warnerr(context, 1, code, 0, fmt, ap);
 185     exit(eval);
 186 }
 187
 188 /**
 189  * Log a warning to the log, default stderr, include bthe error from
 190  * the last failure and then exit.
 191  *
 192  * @param context A Kerberos 5 context
 193  * @param eval the exit code to exit with
 194  * @param code error code of the last error
 195  * @param fmt message to print
 196  *
 197  * @ingroup krb5_error
 198  */
 199
 200 krb5_error_code KRB5_LIB_FUNCTION
 201 krb5_err(krb5_context context, int eval, krb5_error_code code,
 202          const char *fmt, ...)
 203      __attribute__ ((noreturn, format (printf, 4, 5)))
 204 {
 205     FUNC(1, code, 0);
 206     exit(eval);
 207 }
 208
 209 /**
 210  * Log a warning to the log, default stderr, and then exit.
 211  *
 212  * @param context A Kerberos 5 context
 213  * @param eval the exit code to exit with
 214  * @param fmt message to print
 215  * @param ap arguments
 216  *
 217  * @ingroup krb5_error
 218  */
 219
 220 krb5_error_code KRB5_LIB_FUNCTION
 221 krb5_verrx(krb5_context context, int eval, const char *fmt, va_list ap)
 222      __attribute__ ((noreturn, format (printf, 3, 0)))
 223 {
 224     _warnerr(context, 0, 0, 0, fmt, ap);
 225     exit(eval);
 226 }
 227
 228 /**
 229  * Log a warning to the log, default stderr, and then exit.
 230  *
 231  * @param context A Kerberos 5 context
 232  * @param eval the exit code to exit with
 233  * @param fmt message to print
 234  *
 235  * @ingroup krb5_error
 236  */
 237
 238 krb5_error_code KRB5_LIB_FUNCTION
 239 krb5_errx(krb5_context context, int eval, const char *fmt, ...)
 240      __attribute__ ((noreturn, format (printf, 3, 4)))
 241 {
 242     FUNC(0, 0, 0);
 243     exit(eval);
 244 }
 245
 246 /**
 247  * Log a warning to the log, default stderr, include bthe error from
 248  * the last failure and then abort.
 249  *
 250  * @param context A Kerberos 5 context
 251  * @param code error code of the last error
 252  * @param fmt message to print
 253  * @param ap arguments
 254  *
 255  * @ingroup krb5_error
 256  */
 257
 258 krb5_error_code KRB5_LIB_FUNCTION
 259 krb5_vabort(krb5_context context, krb5_error_code code,
 260             const char *fmt, va_list ap)
 261      __attribute__ ((noreturn, format (printf, 3, 0)))
 262 {
 263     _warnerr(context, 1, code, 0, fmt, ap);
 264     abort();
 265 }
 266
 267 /**
 268  * Log a warning to the log, default stderr, include the error from
 269  * the last failure and then abort.
 270  *
 271  * @param context A Kerberos 5 context
 272  * @param code error code of the last error
 273  * @param fmt message to print
 274  *
 275  * @ingroup krb5_error
 276  */
 277
 278 krb5_error_code KRB5_LIB_FUNCTION
 279 krb5_abort(krb5_context context, krb5_error_code code, const char *fmt, ...)
 280      __attribute__ ((noreturn, format (printf, 3, 4)))
 281 {
 282     FUNC(1, code, 0);
 283     abort();
 284 }
 285
 286 krb5_error_code KRB5_LIB_FUNCTION
 287 krb5_vabortx(krb5_context context, const char *fmt, va_list ap)
 288      __attribute__ ((noreturn, format (printf, 2, 0)))
 289 {
 290     _warnerr(context, 0, 0, 0, fmt, ap);
 291     abort();
 292 }
 293
 294 /**
 295  * Log a warning to the log, default stderr, and then abort.
 296  *
 297  * @param context A Kerberos 5 context
 298  * @param code error code of the last error
 299  * @param fmt message to print
 300  *
 301  * @ingroup krb5_error
 302  */
 303
 304 krb5_error_code KRB5_LIB_FUNCTION
 305 krb5_abortx(krb5_context context, const char *fmt, ...)
 306      __attribute__ ((noreturn, format (printf, 2, 3)))
 307 {
 308     FUNC(0, 0, 0);
 309     abort();
 310 }
 311
 312 /**
 313  * Set the default logging facility.
 314  *
 315  * @param context A Kerberos 5 context
 316  * @param fac Facility to use for logging.
 317  *
 318  * @ingroup krb5_error
 319  */
 320
 321 krb5_error_code KRB5_LIB_FUNCTION
 322 krb5_set_warn_dest(krb5_context context, krb5_log_facility *fac)
 323 {
 324     context->warn_dest = fac;
 325     return 0;
 326 }
 327
 328 /**
 329  * Get the default logging facility.
 330  *
 331  * @param context A Kerberos 5 context
 332  *
 333  * @ingroup krb5_error
 334  */
 335
 336 krb5_log_facility * KRB5_LIB_FUNCTION
 337 krb5_get_warn_dest(krb5_context context)
 338 {
 339     return context->warn_dest;
 340 }