xref: /freebsd/crypto/heimdal/lib/krb5/krb5_find_padata.3 (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
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.\" $Id$
33.\"
34.Dd March 21, 2004
35.Dt KRB5_FIND_PADATA 3
36.Os HEIMDAL
37.Sh NAME
38.Nm krb5_find_padata ,
39.Nm krb5_padata_add
40.Nd Kerberos 5 pre-authentication data handling functions
41.Sh LIBRARY
42Kerberos 5 Library (libkrb5, -lkrb5)
43.Sh SYNOPSIS
44.In krb5.h
45.Pp
46.Ft "PA_DATA *"
47.Fo krb5_find_padata
48.Fa "PA_DATA *val"
49.Fa "unsigned len"
50.Fa "int type"
51.Fa "int *index"
52.Fc
53.Ft int
54.Fo krb5_padata_add
55.Fa "krb5_context context"
56.Fa "METHOD_DATA *md"
57.Fa "int type"
58.Fa "void *buf"
59.Fa "size_t len"
60.Fc
61.Sh DESCRIPTION
62.Fn krb5_find_padata
63tries to find the pre-authentication data entry of type
64.Fa type
65in the array
66.Fa val
67of length
68.Fa len .
69The search is started at entry pointed out by
70.Fa *index
71(zero based indexing).
72If the type isn't found,
73.Dv NULL
74is returned.
75.Pp
76.Fn krb5_padata_add
77adds a pre-authentication data entry of type
78.Fa type
79pointed out by
80.Fa buf
81and
82.Fa len
83to
84.Fa md .
85.Sh SEE ALSO
86.Xr krb5 3 ,
87.Xr kerberos 8
88