rpc.subproj/auth.h

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
   7  * Reserved.  This file contains Original Code and/or Modifications of
   8  * Original Code as defined in and that are subject to the Apple Public
   9  * Source License Version 1.1 (the "License").  You may not use this file
  10  * except in compliance with the License.  Please obtain a copy of the
  11  * License at http://www.apple.com/publicsource and read it before using
  12  * this file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
  19  * License for the specific language governing rights and limitations
  20  * under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24 /*
  25  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  26  * unrestricted use provided that this legend is included on all tape
  27  * media and as a part of the software program in whole or part.  Users
  28  * may copy or modify Sun RPC without charge, but are not authorized
  29  * to license or distribute it to anyone else except as part of a product or
  30  * program developed by the user.
  31  *
  32  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  33  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  34  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  35  *
  36  * Sun RPC is provided with no support and without any obligation on the
  37  * part of Sun Microsystems, Inc. to assist in its use, correction,
  38  * modification or enhancement.
  39  *
  40  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  41  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  42  * OR ANY PART THEREOF.
  43  *
  44  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  45  * or profits or other special, indirect and consequential damages, even if
  46  * Sun has been advised of the possibility of such damages.
  47  *
  48  * Sun Microsystems, Inc.
  49  * 2550 Garcia Avenue
  50  * Mountain View, California  94043
  51  *
  52  *      from: @(#)auth.h 1.17 88/02/08 SMI
  53  *      from: @(#)auth.h        2.3 88/08/07 4.0 RPCSRC
  54  *      $Id: auth.h,v 1.2 1999/10/14 21:56:52 wsanchez Exp $
  55  */
  56
  57 /*
  58  * auth.h, Authentication interface.
  59  *
  60  * Copyright (C) 1984, Sun Microsystems, Inc.
  61  *
  62  * The data structures are completely opaque to the client.  The client
  63  * is required to pass a AUTH * to routines that create rpc
  64  * "sessions".
  65  */
  66
  67 #ifndef _RPC_AUTH_H
  68 #define _RPC_AUTH_H
  69 #include <sys/cdefs.h>
  70
  71 #define MAX_AUTH_BYTES  400
  72 #define MAXNETNAMELEN   255     /* maximum length of network user's name */
  73
  74 /*
  75  * Status returned from authentication check
  76  */
  77 enum auth_stat {
  78         AUTH_OK=0,
  79         /*
  80          * failed at remote end
  81          */
  82         AUTH_BADCRED=1,                 /* bogus credentials (seal broken) */
  83         AUTH_REJECTEDCRED=2,            /* client should begin new session */
  84         AUTH_BADVERF=3,                 /* bogus verifier (seal broken) */
  85         AUTH_REJECTEDVERF=4,            /* verifier expired or was replayed */
  86         AUTH_TOOWEAK=5,                 /* rejected due to security reasons */
  87         /*
  88          * failed locally
  89         */
  90         AUTH_INVALIDRESP=6,             /* bogus response verifier */
  91         AUTH_FAILED=7                   /* some unknown reason */
  92 };
  93
  94 typedef u_long u_int32; /* 32-bit unsigned integers */
  95
  96 union des_block {
  97         struct {
  98                 u_int32 high;
  99                 u_int32 low;
 100         } key;
 101         char c[8];
 102 };
 103 typedef union des_block des_block;
 104 __BEGIN_DECLS
 105 extern bool_t xdr_des_block __P((XDR *, des_block *));
 106 __END_DECLS
 107
 108 /*
 109  * Authentication info.  Opaque to client.
 110  */
 111 struct opaque_auth {
 112         enum_t  oa_flavor;              /* flavor of auth */
 113         caddr_t oa_base;                /* address of more auth stuff */
 114         u_int   oa_length;              /* not to exceed MAX_AUTH_BYTES */
 115 };
 116
 117
 118 /*
 119  * Auth handle, interface to client side authenticators.
 120  */
 121 typedef struct {
 122         struct  opaque_auth     ah_cred;
 123         struct  opaque_auth     ah_verf;
 124         union   des_block       ah_key;
 125         struct auth_ops {
 126                 void    (*ah_nextverf)();
 127                 int     (*ah_marshal)();        /* nextverf & serialize */
 128                 int     (*ah_validate)();       /* validate varifier */
 129                 int     (*ah_refresh)();        /* refresh credentials */
 130                 void    (*ah_destroy)();        /* destroy this structure */
 131         } *ah_ops;
 132         caddr_t ah_private;
 133 } AUTH;
 134
 135
 136 /*
 137  * Authentication ops.
 138  * The ops and the auth handle provide the interface to the authenticators.
 139  *
 140  * AUTH *auth;
 141  * XDR  *xdrs;
 142  * struct opaque_auth verf;
 143  */
 144 #define AUTH_NEXTVERF(auth)             \
 145                 ((*((auth)->ah_ops->ah_nextverf))(auth))
 146 #define auth_nextverf(auth)             \
 147                 ((*((auth)->ah_ops->ah_nextverf))(auth))
 148
 149 #define AUTH_MARSHALL(auth, xdrs)       \
 150                 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
 151 #define auth_marshall(auth, xdrs)       \
 152                 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
 153
 154 #define AUTH_VALIDATE(auth, verfp)      \
 155                 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
 156 #define auth_validate(auth, verfp)      \
 157                 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
 158
 159 #define AUTH_REFRESH(auth)              \
 160                 ((*((auth)->ah_ops->ah_refresh))(auth))
 161 #define auth_refresh(auth)              \
 162                 ((*((auth)->ah_ops->ah_refresh))(auth))
 163
 164 #define AUTH_DESTROY(auth)              \
 165                 ((*((auth)->ah_ops->ah_destroy))(auth))
 166 #define auth_destroy(auth)              \
 167                 ((*((auth)->ah_ops->ah_destroy))(auth))
 168
 169
 170 extern struct opaque_auth _null_auth;
 171
 172
 173 /*
 174  * These are the various implementations of client side authenticators.
 175  */
 176
 177 /*
 178  * Unix style authentication
 179  * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
 180  *      char *machname;
 181  *      int uid;
 182  *      int gid;
 183  *      int len;
 184  *      int *aup_gids;
 185  */
 186 __BEGIN_DECLS
 187 extern AUTH *authunix_create            __P((char *, int, int, int, int *));
 188 extern AUTH *authunix_create_default    __P((void));
 189 extern AUTH *authnone_create            __P((void));
 190 extern AUTH *authdes_create             __P((char *, u_int,
 191                                              struct sockaddr_in *,
 192                                              des_block *));
 193 __END_DECLS
 194
 195 #define AUTH_NONE       0               /* no authentication */
 196 #define AUTH_NULL       0               /* backward compatibility */
 197 #define AUTH_UNIX       1               /* unix style (uid, gids) */
 198 #define AUTH_SHORT      2               /* short hand unix style */
 199 #define AUTH_DES        3               /* des style (encrypted timestamps) */
 200
 201 #endif /* !_RPC_AUTH_H */