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

   1 .\" Copyright (c) 2004, 2006 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 .\" $Heimdal: krb5_acl_match_file.3 17534 2006-05-11 22:43:44Z lha $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd May 12, 2006
  36 .Dt KRB5_ACL_MATCH_FILE 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_acl_match_file ,
  40 .Nm krb5_acl_match_string
  41 .Nd ACL matching functions
  42 .Sh LIBRARY
  43 Kerberos 5 Library (libkrb5, -lkrb5)
  44 .Sh SYNOPSIS
  45 .Ft krb5_error_code
  46 .Fo krb5_acl_match_file
  47 .Fa "krb5_context context"
  48 .Fa "const char *file"
  49 .Fa "const char *format"
  50 .Fa "..."
  51 .Fc
  52 .Ft krb5_error_code
  53 .Fo krb5_acl_match_string
  54 .Fa "krb5_context context"
  55 .Fa "const char *string"
  56 .Fa "const char *format"
  57 .Fa "..."
  58 .Fc
  59 .Sh DESCRIPTION
  60 .Nm krb5_acl_match_file
  61 matches ACL format against each line in a file.
  62 Lines starting with # are treated like comments and ignored.
  63 .Pp
  64 .Nm krb5_acl_match_string
  65 matches ACL format against a string.
  66 .Pp
  67 The ACL format has three format specifiers: s, f, and r.
  68 Each specifier will retrieve one argument from the variable arguments
  69 for either matching or storing data.
  70 The input string is split up using " " and "\et" as a delimiter; multiple
  71 " " and "\et" in a row are considered to be the same.
  72 .Pp
  73 .Bl -tag -width "fXX" -offset indent
  74 .It s
  75 Matches a string using
  76 .Xr strcmp 3
  77 (case sensitive).
  78 .It f
  79 Matches the string with
  80 .Xr fnmatch 3 .
  81 The
  82 .Fa flags
  83 argument (the last argument) passed to the fnmatch function is 0.
  84 .It r
  85 Returns a copy of the string in the char ** passed in; the copy must be
  86 freed with
  87 .Xr free 3 .
  88 There is no need to
  89 .Xr free 3
  90 the string on error: the function will clean up and set the pointer to
  91 .Dv NULL .
  92 .El
  93 .Pp
  94 All unknown format specifiers cause an error.
  95 .Sh EXAMPLES
  96 .Bd -literal -offset indent
  97 char *s;
  98
  99 ret = krb5_acl_match_string(context, "foo", "s", "foo");
 100 if (ret)
 101     krb5_errx(context, 1, "acl didn't match");
 102 ret = krb5_acl_match_string(context, "foo foo baz/kaka",
 103     "ss", "foo", &s, "foo/*");
 104 if (ret) {
 105     /* no need to free(s) on error */
 106     assert(s == NULL);
 107     krb5_errx(context, 1, "acl didn't match");
 108 }
 109 free(s);
 110 .Ed
 111 .Sh SEE ALSO
 112 .Xr krb5 3