def pack_reply(xid, *args):
"""Packs an RPC reply from a variable-length arg list (args):
MSG_ACCEPTED, verf, (SUCCESS | PROG_MISMATCH, low, hi | PROG_UNAVAIL
| PROC_UNAVAIL | GARBAGE_ARGS | SYSTEM_ERR)
MSG_DENIED, (RPC_MISMATCH, hi, low | AUTH_ERROR, auth_stat)
verf is an auth of the form (flavor, value)
Returns an xdrlib.Packer that the caller can use to add data,
such as the results of a SUCCESSful call.
"""
arg = list(args) # need a mutable list for pop()
msg = RPCProto.rpc_msg()
msg.xid = xid
msg.body = RPCProto.body_t()
msg.body.mtype = RPCProto.REPLY
msg.body.rbody = reply = RPCProto.reply_body()
reply.stat = reply_stat = arg.pop(0)
if reply_stat == MSG_ACCEPTED:
reply.areply = RPCProto.accepted_reply()
reply.areply.verf = verf = arg.pop(0)
reply.areply.reply_data = RPCProto.reply_data_t()
reply.areply.reply_data.stat = accept_stat = arg.pop(0)
if accept_stat == PROG_MISMATCH:
reply.areply.reply_data.mismatch_info = RPCProto.mismatch_info_t()
reply.areply.reply_data.mismatch_info.low = arg.pop(0)
reply.areply.reply_data.mismatch_info.high = arg.pop(0)
elif (accept_stat == SUCCESS):
reply.areply.reply_data.results = '' # FIXME?
elif (accept_stat == PROG_UNAVAIL or
accept_stat == PROC_UNAVAIL or
accept_stat == GARBAGE_ARGS or
accept_stat == SYSTEM_ERR):
pass
else:
raise ValueError("unknown accept_stat: %u" % accept_stat)
elif reply_stat == MSG_DENIED:
reply.rreply = RPCProto.rejected_reply()
reply.rreply.stat = reject_stat = arg.pop(0)
if reject_stat == RPC_MISMATCH:
reply.rreply.mismatch_info.low = RPCProto.mismatch_info_t()
reply.rreply.mismatch_info.low = arg.pop(0)
reply.rreply.mismatch_info.high = arg.pop(0)
elif reject_stat == AUTH_ERROR:
reply.rreply.astat = arg.pop(0)
else:
raise ValueError("unknown reject_stat: %u" % reject_stat)
else:
raise ValueError("unknown reply_stat: %u" % reply_stat)
p = Packer()
RPCProto.pack_rpc_msg(p, msg)
return p
def pack_reply(xid, *args):
"""Packs an RPC reply from a variable-length arg list (args):
MSG_ACCEPTED, verf, (SUCCESS | PROG_MISMATCH, low, hi | PROG_UNAVAIL
| PROC_UNAVAIL | GARBAGE_ARGS | SYSTEM_ERR)
MSG_DENIED, (RPC_MISMATCH, hi, low | AUTH_ERROR, auth_stat)
verf is an auth of the form (flavor, value)
Returns an xdrlib.Packer that the caller can use to add data,
such as the results of a SUCCESSful call.
"""
arg = list(args) # need a mutable list for pop()
msg = RPCProto.rpc_msg()
msg.xid = xid
msg.body = RPCProto.body_t()
msg.body.mtype = RPCProto.REPLY
msg.body.rbody = reply = RPCProto.reply_body()
reply.stat = reply_stat = arg.pop(0)
if reply_stat == MSG_ACCEPTED:
reply.areply = RPCProto.accepted_reply()
reply.areply.verf = verf = arg.pop(0)
reply.areply.reply_data = RPCProto.reply_data_t()
reply.areply.reply_data.stat = accept_stat = arg.pop(0)
if accept_stat == PROG_MISMATCH:
reply.areply.reply_data.mismatch_info = RPCProto.mismatch_info_t()
reply.areply.reply_data.mismatch_info.low = arg.pop(0)
reply.areply.reply_data.mismatch_info.high = arg.pop(0)
elif (accept_stat == SUCCESS):
reply.areply.reply_data.results = '' # FIXME?
elif (accept_stat == PROG_UNAVAIL or accept_stat == PROC_UNAVAIL
or accept_stat == GARBAGE_ARGS or accept_stat == SYSTEM_ERR):
pass
else:
raise ValueError("unknown accept_stat: %u" % accept_stat)
elif reply_stat == MSG_DENIED:
reply.rreply = RPCProto.rejected_reply()
reply.rreply.stat = reject_stat = arg.pop(0)
if reject_stat == RPC_MISMATCH:
reply.rreply.mismatch_info.low = RPCProto.mismatch_info_t()
reply.rreply.mismatch_info.low = arg.pop(0)
reply.rreply.mismatch_info.high = arg.pop(0)
elif reject_stat == AUTH_ERROR:
reply.rreply.astat = arg.pop(0)
else:
raise ValueError("unknown reject_stat: %u" % reject_stat)
else:
raise ValueError("unknown reply_stat: %u" % reply_stat)
p = Packer()
RPCProto.pack_rpc_msg(p, msg)
return p
def unpack_reply(response,
myxid=None,
myreply_stat=MSG_ACCEPTED,
myverf=NULL_AUTH,
myaccept_stat=SUCCESS,
myreject_stat=None,
myauth_stat=None):
"""Unpacks an RPC reply and returns a variable-length arg list
of the same form as the argument to pack_reply, but for SUCCESS also
returns an xdrlib.Unpacker as the final element of the list
that the caller can use to unpack the results of the call.
If values are given for any myXXX arguments, checks that those
values match the unpacked XXX values. Default myXXX values assume
success with no authentication.
Raises UnpackException on any errors or mismatches.
"""
u = Unpacker(response)
msg = RPCProto.unpack_rpc_msg(u)
check(myxid, msg.xid, "xid")
if msg.body.mtype == RPCProto.CALL:
raise UnpackException("Expected reply, but got call")
reply = msg.body.rbody
check(myreply_stat, reply.stat, "reply_stat")
retval = [msg.xid, reply.stat]
if reply.stat == RPCProto.MSG_ACCEPTED:
check(myverf, reply.areply.verf, "verf")
retval.append(reply.areply.verf)
accept_stat = reply.areply.reply_data.stat
check(myaccept_stat, accept_stat, "accept_stat")
retval.append(accept_stat)
if accept_stat == RPCProto.SUCCESS:
retval.append(u)
elif accept_stat == RPCProto.PROG_MISMATCH:
retval.append(reply.areply.reply_data.mismatch_info.low)
retval.append(reply.areply.reply_data.mismatch_info.high)
elif (accept_stat == RPCProto.PROG_UNAVAIL
or accept_stat == RPCProto.PROC_UNAVAIL
or accept_stat == RPCProto.GARBAGE_ARGS
or accept_stat == RPCProto.SYSTEM_ERR):
pass
else:
raise UnpackException("unknown accept_stat: %u" % accept_stat)
elif reply.stat == RPCProto.MSG_DENIED:
reject_stat = reply.rreply.stat
check(myreject_stat, reject_stat, "reject_stat")
retval.append(reject_stat)
if reject_stat == RPCProto.RPC_MISMATCH:
retval.append(reply.rreply.mismatch_info.low)
retval.append(reply.rreply.mismatch_info.high)
elif reject_stat == RPCProto.AUTH_ERROR:
check(myauth_stat, reply.rreply.astat, "auth_stat")
retval.append(reply.rreply.astat)
else:
raise UnpackException("unknown reject_stat: %u" % reject_stat)
else:
raise UnpackException("unknown reply_stat: %u" % reply.stat)
return retval
def pack_call(xid, prog, vers, proc, cred=NULL_AUTH, verf=NULL_AUTH):
"""Packs an RPC call message; returns an xdrlib.Packer that
the caller can use to add more data, e.g., the call arguments.
"""
msg = RPCProto.rpc_msg()
msg.xid = xid
msg.body = RPCProto.body_t()
msg.body.mtype = RPCProto.CALL
msg.body.cbody = RPCProto.call_body()
msg.body.cbody.rpcvers = RPCProto.RPC_VERSION
msg.body.cbody.prog = prog
msg.body.cbody.vers = vers
msg.body.cbody.proc = proc
msg.body.cbody.cred = cred
msg.body.cbody.verf = verf
p = Packer()
RPCProto.pack_rpc_msg(p, msg)
return p
def pack_call(xid, prog, vers, proc,
cred=NULL_AUTH, verf=NULL_AUTH):
"""Packs an RPC call message; returns an xdrlib.Packer that
the caller can use to add more data, e.g., the call arguments.
"""
msg = RPCProto.rpc_msg()
msg.xid = xid
msg.body = RPCProto.body_t()
msg.body.mtype = RPCProto.CALL
msg.body.cbody = RPCProto.call_body()
msg.body.cbody.rpcvers = RPCProto.RPC_VERSION
msg.body.cbody.prog = prog
msg.body.cbody.vers = vers
msg.body.cbody.proc = proc
msg.body.cbody.cred = cred
msg.body.cbody.verf = verf
p = Packer()
RPCProto.pack_rpc_msg(p, msg)
return p
def unpack_reply(response, myxid=None, myreply_stat=MSG_ACCEPTED,
myverf=NULL_AUTH, myaccept_stat=SUCCESS,
myreject_stat=None, myauth_stat=None):
"""Unpacks an RPC reply and returns a variable-length arg list
of the same form as the argument to pack_reply, but for SUCCESS also
returns an xdrlib.Unpacker as the final element of the list
that the caller can use to unpack the results of the call.
If values are given for any myXXX arguments, checks that those
values match the unpacked XXX values. Default myXXX values assume
success with no authentication.
Raises UnpackException on any errors or mismatches.
"""
u = Unpacker(response)
msg = RPCProto.unpack_rpc_msg(u)
check(myxid, msg.xid, "xid")
if msg.body.mtype == RPCProto.CALL:
raise UnpackException("Expected reply, but got call")
reply = msg.body.rbody
check(myreply_stat, reply.stat, "reply_stat")
retval = [msg.xid, reply.stat]
if reply.stat == RPCProto.MSG_ACCEPTED:
check(myverf, reply.areply.verf, "verf")
retval.append(reply.areply.verf)
accept_stat = reply.areply.reply_data.stat
check(myaccept_stat, accept_stat, "accept_stat")
retval.append(accept_stat)
if accept_stat == RPCProto.SUCCESS:
retval.append(u)
elif accept_stat == RPCProto.PROG_MISMATCH:
retval.append(reply.areply.reply_data.mismatch_info.low)
retval.append(reply.areply.reply_data.mismatch_info.high)
elif (accept_stat == RPCProto.PROG_UNAVAIL or
accept_stat == RPCProto.PROC_UNAVAIL or
accept_stat == RPCProto.GARBAGE_ARGS or
accept_stat == RPCProto.SYSTEM_ERR):
pass
else:
raise UnpackException("unknown accept_stat: %u" % accept_stat)
elif reply.stat == RPCProto.MSG_DENIED:
reject_stat = reply.rreply.stat
check(myreject_stat, reject_stat, "reject_stat")
retval.append(reject_stat)
if reject_stat == RPCProto.RPC_MISMATCH:
retval.append(reply.rreply.mismatch_info.low)
retval.append(reply.rreply.mismatch_info.high)
elif reject_stat == RPCProto.AUTH_ERROR:
check(myauth_stat, reply.rreply.astat, "auth_stat")
retval.append(reply.rreply.astat)
else:
raise UnpackException("unknown reject_stat: %u" % reject_stat)
else:
raise UnpackException("unknown reply_stat: %u" % reply.stat)
return retval
def unpack_call(request, myprog=None, myvers=None,
mycred=NULL_AUTH, myverf=NULL_AUTH):
"""Unpacks an RPC call message from request.
Returns (xid, prog, vers, proc, cred, verf, u) if okay,
where u is an xdrlib.Unpacker.
otherwise raises either UnpackException or ReplyException.
If myXXX is not None, checks that XXX == myXXX.
Assumes AUTH_NONE for cred and verf; override with mycred and myverf.
"""
if len(request) < 24:
raise UnpackException("Packet too short (%d bytes)" % len(request))
u = Unpacker(request)
msg = RPCProto.unpack_rpc_msg(u)
if msg.body.mtype == RPCProto.REPLY:
raise UnpackException("Expected call, but got reply")
call = msg.body.cbody
check(RPCProto.RPC_VERSION, call.rpcvers, "RPC version",
lambda: pack_reply(msg.xid,
RPCProto.MSG_DENIED,
RPCProto.RPC_MISMATCH,
RPCProto.RPC_VERSION,
RPCProto.RPC_VERSION).get_buffer())
check(myprog, call.prog, "program",
lambda: pack_reply(msg.xid,
RPCProto.MSG_ACCEPTED,
NULL_AUTH,
RPCProto.PROG_UNAVAIL).get_buffer())
check(myvers, call.vers, "version",
lambda: pack_reply(msg.xid,
RPCProto.MSG_ACCEPTED,
NULL_AUTH,
RPCProto.PROG_MISMATCH,
myvers,
myvers).get_buffer())
check(mycred, call.cred, "cred",
lambda: pack_reply(msg.xid,
RPCProto.MSG_DENIED,
RPCProto.AUTH_ERROR,
RPCProto.AUTH_BADCRED).get_buffer())
check(myverf, call.verf, "verf",
lambda: pack_reply(msg.xid,
RPCProto.MSG_DENIED,
RPCProto.AUTH_ERROR,
RPCProto.AUTH_BADVERF).get_buffer())
return (msg.xid, call.prog, call.vers,
call.proc, call.cred, call.verf, u)
def unpack_call(request,
myprog=None,
myvers=None,
mycred=NULL_AUTH,
myverf=NULL_AUTH):
"""Unpacks an RPC call message from request.
Returns (xid, prog, vers, proc, cred, verf, u) if okay,
where u is an xdrlib.Unpacker.
otherwise raises either UnpackException or ReplyException.
If myXXX is not None, checks that XXX == myXXX.
Assumes AUTH_NONE for cred and verf; override with mycred and myverf.
"""
if len(request) < 24:
raise UnpackException("Packet too short (%d bytes)" % len(request))
u = Unpacker(request)
msg = RPCProto.unpack_rpc_msg(u)
if msg.body.mtype == RPCProto.REPLY:
raise UnpackException("Expected call, but got reply")
call = msg.body.cbody
check(
RPCProto.RPC_VERSION, call.rpcvers, "RPC version", lambda: pack_reply(
msg.xid, RPCProto.MSG_DENIED, RPCProto.RPC_MISMATCH, RPCProto.
RPC_VERSION, RPCProto.RPC_VERSION).get_buffer())
check(
myprog, call.prog, "program",
lambda: pack_reply(msg.xid, RPCProto.MSG_ACCEPTED, NULL_AUTH, RPCProto.
PROG_UNAVAIL).get_buffer())
check(
myvers, call.vers, "version",
lambda: pack_reply(msg.xid, RPCProto.MSG_ACCEPTED, NULL_AUTH, RPCProto.
PROG_MISMATCH, myvers, myvers).get_buffer())
check(
mycred, call.cred, "cred",
lambda: pack_reply(msg.xid, RPCProto.MSG_DENIED, RPCProto.AUTH_ERROR,
RPCProto.AUTH_BADCRED).get_buffer())
check(
myverf, call.verf, "verf",
lambda: pack_reply(msg.xid, RPCProto.MSG_DENIED, RPCProto.AUTH_ERROR,
RPCProto.AUTH_BADVERF).get_buffer())
return (msg.xid, call.prog, call.vers, call.proc, call.cred, call.verf, u)
PROG_UNAVAIL = RPCProto.PROG_UNAVAIL # remote hasn't exported program
PROG_MISMATCH = RPCProto.PROG_MISMATCH # remote can't support version #
PROC_UNAVAIL = RPCProto.PROC_UNAVAIL # program can't support procedure
GARBAGE_ARGS = RPCProto.GARBAGE_ARGS # procedure can't decode params
SYSTEM_ERR = RPCProto.SYSTEM_ERR # errors like memory allocation
AUTH_OK = RPCProto.AUTH_OK # success
AUTH_BADCRED = RPCProto.AUTH_BADCRED # bad credential (seal broken)
AUTH_REJECTEDCRED = RPCProto.AUTH_REJECTEDCRED # client must begin new session
AUTH_BADVERF = RPCProto.AUTH_BADVERF # bad verifier (seal broken)
AUTH_REJECTEDVERF = RPCProto.AUTH_REJECTEDVERF # verifier expired or replayed
AUTH_TOOWEAK = RPCProto.AUTH_TOOWEAK # rejected for security reasons
AUTH_INVALIDRESP = RPCProto.AUTH_INVALIDRESP # bogus response verifier
AUTH_FAILED = RPCProto.AUTH_FAILED # reason unknown
PROC_NULL = 0
NULL_AUTH = RPCProto.opaque_auth()
NULL_AUTH.flavor = RPCProto.AUTH_NONE
NULL_AUTH.body = ''
def parse_frag_len(data):
if len(data) < 4:
raise EOFError, "no fraglen"
fraglen = struct.unpack('>L', data[:4])[0]
lastfrag = fraglen & 0x80000000
fraglen = fraglen & 0x7fffffff
return (fraglen, lastfrag)
def writefrags(message, write):
"""Fragments message and writes the fragments using write.
PROG_UNAVAIL = RPCProto.PROG_UNAVAIL # remote hasn't exported program
PROG_MISMATCH = RPCProto.PROG_MISMATCH # remote can't support version #
PROC_UNAVAIL = RPCProto.PROC_UNAVAIL # program can't support procedure
GARBAGE_ARGS = RPCProto.GARBAGE_ARGS # procedure can't decode params
SYSTEM_ERR = RPCProto.SYSTEM_ERR # errors like memory allocation
AUTH_OK = RPCProto.AUTH_OK # success
AUTH_BADCRED = RPCProto.AUTH_BADCRED # bad credential (seal broken)
AUTH_REJECTEDCRED = RPCProto.AUTH_REJECTEDCRED # client must begin new session
AUTH_BADVERF = RPCProto.AUTH_BADVERF # bad verifier (seal broken)
AUTH_REJECTEDVERF = RPCProto.AUTH_REJECTEDVERF # verifier expired or replayed
AUTH_TOOWEAK = RPCProto.AUTH_TOOWEAK # rejected for security reasons
AUTH_INVALIDRESP = RPCProto.AUTH_INVALIDRESP # bogus response verifier
AUTH_FAILED = RPCProto.AUTH_FAILED # reason unknown
PROC_NULL = 0
NULL_AUTH = RPCProto.opaque_auth()
NULL_AUTH.flavor = RPCProto.AUTH_NONE
NULL_AUTH.body = ''
def parse_frag_len(data):
if len(data) < 4:
raise EOFError, "no fraglen"
fraglen = struct.unpack('>L', data[:4])[0]
lastfrag = fraglen & 0x80000000
fraglen = fraglen & 0x7fffffff
return (fraglen, lastfrag)
def writefrags(message, write):
"""Fragments message and writes the fragments using write.
