1.\" $NetBSD: krb5_rd_error.3,v 1.1.1.2 2011/04/14 14:09:23 elric Exp $ 2.\" 3.\" Copyright (c) 2004 Kungliga Tekniska Högskolan 4.\" (Royal Institute of Technology, Stockholm, Sweden). 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" 3. Neither the name of the Institute nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" Id 35.\" 36.Dd July 26, 2004 37.Dt KRB5_RD_ERROR 3 38.Os 39.Sh NAME 40.Nm krb5_rd_error , 41.Nm krb5_free_error , 42.Nm krb5_free_error_contents , 43.Nm krb5_error_from_rd_error 44.Nd parse, free and read error from KRB-ERROR message 45.Sh LIBRARY 46Kerberos 5 Library (libkrb5, -lkrb5) 47.Sh SYNOPSIS 48.In krb5/krb5.h 49.Ft krb5_error_code 50.Fo krb5_rd_error 51.Fa "krb5_context context" 52.Fa "const krb5_data *msg" 53.Fa "KRB_ERROR *result" 54.Fc 55.Ft void 56.Fo krb5_free_error 57.Fa "krb5_context context" 58.Fa "krb5_error *error" 59.Fc 60.Ft void 61.Fo krb5_free_error_contents 62.Fa "krb5_context context" 63.Fa "krb5_error *error" 64.Fc 65.Ft krb5_error_code 66.Fo krb5_error_from_rd_error 67.Fa "krb5_context context" 68.Fa "const krb5_error *error" 69.Fa "const krb5_creds *creds" 70.Fc 71.Sh DESCRIPTION 72Usually applications never needs to parse and understand Kerberos 73error messages since higher level functions will parse and push up the 74error in the krb5_context. 75These functions are described for completeness. 76.Pp 77.Fn krb5_rd_error 78parses and returns the kerboeros error message, the structure should be freed with 79.Fn krb5_free_error_contents 80when the caller is done with the structure. 81.Pp 82.Fn krb5_free_error 83frees the content and the memory region holding the structure iself. 84.Pp 85.Fn krb5_free_error_contents 86free the content of the KRB-ERROR message. 87.Pp 88.Fn krb5_error_from_rd_error 89will parse the error message and set the error buffer in krb5_context 90to the error string passed back or the matching error code in the 91KRB-ERROR message. 92Caller should pick up the message with 93.Fn krb5_get_error_string 3 94(don't forget to free the returned string with 95.Fn krb5_free_error_string ) . 96.Sh SEE ALSO 97.Xr krb5 3 , 98.Xr krb5_set_error_string 3 , 99.Xr krb5_get_error_string 3 , 100.Xr krb5.conf 5 101