From 2d474d6b042547251a598096ed61306462d83154 Mon Sep 17 00:00:00 2001 From: Jonathan Bastien-Filiatrault Date: Wed, 12 Dec 2018 21:11:12 -0500 Subject: [PATCH 1/3] Do not take the name length into account on the second line when folding. Setting namelen could have no effect, my guess is that this was the original intention of the code. This results in more efficient usage of lines. --- dkim/__init__.py | 2 +- dkim/tests/test_arc.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dkim/__init__.py b/dkim/__init__.py index ed54d1f..7e1b2a8 100644 --- a/dkim/__init__.py +++ b/dkim/__init__.py @@ -403,7 +403,7 @@ def fold(header, namelen=0): j = i + 1 pre += header[:j] + b"\r\n " header = header[j:] - namelen = 0 + maxleng = 72 if len(header) > 2: return pre + header else: diff --git a/dkim/tests/test_arc.py b/dkim/tests/test_arc.py index 18719a3..2a3b6f1 100644 --- a/dkim/tests/test_arc.py +++ b/dkim/tests/test_arc.py @@ -74,7 +74,7 @@ Y+vtSBczUiKERHv1yRbcaQtZFh5wtiRrN04BLUTD21MycBX5jYchHjPY/wIDAQAB""" sig_lines = dkim.arc_sign( self.message, b"test", b"example.com", self.key, b"lists.example.org", timestamp="12345") - expected_sig = [b'ARC-Seal: i=1; cv=none; a=rsa-sha256; d=example.com; s=test; t=12345; \r\n b=2DTLaiAcKznJwwNOWoOG8WBsdTq+/S92TZbURDxkgjGCmsSw8czQiisf02sC92\r\n 0nswz3JItA80l70iguM00onrj3eCe41yRDzB8lQL3kbrDyM+wUewmyhPoifRTsng\r\n t9ELTFrax4kCeHv6SdNz3uJfGYwQc+WCFEchXt3szNTRM=\r\n', b'ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; \r\n d=example.com; s=test; t=12345; h=message-id : \r\n date : from : to : subject : from; \r\n bh=wE7NXSkgnx9PGiavN4OZhJztvkqPDlemV3OGuEnLwNo=; \r\n b=a0f6qc3k9eECTSR155A0TQS+LjqPFWfI/brQBA83EUz00SNxj\r\n 1wmWykvs1hhBVeM0r1kEQc6CKbzRYaBNSiFj4q8JBpRIujLz1qL\r\n yGmPuAI6ddu/Z/1hQxgpVcp/odmI1UMV2R+d+yQ7tUp3EQxF/GY\r\n Nt22rV4rNmDmANZVqJ90=\r\n', b'ARC-Authentication-Results: i=1; lists.example.org; arc=none;\r\n spf=pass smtp.mfrom=jqd@d1.example;\r\n dkim=pass (1024-bit key) header.i=@d1.example;\r\n dmarc=pass\r\n'] + expected_sig = [b'ARC-Seal: i=1; cv=none; a=rsa-sha256; d=example.com; s=test; t=12345; \r\n b=AwwfB+haHcusCH1o5kKebsCtsGWBa2sW1jJRHPNLRv8e5fuDl8VMYtj/r5LIZRgj+2ubPc\r\n hjLhoj6/Nf3Sv5m3P6iW9nnXM/HV0CLFxD5RjLhNy0Wsi6POBHVQ2KTT85xv7AyBURBv00Np\r\n kgGt+v3g7wtDQ3T+MwquceXqPmRjM=\r\n', b'ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; \r\n d=example.com; s=test; t=12345; h=message-id : date : from : to : \r\n subject : from; bh=wE7NXSkgnx9PGiavN4OZhJztvkqPDlemV3OGuEnLwNo=; \r\n b=a0f6qc3k9eECTSR155A0TQS+LjqPFWfI/brQBA83EUz00SNxj1wmWykvs1hhBVeM0r1kEQ\r\n c6CKbzRYaBNSiFj4q8JBpRIujLz1qLyGmPuAI6ddu/Z/1hQxgpVcp/odmI1UMV2R+d+yQ7tU\r\n p3EQxF/GYNt22rV4rNmDmANZVqJ90=\r\n', b'ARC-Authentication-Results: i=1; lists.example.org; arc=none;\r\n spf=pass smtp.mfrom=jqd@d1.example;\r\n dkim=pass (1024-bit key) header.i=@d1.example;\r\n dmarc=pass\r\n'] self.assertEqual(expected_sig, sig_lines) From 6b4127f9205c150c15877b3ed094895ca74908c7 Mon Sep 17 00:00:00 2001 From: Jonathan Bastien-Filiatrault Date: Wed, 12 Dec 2018 21:30:56 -0500 Subject: [PATCH 2/3] Don't insert an extra space at the end of the line when doing a soft fold. Trailing whitespaces are best avoided. --- dkim/__init__.py | 5 +++-- dkim/tests/test_arc.py | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/dkim/__init__.py b/dkim/__init__.py index 7e1b2a8..a8d3bbe 100644 --- a/dkim/__init__.py +++ b/dkim/__init__.py @@ -371,7 +371,7 @@ def fold(header, namelen=0): >>> text(fold(b'foo')) 'foo' >>> text(fold(b'foo '+b'foo'*24).splitlines()[0]) - 'foo ' + 'foo ' >>> text(fold(b'foo'*25).splitlines()[-1]) ' foo' >>> len(fold(b'foo'*25).splitlines()[0]) @@ -399,9 +399,10 @@ def fold(header, namelen=0): i = header[:maxleng].rfind(b" ") if i == -1: j = maxleng + pre += header[:j] + b"\r\n " else: j = i + 1 - pre += header[:j] + b"\r\n " + pre += header[:i] + b"\r\n " header = header[j:] maxleng = 72 if len(header) > 2: diff --git a/dkim/tests/test_arc.py b/dkim/tests/test_arc.py index 2a3b6f1..687bd8f 100644 --- a/dkim/tests/test_arc.py +++ b/dkim/tests/test_arc.py @@ -74,7 +74,7 @@ Y+vtSBczUiKERHv1yRbcaQtZFh5wtiRrN04BLUTD21MycBX5jYchHjPY/wIDAQAB""" sig_lines = dkim.arc_sign( self.message, b"test", b"example.com", self.key, b"lists.example.org", timestamp="12345") - expected_sig = [b'ARC-Seal: i=1; cv=none; a=rsa-sha256; d=example.com; s=test; t=12345; \r\n b=AwwfB+haHcusCH1o5kKebsCtsGWBa2sW1jJRHPNLRv8e5fuDl8VMYtj/r5LIZRgj+2ubPc\r\n hjLhoj6/Nf3Sv5m3P6iW9nnXM/HV0CLFxD5RjLhNy0Wsi6POBHVQ2KTT85xv7AyBURBv00Np\r\n kgGt+v3g7wtDQ3T+MwquceXqPmRjM=\r\n', b'ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; \r\n d=example.com; s=test; t=12345; h=message-id : date : from : to : \r\n subject : from; bh=wE7NXSkgnx9PGiavN4OZhJztvkqPDlemV3OGuEnLwNo=; \r\n b=a0f6qc3k9eECTSR155A0TQS+LjqPFWfI/brQBA83EUz00SNxj1wmWykvs1hhBVeM0r1kEQ\r\n c6CKbzRYaBNSiFj4q8JBpRIujLz1qLyGmPuAI6ddu/Z/1hQxgpVcp/odmI1UMV2R+d+yQ7tU\r\n p3EQxF/GYNt22rV4rNmDmANZVqJ90=\r\n', b'ARC-Authentication-Results: i=1; lists.example.org; arc=none;\r\n spf=pass smtp.mfrom=jqd@d1.example;\r\n dkim=pass (1024-bit key) header.i=@d1.example;\r\n dmarc=pass\r\n'] + expected_sig = [b'ARC-Seal: i=1; cv=none; a=rsa-sha256; d=example.com; s=test; t=12345;\r\n b=AwwfB+haHcusCH1o5kKebsCtsGWBa2sW1jJRHPNLRv8e5fuDl8VMYtj/r5LIZRgj+2ubPc\r\n hjLhoj6/Nf3Sv5m3P6iW9nnXM/HV0CLFxD5RjLhNy0Wsi6POBHVQ2KTT85xv7AyBURBv00Np\r\n kgGt+v3g7wtDQ3T+MwquceXqPmRjM=\r\n', b'ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed;\r\n d=example.com; s=test; t=12345; h=message-id : date : from : to :\r\n subject : from; bh=wE7NXSkgnx9PGiavN4OZhJztvkqPDlemV3OGuEnLwNo=;\r\n b=a0f6qc3k9eECTSR155A0TQS+LjqPFWfI/brQBA83EUz00SNxj1wmWykvs1hhBVeM0r1kEQ\r\n c6CKbzRYaBNSiFj4q8JBpRIujLz1qLyGmPuAI6ddu/Z/1hQxgpVcp/odmI1UMV2R+d+yQ7tU\r\n p3EQxF/GYNt22rV4rNmDmANZVqJ90=\r\n', b'ARC-Authentication-Results: i=1; lists.example.org; arc=none;\r\n spf=pass smtp.mfrom=jqd@d1.example;\r\n dkim=pass (1024-bit key) header.i=@d1.example;\r\n dmarc=pass\r\n'] self.assertEqual(expected_sig, sig_lines) @@ -84,7 +84,7 @@ Y+vtSBczUiKERHv1yRbcaQtZFh5wtiRrN04BLUTD21MycBX5jYchHjPY/wIDAQAB""" def test_fails_h_in_as(self): # ARC 4.1.3, h= not allowed in AS self.maxDiff = None - sig_lines = [b'ARC-Seal: i=1; cv=none; a=rsa-sha256; d=example.com; s=test; t=12345; \r\n h=message-id : date : from : to : subject : from; \r\n b=mIurIuLl0/wAxWhA4DBS1wsUE15IBnmJ7o3sH15hIuesdD4smz1cCLXVhRtxQE\r\n rVtVLv4OgNCgdFsB5zbSOUao2bSSYP6y0BGyCWvr+hU4tai5axIc1Kfwbtv/0Mqg\r\n waiGJPreOAAeZOJ4vPfdaAbSXlN5MI4PHW89U82FSIBKI=\r\n', b'ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; \r\n d=example.com; s=test; t=12345; h=message-id : \r\n date : from : to : subject : from; \r\n bh=wE7NXSkgnx9PGiavN4OZhJztvkqPDlemV3OGuEnLwNo=; \r\n b=a0f6qc3k9eECTSR155A0TQS+LjqPFWfI/brQBA83EUz00SNxj\r\n 1wmWykvs1hhBVeM0r1kEQc6CKbzRYaBNSiFj4q8JBpRIujLz1qL\r\n yGmPuAI6ddu/Z/1hQxgpVcp/odmI1UMV2R+d+yQ7tUp3EQxF/GY\r\n Nt22rV4rNmDmANZVqJ90=\r\n', b'ARC-Authentication-Results: i=1; lists.example.org; arc=none;\r\n spf=pass smtp.mfrom=jqd@d1.example;\r\n dkim=pass (1024-bit key) header.i=@d1.example;\r\n dmarc=pass\r\n'] + sig_lines = [b'ARC-Seal: i=1; cv=none; a=rsa-sha256; d=example.com; s=test; t=12345;\r\n h=message-id : date : from : to : subject : from;\r\n b=mIurIuLl0/wAxWhA4DBS1wsUE15IBnmJ7o3sH15hIuesdD4smz1cCLXVhRtxQE\r\n rVtVLv4OgNCgdFsB5zbSOUao2bSSYP6y0BGyCWvr+hU4tai5axIc1Kfwbtv/0Mqg\r\n waiGJPreOAAeZOJ4vPfdaAbSXlN5MI4PHW89U82FSIBKI=\r\n', b'ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed;\r\n d=example.com; s=test; t=12345; h=message-id :\r\n date : from : to : subject : from;\r\n bh=wE7NXSkgnx9PGiavN4OZhJztvkqPDlemV3OGuEnLwNo=;\r\n b=a0f6qc3k9eECTSR155A0TQS+LjqPFWfI/brQBA83EUz00SNxj\r\n 1wmWykvs1hhBVeM0r1kEQc6CKbzRYaBNSiFj4q8JBpRIujLz1qL\r\n yGmPuAI6ddu/Z/1hQxgpVcp/odmI1UMV2R+d+yQ7tUp3EQxF/GY\r\n Nt22rV4rNmDmANZVqJ90=\r\n', b'ARC-Authentication-Results: i=1; lists.example.org; arc=none;\r\n spf=pass smtp.mfrom=jqd@d1.example;\r\n dkim=pass (1024-bit key) header.i=@d1.example;\r\n dmarc=pass\r\n'] (cv, res, reason) = dkim.arc_verify(b''.join(sig_lines) + self.message, dnsfunc=self.dnsfunc) self.assertEqual(cv, dkim.CV_Fail) From 0555cb595d089e72e00dc67caf29dad1a82c79be Mon Sep 17 00:00:00 2001 From: Scott Kitterman Date: Sun, 23 Dec 2018 01:57:38 -0500 Subject: [PATCH 3/3] ChangeLog engry for jbfzs/beautifold --- ChangeLog | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ChangeLog b/ChangeLog index 903ef34..ffaa3dc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,6 +2,8 @@ UNRELEASED Version 0.9.2 - Refactor canonicalization.py strip_trailing_lines to avoid using re for more consistent processing across python versions (Thanks to Jonathan Bastien-Filiatrault for the change) + - Refactor header folding for more consistent results, including reduced + stray whitespace (Also Jonathan Bastien-Filiatrault) 2018-12-09 Version 0.9.1 - Fixed ARC verification to fail if h= tag is present in Arc-Seal and added tests