xref: /freebsd/crypto/heimdal/lib/krb5/krb5_appdefault.3 (revision 02e9120893770924227138ba49df1edb3896112a)
1.\" Copyright (c) 2000 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 July 25, 2000
35.Dt KRB5_APPDEFAULT 3
36.Os HEIMDAL
37.Sh NAME
38.Nm krb5_appdefault_boolean ,
39.Nm krb5_appdefault_string ,
40.Nm krb5_appdefault_time
41.Nd get application configuration value
42.Sh LIBRARY
43Kerberos 5 Library (libkrb5, -lkrb5)
44.Sh SYNOPSIS
45.In krb5.h
46.Ft void
47.Fn krb5_appdefault_boolean "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "krb5_boolean def_val" "krb5_boolean *ret_val"
48.Ft void
49.Fn krb5_appdefault_string "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "const char *def_val" "char **ret_val"
50.Ft void
51.Fn krb5_appdefault_time "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "time_t def_val" "time_t *ret_val"
52.Sh DESCRIPTION
53These functions get application defaults from the
54.Dv appdefaults
55section of the
56.Xr krb5.conf 5
57configuration file. These defaults can be specified per application,
58and/or per realm.
59.Pp
60These values will be looked for in
61.Xr krb5.conf 5 ,
62in order of descending importance.
63.Bd -literal -offset indent
64[appdefaults]
65	appname = {
66		realm = {
67			option = value
68		}
69	}
70	appname = {
71		option = value
72	}
73	realm = {
74		option = value
75	}
76	option = value
77.Ed
78.Fa appname
79is the name of the application, and
80.Fa realm
81is the realm name. If the realm is omitted it will not be used for
82resolving values.
83.Fa def_val
84is the value to return if no value is found in
85.Xr krb5.conf 5 .
86.Sh SEE ALSO
87.Xr krb5_config 3 ,
88.Xr krb5.conf 5
89