freebsd-nq/crypto/heimdal/lib/krb5/krb5_find_padata.3
2008-05-07 13:39:42 +00:00

88 lines
2.6 KiB
Groff

.\" Copyright (c) 2004 Kungliga Tekniska Högskolan
.\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 3. Neither the name of the Institute nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: krb5_find_padata.3 13595 2004-03-21 13:17:41Z lha $
.\"
.Dd March 21, 2004
.Dt KRB5_FIND_PADATA 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_find_padata ,
.Nm krb5_padata_add
.Nd Kerberos 5 pre-authentication data handling functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Pp
.Ft "PA_DATA *"
.Fo krb5_find_padata
.Fa "PA_DATA *val"
.Fa "unsigned len"
.Fa "int type"
.Fa "int *index"
.Fc
.Ft int
.Fo krb5_padata_add
.Fa "krb5_context context"
.Fa "METHOD_DATA *md"
.Fa "int type"
.Fa "void *buf"
.Fa "size_t len"
.Fc
.Sh DESCRIPTION
.Fn krb5_find_padata
tries to find the pre-authentication data entry of type
.Fa type
in the array
.Fa val
of length
.Fa len .
The search is started at entry pointed out by
.Fa *index
(zero based indexing).
If the type isn't found,
.Dv NULL
is returned.
.Pp
.Fn krb5_padata_add
adds a pre-authentication data entry of type
.Fa type
pointed out by
.Fa buf
and
.Fa len
to
.Fa md .
.Sh SEE ALSO
.Xr krb5 3 ,
.Xr kerberos 8