add krb5_context.3 and krb5_init_context.3, from <lha@stacken.kth.se>

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@9540 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Assar Westerlund
2001-01-28 21:39:29 +00:00
parent 92cd5172a2
commit 5108851012
3 changed files with 61 additions and 1 deletions

View File

@@ -145,7 +145,9 @@ man_MANS = \
krb5_unparse_name.3 \
krb5_warn.3 \
verify_krb5_conf.8 \
krb5_auth_context.3
krb5_auth_context.3 \
krb5_context.3 \
krb5_init_context.3
include_HEADERS = krb5.h krb5-protos.h krb5-private.h krb5_err.h heim_err.h

20
lib/krb5/krb5_context.3 Normal file
View File

@@ -0,0 +1,20 @@
.\" Copyright (c) 2001 Kungliga Tekniska H<>gskolan
.\" $Id$
.Dd Jan 21, 2001
.Dt KRB5_CONTEXT 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_context
.Sh DESCRIPTION
The
.Nm
structure is designed to hold all per thread state. All global
variables that are context specific are stored in this struture,
including default encryption types, credential-cache (ticket file), and
default realms.
.Pp
The internals of the structure should never be accessed directly,
functions exist for extracting information.
.Sh SEE ALSO
.Xr krb5_init_context 3 ,
.Xr kerberos 8

View File

@@ -0,0 +1,38 @@
.\" Copyright (c) 2001 Kungliga Tekniska H<>gskolan
.\" $Id$
.Dd Jan 21, 2001
.Dt KRB5_CONTEXT 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_init_context ,
.Nm krb5_free_context
.Sh SYNOPSIS
.Fd #include <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 configration 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 krb5_context 3 ,
.Xr errno 2 ,
.Xr kerberos 8