blob: 00397dd852e4edfa663bdd0d78d6431396e32e76 [file] [log] [blame]
Guido van Rossum8f1506b1992-12-21 14:32:06 +00001# Sun RPC version 2 -- RFC1057.
Guido van Rossume3cafbe1992-12-14 23:25:04 +00002
Guido van Rossumc4698fb1992-12-17 17:12:17 +00003# XXX There should be separate exceptions for the various reasons why
4# XXX an RPC can fail, rather than using RuntimeError for everything
5
6# XXX The UDP version of the protocol resends requests when it does
7# XXX not receive a timely reply -- use only for idempotent calls!
8
Guido van Rossum79f85ee1992-12-20 14:56:32 +00009# XXX There is no provision for call timeout on TCP connections
10
Guido van Rossume3cafbe1992-12-14 23:25:04 +000011import xdr
12import socket
13import os
14
15RPCVERSION = 2
16
17CALL = 0
18REPLY = 1
19
20AUTH_NULL = 0
21AUTH_UNIX = 1
22AUTH_SHORT = 2
23AUTH_DES = 3
24
25MSG_ACCEPTED = 0
26MSG_DENIED = 1
27
28SUCCESS = 0 # RPC executed successfully
29PROG_UNAVAIL = 1 # remote hasn't exported program
30PROG_MISMATCH = 2 # remote can't support version #
31PROC_UNAVAIL = 3 # program can't support procedure
32GARBAGE_ARGS = 4 # procedure can't decode params
33
34RPC_MISMATCH = 0 # RPC version number != 2
35AUTH_ERROR = 1 # remote can't authenticate caller
36
37AUTH_BADCRED = 1 # bad credentials (seal broken)
38AUTH_REJECTEDCRED = 2 # client must begin new session
39AUTH_BADVERF = 3 # bad verifier (seal broken)
40AUTH_REJECTEDVERF = 4 # verifier expired or replayed
41AUTH_TOOWEAK = 5 # rejected for security reasons
42
43
44class Packer(xdr.Packer):
45
46 def pack_auth(self, auth):
47 flavor, stuff = auth
48 self.pack_enum(flavor)
49 self.pack_opaque(stuff)
50
51 def pack_auth_unix(self, stamp, machinename, uid, gid, gids):
52 self.pack_uint(stamp)
53 self.pack_string(machinename)
54 self.pack_uint(uid)
55 self.pack_uint(gid)
56 self.pack_uint(len(gids))
57 for i in gids:
58 self.pack_uint(i)
59
60 def pack_callheader(self, xid, prog, vers, proc, cred, verf):
61 self.pack_uint(xid)
62 self.pack_enum(CALL)
63 self.pack_uint(RPCVERSION)
64 self.pack_uint(prog)
65 self.pack_uint(vers)
66 self.pack_uint(proc)
67 self.pack_auth(cred)
68 self.pack_auth(verf)
69 # Caller must add procedure-specific part of call
70
71 def pack_replyheader(self, xid, verf):
72 self.pack_uint(xid)
73 self.pack_enum(REPLY)
74 self.pack_uint(MSG_ACCEPTED)
75 self.pack_auth(verf)
76 self.pack_enum(SUCCESS)
77 # Caller must add procedure-specific part of reply
78
79
Guido van Rossum424c6731992-12-19 00:05:55 +000080# Exceptions
81BadRPCFormat = 'rpc.BadRPCFormat'
82BadRPCVersion = 'rpc.BadRPCVersion'
83GarbageArgs = 'rpc.GarbageArgs'
84
Guido van Rossume3cafbe1992-12-14 23:25:04 +000085class Unpacker(xdr.Unpacker):
86
87 def unpack_auth(self):
88 flavor = self.unpack_enum()
89 stuff = self.unpack_opaque()
90 return (flavor, stuff)
91
Guido van Rossum424c6731992-12-19 00:05:55 +000092 def unpack_callheader(self):
93 xid = self.unpack_uint(xid)
94 temp = self.unpack_enum()
95 if temp <> CALL:
96 raise BadRPCFormat, 'no CALL but ' + `temp`
97 temp = self.unpack_uint()
98 if temp <> RPCVERSION:
99 raise BadRPCVerspion, 'bad RPC version ' + `temp`
100 prog = self.unpack_uint()
101 vers = self.unpack_uint()
102 proc = self.unpack_uint()
103 cred = self.unpack_auth()
104 verf = self.unpack_auth()
105 return xid, prog, vers, proc, cred, verf
106 # Caller must add procedure-specific part of call
107
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000108 def unpack_replyheader(self):
109 xid = self.unpack_uint()
110 mtype = self.unpack_enum()
111 if mtype <> REPLY:
Guido van Rossumc4698fb1992-12-17 17:12:17 +0000112 raise RuntimeError, 'no REPLY but ' + `mtype`
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000113 stat = self.unpack_enum()
Guido van Rossumc4698fb1992-12-17 17:12:17 +0000114 if stat == MSG_DENIED:
115 stat = self.unpack_enum()
116 if stat == RPC_MISMATCH:
117 low = self.unpack_uint()
118 high = self.unpack_uint()
119 raise RuntimeError, \
120 'MSG_DENIED: RPC_MISMATCH: ' + `low, high`
121 if stat == AUTH_ERROR:
122 stat = self.unpack_uint()
123 raise RuntimeError, \
124 'MSG_DENIED: AUTH_ERROR: ' + `stat`
125 raise RuntimeError, 'MSG_DENIED: ' + `stat`
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000126 if stat <> MSG_ACCEPTED:
Guido van Rossumc4698fb1992-12-17 17:12:17 +0000127 raise RuntimeError, \
128 'Neither MSG_DENIED nor MSG_ACCEPTED: ' + `stat`
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000129 verf = self.unpack_auth()
130 stat = self.unpack_enum()
Guido van Rossum424c6731992-12-19 00:05:55 +0000131 if stat == PROG_UNAVAIL:
132 raise RuntimeError, 'call failed: PROG_UNAVAIL'
Guido van Rossumc4698fb1992-12-17 17:12:17 +0000133 if stat == PROG_MISMATCH:
134 low = self.unpack_uint()
135 high = self.unpack_uint()
136 raise RuntimeError, \
137 'call failed: PROG_MISMATCH: ' + `low, high`
Guido van Rossum424c6731992-12-19 00:05:55 +0000138 if stat == PROC_UNAVAIL:
139 raise RuntimeError, 'call failed: PROC_UNAVAIL'
140 if stat == GARBAGE_ARGS:
141 raise RuntimeError, 'call failed: GARBAGE_ARGS'
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000142 if stat <> SUCCESS:
Guido van Rossumc4698fb1992-12-17 17:12:17 +0000143 raise RuntimeError, 'call failed: ' + `stat`
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000144 return xid, verf
145 # Caller must get procedure-specific part of reply
146
147
Guido van Rossum749d0bb1992-12-15 20:52:53 +0000148# Subroutines to create opaque authentication objects
149
150def make_auth_null():
151 return ''
152
153def make_auth_unix(seed, host, uid, gid, groups):
154 p = Packer().init()
155 p.pack_auth_unix(seed, host, uid, gid, groups)
156 return p.get_buf()
157
158def make_auth_unix_default():
Guido van Rossuma5854441992-12-17 17:31:58 +0000159 try:
160 from os import getuid, getgid
161 uid = getuid()
162 gid = getgid()
163 except ImportError:
164 uid = gid = 0
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000165 import time
166 return make_auth_unix(time.time(), socket.gethostname(), uid, gid, [])
Guido van Rossum749d0bb1992-12-15 20:52:53 +0000167
168
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000169# Common base class for clients
170
171class Client:
172
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000173 def init(self, host, prog, vers, port):
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000174 self.host = host
175 self.prog = prog
176 self.vers = vers
177 self.port = port
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000178 self.makesocket() # Assigns to self.sock
179 self.bindsocket()
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000180 self.connsocket()
181 self.lastxid = 0 # XXX should be more random?
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000182 self.addpackers()
183 self.cred = None
184 self.verf = None
185 return self
186
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000187 def close(self):
188 self.sock.close()
189
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000190 def makesocket(self):
191 # This MUST be overridden
192 raise RuntimeError, 'makesocket not defined'
193
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000194 def connsocket(self):
195 # Override this if you don't want/need a connection
196 self.sock.connect((self.host, self.port))
197
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000198 def bindsocket(self):
199 # Override this to bind to a different port (e.g. reserved)
200 self.sock.bind(('', 0))
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000201
202 def addpackers(self):
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000203 # Override this to use derived classes from Packer/Unpacker
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000204 self.packer = Packer().init()
205 self.unpacker = Unpacker().init('')
206
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000207 def make_call(self, proc, args, pack_func, unpack_func):
208 # Don't normally override this (but see Broadcast)
209 if pack_func is None and args is not None:
210 raise TypeError, 'non-null args with null pack_func'
211 self.start_call(proc)
212 if pack_func:
213 pack_func(args)
214 self.do_call()
215 if unpack_func:
216 result = unpack_func()
217 else:
218 result = None
219 self.unpacker.done()
220 return result
221
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000222 def start_call(self, proc):
223 # Don't override this
224 self.lastxid = xid = self.lastxid + 1
225 cred = self.mkcred()
226 verf = self.mkverf()
227 p = self.packer
228 p.reset()
229 p.pack_callheader(xid, self.prog, self.vers, proc, cred, verf)
230
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000231 def do_call(self):
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000232 # This MUST be overridden
233 raise RuntimeError, 'do_call not defined'
234
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000235 def mkcred(self):
236 # Override this to use more powerful credentials
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000237 if self.cred == None:
Guido van Rossum749d0bb1992-12-15 20:52:53 +0000238 self.cred = (AUTH_NULL, make_auth_null())
239 return self.cred
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000240
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000241 def mkverf(self):
242 # Override this to use a more powerful verifier
Guido van Rossum749d0bb1992-12-15 20:52:53 +0000243 if self.verf == None:
244 self.verf = (AUTH_NULL, make_auth_null())
245 return self.verf
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000246
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000247 def Null(self): # Procedure 0 is always like this
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000248 return self.make_call(0, None, None, None)
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000249
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000250
251# Record-Marking standard support
252
253def sendfrag(sock, last, frag):
254 x = len(frag)
255 if last: x = x | 0x80000000L
256 header = (chr(int(x>>24 & 0xff)) + chr(int(x>>16 & 0xff)) + \
257 chr(int(x>>8 & 0xff)) + chr(int(x & 0xff)))
258 sock.send(header + frag)
259
260def sendrecord(sock, record):
261 sendfrag(sock, 1, record)
262
263def recvfrag(sock):
264 header = sock.recv(4)
Guido van Rossum424c6731992-12-19 00:05:55 +0000265 if len(header) < 4:
266 raise EOFError
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000267 x = long(ord(header[0]))<<24 | ord(header[1])<<16 | \
268 ord(header[2])<<8 | ord(header[3])
269 last = ((x & 0x80000000) != 0)
270 n = int(x & 0x7fffffff)
271 frag = ''
272 while n > 0:
273 buf = sock.recv(n)
274 if not buf: raise EOFError
275 n = n - len(buf)
276 frag = frag + buf
277 return last, frag
278
279def recvrecord(sock):
280 record = ''
281 last = 0
282 while not last:
283 last, frag = recvfrag(sock)
284 record = record + frag
285 return record
286
287
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000288# Try to bind to a reserved port (must be root)
289
290last_resv_port_tried = None
291def bindresvport(sock, host):
292 global last_resv_port_tried
293 FIRST, LAST = 600, 1024 # Range of ports to try
294 if last_resv_port_tried == None:
295 import os
296 last_resv_port_tried = FIRST + os.getpid() % (LAST-FIRST)
297 for i in range(last_resv_port_tried, LAST) + \
298 range(FIRST, last_resv_port_tried):
299 last_resv_port_tried = i
300 try:
301 sock.bind((host, i))
302 return last_resv_port_tried
303 except socket.error, (errno, msg):
304 if errno <> 114:
305 raise socket.error, (errno, msg)
306 raise RuntimeError, 'can\'t assign reserved port'
307
308
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000309# Client using TCP to a specific port
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000310
311class RawTCPClient(Client):
312
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000313 def makesocket(self):
314 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000315
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000316 def do_call(self):
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000317 call = self.packer.get_buf()
318 sendrecord(self.sock, call)
319 reply = recvrecord(self.sock)
320 u = self.unpacker
321 u.reset(reply)
322 xid, verf = u.unpack_replyheader()
323 if xid <> self.lastxid:
324 # Can't really happen since this is TCP...
325 raise RuntimeError, 'wrong xid in reply ' + `xid` + \
326 ' instead of ' + `self.lastxid`
327
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000328
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000329# Client using UDP to a specific port
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000330
331class RawUDPClient(Client):
332
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000333 def makesocket(self):
334 self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000335
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000336 def do_call(self):
337 call = self.packer.get_buf()
338 self.sock.send(call)
Guido van Rossuma5854441992-12-17 17:31:58 +0000339 try:
340 from select import select
341 except ImportError:
342 print 'WARNING: select not found, RPC may hang'
343 select = None
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000344 BUFSIZE = 8192 # Max UDP buffer size
Guido van Rossum16b22191992-12-15 21:44:31 +0000345 timeout = 1
346 count = 5
Guido van Rossum16b22191992-12-15 21:44:31 +0000347 while 1:
Guido van Rossuma5854441992-12-17 17:31:58 +0000348 r, w, x = [self.sock], [], []
349 if select:
350 r, w, x = select(r, w, x, timeout)
Guido van Rossum16b22191992-12-15 21:44:31 +0000351 if self.sock not in r:
352 count = count - 1
353 if count < 0: raise RuntimeError, 'timeout'
354 if timeout < 25: timeout = timeout *2
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000355## print 'RESEND', timeout, count
Guido van Rossum16b22191992-12-15 21:44:31 +0000356 self.sock.send(call)
357 continue
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000358 reply = self.sock.recv(BUFSIZE)
Guido van Rossum16b22191992-12-15 21:44:31 +0000359 u = self.unpacker
360 u.reset(reply)
361 xid, verf = u.unpack_replyheader()
362 if xid <> self.lastxid:
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000363## print 'BAD xid'
Guido van Rossum16b22191992-12-15 21:44:31 +0000364 continue
365 break
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000366
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000367
368# Client using UDP broadcast to a specific port
369
370class RawBroadcastUDPClient(RawUDPClient):
371
372 def init(self, bcastaddr, prog, vers, port):
373 self = RawUDPClient.init(self, bcastaddr, prog, vers, port)
374 self.reply_handler = None
375 self.timeout = 30
376 return self
377
378 def connsocket(self):
379 # Don't connect -- use sendto
380 self.sock.allowbroadcast(1)
381
382 def set_reply_handler(self, reply_handler):
383 self.reply_handler = reply_handler
384
385 def set_timeout(self, timeout):
386 self.timeout = timeout # Use None for infinite timeout
387
388 def make_call(self, proc, args, pack_func, unpack_func):
389 if pack_func is None and args is not None:
390 raise TypeError, 'non-null args with null pack_func'
391 self.start_call(proc)
392 if pack_func:
393 pack_func(args)
394 call = self.packer.get_buf()
395 self.sock.sendto(call, (self.host, self.port))
396 try:
397 from select import select
398 except ImportError:
399 print 'WARNING: select not found, broadcast will hang'
400 select = None
401 BUFSIZE = 8192 # Max UDP buffer size (for reply)
402 replies = []
403 if unpack_func is None:
404 def dummy(): pass
405 unpack_func = dummy
406 while 1:
407 r, w, x = [self.sock], [], []
408 if select:
409 if self.timeout is None:
410 r, w, x = select(r, w, x)
411 else:
412 r, w, x = select(r, w, x, self.timeout)
413 if self.sock not in r:
414 break
415 reply, fromaddr = self.sock.recvfrom(BUFSIZE)
416 u = self.unpacker
417 u.reset(reply)
418 xid, verf = u.unpack_replyheader()
419 if xid <> self.lastxid:
420## print 'BAD xid'
421 continue
422 reply = unpack_func()
423 self.unpacker.done()
424 replies.append((reply, fromaddr))
425 if self.reply_handler:
426 self.reply_handler(reply, fromaddr)
427 return replies
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000428
429
430# Port mapper interface
431
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000432# Program number, version and (fixed!) port number
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000433PMAP_PROG = 100000
434PMAP_VERS = 2
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000435PMAP_PORT = 111
436
437# Procedure numbers
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000438PMAPPROC_NULL = 0 # (void) -> void
439PMAPPROC_SET = 1 # (mapping) -> bool
440PMAPPROC_UNSET = 2 # (mapping) -> bool
441PMAPPROC_GETPORT = 3 # (mapping) -> unsigned int
442PMAPPROC_DUMP = 4 # (void) -> pmaplist
443PMAPPROC_CALLIT = 5 # (call_args) -> call_result
444
445# A mapping is (prog, vers, prot, port) and prot is one of:
446
447IPPROTO_TCP = 6
448IPPROTO_UDP = 17
449
450# A pmaplist is a variable-length list of mappings, as follows:
451# either (1, mapping, pmaplist) or (0).
452
453# A call_args is (prog, vers, proc, args) where args is opaque;
454# a call_result is (port, res) where res is opaque.
455
456
457class PortMapperPacker(Packer):
458
459 def pack_mapping(self, mapping):
460 prog, vers, prot, port = mapping
461 self.pack_uint(prog)
462 self.pack_uint(vers)
463 self.pack_uint(prot)
464 self.pack_uint(port)
465
466 def pack_pmaplist(self, list):
467 self.pack_list(list, self.pack_mapping)
468
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000469 def pack_call_args(self, ca):
470 prog, vers, proc, args = ca
471 self.pack_uint(prog)
472 self.pack_uint(vers)
473 self.pack_uint(proc)
474 self.pack_opaque(args)
475
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000476
477class PortMapperUnpacker(Unpacker):
478
479 def unpack_mapping(self):
480 prog = self.unpack_uint()
481 vers = self.unpack_uint()
482 prot = self.unpack_uint()
483 port = self.unpack_uint()
484 return prog, vers, prot, port
485
486 def unpack_pmaplist(self):
487 return self.unpack_list(self.unpack_mapping)
488
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000489 def unpack_call_result(self):
490 port = self.unpack_uint()
491 res = self.unpack_opaque()
492 return port, res
493
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000494
495class PartialPortMapperClient:
496
497 def addpackers(self):
498 self.packer = PortMapperPacker().init()
499 self.unpacker = PortMapperUnpacker().init('')
500
Guido van Rossum424c6731992-12-19 00:05:55 +0000501 def Set(self, mapping):
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000502 return self.make_call(PMAPPROC_SET, mapping, \
503 self.packer.pack_mapping, \
504 self.unpacker.unpack_uint)
Guido van Rossum424c6731992-12-19 00:05:55 +0000505
506 def Unset(self, mapping):
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000507 return self.make_call(PMAPPROC_UNSET, mapping, \
508 self.packer.pack_mapping, \
509 self.unpacker.unpack_uint)
Guido van Rossum424c6731992-12-19 00:05:55 +0000510
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000511 def Getport(self, mapping):
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000512 return self.make_call(PMAPPROC_GETPORT, mapping, \
513 self.packer.pack_mapping, \
514 self.unpacker.unpack_uint)
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000515
516 def Dump(self):
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000517 return self.make_call(PMAPPROC_DUMP, None, \
518 None, \
519 self.unpacker.unpack_pmaplist)
520
521 def Callit(self, ca):
522 return self.make_call(PMAPPROC_CALLIT, ca, \
523 self.packer.pack_call_args, \
524 self.unpacker.unpack_call_result)
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000525
526
527class TCPPortMapperClient(PartialPortMapperClient, RawTCPClient):
528
529 def init(self, host):
530 return RawTCPClient.init(self, \
531 host, PMAP_PROG, PMAP_VERS, PMAP_PORT)
532
533
534class UDPPortMapperClient(PartialPortMapperClient, RawUDPClient):
535
536 def init(self, host):
537 return RawUDPClient.init(self, \
538 host, PMAP_PROG, PMAP_VERS, PMAP_PORT)
539
540
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000541class BroadcastUDPPortMapperClient(PartialPortMapperClient, \
542 RawBroadcastUDPClient):
543
544 def init(self, bcastaddr):
545 return RawBroadcastUDPClient.init(self, \
546 bcastaddr, PMAP_PROG, PMAP_VERS, PMAP_PORT)
547
548
549# Generic clients that find their server through the Port mapper
550
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000551class TCPClient(RawTCPClient):
552
553 def init(self, host, prog, vers):
554 pmap = TCPPortMapperClient().init(host)
555 port = pmap.Getport((prog, vers, IPPROTO_TCP, 0))
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000556 pmap.close()
Guido van Rossum424c6731992-12-19 00:05:55 +0000557 if port == 0:
558 raise RuntimeError, 'program not registered'
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000559 return RawTCPClient.init(self, host, prog, vers, port)
560
561
562class UDPClient(RawUDPClient):
563
564 def init(self, host, prog, vers):
565 pmap = UDPPortMapperClient().init(host)
566 port = pmap.Getport((prog, vers, IPPROTO_UDP, 0))
567 pmap.close()
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000568 if port == 0:
569 raise RuntimeError, 'program not registered'
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000570 return RawUDPClient.init(self, host, prog, vers, port)
571
572
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000573class BroadcastUDPClient(Client):
574
575 def init(self, bcastaddr, prog, vers):
576 self.pmap = BroadcastUDPPortMapperClient().init(bcastaddr)
577 self.pmap.set_reply_handler(self.my_reply_handler)
578 self.prog = prog
579 self.vers = vers
580 self.user_reply_handler = None
581 self.addpackers()
582 return self
583
584 def close(self):
585 self.pmap.close()
586
587 def set_reply_handler(self, reply_handler):
588 self.user_reply_handler = reply_handler
589
590 def set_timeout(self, timeout):
591 self.pmap.set_timeout(timeout)
592
593 def my_reply_handler(self, reply, fromaddr):
594 port, res = reply
595 self.unpacker.reset(res)
596 result = self.unpack_func()
597 self.unpacker.done()
598 self.replies.append((result, fromaddr))
599 if self.user_reply_handler is not None:
600 self.user_reply_handler(result, fromaddr)
601
602 def make_call(self, proc, args, pack_func, unpack_func):
603 self.packer.reset()
604 if pack_func:
605 pack_func(args)
606 if unpack_func is None:
607 def dummy(): pass
608 self.unpack_func = dummy
609 else:
610 self.unpack_func = unpack_func
611 self.replies = []
612 packed_args = self.packer.get_buf()
613 dummy_replies = self.pmap.Callit( \
614 (self.prog, self.vers, proc, packed_args))
615 return self.replies
616
617
Guido van Rossum424c6731992-12-19 00:05:55 +0000618# Server classes
619
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000620# These are not symmetric to the Client classes
621# XXX No attempt is made to provide authorization hooks yet
622
Guido van Rossum424c6731992-12-19 00:05:55 +0000623class Server:
624
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000625 def init(self, host, prog, vers, port):
Guido van Rossum424c6731992-12-19 00:05:55 +0000626 self.host = host # Should normally be '' for default interface
627 self.prog = prog
628 self.vers = vers
629 self.port = port # Should normally be 0 for random port
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000630 self.makesocket() # Assigns to self.sock and self.prot
631 self.bindsocket()
Guido van Rossum424c6731992-12-19 00:05:55 +0000632 self.host, self.port = self.sock.getsockname()
633 self.addpackers()
634 return self
635
636 def register(self):
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000637 mapping = self.prog, self.vers, self.prot, self.port
Guido van Rossum424c6731992-12-19 00:05:55 +0000638 p = TCPPortMapperClient().init(self.host)
639 if not p.Set(mapping):
640 raise RuntimeError, 'register failed'
641
642 def unregister(self):
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000643 mapping = self.prog, self.vers, self.prot, self.port
Guido van Rossum424c6731992-12-19 00:05:55 +0000644 p = TCPPortMapperClient().init(self.host)
645 if not p.Unset(mapping):
646 raise RuntimeError, 'unregister failed'
647
648 def handle(self, call):
649 # Don't use unpack_header but parse the header piecewise
650 # XXX I have no idea if I am using the right error responses!
651 self.unpacker.reset(call)
652 self.packer.reset()
653 xid = self.unpacker.unpack_uint()
654 self.packer.pack_uint(xid)
655 temp = self.unpacker.unpack_enum()
656 if temp <> CALL:
657 return None # Not worthy of a reply
658 self.packer.pack_uint(REPLY)
659 temp = self.unpacker.unpack_uint()
660 if temp <> RPCVERSION:
661 self.packer.pack_uint(MSG_DENIED)
662 self.packer.pack_uint(RPC_MISMATCH)
663 self.packer.pack_uint(RPCVERSION)
664 self.packer.pack_uint(RPCVERSION)
665 return self.packer.get_buf()
666 self.packer.pack_uint(MSG_ACCEPTED)
667 self.packer.pack_auth((AUTH_NULL, make_auth_null()))
668 prog = self.unpacker.unpack_uint()
669 if prog <> self.prog:
670 self.packer.pack_uint(PROG_UNAVAIL)
671 return self.packer.get_buf()
672 vers = self.unpacker.unpack_uint()
673 if vers <> self.vers:
674 self.packer.pack_uint(PROG_MISMATCH)
675 self.packer.pack_uint(self.vers)
676 self.packer.pack_uint(self.vers)
677 return self.packer.get_buf()
678 proc = self.unpacker.unpack_uint()
679 methname = 'handle_' + `proc`
680 try:
681 meth = getattr(self, methname)
682 except AttributeError:
683 self.packer.pack_uint(PROC_UNAVAIL)
684 return self.packer.get_buf()
685 cred = self.unpacker.unpack_auth()
686 verf = self.unpacker.unpack_auth()
687 try:
688 meth() # Unpack args, call turn_around(), pack reply
689 except (EOFError, GarbageArgs):
690 # Too few or too many arguments
691 self.packer.reset()
692 self.packer.pack_uint(xid)
693 self.packer.pack_uint(REPLY)
694 self.packer.pack_uint(MSG_ACCEPTED)
695 self.packer.pack_auth((AUTH_NULL, make_auth_null()))
696 self.packer.pack_uint(GARBAGE_ARGS)
697 return self.packer.get_buf()
698
699 def turn_around(self):
700 try:
701 self.unpacker.done()
702 except RuntimeError:
703 raise GarbageArgs
704 self.packer.pack_uint(SUCCESS)
705
706 def handle_0(self): # Handle NULL message
707 self.turn_around()
708
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000709 def makesocket(self):
710 # This MUST be overridden
711 raise RuntimeError, 'makesocket not defined'
712
713 def bindsocket(self):
714 # Override this to bind to a different port (e.g. reserved)
715 self.sock.bind((self.host, self.port))
Guido van Rossum424c6731992-12-19 00:05:55 +0000716
717 def addpackers(self):
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000718 # Override this to use derived classes from Packer/Unpacker
Guido van Rossum424c6731992-12-19 00:05:55 +0000719 self.packer = Packer().init()
720 self.unpacker = Unpacker().init('')
721
722
723class TCPServer(Server):
724
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000725 def makesocket(self):
726 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
727 self.prot = IPPROTO_TCP
Guido van Rossum424c6731992-12-19 00:05:55 +0000728
729 def loop(self):
730 self.sock.listen(0)
731 while 1:
732 self.session(self.sock.accept())
733
734 def session(self, connection):
735 sock, (host, port) = connection
736 while 1:
737 try:
738 call = recvrecord(sock)
739 except EOFError:
740 break
741 reply = self.handle(call)
742 if reply <> None:
743 sendrecord(sock, reply)
744
745
746class UDPServer(Server):
747
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000748 def makesocket(self):
749 self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
750 self.prot = IPPROTO_UDP
Guido van Rossum424c6731992-12-19 00:05:55 +0000751
752 def loop(self):
753 while 1:
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000754 self.session()
Guido van Rossum424c6731992-12-19 00:05:55 +0000755
756 def session(self):
757 call, host_port = self.sock.recvfrom(8192)
758 reply = self.handle(call)
759 if reply <> None:
760 self.sock.sendto(reply, host_port)
761
762
763# Simple test program -- dump local portmapper status
764
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000765def test():
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000766 pmap = UDPPortMapperClient().init('')
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000767 pmap.Null()
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000768 list = pmap.Dump()
Guido van Rossume3cafbe1992-12-14 23:25:04 +0000769 list.sort()
770 for prog, vers, prot, port in list:
771 print prog, vers,
772 if prot == IPPROTO_TCP: print 'tcp',
773 elif prot == IPPROTO_UDP: print 'udp',
774 else: print prot,
775 print port
Guido van Rossum424c6731992-12-19 00:05:55 +0000776
777
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000778# Test program for broadcast operation -- dump everybody's portmapper status
779
780def testbcast():
781 import sys
782 if sys.argv[1:]:
783 bcastaddr = sys.argv[1]
784 else:
785 bcastaddr = '<broadcast>'
786 def rh(reply, fromaddr):
787 host, port = fromaddr
788 print host + '\t' + `reply`
789 pmap = BroadcastUDPPortMapperClient().init(bcastaddr)
790 pmap.set_reply_handler(rh)
791 pmap.set_timeout(5)
792 replies = pmap.Getport((100002, 1, IPPROTO_UDP, 0))
793
794
795# Test program for server, with corresponding client
Guido van Rossum424c6731992-12-19 00:05:55 +0000796# On machine A: python -c 'import rpc; rpc.testsvr()'
797# On machine B: python -c 'import rpc; rpc.testclt()' A
798# (A may be == B)
799
800def testsvr():
801 # Simple test class -- proc 1 doubles its string argument as reply
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000802 class S(UDPServer):
Guido van Rossum424c6731992-12-19 00:05:55 +0000803 def handle_1(self):
804 arg = self.unpacker.unpack_string()
805 self.turn_around()
806 print 'RPC function 1 called, arg', `arg`
807 self.packer.pack_string(arg + arg)
808 #
809 s = S().init('', 0x20000000, 1, 0)
810 try:
811 s.unregister()
812 except RuntimeError, msg:
813 print 'RuntimeError:', msg, '(ignored)'
814 s.register()
815 print 'Service started...'
816 try:
817 s.loop()
818 finally:
819 s.unregister()
820 print 'Service interrupted.'
821
822
823def testclt():
824 import sys
825 if sys.argv[1:]: host = sys.argv[1]
826 else: host = ''
827 # Client for above server
Guido van Rossum79f85ee1992-12-20 14:56:32 +0000828 class C(UDPClient):
Guido van Rossum424c6731992-12-19 00:05:55 +0000829 def call_1(self, arg):
Guido van Rossum8f1506b1992-12-21 14:32:06 +0000830 return self.make_call(1, arg, \
831 self.packer.pack_string, \
832 self.unpacker.unpack_string)
Guido van Rossum424c6731992-12-19 00:05:55 +0000833 c = C().init(host, 0x20000000, 1)
834 print 'making call...'
835 reply = c.call_1('hello, world, ')
836 print 'call returned', `reply`