mitmproxy/libpathod/language.py

1231 lines
30 KiB
Python
Raw Normal View History

2014-10-25 01:24:05 +00:00
import operator
import string
import random
import mmap
import os
import time
import copy
import abc
2012-04-28 00:42:03 +00:00
import contrib.pyparsing as pp
2015-04-21 21:31:22 +00:00
from netlib import http_status, tcp, http_uastrings, websockets
2012-06-24 05:47:55 +00:00
import utils
2012-04-28 00:42:03 +00:00
BLOCKSIZE = 1024
2012-06-24 07:12:52 +00:00
TRUNCATE = 1024
2014-10-26 03:27:25 +00:00
class Settings:
def __init__(
self,
staticdir = None,
unconstrained_file_access = False,
request_host = None,
websocket_key = None
):
self.staticdir = staticdir
self.unconstrained_file_access = unconstrained_file_access
self.request_host = request_host
self.websocket_key = websocket_key
def quote(s):
quotechar = s[0]
s = s[1:-1]
s = s.replace(quotechar, "\\" + quotechar)
return quotechar + s + quotechar
2014-10-25 01:24:05 +00:00
class RenderError(Exception):
pass
class FileAccessDenied(RenderError):
2014-10-25 01:24:05 +00:00
pass
2012-04-28 02:43:57 +00:00
class ParseException(Exception):
def __init__(self, msg, s, col):
Exception.__init__(self)
self.msg = msg
self.s = s
self.col = col
def marked(self):
return "%s\n%s"%(self.s, " " * (self.col - 1) + "^")
2012-04-28 02:43:57 +00:00
def __str__(self):
2012-07-24 22:44:21 +00:00
return "%s at char %s"%(self.msg, self.col)
2012-04-28 02:43:57 +00:00
def send_chunk(fp, val, blocksize, start, end):
"""
(start, end): Inclusive lower bound, exclusive upper bound.
"""
for i in range(start, end, blocksize):
fp.write(
val[i:min(i + blocksize, end)]
)
return end - start
2015-04-19 20:56:47 +00:00
def write_values(fp, vals, actions, sofar=0, blocksize=BLOCKSIZE):
"""
2012-07-20 11:36:39 +00:00
vals: A list of values, which may be strings or Value objects.
2014-10-25 01:24:05 +00:00
actions: A list of (offset, action, arg) tuples. Action may be "pause"
or "disconnect".
2012-07-20 11:36:39 +00:00
Both vals and actions are in reverse order, with the first items last.
Return True if connection should disconnect.
"""
sofar = 0
2012-07-08 23:09:37 +00:00
try:
while vals:
v = vals.pop()
offset = 0
while actions and actions[-1][0] < (sofar + len(v)):
a = actions.pop()
2014-10-25 01:24:05 +00:00
offset += send_chunk(
fp,
v,
blocksize,
offset,
a[0] - sofar - offset
2014-10-25 01:24:05 +00:00
)
if a[1] == "pause":
time.sleep(a[2])
elif a[1] == "disconnect":
return True
elif a[1] == "inject":
send_chunk(fp, a[2], blocksize, 0, len(a[2]))
send_chunk(fp, v, blocksize, offset, len(v))
sofar += len(v)
2012-07-24 11:49:58 +00:00
# Remainders
while actions:
a = actions.pop()
if a[1] == "pause":
time.sleep(a[2])
elif a[1] == "disconnect":
return True
elif a[1] == "inject":
send_chunk(fp, a[2], blocksize, 0, len(a[2]))
2012-07-23 07:25:57 +00:00
except tcp.NetLibDisconnect: # pragma: no cover
2012-07-08 23:09:37 +00:00
return True
def serve(msg, fp, settings):
"""
fp: The file pointer to write to.
request_host: If this a request, this is the connecting host. If
None, we assume it's a response. Used to decide what standard
modifications to make if raw is not set.
Calling this function may modify the object.
"""
msg = msg.resolve(settings)
started = time.time()
vals = msg.values(settings)
vals.reverse()
actions = msg.actions[:]
actions.sort()
actions.reverse()
actions = [i.intermediate(settings) for i in actions]
disconnect = write_values(fp, vals, actions[:])
duration = time.time() - started
ret = dict(
disconnect = disconnect,
started = started,
duration = duration,
)
ret.update(msg.log(settings))
return ret
2012-04-28 00:42:03 +00:00
DATATYPES = dict(
ascii_letters = string.ascii_letters,
ascii_lowercase = string.ascii_lowercase,
ascii_uppercase = string.ascii_uppercase,
digits = string.digits,
hexdigits = string.hexdigits,
octdigits = string.octdigits,
punctuation = string.punctuation,
whitespace = string.whitespace,
ascii = string.printable,
bytes = "".join(chr(i) for i in range(256))
)
v_integer = pp.Word(pp.nums)\
2012-04-28 00:42:03 +00:00
.setName("integer")\
.setParseAction(lambda toks: int(toks[0]))
v_literal = pp.MatchFirst(
2012-04-28 00:42:03 +00:00
[
2014-10-25 01:24:05 +00:00
pp.QuotedString(
"\"",
escChar="\\",
unquoteResults=True,
multiline=True
),
pp.QuotedString(
"'",
escChar="\\",
unquoteResults=True,
multiline=True
),
2012-04-28 00:42:03 +00:00
]
)
v_naked_literal = pp.MatchFirst(
2012-04-28 00:42:03 +00:00
[
v_literal,
pp.Word("".join(i for i in pp.printables if i not in ",:\n@\'\""))
2012-04-28 00:42:03 +00:00
]
)
class LiteralGenerator:
def __init__(self, s):
self.s = s
def __len__(self):
return len(self.s)
def __getitem__(self, x):
return self.s.__getitem__(x)
def __getslice__(self, a, b):
return self.s.__getslice__(a, b)
def __repr__(self):
2014-10-26 03:27:25 +00:00
return "'%s'"%self.s
2012-04-28 00:42:03 +00:00
class RandomGenerator:
def __init__(self, dtype, length):
self.dtype = dtype
2012-04-28 00:42:03 +00:00
self.length = length
def __len__(self):
return self.length
def __getitem__(self, x):
return random.choice(DATATYPES[self.dtype])
2012-04-28 00:42:03 +00:00
def __getslice__(self, a, b):
b = min(b, self.length)
chars = DATATYPES[self.dtype]
return "".join(random.choice(chars) for x in range(a, b))
def __repr__(self):
return "%s random from %s"%(self.length, self.dtype)
2012-04-28 00:42:03 +00:00
class FileGenerator:
def __init__(self, path):
self.path = path
2013-06-15 22:30:13 +00:00
self.fp = file(path, "rb")
2013-12-16 03:47:29 +00:00
self.map = mmap.mmap(self.fp.fileno(), 0, access=mmap.ACCESS_READ)
2012-04-28 01:16:51 +00:00
def __len__(self):
return len(self.map)
def __getitem__(self, x):
return self.map.__getitem__(x)
def __getslice__(self, a, b):
return self.map.__getslice__(a, b)
2012-04-28 00:42:03 +00:00
def __repr__(self):
return "<%s"%self.path
2012-04-28 00:42:03 +00:00
class _Token(object):
"""
A specification token. Tokens are immutable.
"""
2012-10-28 09:00:19 +00:00
__metaclass__ = abc.ABCMeta
2014-10-25 01:24:05 +00:00
2015-04-19 20:56:47 +00:00
@classmethod
def expr(klass): # pragma: no cover
"""
A parse expression.
"""
2012-10-28 09:00:19 +00:00
return None
@abc.abstractmethod
def spec(self): # pragma: no cover
"""
A parseable specification for this token.
"""
2012-10-28 09:00:19 +00:00
return None
2012-10-30 23:32:13 +00:00
def resolve(self, msg, settings):
"""
Resolves this token to ready it for transmission. This means that
the calculated offsets of actions are fixed.
"""
return self
def __repr__(self):
return self.spec()
2012-10-28 09:00:19 +00:00
class _ValueLiteral(_Token):
2012-04-28 00:42:03 +00:00
def __init__(self, val):
self.val = val.decode("string_escape")
2012-04-28 00:42:03 +00:00
def get_generator(self, settings):
return LiteralGenerator(self.val)
def freeze(self, settings):
return self
2012-10-28 09:00:19 +00:00
class ValueLiteral(_ValueLiteral):
2012-04-28 00:42:03 +00:00
@classmethod
def expr(klass):
e = v_literal.copy()
2014-10-26 03:27:25 +00:00
return e.setParseAction(klass.parseAction)
@classmethod
def parseAction(klass, x):
v = klass(*x)
return v
2012-04-28 00:42:03 +00:00
def spec(self):
2014-10-26 03:27:25 +00:00
ret = "'%s'"%self.val.encode("string_escape")
return ret
2012-10-28 09:00:19 +00:00
class ValueNakedLiteral(_ValueLiteral):
@classmethod
def expr(klass):
e = v_naked_literal.copy()
return e.setParseAction(lambda x: klass(*x))
2012-04-28 00:42:03 +00:00
def spec(self):
return self.val.encode("string_escape")
2012-04-28 00:42:03 +00:00
class ValueGenerate(_Token):
2012-04-28 00:42:03 +00:00
def __init__(self, usize, unit, datatype):
if not unit:
unit = "b"
self.usize, self.unit, self.datatype = usize, unit, datatype
def bytes(self):
return self.usize * utils.SIZE_UNITS[self.unit]
2012-04-28 00:42:03 +00:00
def get_generator(self, settings):
return RandomGenerator(self.datatype, self.bytes())
2012-04-28 00:42:03 +00:00
def freeze(self, settings):
g = self.get_generator(settings)
return ValueLiteral(g[:].encode("string_escape"))
2012-04-28 00:42:03 +00:00
@classmethod
def expr(klass):
e = pp.Literal("@").suppress() + v_integer
2012-04-28 00:42:03 +00:00
2014-10-25 01:24:05 +00:00
u = reduce(
operator.or_,
[pp.Literal(i) for i in utils.SIZE_UNITS.keys()]
).leaveWhitespace()
2012-04-28 00:42:03 +00:00
e = e + pp.Optional(u, default=None)
s = pp.Literal(",").suppress()
2012-04-28 00:42:03 +00:00
s += reduce(operator.or_, [pp.Literal(i) for i in DATATYPES.keys()])
e += pp.Optional(s, default="bytes")
return e.setParseAction(lambda x: klass(*x))
def spec(self):
s = "@%s"%self.usize
if self.unit != "b":
s += self.unit
if self.datatype != "bytes":
s += ",%s"%self.datatype
return s
2012-04-28 00:42:03 +00:00
class ValueFile(_Token):
2012-04-28 00:42:03 +00:00
def __init__(self, path):
self.path = str(path)
2012-04-28 00:42:03 +00:00
@classmethod
def expr(klass):
e = pp.Literal("<").suppress()
e = e + v_naked_literal
2012-04-28 00:42:03 +00:00
return e.setParseAction(lambda x: klass(*x))
def freeze(self, settings):
return self
2012-04-28 00:42:03 +00:00
def get_generator(self, settings):
if not settings.staticdir:
2012-07-23 05:53:17 +00:00
raise FileAccessDenied("File access disabled.")
sd = os.path.normpath(os.path.abspath(settings.staticdir))
s = os.path.expanduser(self.path)
s = os.path.normpath(
os.path.abspath(os.path.join(settings.staticdir, s))
)
uf = settings.unconstrained_file_access
if not uf and not s.startswith(settings.staticdir):
2014-10-25 01:24:05 +00:00
raise FileAccessDenied(
"File access outside of configured directory"
)
if not os.path.isfile(s):
2012-07-23 05:53:17 +00:00
raise FileAccessDenied("File not readable")
return FileGenerator(s)
2012-04-28 00:42:03 +00:00
def spec(self):
2014-10-26 03:27:25 +00:00
return "<'%s'"%self.path.encode("string_escape")
2012-04-28 00:42:03 +00:00
Value = pp.MatchFirst(
[
ValueGenerate.expr(),
ValueFile.expr(),
ValueLiteral.expr()
]
)
NakedValue = pp.MatchFirst(
[
ValueGenerate.expr(),
ValueFile.expr(),
ValueLiteral.expr(),
ValueNakedLiteral.expr(),
]
)
Offset = pp.MatchFirst(
2014-10-25 01:24:05 +00:00
[
v_integer,
pp.Literal("r"),
pp.Literal("a")
]
)
class Raw(_Token):
2012-10-28 21:00:41 +00:00
@classmethod
def expr(klass):
e = pp.Literal("r").suppress()
return e.setParseAction(lambda x: klass(*x))
def spec(self):
return "r"
def freeze(self, settings):
return self
2012-10-28 21:00:41 +00:00
class _Component(_Token):
2012-10-28 21:00:41 +00:00
"""
A value component of the primary specification of an HTTP message.
"""
@abc.abstractmethod
2012-10-28 21:00:41 +00:00
def values(self, settings): # pragma: no cover
2012-10-28 04:39:58 +00:00
"""
2012-10-28 21:00:41 +00:00
A sequence of value objects.
2012-10-28 04:39:58 +00:00
"""
2012-10-28 09:00:19 +00:00
return None
def string(self, settings=None):
2012-10-28 04:39:58 +00:00
"""
2012-10-28 09:00:19 +00:00
A string representation of the object.
2012-10-28 04:39:58 +00:00
"""
return "".join(i[:] for i in self.values(settings or {}))
class _Header(_Component):
def __init__(self, key, value):
self.key, self.value = key, value
def values(self, settings):
return [
2014-10-25 01:24:05 +00:00
self.key.get_generator(settings),
": ",
self.value.get_generator(settings),
"\r\n",
]
class Header(_Header):
@classmethod
def expr(klass):
e = pp.Literal("h").suppress()
e += Value
e += pp.Literal("=").suppress()
e += Value
return e.setParseAction(lambda x: klass(*x))
def spec(self):
return "h%s=%s"%(self.key.spec(), self.value.spec())
def freeze(self, settings):
return Header(self.key.freeze(settings), self.value.freeze(settings))
class ShortcutContentType(_Header):
def __init__(self, value):
_Header.__init__(self, ValueLiteral("Content-Type"), value)
@classmethod
def expr(klass):
e = pp.Literal("c").suppress()
e = e + Value
return e.setParseAction(lambda x: klass(*x))
def spec(self):
return "c%s"%(self.value.spec())
def freeze(self, settings):
return ShortcutContentType(self.value.freeze(settings))
class ShortcutLocation(_Header):
def __init__(self, value):
_Header.__init__(self, ValueLiteral("Location"), value)
@classmethod
def expr(klass):
e = pp.Literal("l").suppress()
e = e + Value
return e.setParseAction(lambda x: klass(*x))
def spec(self):
return "l%s"%(self.value.spec())
def freeze(self, settings):
return ShortcutLocation(self.value.freeze(settings))
class ShortcutUserAgent(_Header):
def __init__(self, value):
self.specvalue = value
if isinstance(value, basestring):
value = ValueLiteral(http_uastrings.get_by_shortcut(value)[2])
_Header.__init__(self, ValueLiteral("User-Agent"), value)
@classmethod
def expr(klass):
e = pp.Literal("u").suppress()
2014-10-25 01:24:05 +00:00
u = reduce(
operator.or_,
[pp.Literal(i[1]) for i in http_uastrings.UASTRINGS]
)
e += u | Value
return e.setParseAction(lambda x: klass(*x))
def spec(self):
return "u%s"%self.specvalue
def freeze(self, settings):
return ShortcutUserAgent(self.value.freeze(settings))
class Body(_Component):
2012-04-28 00:42:03 +00:00
def __init__(self, value):
self.value = value
@classmethod
def expr(klass):
e = pp.Literal("b").suppress()
2012-04-28 00:42:03 +00:00
e = e + Value
return e.setParseAction(lambda x: klass(*x))
def values(self, settings):
return [
2014-10-25 01:24:05 +00:00
self.value.get_generator(settings),
]
def spec(self):
return "b%s"%(self.value.spec())
def freeze(self, settings):
return Body(self.value.freeze(settings))
2012-04-28 00:42:03 +00:00
class PathodSpec(_Token):
def __init__(self, value):
self.value = value
try:
self.parsed = Response(
Response.expr().parseString(
value.val,
parseAll=True
)
)
except pp.ParseException, v:
raise ParseException(v.msg, v.line, v.col)
@classmethod
def expr(klass):
e = pp.Literal("s").suppress()
e = e + ValueLiteral.expr()
return e.setParseAction(lambda x: klass(*x))
def values(self, settings):
return [
self.value.get_generator(settings),
]
def spec(self):
return "s%s"%(self.value.spec())
def freeze(self, settings):
f = self.parsed.freeze(settings).spec()
2014-10-26 03:27:25 +00:00
return PathodSpec(ValueLiteral(f.encode("string_escape")))
class Path(_Component):
def __init__(self, value):
if isinstance(value, basestring):
value = ValueLiteral(value)
self.value = value
@classmethod
def expr(klass):
e = Value | NakedValue
return e.setParseAction(lambda x: klass(*x))
def values(self, settings):
return [
2014-10-25 01:24:05 +00:00
self.value.get_generator(settings),
]
def spec(self):
return "%s"%(self.value.spec())
def freeze(self, settings):
return Path(self.value.freeze(settings))
class WS(_Component):
def __init__(self, value):
self.value = value
@classmethod
def expr(klass):
spec = pp.Literal("ws")
spec = spec.setParseAction(lambda x: klass(*x))
return spec
def values(self, settings):
return "ws"
def spec(self):
return "ws"
def freeze(self, settings):
return self
class Method(_Component):
2012-06-24 05:23:37 +00:00
methods = [
"get",
"head",
"post",
"put",
"delete",
"options",
"trace",
"connect",
]
2014-10-25 01:24:05 +00:00
2012-06-24 05:23:37 +00:00
def __init__(self, value):
# If it's a string, we were passed one of the methods, so we upper-case
# it to be canonical. The user can specify a different case by using a
# string value literal.
if isinstance(value, basestring):
2012-06-24 05:47:55 +00:00
value = ValueLiteral(value.upper())
2012-06-24 05:23:37 +00:00
self.value = value
@classmethod
def expr(klass):
parts = [pp.CaselessLiteral(i) for i in klass.methods]
m = pp.MatchFirst(parts)
spec = m | Value.copy()
spec = spec.setParseAction(lambda x: klass(*x))
return spec
def values(self, settings):
return [
self.value.get_generator(settings)
]
def spec(self):
s = self.value.spec()
if s[1:-1].lower() in self.methods:
s = s[1:-1].lower()
return "%s"%s
def freeze(self, settings):
return Method(self.value.freeze(settings))
2012-06-24 05:23:37 +00:00
2012-10-28 21:00:41 +00:00
class Code(_Component):
def __init__(self, code):
self.code = str(code)
@classmethod
def expr(klass):
e = v_integer.copy()
return e.setParseAction(lambda x: klass(*x))
def values(self, settings):
return [LiteralGenerator(self.code)]
def spec(self):
return "%s"%(self.code)
def freeze(self, settings):
return Code(self.code)
2012-10-28 21:00:41 +00:00
class Reason(_Component):
def __init__(self, value):
self.value = value
@classmethod
def expr(klass):
e = pp.Literal("m").suppress()
e = e + Value
return e.setParseAction(lambda x: klass(*x))
def values(self, settings):
return [self.value.get_generator(settings)]
def spec(self):
return "m%s"%(self.value.spec())
def freeze(self, settings):
return Reason(self.value.freeze(settings))
2012-10-28 21:00:41 +00:00
class _Action(_Token):
"""
An action that operates on the raw data stream of the message. All
actions have one thing in common: an offset that specifies where the
action should take place.
"""
def __init__(self, offset):
self.offset = offset
def resolve(self, msg, settings):
"""
Resolves offset specifications to a numeric offset. Returns a copy
of the action object.
"""
c = copy.copy(self)
l = msg.length(settings)
if c.offset == "r":
c.offset = random.randrange(l)
elif c.offset == "a":
c.offset = l + 1
return c
def __cmp__(self, other):
return cmp(self.offset, other.offset)
def __repr__(self):
return self.spec()
2012-10-28 21:00:41 +00:00
@abc.abstractmethod
def spec(self): # pragma: no cover
pass
2012-10-28 21:00:41 +00:00
@abc.abstractmethod
2015-04-19 20:56:47 +00:00
def intermediate(self, settings): # pragma: no cover
2012-10-28 21:00:41 +00:00
pass
class PauseAt(_Action):
def __init__(self, offset, seconds):
_Action.__init__(self, offset)
self.seconds = seconds
2012-04-28 00:42:03 +00:00
@classmethod
def expr(klass):
e = pp.Literal("p").suppress()
e += Offset
e += pp.Literal(",").suppress()
2012-06-24 05:23:37 +00:00
e += pp.MatchFirst(
2014-10-25 01:24:05 +00:00
[
v_integer,
pp.Literal("f")
]
)
2012-04-28 00:42:03 +00:00
return e.setParseAction(lambda x: klass(*x))
def spec(self):
return "p%s,%s"%(self.offset, self.seconds)
def intermediate(self, settings):
return (self.offset, "pause", self.seconds)
2012-04-28 00:42:03 +00:00
def freeze(self, settings):
return self
2012-04-28 00:42:03 +00:00
class DisconnectAt(_Action):
def __init__(self, offset):
_Action.__init__(self, offset)
2012-04-28 00:42:03 +00:00
@classmethod
def expr(klass):
e = pp.Literal("d").suppress()
2012-07-24 11:49:58 +00:00
e += Offset
return e.setParseAction(lambda x: klass(*x))
2012-04-28 00:42:03 +00:00
def spec(self):
return "d%s"%self.offset
def intermediate(self, settings):
return (self.offset, "disconnect")
def freeze(self, settings):
return self
2012-04-28 00:42:03 +00:00
class InjectAt(_Action):
2012-07-20 11:36:39 +00:00
def __init__(self, offset, value):
_Action.__init__(self, offset)
self.value = value
2012-07-20 11:36:39 +00:00
@classmethod
def expr(klass):
e = pp.Literal("i").suppress()
e += Offset
2012-07-20 11:36:39 +00:00
e += pp.Literal(",").suppress()
e += Value
return e.setParseAction(lambda x: klass(*x))
def spec(self):
return "i%s,%s"%(self.offset, self.value.spec())
def intermediate(self, settings):
return (
2014-10-25 01:24:05 +00:00
self.offset,
"inject",
self.value.get_generator(settings)
)
2012-07-20 11:36:39 +00:00
def freeze(self, settings):
return InjectAt(self.offset, self.value.freeze(settings))
2012-07-20 11:36:39 +00:00
2012-10-28 21:00:41 +00:00
class _Message(object):
__metaclass__ = abc.ABCMeta
2012-06-24 07:12:52 +00:00
version = "HTTP/1.1"
2015-04-19 20:56:47 +00:00
logattrs = []
2014-10-25 01:24:05 +00:00
def __init__(self, tokens):
self.tokens = tokens
def toks(self, klass):
"""
Fetch all tokens that are instances of klass
"""
return [i for i in self.tokens if isinstance(i, klass)]
def tok(self, klass):
"""
Fetch first token that is an instance of klass
"""
l = self.toks(klass)
if l:
return l[0]
@property
def raw(self):
return bool(self.tok(Raw))
@property
def actions(self):
return self.toks(_Action)
@property
def body(self):
return self.tok(Body)
@property
def headers(self):
return self.toks(_Header)
def length(self, settings):
"""
2014-10-25 01:24:05 +00:00
Calculate the length of the base message without any applied
actions.
"""
return sum(len(x) for x in self.values(settings))
2012-06-24 07:12:52 +00:00
def preview_safe(self):
"""
Return a copy of this message that issafe for previews.
"""
tokens = [i for i in self.tokens if not isinstance(i, PauseAt)]
return self.__class__(tokens)
def maximum_length(self, settings):
"""
2014-10-25 01:24:05 +00:00
Calculate the maximum length of the base message with all applied
actions.
"""
l = self.length(settings)
for i in self.actions:
if isinstance(i, InjectAt):
l += len(i.value.get_generator(settings))
return l
2012-10-28 21:00:41 +00:00
@abc.abstractmethod
def preamble(self, settings): # pragma: no cover
pass
2015-04-19 20:56:47 +00:00
@classmethod
2012-10-28 21:00:41 +00:00
def expr(klass): # pragma: no cover
pass
def log(self, settings):
"""
A dictionary that should be logged if this message is served.
"""
ret = {}
for i in self.logattrs:
v = getattr(self, i)
2014-10-25 01:24:05 +00:00
# Careful not to log any VALUE specs without sanitizing them first.
# We truncate at 1k.
if hasattr(v, "values"):
v = [x[:TRUNCATE] for x in v.values(settings)]
v = "".join(v).encode("string_escape")
elif hasattr(v, "__len__"):
v = v[:TRUNCATE]
v = v.encode("string_escape")
ret[i] = v
ret["spec"] = self.spec()
return ret
def values(self, settings):
vals = self.preamble(settings)
vals.append("\r\n")
for h in self.headers:
vals.extend(h.values(settings))
vals.append("\r\n")
if self.body:
vals.append(self.body.value.get_generator(settings))
return vals
def freeze(self, settings):
r = self.resolve(settings)
return self.__class__([i.freeze(settings) for i in r.tokens])
def __repr__(self):
return self.spec()
2012-06-24 07:12:52 +00:00
Sep = pp.Optional(pp.Literal(":")).suppress()
2014-10-25 01:24:05 +00:00
class Response(_Message):
2012-06-24 05:47:55 +00:00
comps = (
Body,
Header,
PauseAt,
DisconnectAt,
2012-07-20 11:36:39 +00:00
InjectAt,
2012-06-24 05:47:55 +00:00
ShortcutContentType,
2012-06-24 07:12:52 +00:00
ShortcutLocation,
Raw,
Reason
2012-06-24 05:47:55 +00:00
)
logattrs = ["code", "reason", "version", "body"]
2014-10-25 01:24:05 +00:00
@property
def ws(self):
return self.tok(WS)
@property
def code(self):
return self.tok(Code)
@property
def reason(self):
return self.tok(Reason)
2012-06-24 07:12:52 +00:00
def preamble(self, settings):
l = [self.version, " "]
if self.code:
l.extend(self.code.values(settings))
code = int(self.code.code)
elif self.ws:
l.extend(Code(101).values(settings))
code = 101
l.append(" ")
if self.reason:
l.extend(self.reason.values(settings))
else:
2014-10-25 01:24:05 +00:00
l.append(
LiteralGenerator(
http_status.RESPONSES.get(
code,
2014-10-25 01:24:05 +00:00
"Unknown code"
)
)
)
return l
2012-06-24 05:47:55 +00:00
def resolve(self, settings):
tokens = self.tokens[:]
if self.ws:
if not settings.websocket_key:
raise RenderError(
"No websocket key - have we seen a client handshake?"
)
if not self.code:
tokens.insert(
1,
Code(101)
)
hdrs = websockets.server_handshake_headers(settings.websocket_key)
for i in hdrs.lst:
if not utils.get_header(i[0], self.headers):
tokens.append(
Header(ValueLiteral(i[0]), ValueLiteral(i[1]))
)
if not self.raw:
if not utils.get_header("Content-Length", self.headers):
if not self.body:
length = 0
else:
length = len(self.body.value.get_generator(settings))
tokens.append(
Header(
ValueLiteral("Content-Length"),
ValueLiteral(str(length)),
)
)
intermediate = self.__class__(tokens)
return self.__class__(
[i.resolve(intermediate, settings) for i in tokens]
)
2012-06-24 05:47:55 +00:00
@classmethod
def expr(klass):
parts = [i.expr() for i in klass.comps]
atom = pp.MatchFirst(parts)
resp = pp.And(
[
pp.MatchFirst(
[
WS.expr() + pp.Optional(Sep + Code.expr()),
Code.expr(),
]
),
pp.ZeroOrMore(Sep + atom)
2012-06-24 05:47:55 +00:00
]
)
return resp
def spec(self):
return ":".join([i.spec() for i in self.tokens])
2012-06-24 05:47:55 +00:00
class Request(_Message):
comps = (
2012-04-28 00:42:03 +00:00
Body,
Header,
PauseAt,
DisconnectAt,
2012-07-20 11:36:39 +00:00
InjectAt,
ShortcutContentType,
2012-11-16 01:41:02 +00:00
ShortcutUserAgent,
Raw,
PathodSpec,
)
logattrs = ["method", "path", "body"]
2014-10-25 01:24:05 +00:00
@property
def ws(self):
return self.tok(WS)
@property
def method(self):
return self.tok(Method)
@property
def path(self):
return self.tok(Path)
2012-04-28 00:42:03 +00:00
@property
def pathodspec(self):
return self.tok(PathodSpec)
def preamble(self, settings):
v = self.method.values(settings)
v.append(" ")
v.extend(self.path.values(settings))
if self.pathodspec:
v.append(self.pathodspec.parsed.spec())
v.append(" ")
v.append(self.version)
return v
2012-06-24 07:12:52 +00:00
def resolve(self, settings):
tokens = self.tokens[:]
if self.ws:
if not self.method:
tokens.insert(
1,
Method("get")
)
2015-04-21 21:31:22 +00:00
for i in websockets.client_handshake_headers().lst:
if not utils.get_header(i[0], self.headers):
tokens.append(
Header(ValueLiteral(i[0]), ValueLiteral(i[1]))
)
if not self.raw:
if not utils.get_header("Content-Length", self.headers):
if self.body:
length = len(self.body.value.get_generator(settings))
tokens.append(
Header(
ValueLiteral("Content-Length"),
ValueLiteral(str(length)),
)
)
if settings.request_host:
if not utils.get_header("Host", self.headers):
tokens.append(
Header(
ValueLiteral("Host"),
ValueLiteral(settings.request_host)
)
)
intermediate = self.__class__(tokens)
return self.__class__(
[i.resolve(intermediate, settings) for i in tokens]
)
2012-04-28 00:42:03 +00:00
@classmethod
def expr(klass):
parts = [i.expr() for i in klass.comps]
atom = pp.MatchFirst(parts)
resp = pp.And(
[
pp.MatchFirst(
[
WS.expr() + pp.Optional(Sep + Method.expr()),
Method.expr(),
]
),
Sep,
2012-06-24 07:12:52 +00:00
Path.expr(),
pp.ZeroOrMore(Sep + atom)
2012-04-28 00:42:03 +00:00
]
)
return resp
def spec(self):
return ":".join([i.spec() for i in self.tokens])
2012-04-28 02:43:57 +00:00
class WebsocketFrame(_Message):
comps = (
Body,
PauseAt,
DisconnectAt,
InjectAt
)
logattrs = ["body"]
@classmethod
def expr(klass):
parts = [i.expr() for i in klass.comps]
atom = pp.MatchFirst(parts)
resp = pp.And(
[
2015-04-21 21:31:22 +00:00
pp.Literal("wf"),
Sep,
pp.ZeroOrMore(Sep + atom)
]
)
return resp
def spec(self):
return ":".join([i.spec() for i in self.tokens])
class PathodErrorResponse(Response):
pass
def make_error_response(reason, body=None):
tokens = [
Code("800"),
Header(ValueLiteral("Content-Type"), ValueLiteral("text/plain")),
Reason(ValueLiteral(reason)),
Body(ValueLiteral("pathod error: " + (body or reason))),
]
return PathodErrorResponse(tokens)
2012-04-28 00:42:03 +00:00
2014-10-25 01:24:05 +00:00
def read_file(settings, s):
uf = settings.get("unconstrained_file_access")
sd = settings.get("staticdir")
if not sd:
raise FileAccessDenied("File access disabled.")
sd = os.path.normpath(os.path.abspath(sd))
s = s[1:]
s = os.path.expanduser(s)
s = os.path.normpath(os.path.abspath(os.path.join(sd, s)))
if not uf and not s.startswith(sd):
raise FileAccessDenied("File access outside of configured directory")
if not os.path.isfile(s):
raise FileAccessDenied("File not readable")
2013-06-15 22:30:13 +00:00
return file(s, "rb").read()
def parse_response(s):
"""
May raise ParseException
"""
try:
s = s.decode("ascii")
except UnicodeError:
raise ParseException("Spec must be valid ASCII.", 0, 0)
2012-04-28 00:42:03 +00:00
try:
return Response(Response.expr().parseString(s, parseAll=True))
2012-04-28 00:42:03 +00:00
except pp.ParseException, v:
2012-04-28 02:43:57 +00:00
raise ParseException(v.msg, v.line, v.col)
2012-06-24 05:47:55 +00:00
def parse_requests(s):
"""
May raise ParseException
"""
try:
s = s.decode("ascii")
except UnicodeError:
raise ParseException("Spec must be valid ASCII.", 0, 0)
2012-06-24 05:47:55 +00:00
try:
parts = pp.OneOrMore(
pp.Group(
Request.expr()
)
).parseString(s, parseAll=True)
return [Request(i) for i in parts]
2012-06-24 05:47:55 +00:00
except pp.ParseException, v:
raise ParseException(v.msg, v.line, v.col)