sys/rpc/svc_auth.h

   1 /*      $NetBSD: svc_auth.h,v 1.8 2000/06/02 22:57:57 fvdl Exp $        */
   2
   3 /*-
   4  * Copyright (c) 2009, Sun Microsystems, Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  * - Redistributions of source code must retain the above copyright notice,
  10  *   this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright notice,
  12  *   this list of conditions and the following disclaimer in the documentation
  13  *   and/or other materials provided with the distribution.
  14  * - Neither the name of Sun Microsystems, Inc. nor the names of its
  15  *   contributors may be used to endorse or promote products derived
  16  *   from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  *      from: @(#)svc_auth.h 1.6 86/07/16 SMI
  31  *      @(#)svc_auth.h  2.1 88/07/29 4.0 RPCSRC
  32  * $FreeBSD$
  33  */
  34
  35 /*
  36  * svc_auth.h, Service side of rpc authentication.
  37  *
  38  * Copyright (C) 1984, Sun Microsystems, Inc.
  39  */
  40
  41 #ifndef _RPC_SVC_AUTH_H
  42 #define _RPC_SVC_AUTH_H
  43
  44 /*
  45  * Server side authenticator
  46  */
  47 __BEGIN_DECLS
  48 extern enum auth_stat _authenticate(struct svc_req *, struct rpc_msg *);
  49 #ifdef _KERNEL
  50 extern int svc_auth_reg(int,
  51     enum auth_stat (*)(struct svc_req *, struct rpc_msg *),
  52     int (*)(struct svc_req *, struct ucred **, int *));
  53 #else
  54 extern int svc_auth_reg(int, enum auth_stat (*)(struct svc_req *,
  55                           struct rpc_msg *));
  56 #endif
  57
  58
  59 extern int svc_getcred(struct svc_req *, struct ucred **, int *);
  60 /*
  61  * struct svc_req *req;                 -- RPC request
  62  * struct ucred **crp                   -- Kernel cred to modify
  63  * int *flavorp                         -- Return RPC auth flavor
  64  *
  65  * Retrieve unix creds corresponding to an RPC request, if
  66  * possible. The auth flavor (AUTH_NONE or AUTH_UNIX) is returned in
  67  * *flavorp. If the flavor is AUTH_UNIX the caller's ucred pointer
  68  * will be modified to point at a ucred structure which reflects the
  69  * values from the request. The caller should call crfree on this
  70  * pointer.
  71  *
  72  * Return's non-zero if credentials were retrieved from the request,
  73  * otherwise zero.
  74  */
  75
  76 __END_DECLS
  77
  78 #endif /* !_RPC_SVC_AUTH_H */