|
| 1 | +import base64 |
| 2 | +import os |
1 | 3 | import unittest |
2 | 4 | from datetime import datetime, timedelta |
| 5 | +from unittest import mock |
3 | 6 |
|
4 | 7 | from http_message_signatures import HTTPMessageSigner |
5 | 8 | from http_message_signatures._algorithms import ED25519 |
6 | 9 |
|
7 | 10 | from dispatch.signature import ( |
8 | 11 | CaseInsensitiveDict, |
| 12 | + Ed25519PublicKey, |
9 | 13 | InvalidSignature, |
10 | 14 | Request, |
| 15 | + parse_verification_key, |
11 | 16 | sign_request, |
12 | 17 | verify_request, |
13 | 18 | ) |
|
33 | 38 | """ |
34 | 39 | ) |
35 | 40 |
|
| 41 | +public_key2_pem = """-----BEGIN PUBLIC KEY----- |
| 42 | +MCowBQYDK2VwAyEAJrQLj5P/89iXES9+vFgrIy29clF9CC/oPPsw3c5D0bs= |
| 43 | +-----END PUBLIC KEY----- |
| 44 | +""" |
| 45 | +public_key2_pem2 = """-----BEGIN PUBLIC KEY----- |
| 46 | +MCowBQYDK2VwAyEAJrQLj5P/89iXES9+vFgrIy29clF9CC/oPPsw3c5D0bs= |
| 47 | +-----END PUBLIC KEY----- |
| 48 | +""" |
| 49 | +public_key2 = public_key_from_pem(public_key2_pem) |
| 50 | +public_key2_bytes = public_key2.public_bytes_raw() |
| 51 | +public_key2_b64 = base64.b64encode(public_key2_bytes) |
| 52 | + |
36 | 53 |
|
37 | 54 | class TestSignature(unittest.TestCase): |
38 | 55 | def setUp(self): |
@@ -125,3 +142,70 @@ def test_known_signature(self): |
125 | 142 | ValueError, "public key 'test-key-ed25519' not available" |
126 | 143 | ): |
127 | 144 | verify_request(request, public_key, max_age=timedelta(weeks=9000)) |
| 145 | + |
| 146 | + @mock.patch.dict(os.environ, {"DISPATCH_VERIFICATION_KEY": public_key2_pem}) |
| 147 | + def test_parse_verification_key_env_pem_str(self): |
| 148 | + verification_key = parse_verification_key(None) |
| 149 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 150 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 151 | + |
| 152 | + @mock.patch.dict(os.environ, {"DISPATCH_VERIFICATION_KEY": public_key2_pem2}) |
| 153 | + def test_parse_verification_key_env_pem_escaped_newline_str(self): |
| 154 | + verification_key = parse_verification_key(None) |
| 155 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 156 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 157 | + |
| 158 | + @mock.patch.dict( |
| 159 | + os.environ, {"DISPATCH_VERIFICATION_KEY": public_key2_b64.decode()} |
| 160 | + ) |
| 161 | + def test_parse_verification_key_env_b64_str(self): |
| 162 | + verification_key = parse_verification_key(None) |
| 163 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 164 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 165 | + |
| 166 | + def test_parse_verification_key_none(self): |
| 167 | + # The verification key is optional. Both Dispatch(verification_key=...) and |
| 168 | + # DISPATCH_VERIFICATION_KEY may be omitted/None. |
| 169 | + verification_key = parse_verification_key(None) |
| 170 | + self.assertIsNone(verification_key) |
| 171 | + |
| 172 | + def test_parse_verification_key_ed25519publickey(self): |
| 173 | + verification_key = parse_verification_key(public_key2) |
| 174 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 175 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 176 | + |
| 177 | + def test_parse_verification_key_pem_str(self): |
| 178 | + verification_key = parse_verification_key(public_key2_pem) |
| 179 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 180 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 181 | + |
| 182 | + def test_parse_verification_key_pem_escaped_newline_str(self): |
| 183 | + verification_key = parse_verification_key(public_key2_pem2) |
| 184 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 185 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 186 | + |
| 187 | + def test_parse_verification_key_pem_bytes(self): |
| 188 | + verification_key = parse_verification_key(public_key2_pem.encode()) |
| 189 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 190 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 191 | + |
| 192 | + def test_parse_verification_key_b64_str(self): |
| 193 | + verification_key = parse_verification_key(public_key2_b64.decode()) |
| 194 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 195 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 196 | + |
| 197 | + def test_parse_verification_key_b64_bytes(self): |
| 198 | + verification_key = parse_verification_key(public_key2_b64) |
| 199 | + self.assertIsInstance(verification_key, Ed25519PublicKey) |
| 200 | + self.assertEqual(verification_key.public_bytes_raw(), public_key2_bytes) |
| 201 | + |
| 202 | + def test_parse_verification_key_invalid(self): |
| 203 | + with self.assertRaisesRegex(ValueError, "invalid verification key 'foo'"): |
| 204 | + parse_verification_key("foo") |
| 205 | + |
| 206 | + @mock.patch.dict(os.environ, {"DISPATCH_VERIFICATION_KEY": "foo"}) |
| 207 | + def test_parse_verification_key_invalid_env(self): |
| 208 | + with self.assertRaisesRegex( |
| 209 | + ValueError, "invalid DISPATCH_VERIFICATION_KEY 'foo'" |
| 210 | + ): |
| 211 | + parse_verification_key(None) |
0 commit comments