sys/rpc/svc_auth.h

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