The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/rpc/auth.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: auth.h,v 1.15 2000/06/02 22:57:55 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: @(#)auth.h 1.17 88/02/08 SMI
   31  *      from: @(#)auth.h        2.3 88/08/07 4.0 RPCSRC
   32  *      from: @(#)auth.h        1.43    98/02/02 SMI
   33  * $FreeBSD: stable/11/sys/rpc/auth.h 331722 2018-03-29 02:50:57Z eadler $
   34  */
   35 
   36 /*
   37  * auth.h, Authentication interface.
   38  *
   39  * Copyright (C) 1984, Sun Microsystems, Inc.
   40  *
   41  * The data structures are completely opaque to the client.  The client
   42  * is required to pass an AUTH * to routines that create rpc
   43  * "sessions".
   44  */
   45 
   46 #ifndef _RPC_AUTH_H
   47 #define _RPC_AUTH_H
   48 #include <rpc/xdr.h>
   49 #include <rpc/clnt_stat.h>
   50 #include <sys/cdefs.h>
   51 #include <sys/socket.h>
   52 
   53 #define MAX_AUTH_BYTES  400
   54 #define MAXNETNAMELEN   255     /* maximum length of network user's name */
   55 
   56 /*
   57  *  Client side authentication/security data
   58  */
   59 
   60 typedef struct sec_data {
   61         u_int   secmod;         /* security mode number e.g. in nfssec.conf */
   62         u_int   rpcflavor;      /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
   63         int     flags;          /* AUTH_F_xxx flags */
   64         caddr_t data;           /* opaque data per flavor */
   65 } sec_data_t;
   66 
   67 #ifdef _SYSCALL32_IMPL
   68 struct sec_data32 {
   69         uint32_t secmod;        /* security mode number e.g. in nfssec.conf */
   70         uint32_t rpcflavor;     /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
   71         int32_t flags;          /* AUTH_F_xxx flags */
   72         caddr32_t data;         /* opaque data per flavor */
   73 };
   74 #endif /* _SYSCALL32_IMPL */
   75 
   76 /*
   77  * AUTH_DES flavor specific data from sec_data opaque data field.
   78  * AUTH_KERB has the same structure.
   79  */
   80 typedef struct des_clnt_data {
   81         struct netbuf   syncaddr;       /* time sync addr */
   82         struct knetconfig *knconf;      /* knetconfig info that associated */
   83                                         /* with the syncaddr. */
   84         char            *netname;       /* server's netname */
   85         int             netnamelen;     /* server's netname len */
   86 } dh_k4_clntdata_t;
   87 
   88 #ifdef _SYSCALL32_IMPL
   89 struct des_clnt_data32 {
   90         struct netbuf32 syncaddr;       /* time sync addr */
   91         caddr32_t knconf;               /* knetconfig info that associated */
   92                                         /* with the syncaddr. */
   93         caddr32_t netname;              /* server's netname */
   94         int32_t netnamelen;             /* server's netname len */
   95 };
   96 #endif /* _SYSCALL32_IMPL */
   97 
   98 #ifdef KERBEROS
   99 /*
  100  * flavor specific data to hold the data for AUTH_DES/AUTH_KERB(v4)
  101  * in sec_data->data opaque field.
  102  */
  103 typedef struct krb4_svc_data {
  104         int             window;         /* window option value */
  105 } krb4_svcdata_t;
  106  
  107 typedef struct krb4_svc_data    des_svcdata_t;
  108 #endif /* KERBEROS */
  109 
  110 /*
  111  * authentication/security specific flags
  112  */
  113 #define AUTH_F_RPCTIMESYNC      0x001   /* use RPC to do time sync */
  114 #define AUTH_F_TRYNONE          0x002   /* allow fall back to AUTH_NONE */
  115 
  116 
  117 /*
  118  * Status returned from authentication check
  119  */
  120 enum auth_stat {
  121         AUTH_OK=0,
  122         /*
  123          * failed at remote end
  124          */
  125         AUTH_BADCRED=1,                 /* bogus credentials (seal broken) */
  126         AUTH_REJECTEDCRED=2,            /* client should begin new session */
  127         AUTH_BADVERF=3,                 /* bogus verifier (seal broken) */
  128         AUTH_REJECTEDVERF=4,            /* verifier expired or was replayed */
  129         AUTH_TOOWEAK=5,                 /* rejected due to security reasons */
  130         /*
  131          * failed locally
  132         */
  133         AUTH_INVALIDRESP=6,             /* bogus response verifier */
  134         AUTH_FAILED=7,                  /* some unknown reason */
  135 #ifdef KERBEROS
  136         /*
  137          * kerberos errors
  138          */
  139         ,
  140         AUTH_KERB_GENERIC = 8,          /* kerberos generic error */
  141         AUTH_TIMEEXPIRE = 9,            /* time of credential expired */
  142         AUTH_TKT_FILE = 10,             /* something wrong with ticket file */
  143         AUTH_DECODE = 11,                       /* can't decode authenticator */
  144         AUTH_NET_ADDR = 12,             /* wrong net address in ticket */
  145 #endif /* KERBEROS */
  146         /*
  147          * RPCSEC_GSS errors
  148          */
  149         RPCSEC_GSS_CREDPROBLEM = 13,
  150         RPCSEC_GSS_CTXPROBLEM = 14,
  151         RPCSEC_GSS_NODISPATCH = 0x8000000
  152 };
  153 
  154 union des_block {
  155         struct {
  156                 uint32_t high;
  157                 uint32_t low;
  158         } key;
  159         char c[8];
  160 };
  161 typedef union des_block des_block;
  162 __BEGIN_DECLS
  163 extern bool_t xdr_des_block(XDR *, des_block *);
  164 __END_DECLS
  165 
  166 /*
  167  * Authentication info.  Opaque to client.
  168  */
  169 struct opaque_auth {
  170         enum_t  oa_flavor;              /* flavor of auth */
  171         caddr_t oa_base;                /* address of more auth stuff */
  172         u_int   oa_length;              /* not to exceed MAX_AUTH_BYTES */
  173 };
  174 
  175 
  176 /*
  177  * Auth handle, interface to client side authenticators.
  178  */
  179 struct rpc_err;
  180 typedef struct __auth {
  181         struct  opaque_auth     ah_cred;
  182         struct  opaque_auth     ah_verf;
  183         union   des_block       ah_key;
  184         struct auth_ops {
  185                 void    (*ah_nextverf) (struct __auth *);
  186                 /* nextverf & serialize */
  187                 int     (*ah_marshal) (struct __auth *, uint32_t, XDR *,
  188                     struct mbuf *);
  189                 /* validate verifier */
  190                 int     (*ah_validate) (struct __auth *, uint32_t,
  191                     struct opaque_auth *, struct mbuf **);
  192                 /* refresh credentials */
  193                 int     (*ah_refresh) (struct __auth *, void *);
  194                 /* destroy this structure */
  195                 void    (*ah_destroy) (struct __auth *);
  196         } *ah_ops;
  197         void *ah_private;
  198 } AUTH;
  199 
  200 
  201 /*
  202  * Authentication ops.
  203  * The ops and the auth handle provide the interface to the authenticators.
  204  *
  205  * AUTH *auth;
  206  * XDR  *xdrs;
  207  * struct opaque_auth verf;
  208  */
  209 #define AUTH_NEXTVERF(auth)             \
  210                 ((*((auth)->ah_ops->ah_nextverf))(auth))
  211 
  212 #define AUTH_MARSHALL(auth, xid, xdrs, args)    \
  213                 ((*((auth)->ah_ops->ah_marshal))(auth, xid, xdrs, args))
  214 
  215 #define AUTH_VALIDATE(auth, xid, verfp, resultsp) \
  216                 ((*((auth)->ah_ops->ah_validate))((auth), xid, verfp, resultsp))
  217 
  218 #define AUTH_REFRESH(auth, msg)         \
  219                 ((*((auth)->ah_ops->ah_refresh))(auth, msg))
  220 
  221 #define AUTH_DESTROY(auth)              \
  222                 ((*((auth)->ah_ops->ah_destroy))(auth))
  223 
  224 __BEGIN_DECLS
  225 extern struct opaque_auth _null_auth;
  226 __END_DECLS
  227 
  228 /*
  229  * These are the various implementations of client side authenticators.
  230  */
  231 
  232 /*
  233  * System style authentication
  234  * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
  235  *      char *machname;
  236  *      u_int uid;
  237  *      u_int gid;
  238  *      int len;
  239  *      u_int *aup_gids;
  240  */
  241 __BEGIN_DECLS
  242 #ifdef _KERNEL
  243 struct ucred;
  244 extern AUTH *authunix_create(struct ucred *);
  245 #else
  246 extern AUTH *authunix_create(char *, u_int, u_int, int, u_int *);
  247 extern AUTH *authunix_create_default(void);     /* takes no parameters */
  248 #endif
  249 extern AUTH *authnone_create(void);             /* takes no parameters */
  250 __END_DECLS
  251 /*
  252  * DES style authentication
  253  * AUTH *authsecdes_create(servername, window, timehost, ckey)
  254  *      char *servername;               - network name of server
  255  *      u_int window;                   - time to live
  256  *      const char *timehost;                   - optional hostname to sync with
  257  *      des_block *ckey;                - optional conversation key to use
  258  */
  259 __BEGIN_DECLS
  260 extern AUTH *authdes_create (char *, u_int, struct sockaddr *, des_block *);
  261 extern AUTH *authdes_seccreate (const char *, const u_int, const  char *,
  262     const  des_block *);
  263 __END_DECLS
  264 
  265 __BEGIN_DECLS
  266 extern bool_t xdr_opaque_auth           (XDR *, struct opaque_auth *);
  267 __END_DECLS
  268 
  269 #define authsys_create(c,i1,i2,i3,ip) authunix_create((c),(i1),(i2),(i3),(ip))
  270 #define authsys_create_default() authunix_create_default()
  271 
  272 /*
  273  * Netname manipulation routines.
  274  */
  275 __BEGIN_DECLS
  276 extern int getnetname(char *);
  277 extern int host2netname(char *, const char *, const char *);
  278 extern int user2netname(char *, const uid_t, const char *);
  279 extern int netname2user(char *, uid_t *, gid_t *, int *, gid_t *);
  280 extern int netname2host(char *, char *, const int);
  281 extern void passwd2des ( char *, char * );
  282 __END_DECLS
  283 
  284 /*
  285  *
  286  * These routines interface to the keyserv daemon
  287  *
  288  */
  289 __BEGIN_DECLS
  290 extern int key_decryptsession(const char *, des_block *);
  291 extern int key_encryptsession(const char *, des_block *);
  292 extern int key_gendes(des_block *);
  293 extern int key_setsecret(const char *);
  294 extern int key_secretkey_is_set(void);
  295 __END_DECLS
  296 
  297 /*
  298  * Publickey routines.
  299  */
  300 __BEGIN_DECLS
  301 extern int getpublickey (const char *, char *);
  302 extern int getpublicandprivatekey (const char *, char *);
  303 extern int getsecretkey (char *, char *, char *);
  304 __END_DECLS
  305 
  306 #ifdef KERBEROS
  307 /*
  308  * Kerberos style authentication
  309  * AUTH *authkerb_seccreate(service, srv_inst, realm, window, timehost, status)
  310  *      const char *service;                    - service name
  311  *      const char *srv_inst;                   - server instance
  312  *      const char *realm;                      - server realm
  313  *      const u_int window;                     - time to live
  314  *      const char *timehost;                   - optional hostname to sync with
  315  *      int *status;                            - kerberos status returned
  316  */
  317 __BEGIN_DECLS
  318 extern AUTH     *authkerb_seccreate(const char *, const char *, const  char *,
  319                     const u_int, const char *, int *);
  320 __END_DECLS
  321 
  322 /*
  323  * Map a kerberos credential into a unix cred.
  324  *
  325  *      authkerb_getucred(rqst, uid, gid, grouplen, groups)
  326  *      const struct svc_req *rqst;             - request pointer
  327  *      uid_t *uid;
  328  *      gid_t *gid;
  329  *      short *grouplen;
  330  *      int *groups;
  331  *
  332  */
  333 __BEGIN_DECLS
  334 extern int      authkerb_getucred(/* struct svc_req *, uid_t *, gid_t *,
  335                     short *, int * */);
  336 __END_DECLS
  337 #endif /* KERBEROS */
  338 
  339 __BEGIN_DECLS
  340 struct svc_req;
  341 struct rpc_msg;
  342 enum auth_stat _svcauth_null (struct svc_req *, struct rpc_msg *);
  343 enum auth_stat _svcauth_short (struct svc_req *, struct rpc_msg *);
  344 enum auth_stat _svcauth_unix (struct svc_req *, struct rpc_msg *);
  345 __END_DECLS
  346 
  347 #define AUTH_NONE       0               /* no authentication */
  348 #define AUTH_NULL       0               /* backward compatibility */
  349 #define AUTH_SYS        1               /* unix style (uid, gids) */
  350 #define AUTH_UNIX       AUTH_SYS
  351 #define AUTH_SHORT      2               /* short hand unix style */
  352 #define AUTH_DH         3               /* for Diffie-Hellman mechanism */
  353 #define AUTH_DES        AUTH_DH         /* for backward compatibility */
  354 #define AUTH_KERB       4               /* kerberos style */
  355 #define RPCSEC_GSS      6               /* RPCSEC_GSS */
  356 
  357 /*
  358  * Pseudo auth flavors for RPCSEC_GSS.
  359  */
  360 #define RPCSEC_GSS_KRB5         390003
  361 #define RPCSEC_GSS_KRB5I        390004
  362 #define RPCSEC_GSS_KRB5P        390005
  363 
  364 #endif /* !_RPC_AUTH_H */

Cache object: 8512c7b715295e34d9fe1170233838d1


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.