dc130c2c75
from Thomas Klausner <wiz@netbsd.org> git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@12032 ec53bebd-3082-4978-b11e-865c3cabbd6b
73 lines
2.6 KiB
Groff
73 lines
2.6 KiB
Groff
.\" Copyright (c) 2001 - 2002 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$
|
|
.\"
|
|
.Dd January 21, 2001
|
|
.Dt KRB5_CONTEXT 3
|
|
.Os HEIMDAL
|
|
.Sh NAME
|
|
.Nm krb5_init_context ,
|
|
.Nm krb5_free_context
|
|
.Nd create and delete krb5_context structures
|
|
.Sh LIBRARY
|
|
Kerberos 5 Library (libkrb5, -lkrb5)
|
|
.Sh SYNOPSIS
|
|
.In krb5.h
|
|
.Ft krb5_error_code
|
|
.Fn krb5_init_context "krb5_context *context"
|
|
.Ft void
|
|
.Fn krb5_free_context "krb5_context context"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn krb5_init_context
|
|
function initializes the
|
|
.Fa context
|
|
structure and reads the configuration file
|
|
.Pa /etc/krb5.conf .
|
|
.Pp
|
|
The structure should be freed by calling
|
|
.Fn krb5_free_context
|
|
when it is no longer being used.
|
|
.Sh RETURN VALUES
|
|
.Fn krb5_init_context
|
|
returns 0 to indicate success.
|
|
Otherwise an errno code is returned.
|
|
Failure means either that something bad happened during initialization
|
|
(typically
|
|
.Bq ENOMEM )
|
|
or that Kerberos should not be used
|
|
.Bq ENXIO .
|
|
.Sh SEE ALSO
|
|
.Xr errno 2 ,
|
|
.Xr krb5_context 3 ,
|
|
.Xr kerberos 8
|