include/rpc/auth.h

	auth.h revision 7c478bd95313f5f23a4c958a745db2134aa03244
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
#pragma ident   "%Z%%M% %I% %E% SMI"

/*
 * auth.h, Authentication interface.
 *
 * Copyright (C) 1984, Sun Microsystems, Inc.
 *
 * The data structures are completely opaque to the client.  The client
 * is required to pass a AUTH * to routines that create rpc
 * "sessions".
 */


#ifndef _rpc_auth_h
#define _rpc_auth_h

#define MAX_AUTH_BYTES  400
#define MAXNETNAMELEN   255 /* maximum length of network user's name */

/*
 * Status returned from authentication check
 */
enum auth_stat {
    AUTH_OK=0,
    /*
     * failed at remote end
     */
    AUTH_BADCRED=1,         /* bogus credentials (seal broken) */
    AUTH_REJECTEDCRED=2,        /* client should begin new session */
    AUTH_BADVERF=3,         /* bogus verifier (seal broken) */
    AUTH_REJECTEDVERF=4,        /* verifier expired or was replayed */
    AUTH_TOOWEAK=5,         /* rejected due to security reasons */
    /*
     * failed locally
    */
    AUTH_INVALIDRESP=6,     /* bogus response verifier */
    AUTH_FAILED=7           /* some unknown reason */
};

#if (mc68000 || sparc || vax || i386)
typedef u_long u_int32; /* 32-bit unsigned integers */
#endif

union des_block {
    struct {
        u_int32 high;
        u_int32 low;
    } key;
    char c[8];
};
typedef union des_block des_block;
extern bool_t xdr_des_block();

/*
 * Authentication info.  Opaque to client.
 */
struct opaque_auth {
    enum_t  oa_flavor;      /* flavor of auth */
    caddr_t oa_base;        /* address of more auth stuff */
    u_int   oa_length;      /* not to exceed MAX_AUTH_BYTES */
};


/*
 * Auth handle, interface to client side authenticators.
 */
typedef struct {
    struct  opaque_auth ah_cred;
    struct  opaque_auth ah_verf;
    union   des_block   ah_key;
    struct auth_ops {
        void    (*ah_nextverf)();
        int (*ah_marshal)();    /* nextverf & serialize */
        int (*ah_validate)();   /* validate varifier */
        int (*ah_refresh)();    /* refresh credentials */
        void    (*ah_destroy)();    /* destroy this structure */
    } *ah_ops;
    caddr_t ah_private;
} AUTH;


/*
 * Authentication ops.
 * The ops and the auth handle provide the interface to the authenticators.
 *
 * AUTH *auth;
 * XDR  *xdrs;
 * struct opaque_auth verf;
 */
#define AUTH_NEXTVERF(auth)     \
        ((*((auth)->ah_ops->ah_nextverf))(auth))
#define auth_nextverf(auth)     \
        ((*((auth)->ah_ops->ah_nextverf))(auth))

#define AUTH_MARSHALL(auth, xdrs)   \
        ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
#define auth_marshall(auth, xdrs)   \
        ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))

#define AUTH_VALIDATE(auth, verfp)  \
        ((*((auth)->ah_ops->ah_validate))((auth), verfp))
#define auth_validate(auth, verfp)  \
        ((*((auth)->ah_ops->ah_validate))((auth), verfp))

#define AUTH_REFRESH(auth)      \
        ((*((auth)->ah_ops->ah_refresh))(auth))
#define auth_refresh(auth)      \
        ((*((auth)->ah_ops->ah_refresh))(auth))

#define AUTH_DESTROY(auth)      \
        ((*((auth)->ah_ops->ah_destroy))(auth))
#define auth_destroy(auth)      \
        ((*((auth)->ah_ops->ah_destroy))(auth))


extern struct opaque_auth _null_auth;


/*
 * These are the various implementations of client side authenticators.
 */

/*
 * Unix style authentication
 * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
 *  char *machname;
 *  int uid;
 *  int gid;
 *  int len;
 *  int *aup_gids;
 */
#ifdef KERNEL
extern AUTH *authkern_create();     /* takes no parameters */
#else
extern AUTH *authsys_create(const char *, const uid_t, const gid_t,
    const int, const gid_t *);
extern AUTH *authsys_create_default(void);  /* takes no parameters */
extern AUTH *authnone_create();     /* takes no parameters */
#endif
extern AUTH *authdes_create();

#define AUTH_NONE   0       /* no authentication */
#define AUTH_NULL   0       /* backward compatibility */
#define AUTH_UNIX   1       /* unix style (uid, gids) */
#define AUTH_SHORT  2       /* short hand unix style */
#define AUTH_DES    3       /* des style (encrypted timestamps) */

#endif /* !_rpc_auth_h */