No empty .Rs/.Re
[netbsd-mini2440.git] / crypto / dist / heimdal / lib / krb5 / krb5_find_padata.3
blob6f2c1525b7232e42ae1eca10adc32c3d704044a3
1 .\" Copyright (c) 2004 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $Heimdal: krb5_find_padata.3 13595 2004-03-21 13:17:41Z lha $
33 .\" $NetBSD$
34 .\"
35 .Dd March 21, 2004
36 .Dt KRB5_FIND_PADATA 3
37 .Os
38 .Sh NAME
39 .Nm krb5_find_padata ,
40 .Nm krb5_padata_add
41 .Nd Kerberos 5 pre-authentication data handling functions
42 .Sh LIBRARY
43 Kerberos 5 Library (libkrb5, -lkrb5)
44 .Sh SYNOPSIS
45 .In krb5/krb5.h
46 .Pp
47 .Ft "PA_DATA *"
48 .Fo krb5_find_padata
49 .Fa "PA_DATA *val"
50 .Fa "unsigned len"
51 .Fa "int type"
52 .Fa "int *index"
53 .Fc
54 .Ft int
55 .Fo krb5_padata_add
56 .Fa "krb5_context context"
57 .Fa "METHOD_DATA *md"
58 .Fa "int type"
59 .Fa "void *buf"
60 .Fa "size_t len"
61 .Fc
62 .Sh DESCRIPTION
63 .Fn krb5_find_padata
64 tries to find the pre-authentication data entry of type
65 .Fa type
66 in the array
67 .Fa val
68 of length
69 .Fa len .
70 The search is started at entry pointed out by
71 .Fa *index
72 (zero based indexing).
73 If the type isn't found,
74 .Dv NULL
75 is returned.
76 .Pp
77 .Fn krb5_padata_add
78 adds a pre-authentication data entry of type
79 .Fa type
80 pointed out by
81 .Fa buf
82 and
83 .Fa len
85 .Fa md .
86 .Sh SEE ALSO
87 .Xr krb5 3 ,
88 .Xr kerberos 8