crypto/dist/heimdal/lib/krb5/krb5_config.3

   1 .\" Copyright (c) 2000 - 2007 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 .\"
  33 .\" $Heimdal: krb5_config.3 21905 2007-08-10 10:16:45Z lha $
  34 .\" $NetBSD$
  35 .\"
  36 .Dd August 10, 2007
  37 .Dt KRB5_CONFIG_GET 3
  38 .Os
  39 .Sh NAME
  40 .Nm krb5_config_file_free ,
  41 .Nm krb5_config_free_strings ,
  42 .Nm krb5_config_get ,
  43 .Nm krb5_config_get_bool ,
  44 .Nm krb5_config_get_bool_default ,
  45 .Nm krb5_config_get_int ,
  46 .Nm krb5_config_get_int_default ,
  47 .Nm krb5_config_get_list ,
  48 .Nm krb5_config_get_next ,
  49 .Nm krb5_config_get_string ,
  50 .Nm krb5_config_get_string_default ,
  51 .Nm krb5_config_get_strings ,
  52 .Nm krb5_config_get_time ,
  53 .Nm krb5_config_get_time_default ,
  54 .Nm krb5_config_parse_file ,
  55 .Nm krb5_config_parse_file_multi ,
  56 .Nm krb5_config_vget ,
  57 .Nm krb5_config_vget_bool ,
  58 .Nm krb5_config_vget_bool_default ,
  59 .Nm krb5_config_vget_int ,
  60 .Nm krb5_config_vget_int_default ,
  61 .Nm krb5_config_vget_list ,
  62 .Nm krb5_config_vget_next ,
  63 .Nm krb5_config_vget_string ,
  64 .Nm krb5_config_vget_string_default ,
  65 .Nm krb5_config_vget_strings ,
  66 .Nm krb5_config_vget_time ,
  67 .Nm krb5_config_vget_time_default
  68 .Nd get configuration value
  69 .Sh LIBRARY
  70 Kerberos 5 Library (libkrb5, -lkrb5)
  71 .Sh SYNOPSIS
  72 .In krb5/krb5.h
  73 .Ft krb5_error_code
  74 .Fo krb5_config_file_free
  75 .Fa "krb5_context context"
  76 .Fa "krb5_config_section *s"
  77 .Fc
  78 .Ft void
  79 .Fo krb5_config_free_strings
  80 .Fa "char **strings"
  81 .Fc
  82 .Ft "const void *"
  83 .Fo krb5_config_get
  84 .Fa "krb5_context context"
  85 .Fa "const krb5_config_section *c"
  86 .Fa "int type"
  87 .Fa "..."
  88 .Fc
  89 .Ft krb5_boolean
  90 .Fo krb5_config_get_bool
  91 .Fa "krb5_context context"
  92 .Fa "krb5_config_section *c"
  93 .Fa "..."
  94 .Fc
  95 .Ft krb5_boolean
  96 .Fo krb5_config_get_bool_default
  97 .Fa "krb5_context context"
  98 .Fa "krb5_config_section *c"
  99 .Fa "krb5_boolean def_value"
 100 .Fa "..."
 101 .Fc
 102 .Ft int
 103 .Fo krb5_config_get_int
 104 .Fa "krb5_context context"
 105 .Fa "krb5_config_section *c"
 106 .Fa "..."
 107 .Fc
 108 .Ft int
 109 .Fo krb5_config_get_int_default
 110 .Fa "krb5_context context"
 111 .Fa "krb5_config_section *c"
 112 .Fa "int def_value"
 113 .Fa "..."
 114 .Fc
 115 .Ft const char*
 116 .Fo krb5_config_get_string
 117 .Fa "krb5_context context"
 118 .Fa "krb5_config_section *c"
 119 .Fa "..."
 120 .Fc
 121 .Ft const char*
 122 .Fo krb5_config_get_string_default
 123 .Fa "krb5_context context"
 124 .Fa "krb5_config_section *c"
 125 .Fa "const char *def_value"
 126 .Fa "..."
 127 .Fc
 128 .Ft "char**"
 129 .Fo krb5_config_get_strings
 130 .Fa "krb5_context context"
 131 .Fa "const krb5_config_section *c"
 132 .Fa "..."
 133 .Fc
 134 .Ft int
 135 .Fo krb5_config_get_time
 136 .Fa "krb5_context context"
 137 .Fa "krb5_config_section *c"
 138 .Fa "..."
 139 .Fc
 140 .Ft int
 141 .Fo krb5_config_get_time_default
 142 .Fa "krb5_context context"
 143 .Fa "krb5_config_section *c"
 144 .Fa "int def_value"
 145 .Fa "..."
 146 .Fc
 147 .Ft krb5_error_code
 148 .Fo krb5_config_parse_file
 149 .Fa "krb5_context context"
 150 .Fa "const char *fname"
 151 .Fa "krb5_config_section **res"
 152 .Fc
 153 .Ft krb5_error_code
 154 .Fo krb5_config_parse_file_multi
 155 .Fa "krb5_context context"
 156 .Fa "const char *fname"
 157 .Fa "krb5_config_section **res"
 158 .Fc
 159 .Ft "const void *"
 160 .Fo krb5_config_vget
 161 .Fa "krb5_context context"
 162 .Fa "const krb5_config_section *c"
 163 .Fa "int type"
 164 .Fa "va_list args"
 165 .Fc
 166 .Ft krb5_boolean
 167 .Fo krb5_config_vget_bool
 168 .Fa "krb5_context context"
 169 .Fa "const krb5_config_section *c"
 170 .Fa "va_list args"
 171 .Fc
 172 .Ft krb5_boolean
 173 .Fo krb5_config_vget_bool_default
 174 .Fa "krb5_context context"
 175 .Fa "const krb5_config_section *c"
 176 .Fa "krb5_boolean def_value"
 177 .Fa "va_list args"
 178 .Fc
 179 .Ft int
 180 .Fo krb5_config_vget_int
 181 .Fa "krb5_context context"
 182 .Fa "const krb5_config_section *c"
 183 .Fa "va_list args"
 184 .Fc
 185 .Ft int
 186 .Fo krb5_config_vget_int_default
 187 .Fa "krb5_context context"
 188 .Fa "const krb5_config_section *c"
 189 .Fa "int def_value"
 190 .Fa "va_list args"
 191 .Fc
 192 .Ft "const krb5_config_binding *"
 193 .Fo krb5_config_vget_list
 194 .Fa "krb5_context context"
 195 .Fa "const krb5_config_section *c"
 196 .Fa "va_list args"
 197 .Fc
 198 .Ft "const void *"
 199 .Fo krb5_config_vget_next
 200 .Fa "krb5_context context"
 201 .Fa "const krb5_config_section *c"
 202 .Fa "const krb5_config_binding **pointer"
 203 .Fa "int type"
 204 .Fa "va_list args"
 205 .Fc
 206 .Ft "const char *"
 207 .Fo krb5_config_vget_string
 208 .Fa "krb5_context context"
 209 .Fa "const krb5_config_section *c"
 210 .Fa "va_list args"
 211 .Fc
 212 .Ft "const char *"
 213 .Fo krb5_config_vget_string_default
 214 .Fa "krb5_context context"
 215 .Fa "const krb5_config_section *c"
 216 .Fa "const char *def_value"
 217 .Fa "va_list args"
 218 .Fc
 219 .Ft char **
 220 .Fo krb5_config_vget_strings
 221 .Fa "krb5_context context"
 222 .Fa "const krb5_config_section *c"
 223 .Fa "va_list args"
 224 .Fc
 225 .Ft int
 226 .Fo krb5_config_vget_time
 227 .Fa "krb5_context context"
 228 .Fa "const krb5_config_section *c"
 229 .Fa "va_list args"
 230 .Fc
 231 .Ft int
 232 .Fo krb5_config_vget_time_default
 233 .Fa "krb5_context context"
 234 .Fa "const krb5_config_section *c"
 235 .Fa "int def_value"
 236 .Fa "va_list args"
 237 .Fc
 238 .Sh DESCRIPTION
 239 These functions get values from the
 240 .Xr krb5.conf 5
 241 configuration file, or another configuration database specified by the
 242 .Fa c
 243 parameter.
 244 .Pp
 245 The variable arguments should be a list of strings naming each
 246 subsection to look for. For example:
 247 .Bd -literal -offset indent
 248 krb5_config_get_bool_default(context, NULL, FALSE,
 249      "libdefaults", "log_utc", NULL);
 250 .Ed
 251 .Pp
 252 gets the boolean value for the
 253 .Dv log_utc
 254 option, defaulting to
 255 .Dv FALSE .
 256 .Pp
 257 .Fn krb5_config_get_bool_default
 258 will convert the option value to a boolean value, where
 259 .Sq yes ,
 260 .Sq true ,
 261 and any non-zero number means
 262 .Dv TRUE ,
 263 and any other value
 264 .Dv FALSE .
 265 .Pp
 266 .Fn krb5_config_get_int_default
 267 will convert the value to an integer.
 268 .Pp
 269 .Fn krb5_config_get_time_default
 270 will convert the value to a period of time (not a time stamp) in
 271 seconds, so the string
 272 .Sq 2 weeks
 273 will be converted to
 274 1209600 (2 * 7 * 24 * 60 * 60).
 275 .Pp
 276 .Fn krb5_config_get_string
 277 returns a
 278 .Ft "const char *"
 279 to a string in the configuration database.  The string not be valid
 280 after reload of the configuration database
 281 .\" or a call to .Fn krb5_config_set_string ,
 282 so a caller should make a local copy if its need to keep the database.
 283 .Pp
 284 .Fn krb5_config_free_strings
 285 free
 286 .Fa strings
 287 as returned by
 288 .Fn krb5_config_get_strings
 289 and
 290 .Fn krb5_config_vget_strings .
 291 If the argument
 292 .Fa strings
 293 is a
 294 .Dv NULL
 295 pointer, no action occurs.
 296 .Pp
 297 .Fn krb5_config_file_free
 298 free the result of
 299 .Fn krb5_config_parse_file
 300 and
 301 .Fn krb5_config_parse_file_multi .
 302 .Sh SEE ALSO
 303 .Xr krb5_appdefault 3 ,
 304 .Xr krb5_init_context 3 ,
 305 .Xr krb5.conf 5
 306 .Sh BUGS
 307 For the default functions, other than for the string case, there's no
 308 way to tell whether there was a value specified or not.