lib/librpcsec_gss/rpc_gss_set_callback.3

   1 .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
   2 .\" Authors: Doug Rabson <dfr@rabson.org>
   3 .\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
   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 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .Dd January 26, 2010
  28 .Dt RPC_GSS_SET_CALLBACK 3
  29 .Os
  30 .Sh NAME
  31 .Nm rpc_gss_set_callback
  32 .Nd "Register a security context creation callback"
  33 .Sh LIBRARY
  34 .Lb librpcsec_gss
  35 .Sh SYNOPSIS
  36 .In rpc/rpcsec_gss.h
  37 .Ft bool_t
  38 .Fo (*callback)
  39 .Fa "struct svc_req *req"
  40 .Fa "gss_cred_id_t deleg"
  41 .Fa "gss_ctx_id_t gss_context"
  42 .Fa "rpc_gss_lock_t *lock"
  43 .Fa "void **cookie"
  44 .Fc
  45 .Ft bool_t
  46 .Fn rpc_gss_set_callback "rpc_gss_callback_t *cb"
  47 .Sh DESCRIPTION
  48 Register a function which will be called when new security contexts
  49 are created on a server.
  50 This function will be called on the first RPC request which uses that
  51 context and has the opportunity of rejecting the request (for instance
  52 after matching the request credentials to an access control list).
  53 To accept the new security context, the callback should return
  54 .Dv TRUE ,
  55 otherwise
  56 .Dv FALSE .
  57 If the callback accepts a context, it becomes responsible for the
  58 lifetime of the delegated client credentials (if any).
  59 .Pp
  60 It is also possible to 'lock' the values of service and quality of
  61 protection used by the context.
  62 If a context is locked, any subsequent requests which use different
  63 values for service and quality of protection will be rejected.
  64 .Sh PARAMETERS
  65 .Bl -tag
  66 .It cb
  67 A structure containing the RPC program and version for this callback
  68 and a function which will be called when new contexts are created for
  69 the given RPC program and version
  70 .It req
  71 The RPC request using the new context
  72 .It deleg
  73 GSS-API delegated credentials (if any)
  74 .It gss_context
  75 The GSS-API context
  76 .It lock
  77 A structure used to enforce a particular QOP and service. Set
  78 .Fa lock->locked
  79 to
  80 .Dv TRUE
  81 to lock the service and QOP values
  82 .It cookie
  83 The callback function may set
  84 .Fa *cookie
  85 to any pointer sized value.
  86 This value can be accessed during the lifetime of the context via
  87 .Fn rpc_gss_getcred .
  88 .El
  89 .Sh RETURN VALUES
  90 Returns
  91 .Dv TRUE
  92 if the callback was registered successfully or
  93 .Dv FALSE
  94 otherwise
  95 .Sh SEE ALSO
  96 .Xr rpc 3 ,
  97 .Xr gssapi 3 ,
  98 .Xr rpc_gss_getcred 3
  99 .Xr rpcset_gss 3
 100 .Sh HISTORY
 101 The
 102 .Nm
 103 function first appeared in
 104 .Fx 8.0 .
 105 .Sh AUTHORS
 106 This
 107 manual page was written by
 108 .An Doug Rabson Aq dfr@FreeBSD.org .
 109 .Sh BUGS
 110 There is no mechanism for informing a server when a security context
 111 has been deleted.
 112 This makes it difficult to allocate resources (e.g. to return via the
 113 callback's
 114 .Fa cookie
 115 argument).