xref: /minix3/crypto/external/bsd/heimdal/dist/lib/krb5/krb5_appdefault.3 (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc.\"	$NetBSD: krb5_appdefault.3,v 1.1.1.2 2011/04/14 14:09:22 elric Exp $
2*ebfedea0SLionel Sambuc.\"
3*ebfedea0SLionel Sambuc.\" Copyright (c) 2000 Kungliga Tekniska Högskolan
4*ebfedea0SLionel Sambuc.\" (Royal Institute of Technology, Stockholm, Sweden).
5*ebfedea0SLionel Sambuc.\" All rights reserved.
6*ebfedea0SLionel Sambuc.\"
7*ebfedea0SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
8*ebfedea0SLionel Sambuc.\" modification, are permitted provided that the following conditions
9*ebfedea0SLionel Sambuc.\" are met:
10*ebfedea0SLionel Sambuc.\"
11*ebfedea0SLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright
12*ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer.
13*ebfedea0SLionel Sambuc.\"
14*ebfedea0SLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright
15*ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer in the
16*ebfedea0SLionel Sambuc.\"    documentation and/or other materials provided with the distribution.
17*ebfedea0SLionel Sambuc.\"
18*ebfedea0SLionel Sambuc.\" 3. Neither the name of the Institute nor the names of its contributors
19*ebfedea0SLionel Sambuc.\"    may be used to endorse or promote products derived from this software
20*ebfedea0SLionel Sambuc.\"    without specific prior written permission.
21*ebfedea0SLionel Sambuc.\"
22*ebfedea0SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
23*ebfedea0SLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24*ebfedea0SLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25*ebfedea0SLionel Sambuc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
26*ebfedea0SLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27*ebfedea0SLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28*ebfedea0SLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29*ebfedea0SLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30*ebfedea0SLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31*ebfedea0SLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32*ebfedea0SLionel Sambuc.\" SUCH DAMAGE.
33*ebfedea0SLionel Sambuc.\"
34*ebfedea0SLionel Sambuc.\" Id
35*ebfedea0SLionel Sambuc.\"
36*ebfedea0SLionel Sambuc.Dd July 25, 2000
37*ebfedea0SLionel Sambuc.Dt KRB5_APPDEFAULT 3
38*ebfedea0SLionel Sambuc.Os
39*ebfedea0SLionel Sambuc.Sh NAME
40*ebfedea0SLionel Sambuc.Nm krb5_appdefault_boolean ,
41*ebfedea0SLionel Sambuc.Nm krb5_appdefault_string ,
42*ebfedea0SLionel Sambuc.Nm krb5_appdefault_time
43*ebfedea0SLionel Sambuc.Nd get application configuration value
44*ebfedea0SLionel Sambuc.Sh LIBRARY
45*ebfedea0SLionel SambucKerberos 5 Library (libkrb5, -lkrb5)
46*ebfedea0SLionel Sambuc.Sh SYNOPSIS
47*ebfedea0SLionel Sambuc.In krb5/krb5.h
48*ebfedea0SLionel Sambuc.Ft void
49*ebfedea0SLionel Sambuc.Fn krb5_appdefault_boolean "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "krb5_boolean def_val" "krb5_boolean *ret_val"
50*ebfedea0SLionel Sambuc.Ft void
51*ebfedea0SLionel Sambuc.Fn krb5_appdefault_string "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "const char *def_val" "char **ret_val"
52*ebfedea0SLionel Sambuc.Ft void
53*ebfedea0SLionel Sambuc.Fn krb5_appdefault_time "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "time_t def_val" "time_t *ret_val"
54*ebfedea0SLionel Sambuc.Sh DESCRIPTION
55*ebfedea0SLionel SambucThese functions get application defaults from the
56*ebfedea0SLionel Sambuc.Dv appdefaults
57*ebfedea0SLionel Sambucsection of the
58*ebfedea0SLionel Sambuc.Xr krb5.conf 5
59*ebfedea0SLionel Sambucconfiguration file. These defaults can be specified per application,
60*ebfedea0SLionel Sambucand/or per realm.
61*ebfedea0SLionel Sambuc.Pp
62*ebfedea0SLionel SambucThese values will be looked for in
63*ebfedea0SLionel Sambuc.Xr krb5.conf 5 ,
64*ebfedea0SLionel Sambucin order of descending importance.
65*ebfedea0SLionel Sambuc.Bd -literal -offset indent
66*ebfedea0SLionel Sambuc[appdefaults]
67*ebfedea0SLionel Sambuc	appname = {
68*ebfedea0SLionel Sambuc		realm = {
69*ebfedea0SLionel Sambuc			option = value
70*ebfedea0SLionel Sambuc		}
71*ebfedea0SLionel Sambuc	}
72*ebfedea0SLionel Sambuc	appname = {
73*ebfedea0SLionel Sambuc		option = value
74*ebfedea0SLionel Sambuc	}
75*ebfedea0SLionel Sambuc	realm = {
76*ebfedea0SLionel Sambuc		option = value
77*ebfedea0SLionel Sambuc	}
78*ebfedea0SLionel Sambuc	option = value
79*ebfedea0SLionel Sambuc.Ed
80*ebfedea0SLionel Sambuc.Fa appname
81*ebfedea0SLionel Sambucis the name of the application, and
82*ebfedea0SLionel Sambuc.Fa realm
83*ebfedea0SLionel Sambucis the realm name. If the realm is omitted it will not be used for
84*ebfedea0SLionel Sambucresolving values.
85*ebfedea0SLionel Sambuc.Fa def_val
86*ebfedea0SLionel Sambucis the value to return if no value is found in
87*ebfedea0SLionel Sambuc.Xr krb5.conf 5 .
88*ebfedea0SLionel Sambuc.Sh SEE ALSO
89*ebfedea0SLionel Sambuc.Xr krb5_config 3 ,
90*ebfedea0SLionel Sambuc.Xr krb5.conf 5
91