auth.h

Go to the documentation of this file.

/*
 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
 * unrestricted use provided that this legend is included on all tape
 * media and as a part of the software program in whole or part.  Users
 * may copy or modify Sun RPC without charge, but are not authorized
 * to license or distribute it to anyone else except as part of a product or
 * program developed by the user.
 *
 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
 * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
 *
 * Sun RPC is provided with no support and without any obligation on the
 * part of Sun Microsystems, Inc. to assist in its use, correction,
 * modification or enhancement.
 *
 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
 * OR ANY PART THEREOF.
 *
 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
 * or profits or other special, indirect and consequential damages, even if
 * Sun has been advised of the possibility of such damages.
 *
 * Sun Microsystems, Inc.
 * 2550 Garcia Avenue
 * Mountain View, California  94043
 *
 *      from: @(#)auth.h 1.17 88/02/08 SMI
 *      from: @(#)auth.h        2.3 88/08/07 4.0 RPCSRC
 * $FreeBSD: src/include/rpc/auth.h,v 1.15 1999/08/27 23:45:02 peter Exp $
 */

/*
 * 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
#include <sys/cdefs.h>
#include <sys/socket.h>
#include <rpc/xdr.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 */
        _AUTH_STAT = 0xffffffff
};

union des_block {
        struct {
                u_int32_t high;
                u_int32_t low;
        } key;
        char c[8];
};
typedef union des_block des_block;
__BEGIN_DECLS
extern bool_t xdr_des_block (XDR *, des_block *);
__END_DECLS

/*
 * 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 */
};
__BEGIN_DECLS
bool_t xdr_opaque_auth (XDR *xdrs, struct opaque_auth *ap);
__END_DECLS


/*
 * Auth handle, interface to client side authenticators.
 */
typedef struct __rpc_auth {
        struct  opaque_auth     ah_cred;
        struct  opaque_auth     ah_verf;
        union   des_block       ah_key;
        struct auth_ops {
                void    (*ah_nextverf) (struct __rpc_auth *);
                /* nextverf & serialize */
                int     (*ah_marshal) (struct __rpc_auth *, XDR *);
                /* validate verifier */
                int     (*ah_validate) (struct __rpc_auth *,
                                struct opaque_auth *);
                /* refresh credentials */
                int     (*ah_refresh) (struct __rpc_auth *);
                /* destroy this structure */
                void    (*ah_destroy) (struct __rpc_auth *);
        } *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;
 */
__BEGIN_DECLS
struct sockaddr_in;
extern AUTH *authunix_create            (char *, int, int, int, int *);
extern AUTH *authunix_create_default    (void);
extern AUTH *authnone_create            (void);
__END_DECLS

/* Forward compatibility with TI-RPC */
#define authsys_create authunix_create
#define authsys_create_default authunix_create_default

/*
 * DES style authentication
 * AUTH *authdes_create(servername, window, timehost, ckey)
 *      char *servername;               - network name of server
 *      u_int window;                   - time to live
 *      struct sockaddr *timehost;      - optional hostname to sync with
 *      des_block *ckey;                - optional conversation key to use
 */
__BEGIN_DECLS
extern AUTH *authdes_create ( char *, u_int, struct sockaddr *, des_block * );
#ifdef NOTYET
/*
 * TI-RPC supports this call, but it requires the inclusion of
 * NIS+-specific headers which would require the inclusion of other
 * headers which would result in a tangled mess. For now, the NIS+
 * code prototypes this routine internally.
 */
extern AUTH *authdes_pk_create ( char *, netobj *, u_int,
                                     struct sockaddr *, des_block *,
                                     nis_server * );
#endif
__END_DECLS

/*
 * Netname manipulation routines.
 */
__BEGIN_DECLS
extern int netname2user ( char *, uid_t *, gid_t *, int *, gid_t *);
extern int netname2host ( char *, char *, int );
extern int getnetname ( char * );
extern int user2netname ( char *, uid_t, char * );
extern int host2netname ( char *, char *, char * );
extern void passwd2des ( char *, char * );
__END_DECLS

/*
 * Keyserv interface routines.
 * XXX Should not be here.
 */
#ifndef HEXKEYBYTES
#define HEXKEYBYTES 48
#endif
typedef char kbuf[HEXKEYBYTES];
typedef char *namestr;

struct netstarg {
        kbuf st_priv_key;
        kbuf st_pub_key;
        namestr st_netname;
};

__BEGIN_DECLS
extern int key_decryptsession ( const char *, des_block * );
extern int key_decryptsession_pk ( char *, netobj *, des_block * );
extern int key_encryptsession ( const char *, des_block * );
extern int key_encryptsession_pk ( char *, netobj *, des_block * );
extern int key_gendes ( des_block * );
extern int key_setsecret ( const char * );
extern int key_secretkey_is_set ( void );
extern int key_setnet ( struct netstarg * );
extern int key_get_conv ( char *, des_block * );
__END_DECLS

/*
 * Publickey routines.
 */
__BEGIN_DECLS
extern int getpublickey ( char *, char * );
extern int getpublicandprivatekey ( char *, char * );
extern int getsecretkey ( char *, char *, char * );
__END_DECLS


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

#endif /* !_RPC_AUTH_H */