1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
|
import io
import itertools
import os
import random
import pytest
import falcon
from falcon import media
from falcon import testing
from falcon.media.multipart import MultipartParseOptions
from falcon.util import BufferedReader
try:
import msgpack
except ImportError:
msgpack = None
EXAMPLE1 = (
b'--5b11af82ab65407ba8cdccf37d2a9c4f\r\n'
b'Content-Disposition: form-data; name="hello"\r\n\r\n'
b'world\r\n'
b'--5b11af82ab65407ba8cdccf37d2a9c4f\r\n'
b'Content-Disposition: form-data; name="document"\r\n'
b'Content-Type: application/json\r\n\r\n'
b'{"debug": true, "message": "Hello, world!", "score": 7}\r\n'
b'--5b11af82ab65407ba8cdccf37d2a9c4f\r\n'
b'Content-Disposition: form-data; name="file1"; filename="test.txt"\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'Hello, world!\n\r\n'
b'--5b11af82ab65407ba8cdccf37d2a9c4f--\r\n'
)
EXAMPLE2 = (
b'-----------------------------1574247108204320607285918568\r\n'
b'Content-Disposition: form-data; name="description"\r\n\r\n'
b'\r\n'
b'-----------------------------1574247108204320607285918568\r\n'
b'Content-Disposition: form-data; name="moderation"\r\n\r\n'
b'approved\r\n'
b'-----------------------------1574247108204320607285918568\r\n'
b'Content-Disposition: form-data; name="title"\r\n\r\n'
b'A simple text file example.\r\n'
b'-----------------------------1574247108204320607285918568\r\n'
b'Content-Disposition: form-data; name="uploadid"\r\n\r\n'
b'00l33t0174873295\r\n'
b'-----------------------------1574247108204320607285918568\r\n'
b'Content-Disposition: form-data; name="file"; filename="test.txt"\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'Hello, world!\n'
b'\r\n'
b'-----------------------------1574247108204320607285918568--\r\n'
)
EXAMPLE2_PART_COUNT = 5
EXAMPLE3 = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="file"; filename="bytes"\r\n'
b'Content-Type: application/x-falcon\r\n\r\n'
+ (b'123456789abcdef\n' * 64 * 1024 * 2)
+ b'\r\n'
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="empty"\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'\r\n'
b'--BOUNDARY--\r\n'
)
LOREM_IPSUM = (
'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod '
'tempor incididunt ut labore et dolore magna aliqua. Dolor sed viverra '
'ipsum nunc aliquet bibendum enim. In massa tempor nec feugiat. Nunc '
'aliquet bibendum enim facilisis gravida. Nisl nunc mi ipsum faucibus '
'vitae aliquet nec ullamcorper. Amet luctus venenatis lectus magna '
'fringilla. Volutpat maecenas volutpat blandit aliquam etiam erat velit '
'scelerisque in. Egestas egestas fringilla phasellus faucibus scelerisque '
'eleifend. Sagittis orci a scelerisque purus semper eget duis. Nulla '
'pharetra diam sit amet nisl suscipit. Sed adipiscing diam donec '
'adipiscing tristique risus nec feugiat in. Fusce ut placerat orci nulla. '
'Pharetra vel turpis nunc eget lorem dolor. Tristique senectus et netus '
'et malesuada.\n'
).encode()
EXAMPLE4 = (
b'--boundary\r\n'
b'Content-Disposition: form-data; name="lorem1"; filename="bytes1"\r\n'
b'Content-Type: text/plain\r\n\r\n' + LOREM_IPSUM + b'\r\n'
b'--boundary\r\n'
b'Content-Disposition: form-data; name="empty"\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'\r\n'
b'--boundary\r\n'
b'Content-Disposition: form-data; name="lorem2"; filename="bytes1"\r\n'
b'Content-Type: text/plain\r\n\r\n' + LOREM_IPSUM + b'\r\n'
b'--boundary--\r\n'
)
EXAMPLES = {
'5b11af82ab65407ba8cdccf37d2a9c4f': EXAMPLE1,
'---------------------------1574247108204320607285918568': EXAMPLE2,
'BOUNDARY': EXAMPLE3,
'boundary': EXAMPLE4,
}
# APPSEC: This SHA256 hash is safe against preimage attacks.
HASH_BOUNDARY = 'fbeff51e0f5630958701f4941aec5595addcb3ee1b70468c8bd4be920304c184'
@pytest.mark.parametrize('boundary', list(EXAMPLES))
def test_parse(boundary):
handler = media.MultipartFormHandler()
example = EXAMPLES[boundary]
form = handler.deserialize(
io.BytesIO(example), 'multipart/form-data; boundary=' + boundary, len(example)
)
for part in form:
output = io.BytesIO()
part.stream.pipe(output)
assert isinstance(output.getvalue(), bytes)
@pytest.mark.parametrize(
'buffer_size,chunk_size',
list(
itertools.product(
(
32,
64,
128,
256,
),
(
7,
8,
9,
10,
32,
64,
128,
256,
),
)
),
)
def test_parsing_correctness(buffer_size, chunk_size):
example = EXAMPLES['boundary']
handler = media.MultipartFormHandler()
stream = BufferedReader(io.BytesIO(example).read, len(example), buffer_size)
form = handler.deserialize(
stream, 'multipart/form-data; boundary=boundary', len(example)
)
for part in form:
if part.name in ('lorem1', 'lorem2'):
part_stream = part.stream
result = []
while True:
chunk = part_stream.read(chunk_size)
if not chunk:
break
result.append(chunk)
assert b''.join(result) == LOREM_IPSUM
def test_missing_boundary():
handler = media.MultipartFormHandler()
with pytest.raises(falcon.HTTPInvalidHeader):
handler.deserialize(io.BytesIO(), 'multipart/form-data', 0)
with pytest.raises(falcon.HTTPInvalidHeader):
handler.deserialize(io.BytesIO(), 'multipart/form-data; boundary=', 0)
overlong = '-' * 71
content_type = 'multipart/form-data; boundary=' + overlong
with pytest.raises(falcon.HTTPInvalidHeader):
handler.deserialize(io.BytesIO(), content_type, 0)
def test_empty_input():
handler = media.MultipartFormHandler()
form = handler.deserialize(io.BytesIO(), 'multipart/form-data; boundary=404', 0)
with pytest.raises(falcon.MediaMalformedError):
for part in form:
pass
def test_serialize():
handler = media.MultipartFormHandler()
with pytest.raises(NotImplementedError):
handler.serialize({'key': 'value'}, 'multipart/form-data')
@pytest.mark.parametrize(
'charset,data',
[
('utf-8', b'Impossible byte: \xff'),
('utf-8', b'Overlong... \xfc\x83\xbf\xbf\xbf\xbf ... sequence'),
('ascii', b'\x80\x80\x80'),
('pecyn', b'AAHEHlRoZSBGYWxjb24gV2ViIEZyYW1ld29yaywgMjAxOQ=='),
],
)
def test_invalid_text_or_charset(charset, data):
data = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="text"\r\n'
b'Content-Type: text/plain; '
+ 'charset={}\r\n\r\n'.format(charset).encode()
+ data
+ b'\r\n'
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="empty"\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'\r\n'
b'--BOUNDARY--\r\n'
)
handler = media.MultipartFormHandler()
form = handler.deserialize(
io.BytesIO(data), 'multipart/form-data; boundary=BOUNDARY', len(data)
)
with pytest.raises(falcon.MediaMalformedError):
for part in form:
part.text
def test_unknown_header():
data = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="empty"\r\n'
b'Content-Coolness: fair\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'\r\n'
b'--BOUNDARY--\r\n'
)
handler = media.MultipartFormHandler()
form = handler.deserialize(
io.BytesIO(data), 'multipart/form-data; boundary=BOUNDARY', len(data)
)
for part in form:
assert part.data == b''
def test_from_buffered_stream():
data = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="empty"\r\n'
b'Content-Coolness: fair\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'\r\n'
b'--BOUNDARY--\r\n'
)
handler = media.MultipartFormHandler()
stream = BufferedReader(io.BytesIO(data).read, len(data))
form = handler.deserialize(
stream, 'multipart/form-data; boundary=BOUNDARY', len(data)
)
for part in form:
assert part.data == b''
def test_body_part_media():
handler = media.MultipartFormHandler()
content_type = 'multipart/form-data; boundary=' + '5b11af82ab65407ba8cdccf37d2a9c4f'
form = handler.deserialize(io.BytesIO(EXAMPLE1), content_type, len(EXAMPLE1))
expected = {'debug': True, 'message': 'Hello, world!', 'score': 7}
for part in form:
if part.content_type == 'application/json':
assert part.media == part.media == expected
def test_body_part_properties():
handler = media.MultipartFormHandler()
content_type = 'multipart/form-data; boundary=' + '5b11af82ab65407ba8cdccf37d2a9c4f'
form = handler.deserialize(io.BytesIO(EXAMPLE1), content_type, len(EXAMPLE1))
for part in form:
if part.content_type == 'application/json':
# NOTE(vytas): This is not a typo, but a test that the name
# property can be safely referenced multiple times.
assert part.name == part.name == 'document'
elif part.name == 'file1':
# NOTE(vytas): This is not a typo, but a test that the filename
# property can be safely referenced multiple times.
assert part.filename == part.filename == 'test.txt'
assert part.secure_filename == part.filename
def test_empty_or_missing_filename():
data = (
b'--a0d738bcdb30449eb0d13f4b72c2897e\r\n'
b'Content-Disposition: form-data; name="file"; filename=\r\n\r\n'
b'An empty filename.\r\n'
b'--a0d738bcdb30449eb0d13f4b72c2897e\r\n'
b'Content-Disposition: form-data; name="no file";\r\n\r\n'
b'No filename.\r\n'
b'--a0d738bcdb30449eb0d13f4b72c2897e--\r\n'
)
handler = media.MultipartFormHandler()
content_type = 'multipart/form-data; boundary=' + 'a0d738bcdb30449eb0d13f4b72c2897e'
stream = BufferedReader(io.BytesIO(data).read, len(data))
form = handler.deserialize(stream, content_type, len(data))
parts = 0
for part in form:
parts += 1
if part.name == 'file':
assert part.filename == ''
else:
assert part.filename is None
with pytest.raises(falcon.MediaMalformedError):
part.secure_filename
assert parts == 2
class MultipartAnalyzer:
def on_post(self, req, resp):
values = []
for part in req.media:
values.append(
{
'content_type': part.content_type,
'data': part.data.decode(),
'filename': part.filename,
'name': part.name,
'secure_filename': part.secure_filename if part.filename else None,
'text': part.text,
}
)
resp.media = values
def on_post_media(self, req, resp):
deserialized = []
for part in req.media:
part_media = part.get_media()
assert part_media == part.media
deserialized.append(part_media)
resp.media = deserialized
def on_post_mirror(self, req, resp):
parts = []
for part in req.get_media():
parts.append(
{
'content': part.stream.read(),
'content_type': part.content_type,
'name': part.name,
}
)
resp.content_type = falcon.MEDIA_MSGPACK
resp.media = parts
class AsyncMultipartAnalyzer:
async def on_post(self, req, resp):
values = []
form = await req.get_media()
async for part in form:
# NOTE(vytas): use the async property form to exercise that too.
values.append(
{
'content_type': part.content_type,
'data': (await part.data).decode(),
'filename': part.filename,
'name': part.name,
'secure_filename': part.secure_filename if part.filename else None,
'text': (await part.text),
}
)
resp.media = values
async def on_post_media(self, req, resp):
deserialized = []
form = await req.media
async for part in form:
part_media = await part.get_media()
assert part_media == await part.media
deserialized.append(part_media)
resp.media = deserialized
async def on_post_mirror(self, req, resp):
parts = []
async for part in await req.get_media():
parts.append(
{
'content': await part.stream.read(),
'content_type': part.content_type,
'name': part.name,
}
)
resp.content_type = falcon.MEDIA_MSGPACK
resp.media = parts
@pytest.fixture
def custom_client(asgi, util):
def _factory(options):
multipart_handler = media.MultipartFormHandler()
for key, value in options.items():
setattr(multipart_handler.parse_options, key, value)
req_handlers = {
falcon.MEDIA_JSON: media.JSONHandler(),
falcon.MEDIA_MULTIPART: multipart_handler,
}
resp_handlers = {
falcon.MEDIA_JSON: media.JSONHandler(),
}
if msgpack:
resp_handlers[falcon.MEDIA_MSGPACK] = media.MessagePackHandler()
app = util.create_app(asgi)
app.req_options.media_handlers = media.Handlers(req_handlers)
app.resp_options.media_handlers = media.Handlers(resp_handlers)
resource = AsyncMultipartAnalyzer() if asgi else MultipartAnalyzer()
app.add_route('/submit', resource)
app.add_route('/media', resource, suffix='media')
app.add_route('/mirror', resource, suffix='mirror')
return testing.TestClient(app)
return _factory
@pytest.fixture
def client(custom_client):
return custom_client({})
def test_upload_multipart(client):
resp = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; '
'boundary=5b11af82ab65407ba8cdccf37d2a9c4f',
},
body=EXAMPLE1,
)
assert resp.status_code == 200
assert resp.json == [
{
'content_type': 'text/plain',
'data': 'world',
'filename': None,
'name': 'hello',
'secure_filename': None,
'text': 'world',
},
{
'content_type': 'application/json',
'data': '{"debug": true, "message": "Hello, world!", "score": 7}',
'filename': None,
'name': 'document',
'secure_filename': None,
'text': None,
},
{
'content_type': 'text/plain',
'data': 'Hello, world!\n',
'filename': 'test.txt',
'name': 'file1',
'secure_filename': 'test.txt',
'text': 'Hello, world!\n',
},
]
@pytest.mark.parametrize('epilogue', ['', '--', '\n', '\n\n', ' <-- no CRLF', '💥'])
def test_epilogue(client, epilogue):
# NOTE(vytas): According to RFC 2046, actually including an epilogue might
# require a trailing CRLF first, but we do not mandate it either.
form_body = EXAMPLE1[:-2] + epilogue.encode()
resp = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; '
'boundary=5b11af82ab65407ba8cdccf37d2a9c4f',
},
body=form_body,
)
assert resp.status_code == 200
assert [part['name'] for part in resp.json] == ['hello', 'document', 'file1']
@pytest.mark.parametrize('truncated_by', [1, 2, 3, 4])
def test_truncated_form(client, truncated_by):
resp = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; '
'boundary=5b11af82ab65407ba8cdccf37d2a9c4f',
},
# NOTE(vytas): The trailing \r\n is not mandatory, hence +2.
body=EXAMPLE1[: -(truncated_by + 2)],
)
assert resp.status_code == 400
assert resp.json == {
'description': 'unexpected form structure',
'title': 'Malformed multipart/form-data request media',
}
def test_unexpected_form_structure(client):
resp1 = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; '
'boundary=5b11af82ab65407ba8cdccf37d2a9c4f',
},
body=EXAMPLE1[:-4] + b'__\r\n',
)
assert resp1.status_code == 400
assert resp1.json == {
'description': 'unexpected form structure',
'title': 'Malformed multipart/form-data request media',
}
resp2 = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; '
'boundary=5b11af82ab65407ba8cdccf37d2a9c4f',
},
body=EXAMPLE1[:-4] + b'**\r\n',
)
assert resp2.status_code == 400
assert resp2.json == {
'description': 'unexpected form structure',
'title': 'Malformed multipart/form-data request media',
}
def test_data_too_large(client):
resp = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; boundary=BOUNDARY',
},
body=EXAMPLE3,
)
assert resp.status_code == 400
assert resp.json == {
'description': 'body part is too large',
'title': 'Malformed multipart/form-data request media',
}
@pytest.mark.parametrize('max_body_part_count', list(range(7)) + [100, 1000])
def test_too_many_body_parts(custom_client, max_body_part_count):
client = custom_client({'max_body_part_count': max_body_part_count})
boundary = '---------------------------1574247108204320607285918568'
resp = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; boundary=' + boundary,
},
body=EXAMPLE2,
)
if 0 < max_body_part_count < EXAMPLE2_PART_COUNT:
assert resp.status_code == 400
assert resp.json == {
'description': 'maximum number of form body parts exceeded',
'title': 'Malformed multipart/form-data request media',
}
else:
assert resp.status_code == 200
assert len(resp.json) == EXAMPLE2_PART_COUNT
@pytest.mark.skipif(not msgpack, reason='msgpack not installed')
@pytest.mark.parametrize('close_delimiter', ['--', '--\r\n'])
def test_random_form(client, close_delimiter):
part_data = [os.urandom(random.randint(0, 2**18)) for _ in range(64)]
form_data = (
b''.join(
'--{}\r\n'.format(HASH_BOUNDARY).encode()
+ 'Content-Disposition: form-data; name="p{}"\r\n'.format(i).encode()
+ b'Content-Type: application/x-falcon-urandom\r\n\r\n'
+ part_data[i]
+ b'\r\n'
for i in range(64)
)
+ '--{}{}'.format(HASH_BOUNDARY, close_delimiter).encode()
)
handler = media.MultipartFormHandler()
content_type = 'multipart/form-data; boundary=' + HASH_BOUNDARY
form = handler.deserialize(io.BytesIO(form_data), content_type, len(form_data))
resp = client.simulate_post(
'/mirror', headers={'Content-Type': content_type}, body=form_data
)
assert resp.status_code == 200
form = msgpack.unpackb(resp.content, raw=False)
for index, part in enumerate(form):
assert part['content'] == part_data[index]
assert part['content_type'] == 'application/x-falcon-urandom'
def test_invalid_random_form(client):
length = random.randint(2**20, 2**21)
resp = client.simulate_post(
'/submit',
headers={
'Content-Type': 'multipart/form-data; boundary=' + HASH_BOUNDARY,
},
body=os.urandom(length),
)
assert resp.status_code == 400
def test_nested_multipart_mixed():
class Forms:
def on_post(self, req, resp):
example = {}
for part in req.media:
if part.content_type.startswith('multipart/mixed'):
for nested in part.media:
example[nested.filename] = nested.text
resp.media = example
parser = media.MultipartFormHandler()
parser.parse_options.media_handlers['multipart/mixed'] = (
media.MultipartFormHandler()
)
app = falcon.App()
app.req_options.media_handlers[falcon.MEDIA_MULTIPART] = parser
app.add_route('/forms', Forms())
client = testing.TestClient(app)
form_data = (
b'--AaB03x\r\n'
b'Content-Disposition: form-data; name="field1"\r\n\r\n'
b'Joe Blow\r\n'
b'--AaB03x\r\n'
b'Content-Disposition: form-data; name="docs"\r\n'
b'Content-Type: multipart/mixed; boundary=BbC04y\r\n\r\n'
b'--BbC04y\r\n'
b'Content-Disposition: attachment; filename="file1.txt"\r\n\r\n'
b'This is file1.\r\n\r\n'
b'--BbC04y\r\n'
b'Content-Disposition: attachment; filename="file2.txt"\r\n'
b'Content-Transfer-Encoding: binary\r\n\r\n'
b'Hello, World!\r\n\r\n'
b'--BbC04y--\r\n\r\n'
b'--AaB03x--\r\n'
)
resp = client.simulate_post(
'/forms',
headers={'Content-Type': 'multipart/form-data; boundary=AaB03x'},
body=form_data,
)
assert resp.status_code == 200
assert resp.json == {
'file1.txt': 'This is file1.\r\n',
'file2.txt': 'Hello, World!\r\n',
}
def test_content_transfer_encoding_header(client):
data = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="file"; filename="bytes"\r\n'
b'Content-Transfer-Encoding: Base64'
b'Content-Type: application/x-falcon\r\n\r\n'
b'UGVyZWdyaW5lIEZhbGNvbiADLgA='
b'\r\n'
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="empty"\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'\r\n'
b'--BOUNDARY--\r\n'
)
resp = client.simulate_post(
'/submit',
headers={'Content-Type': 'multipart/form-data; boundary=BOUNDARY'},
body=data,
)
assert resp.status_code == 400
assert resp.json == {
'description': (
'the deprecated Content-Transfer-Encoding header field is unsupported'
),
'title': 'Malformed multipart/form-data request media',
}
def test_unsupported_charset(client):
data = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="text"\r\n'
b'Content-Type: text/plain; charset=pecyn\r\n\r\n'
b'AAHEHlRoZSBGYWxjb24gV2ViIEZyYW1ld29yaywgMjAxOQ=='
b'\r\n'
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="empty"\r\n'
b'Content-Type: text/plain\r\n\r\n'
b'\r\n'
b'--BOUNDARY--\r\n'
)
resp = client.simulate_post(
'/submit',
headers={'Content-Type': 'multipart/form-data; boundary=BOUNDARY'},
body=data,
)
assert resp.status_code == 400
assert resp.json == {
'description': 'invalid text or charset: pecyn',
'title': 'Malformed multipart/form-data request media',
}
def test_filename_star(client):
# NOTE(vytas): Generated by requests_toolbelt 0.9.1 on Py2
# (interestingly, one gets a "normal" filename on Py3.7).
data = (
b'--a0d738bcdb30449eb0d13f4b72c2897e\r\n'
b'Content-Disposition: form-data; name="file"; '
b"filename*=utf-8''%E2%AC%85%20Arrow.txt\r\n\r\n"
b'A unicode arrow in the filename.\r\n'
b'--a0d738bcdb30449eb0d13f4b72c2897e--\r\n'
)
content_type = 'multipart/form-data; boundary=' + 'a0d738bcdb30449eb0d13f4b72c2897e'
resp = client.simulate_post(
'/submit', headers={'Content-Type': content_type}, body=data
)
assert resp.status_code == 200
assert resp.json == [
{
'content_type': 'text/plain',
'data': 'A unicode arrow in the filename.',
'filename': '⬅ Arrow.txt',
'name': 'file',
'secure_filename': '__Arrow.txt',
'text': 'A unicode arrow in the filename.',
}
]
data = data.replace(b'*=utf-8', b'*=esoteric')
resp = client.simulate_post(
'/submit', headers={'Content-Type': content_type}, body=data
)
assert resp.status_code == 400
assert resp.json == {
'description': 'invalid text or charset: esoteric',
'title': 'Malformed multipart/form-data request media',
}
@pytest.mark.parametrize('max_headers_size', [64, 140, 141, 142, 256, 1024])
def test_headers_edge_cases(custom_client, max_headers_size):
client = custom_client({'max_body_part_headers_size': max_headers_size})
data = (
b'--a0d738bcdb30449eb0d13f4b72c2897e\r\n'
b'X-Falcon: Peregrine\r\n'
b'Content-Type: application/vnd.oasis.opendocument.text\r\n'
b'Junk\r\n'
b'Content-Disposition: form-data; name="file"; filename=hd.txt\r\n\r\n'
b'No, it is not an ODT document...\r\n'
b'--a0d738bcdb30449eb0d13f4b72c2897e--\r\n'
)
content_type = 'multipart/form-data; boundary=' + 'a0d738bcdb30449eb0d13f4b72c2897e'
resp = client.simulate_post(
'/submit', headers={'Content-Type': content_type}, body=data
)
if max_headers_size < 142:
assert resp.status_code == 400
assert resp.json == {
'description': 'incomplete body part headers',
'title': 'Malformed multipart/form-data request media',
}
else:
assert len(resp.json) == 1
def test_deserialize_part_media(client):
data = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="factorials"\r\n'
b'Content-Type: application/json\r\n\r\n'
b'{"count": 6, "numbers": [1, 2, 6, 24, 120, 720]}\r\n'
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="person"\r\n'
b'Content-Type: application/x-www-form-urlencoded\r\n\r\n'
b'name=Jane&surname=Doe&fruit=%F0%9F%8D%8F\r\n'
b'--BOUNDARY--\r\n'
)
resp = client.simulate_post(
'/media',
headers={'Content-Type': 'multipart/form-data; boundary=BOUNDARY'},
body=data,
)
assert resp.status_code == 200
assert resp.json == [
{'count': 6, 'numbers': [1, 2, 6, 24, 120, 720]},
{'fruit': '🍏', 'name': 'Jane', 'surname': 'Doe'},
]
def test_deserialize_custom_media(custom_client):
class FirstByteHandler(media.BaseHandler):
exhaust_stream = True
def deserialize(self, stream, content_type, content_length):
first_byte = stream.read(1)
if first_byte:
return '0x{:02x}'.format(first_byte[0])
return ''
async def deserialize_async(self, stream, content_type, content_length):
first_byte = await stream.read(1)
if first_byte:
return '0x{:02x}'.format(first_byte[0])
return ''
handlers = media.Handlers({'application/x-falcon-first-byte': FirstByteHandler()})
client = custom_client({'media_handlers': handlers})
data = (
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="first"\r\n'
b'Content-Type: application/x-falcon-first-byte\r\n\r\n'
b'\r\n'
b'--BOUNDARY\r\n'
b'Content-Disposition: form-data; name="second"\r\n'
b'Content-Type: application/x-falcon-first-byte\r\n\r\n'
b'Hi!\r\n'
b'--BOUNDARY--\r\n'
)
resp = client.simulate_post(
'/media',
headers={'Content-Type': 'multipart/form-data; boundary=BOUNDARY'},
body=data,
)
assert resp.status_code == 200
assert resp.json == ['', '0x48']
def test_multipart_parse_options_default_handlers_unique():
parse_options_one = MultipartParseOptions()
parse_options_two = MultipartParseOptions()
parse_options_one.media_handlers.pop(falcon.MEDIA_JSON)
assert parse_options_one.media_handlers is not parse_options_two.media_handlers
assert len(parse_options_one.media_handlers) == 1
assert len(parse_options_two.media_handlers) >= 2
|