Remove building with NOCRYPTO option
[minix.git] / crypto / external / bsd / heimdal / dist / lib / krb5 / krb5_rd_safe.3
blob9d7b67b1d79fd9a421aada0d516dc3caba72887a
1 .\"     $NetBSD: krb5_rd_safe.3,v 1.1.1.2 2011/04/14 14:09:23 elric Exp $
2 .\"
3 .\" Copyright (c) 2003 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 May  1, 2006
37 .Dt KRB5_RD_SAFE 3
38 .Os
39 .Sh NAME
40 .Nm krb5_rd_safe ,
41 .Nm krb5_rd_priv
42 .Nd verifies authenticity of messages
43 .Sh LIBRARY
44 Kerberos 5 Library (libkrb5, -lkrb5)
45 .Sh SYNOPSIS
46 .In krb5/krb5.h
47 .Pp
48 .Ft krb5_error_code
49 .Fn krb5_rd_priv "krb5_context context" "krb5_auth_context auth_context" "const krb5_data *inbuf" "krb5_data *outbuf" "krb5_replay_data *outdata"
50 .Ft krb5_error_code
51 .Fn krb5_rd_safe "krb5_context context" "krb5_auth_context auth_context" "const krb5_data *inbuf" "krb5_data *outbuf" "krb5_replay_data *outdata"
52 .Sh DESCRIPTION
53 .Fn krb5_rd_safe
54 and
55 .Fn krb5_rd_priv
56 parses
57 .Li KRB-SAFE
58 and
59 .Li KRB-PRIV
60 messages (as generated by
61 .Xr krb5_mk_safe 3
62 and
63 .Xr krb5_mk_priv 3 )
64 from
65 .Fa inbuf
66 and verifies its integrity. The user data part of the message in put
68 .Fa outbuf .
69 The encryption state, including keyblocks and addresses, is taken from
70 .Fa auth_context .
71 If the
72 .Dv KRB5_AUTH_CONTEXT_RET_SEQUENCE
74 .Dv KRB5_AUTH_CONTEXT_RET_TIME
75 flags are set in the
76 .Fa auth_context
77 the sequence number and time are returned in the
78 .Fa outdata
79 parameter.
80 .Sh SEE ALSO
81 .Xr krb5_auth_con_init 3 ,
82 .Xr krb5_mk_priv 3 ,
83 .Xr krb5_mk_safe 3