/*      $NetBSD: rpc_prot.c,v 1.21 2013/03/11 20:19:29 tron Exp $       */

/*
* Copyright (c) 2010, Oracle America, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*     * Neither the name of the "Oracle America, Inc." nor the names of its
*       contributors may be used to endorse or promote products derived
*       from this software without specific prior written permission.
*
*   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
*   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
*   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
*   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
*   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
*   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
*   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
*   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
*   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#include <sys/cdefs.h>
#if defined(LIBC_SCCS) && !defined(lint)
#if 0
static char *sccsid = "@(#)rpc_prot.c 1.36 87/08/11 Copyr 1984 Sun Micro";
static char *sccsid = "@(#)rpc_prot.c   2.3 88/08/07 4.0 RPCSRC";
#else
__RCSID("$NetBSD: rpc_prot.c,v 1.21 2013/03/11 20:19:29 tron Exp $");
#endif
#endif

/*
* rpc_prot.c
*
* Copyright (C) 1984, Sun Microsystems, Inc.
*
* This set of routines implements the rpc message definition,
* its serializer and some common rpc utility routines.
* The routines are meant for various implementations of rpc -
* they are NOT for the rpc client or rpc service implementations!
* Because authentication stuff is easy and is part of rpc, the opaque
* routines are also in this program.
*/

#include "namespace.h"

#include <sys/param.h>

#include <assert.h>

#include <rpc/rpc.h>

#ifdef __weak_alias
__weak_alias(xdr_accepted_reply,_xdr_accepted_reply)
__weak_alias(xdr_callhdr,_xdr_callhdr)
__weak_alias(xdr_des_block,_xdr_des_block)
__weak_alias(xdr_opaque_auth,_xdr_opaque_auth)
__weak_alias(xdr_rejected_reply,_xdr_rejected_reply)
__weak_alias(xdr_replymsg,_xdr_replymsg)
#endif

static void accepted(enum accept_stat, struct rpc_err *);
static void rejected(enum reject_stat, struct rpc_err *);

/* * * * * * * * * * * * * * XDR Authentication * * * * * * * * * * * */

/*
* XDR an opaque authentication struct
* (see auth.h)
*/
bool_t
xdr_opaque_auth(XDR *xdrs, struct opaque_auth *ap)
{

       _DIAGASSERT(xdrs != NULL);
       _DIAGASSERT(ap != NULL);

       if (xdr_enum(xdrs, &(ap->oa_flavor)))
               return (xdr_bytes(xdrs, &ap->oa_base,
                       &ap->oa_length, MAX_AUTH_BYTES));
       return (FALSE);
}

/*
* XDR a DES block
*/
bool_t
xdr_des_block(XDR *xdrs, des_block *blkp)
{

       _DIAGASSERT(xdrs != NULL);
       _DIAGASSERT(blkp != NULL);

       return (xdr_opaque(xdrs, (caddr_t)(void *)blkp,
           (u_int)sizeof(des_block)));
}

/* * * * * * * * * * * * * * XDR RPC MESSAGE * * * * * * * * * * * * * * * */

/*
* XDR the MSG_ACCEPTED part of a reply message union
*/
bool_t
xdr_accepted_reply(XDR *xdrs, struct accepted_reply *ar)
{

       _DIAGASSERT(xdrs != NULL);
       _DIAGASSERT(ar != NULL);

       /* personalized union, rather than calling xdr_union */
       if (! xdr_opaque_auth(xdrs, &(ar->ar_verf)))
               return (FALSE);
       if (! xdr_enum(xdrs, (enum_t *)(void *)&(ar->ar_stat)))
               return (FALSE);
       switch (ar->ar_stat) {

       case SUCCESS:
               return ((*(ar->ar_results.proc))(xdrs, ar->ar_results.where));

       case PROG_MISMATCH:
               if (! xdr_u_int32_t(xdrs, &(ar->ar_vers.low)))
                       return (FALSE);
               return (xdr_u_int32_t(xdrs, &(ar->ar_vers.high)));

       case GARBAGE_ARGS:
       case SYSTEM_ERR:
       case PROC_UNAVAIL:
       case PROG_UNAVAIL:
               break;
       }
       return (TRUE);  /* TRUE => open ended set of problems */
}

/*
* XDR the MSG_DENIED part of a reply message union
*/
bool_t
xdr_rejected_reply(XDR *xdrs, struct rejected_reply *rr)
{

       _DIAGASSERT(xdrs != NULL);
       _DIAGASSERT(rr != NULL);

       /* personalized union, rather than calling xdr_union */
       if (! xdr_enum(xdrs, (enum_t *)(void *)&(rr->rj_stat)))
               return (FALSE);
       switch (rr->rj_stat) {

       case RPC_MISMATCH:
               if (! xdr_u_int32_t(xdrs, &(rr->rj_vers.low)))
                       return (FALSE);
               return (xdr_u_int32_t(xdrs, &(rr->rj_vers.high)));

       case AUTH_ERROR:
               return (xdr_enum(xdrs, (enum_t *)(void *)&(rr->rj_why)));
       }
       /* NOTREACHED */
       return (FALSE);
}

static const struct xdr_discrim reply_dscrm[3] = {
       { (int)MSG_ACCEPTED, (xdrproc_t)xdr_accepted_reply },
       { (int)MSG_DENIED, (xdrproc_t)xdr_rejected_reply },
       { __dontcare__, NULL_xdrproc_t } };

