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-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: f12b79ae47a42e338f435a32925f8dd1


[ 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.