"""Items common to both the client and server
"""
+import array as _array
import re as _re
+import socket as _socket
+from . import LOG as _LOG
from . import error as _error
LINE_LENGTH = 1002 # 1000 + [CR,]LF
-_ENCODE_REGEXP = _re.compile(
- '(' + '|'.join(['%', '\r', '\n']) + ')')
-_DECODE_REGEXP = _re.compile('(%[0-9A-F]{2})')
+_ENCODE_PATTERN = '(' + '|'.join(['%', '\r', '\n']) + ')'
+_ENCODE_STR_REGEXP = _re.compile(_ENCODE_PATTERN)
+_ENCODE_BYTE_REGEXP = _re.compile(_ENCODE_PATTERN.encode('ascii'))
+_DECODE_STR_REGEXP = _re.compile('(%[0-9A-Fa-f]{2})')
+_DECODE_BYTE_REGEXP = _re.compile(b'(%[0-9A-Fa-f]{2})')
_REQUEST_REGEXP = _re.compile('^(\w+)( *)(.*)\Z')
-def encode(string):
+def encode(data):
r"""
>>> encode('It grew by 5%!\n')
'It grew by 5%25!%0A'
- """
- return _ENCODE_REGEXP.sub(
- lambda x : to_hex(x.group()), string)
+ >>> encode(b'It grew by 5%!\n')
+ b'It grew by 5%25!%0A'
+ """
+ if isinstance(data, bytes):
+ regexp = _ENCODE_BYTE_REGEXP
+ else:
+ regexp = _ENCODE_STR_REGEXP
+ return regexp.sub(
+ lambda x : to_hex(x.group()), data)
-def decode(string):
+def decode(data):
r"""
>>> decode('%22Look out!%22%0AWhere%3F')
'"Look out!"\nWhere?'
+ >>> decode(b'%22Look out!%22%0AWhere%3F')
+ b'"Look out!"\nWhere?'
"""
- return _DECODE_REGEXP.sub(
- lambda x : from_hex(x.group()), string)
+ if isinstance(data, bytes):
+ regexp = _DECODE_BYTE_REGEXP
+ else:
+ regexp = _DECODE_STR_REGEXP
+ return regexp.sub(
+ lambda x : from_hex(x.group()), data)
def from_hex(code):
r"""
'"'
>>> from_hex('%0A')
'\n'
+ >>> from_hex(b'%0A')
+ b'\n'
"""
- return chr(int(code[1:], 16))
+ c = chr(int(code[1:], 16))
+ if isinstance(code, bytes):
+ c =c.encode('ascii')
+ return c
def to_hex(char):
r"""
'%22'
>>> to_hex('\n')
'%0A'
+ >>> to_hex(b'\n')
+ b'%0A'
"""
- return '%{:02X}'.format(ord(char))
+ hx = '%{:02X}'.format(ord(char))
+ if isinstance(char, bytes):
+ hx = hx.encode('ascii')
+ return hx
class Request (object):
>>> r = Request(command='OPTION', parameters='testing at 5%')
>>> str(r)
'OPTION testing at 5%25'
- >>> r.from_string('BYE')
+ >>> bytes(r)
+ b'OPTION testing at 5%25'
+ >>> r.from_bytes(b'BYE')
>>> r.command
'BYE'
>>> print(r.parameters)
None
- >>> r.from_string('OPTION testing at 5%25')
+ >>> r.from_bytes(b'OPTION testing at 5%25')
>>> r.command
'OPTION'
>>> print(r.parameters)
testing at 5%
- >>> r.from_string(' invalid')
+ >>> r.from_bytes(b' invalid')
Traceback (most recent call last):
...
pyassuan.error.AssuanError: 170 Invalid request
- >>> r.from_string('in-valid')
+ >>> r.from_bytes(b'in-valid')
Traceback (most recent call last):
...
pyassuan.error.AssuanError: 170 Invalid request
return '{} {}'.format(self.command, encoded_parameters)
return self.command
- def from_string(self, string):
- if len(string) > 1000: # TODO: byte-vs-str and newlines?
+ def __bytes__(self):
+ if self.parameters:
+ if self.encoded:
+ encoded_parameters = self.parameters
+ else:
+ encoded_parameters = encode(self.parameters)
+ return '{} {}'.format(
+ self.command, encoded_parameters).encode('utf-8')
+ return self.command.encode('utf-8')
+
+ def from_bytes(self, line):
+ if len(line) > 1000: # TODO: byte-vs-str and newlines?
raise _error.AssuanError(message='Line too long')
- match = _REQUEST_REGEXP.match(string)
+ line = str(line, encoding='utf-8')
+ match = _REQUEST_REGEXP.match(line)
if not match:
raise _error.AssuanError(message='Invalid request')
self.command = match.group(1)
>>> r = Response(type='ERR', parameters='1 General error')
>>> str(r)
'ERR 1 General error'
- >>> r.from_string('OK')
+ >>> bytes(r)
+ b'ERR 1 General error'
+ >>> r.from_bytes(b'OK')
>>> r.type
'OK'
>>> print(r.parameters)
None
- >>> r.from_string('ERR 1 General error')
+ >>> r.from_bytes(b'ERR 1 General error')
>>> r.type
'ERR'
>>> print(r.parameters)
1 General error
- >>> r.from_string(' invalid')
+ >>> r.from_bytes(b' invalid')
Traceback (most recent call last):
...
pyassuan.error.AssuanError: 76 Invalid response
- >>> r.from_string('in-valid')
+ >>> r.from_bytes(b'in-valid')
Traceback (most recent call last):
...
pyassuan.error.AssuanError: 76 Invalid response
return '{} {}'.format(self.type, encode(self.parameters))
return self.type
- def from_string(self, string):
- if len(string) > 1000: # TODO: byte-vs-str and newlines?
+ def __bytes__(self):
+ if self.parameters:
+ if self.type == 'D':
+ return b' '.join((b'D', self.parameters))
+ else:
+ return '{} {}'.format(
+ self.type, encode(self.parameters)).encode('utf-8')
+ return self.type.encode('utf-8')
+
+ def from_bytes(self, line):
+ if len(line) > 1000: # TODO: byte-vs-str and newlines?
raise _error.AssuanError(message='Line too long')
+ if line.startswith(b'D'):
+ self.command = t = 'D'
+ else:
+ line = str(line, encoding='utf-8')
+ t = line[0]
try:
- type = self.types[string[0]]
+ type = self.types[t]
except KeyError:
raise _error.AssuanError(message='Invalid response')
self.type = type
if type == 'D': # data
- self.parameters = decode(string[2:])
+ self.parameters = decode(line[2:])
elif type == '#': # comment
- self.parameters = decode(string[2:])
+ self.parameters = decode(line[2:])
else:
- match = _REQUEST_REGEXP.match(string)
+ match = _REQUEST_REGEXP.match(line)
if not match:
raise _error.AssuanError(message='Invalid request')
if match.group(3):
ERR 1 General error
"""
return Response(type='ERR', parameters=str(error))
+
+
+def send_fds(socket, msg=None, fds=None, logger=_LOG):
+ """Send a file descriptor over a Unix socket using ``sendmsg``.
+
+ ``sendmsg`` suport requires Python >= 3.3.
+
+ Code from
+ http://docs.python.org/dev/library/socket.html#socket.socket.sendmsg
+
+ Assuan equivalent is
+ http://www.gnupg.org/documentation/manuals/assuan/Client-code.html#function-assuan_005fsendfd
+ """
+ if msg is None:
+ msg = b''.join(
+ [b'# descriptors in flight: ', str(fds).encode('ascii'), b'\n'])
+ if logger is not None:
+ logger.debug('sending file descriptors {} down {}'.format(fds, socket))
+ return socket.sendmsg(
+ [msg],
+ [(_socket.SOL_SOCKET, _socket.SCM_RIGHTS, _array.array('i', fds))])
+
+def receive_fds(socket, msglen=200, maxfds=10, logger=_LOG):
+ """Recieve file descriptors using ``recvmsg``.
+
+ ``recvmsg`` suport requires Python >= 3.3.
+
+ Code from http://docs.python.org/dev/library/socket.html
+
+ Assuan equivalent is
+ http://www.gnupg.org/documentation/manuals/assuan/Client-code.html#fun_002dassuan_005freceivedfd
+ """
+ fds = _array.array('i') # Array of ints
+ msg,ancdata,flags,addr = socket.recvmsg(
+ msglen, _socket.CMSG_LEN(maxfds * fds.itemsize))
+ for cmsg_level,cmsg_type,cmsg_data in ancdata:
+ if (cmsg_level == _socket.SOL_SOCKET and
+ cmsg_type == _socket.SCM_RIGHTS):
+ # Append data, ignoring any truncated integers at the end.
+ fds.fromstring(
+ cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
+ if logger is not None:
+ logger.debug('receiving file descriptors {} from {} ({})'.format(
+ fds, socket, msg))
+ return (msg, list(fds))
projects / pyassuan.git / blobdiff