/*
* XDR a reply message
*/
bool_t
xdr_replymsg(XDR *xdrs, struct rpc_msg *rmsg)
{
       _DIAGASSERT(xdrs != NULL);
       _DIAGASSERT(rmsg != NULL);

       if (
           xdr_u_int32_t(xdrs, &(rmsg->rm_xid)) &&
           xdr_enum(xdrs, (enum_t *)(void *)&(rmsg->rm_direction)) &&
           (rmsg->rm_direction == REPLY) )
               return (xdr_union(xdrs, (enum_t *)(void *)&(rmsg->rm_reply.rp_stat),
                  (caddr_t)(void *)&(rmsg->rm_reply.ru), reply_dscrm,
                  NULL_xdrproc_t));
       return (FALSE);
}


/*
* Serializes the "static part" of a call message header.
* The fields include: rm_xid, rm_direction, rpcvers, prog, and vers.
* The rm_xid is not really static, but the user can easily munge on the fly.
*/
bool_t
xdr_callhdr(XDR *xdrs, struct rpc_msg *cmsg)
{

       _DIAGASSERT(xdrs != NULL);
       _DIAGASSERT(cmsg != NULL);

       cmsg->rm_direction = CALL;
       cmsg->rm_call.cb_rpcvers = RPC_MSG_VERSION;
       if (
           (xdrs->x_op == XDR_ENCODE) &&
           xdr_u_int32_t(xdrs, &(cmsg->rm_xid)) &&
           xdr_enum(xdrs, (enum_t *)(void *)&(cmsg->rm_direction)) &&
           xdr_u_int32_t(xdrs, &(cmsg->rm_call.cb_rpcvers)) &&
           xdr_u_int32_t(xdrs, &(cmsg->rm_call.cb_prog)) )
               return (xdr_u_int32_t(xdrs, &(cmsg->rm_call.cb_vers)));
       return (FALSE);
}

/* ************************** Client utility routine ************* */

static void
accepted(enum accept_stat acpt_stat, struct rpc_err *error)
{

       _DIAGASSERT(error != NULL);

       switch (acpt_stat) {

       case PROG_UNAVAIL:
               error->re_status = RPC_PROGUNAVAIL;
               return;

       case PROG_MISMATCH:
               error->re_status = RPC_PROGVERSMISMATCH;
               return;

       case PROC_UNAVAIL:
               error->re_status = RPC_PROCUNAVAIL;
               return;

       case GARBAGE_ARGS:
               error->re_status = RPC_CANTDECODEARGS;
               return;

       case SYSTEM_ERR:
               error->re_status = RPC_SYSTEMERROR;
               return;

       case SUCCESS:
               error->re_status = RPC_SUCCESS;
               return;
       }
       /* NOTREACHED */
       /* something's wrong, but we don't know what ... */
       error->re_status = RPC_FAILED;
       error->re_lb.s1 = (int32_t)MSG_ACCEPTED;
       error->re_lb.s2 = (int32_t)acpt_stat;
}

static void
rejected(enum reject_stat rjct_stat, struct rpc_err *error)
{

       _DIAGASSERT(error != NULL);

       switch (rjct_stat) {
       case RPC_MISMATCH:
               error->re_status = RPC_VERSMISMATCH;
               return;

       case AUTH_ERROR:
               error->re_status = RPC_AUTHERROR;
               return;
       }
       /* something's wrong, but we don't know what ... */
       /* NOTREACHED */
       error->re_status = RPC_FAILED;
       error->re_lb.s1 = (int32_t)MSG_DENIED;
       error->re_lb.s2 = (int32_t)rjct_stat;
}

/*
* given a reply message, fills in the error
*/
void
_seterr_reply(struct rpc_msg *msg, struct rpc_err *error)
{

       _DIAGASSERT(msg != NULL);
       _DIAGASSERT(error != NULL);

       /* optimized for normal, SUCCESSful case */
       switch (msg->rm_reply.rp_stat) {

       case MSG_ACCEPTED:
               if (msg->acpted_rply.ar_stat == SUCCESS) {
                       error->re_status = RPC_SUCCESS;
                       return;
               }
               accepted(msg->acpted_rply.ar_stat, error);
               break;

       case MSG_DENIED:
               rejected(msg->rjcted_rply.rj_stat, error);
               break;

       default:
               error->re_status = RPC_FAILED;
               error->re_lb.s1 = (int32_t)(msg->rm_reply.rp_stat);
               break;
       }
       switch (error->re_status) {

       case RPC_VERSMISMATCH:
               error->re_vers.low = msg->rjcted_rply.rj_vers.low;
               error->re_vers.high = msg->rjcted_rply.rj_vers.high;
               break;

       case RPC_AUTHERROR:
               error->re_why = msg->rjcted_rply.rj_why;
               break;

       case RPC_PROGVERSMISMATCH:
               error->re_vers.low = msg->acpted_rply.ar_vers.low;
               error->re_vers.high = msg->acpted_rply.ar_vers.high;
               break;

       case RPC_FAILED:
       case RPC_SUCCESS:
       case RPC_PROGNOTREGISTERED:
       case RPC_PMAPFAILURE:
       case RPC_UNKNOWNPROTO:
       case RPC_UNKNOWNHOST:
       case RPC_SYSTEMERROR:
       case RPC_CANTDECODEARGS:
       case RPC_PROCUNAVAIL:
       case RPC_PROGUNAVAIL:
       case RPC_TIMEDOUT:
       case RPC_CANTRECV:
       case RPC_CANTSEND:
       case RPC_CANTDECODERES:
       case RPC_CANTENCODEARGS:
       default:
               break;
       }
}