Conditions | 1 |
Paths | 1 |
Total Lines | 67 |
Code Lines | 46 |
Lines | 0 |
Ratio | 0 % |
Changes | 5 | ||
Bugs | 3 | Features | 1 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
32 | public function testA256GCMKWAndA128CBC_HS256Encryption() |
||
33 | { |
||
34 | $expected_payload = "You can trust us to stick with you through thick and thin\xe2\x80\x93to the bitter end. And you can trust us to keep any secret of yours\xe2\x80\x93closer than you keep it yourself. But you cannot trust us to let you face trouble alone, and go off without a word. We are your friends, Frodo."; |
||
35 | |||
36 | $private_key = new JWK([ |
||
37 | 'kty' => 'oct', |
||
38 | 'kid' => '18ec08e1-bfa9-4d95-b205-2b4dd1d4321d', |
||
39 | 'use' => 'enc', |
||
40 | 'alg' => 'A256GCMKW', |
||
41 | 'k' => 'qC57l_uxcm7Nm3K-ct4GFjx8tM1U8CZ0NLBvdQstiS8', |
||
42 | ]); |
||
43 | |||
44 | $protected_headers = [ |
||
45 | 'alg' => 'A256GCMKW', |
||
46 | 'kid' => '18ec08e1-bfa9-4d95-b205-2b4dd1d4321d', |
||
47 | 'tag' => 'kfPduVQ3T3H6vnewt--ksw', |
||
48 | 'iv' => 'KkYT0GX_2jHlfqN_', |
||
49 | 'enc' => 'A128CBC-HS256', |
||
50 | ]; |
||
51 | |||
52 | $expected_compact_json = 'eyJhbGciOiJBMjU2R0NNS1ciLCJraWQiOiIxOGVjMDhlMS1iZmE5LTRkOTUtYjIwNS0yYjRkZDFkNDMyMWQiLCJ0YWciOiJrZlBkdVZRM1QzSDZ2bmV3dC0ta3N3IiwiaXYiOiJLa1lUMEdYXzJqSGxmcU5fIiwiZW5jIjoiQTEyOENCQy1IUzI1NiJ9.lJf3HbOApxMEBkCMOoTnnABxs_CvTWUmZQ2ElLvYNok.gz6NjyEFNm_vm8Gj6FwoFQ.Jf5p9-ZhJlJy_IQ_byKFmI0Ro7w7G1QiaZpI8OaiVgD8EqoDZHyFKFBupS8iaEeVIgMqWmsuJKuoVgzR3YfzoMd3GxEm3VxNhzWyWtZKX0gxKdy6HgLvqoGNbZCzLjqcpDiF8q2_62EVAbr2uSc2oaxFmFuIQHLcqAHxy51449xkjZ7ewzZaGV3eFqhpco8o4DijXaG5_7kp3h2cajRfDgymuxUbWgLqaeNQaJtvJmSMFuEOSAzw9Hdeb6yhdTynCRmu-kqtO5Dec4lT2OMZKpnxc_F1_4yDJFcqb5CiDSmA-psB2k0JtjxAj4UPI61oONK7zzFIu4gBfjJCndsZfdvG7h8wGjV98QhrKEnR7xKZ3KCr0_qR1B-gxpNk3xWU.DKW7jrb4WaRSNfbXVPlT5g'; |
||
53 | |||
54 | /* |
||
55 | * There is an error in this vector |
||
56 | * In the RFC7520, the tag is 'DKW7jrb4WaRSNfbXVPlT5g' (see figure 147), but the tag from the flattened representation is 'NvBveHr_vonkvflfnUrmBQ' |
||
57 | * Same goes for the protected header. The values are good, but as the order is different, the protected header value is different and the tag is not validated. |
||
58 | */ |
||
59 | $expected_flattened_json = '{"protected":"eyJhbGciOiJBMjU2R0NNS1ciLCJraWQiOiIxOGVjMDhlMS1iZmE5LTRkOTUtYjIwNS0yYjRkZDFkNDMyMWQiLCJ0YWciOiJrZlBkdVZRM1QzSDZ2bmV3dC0ta3N3IiwiaXYiOiJLa1lUMEdYXzJqSGxmcU5fIiwiZW5jIjoiQTEyOENCQy1IUzI1NiJ9","encrypted_key":"lJf3HbOApxMEBkCMOoTnnABxs_CvTWUmZQ2ElLvYNok","iv":"gz6NjyEFNm_vm8Gj6FwoFQ","ciphertext":"Jf5p9-ZhJlJy_IQ_byKFmI0Ro7w7G1QiaZpI8OaiVgD8EqoDZHyFKFBupS8iaEeVIgMqWmsuJKuoVgzR3YfzoMd3GxEm3VxNhzWyWtZKX0gxKdy6HgLvqoGNbZCzLjqcpDiF8q2_62EVAbr2uSc2oaxFmFuIQHLcqAHxy51449xkjZ7ewzZaGV3eFqhpco8o4DijXaG5_7kp3h2cajRfDgymuxUbWgLqaeNQaJtvJmSMFuEOSAzw9Hdeb6yhdTynCRmu-kqtO5Dec4lT2OMZKpnxc_F1_4yDJFcqb5CiDSmA-psB2k0JtjxAj4UPI61oONK7zzFIu4gBfjJCndsZfdvG7h8wGjV98QhrKEnR7xKZ3KCr0_qR1B-gxpNk3xWU","tag":"DKW7jrb4WaRSNfbXVPlT5g"}'; |
||
60 | $expected_json = '{"recipients":[{"encrypted_key":"lJf3HbOApxMEBkCMOoTnnABxs_CvTWUmZQ2ElLvYNok"}],"protected":"eyJhbGciOiJBMjU2R0NNS1ciLCJraWQiOiIxOGVjMDhlMS1iZmE5LTRkOTUtYjIwNS0yYjRkZDFkNDMyMWQiLCJ0YWciOiJrZlBkdVZRM1QzSDZ2bmV3dC0ta3N3IiwiaXYiOiJLa1lUMEdYXzJqSGxmcU5fIiwiZW5jIjoiQTEyOENCQy1IUzI1NiJ9","iv":"gz6NjyEFNm_vm8Gj6FwoFQ","ciphertext":"Jf5p9-ZhJlJy_IQ_byKFmI0Ro7w7G1QiaZpI8OaiVgD8EqoDZHyFKFBupS8iaEeVIgMqWmsuJKuoVgzR3YfzoMd3GxEm3VxNhzWyWtZKX0gxKdy6HgLvqoGNbZCzLjqcpDiF8q2_62EVAbr2uSc2oaxFmFuIQHLcqAHxy51449xkjZ7ewzZaGV3eFqhpco8o4DijXaG5_7kp3h2cajRfDgymuxUbWgLqaeNQaJtvJmSMFuEOSAzw9Hdeb6yhdTynCRmu-kqtO5Dec4lT2OMZKpnxc_F1_4yDJFcqb5CiDSmA-psB2k0JtjxAj4UPI61oONK7zzFIu4gBfjJCndsZfdvG7h8wGjV98QhrKEnR7xKZ3KCr0_qR1B-gxpNk3xWU","tag":"DKW7jrb4WaRSNfbXVPlT5g"}'; |
||
61 | $expected_iv = 'gz6NjyEFNm_vm8Gj6FwoFQ'; |
||
62 | $expected_encrypted_key = 'lJf3HbOApxMEBkCMOoTnnABxs_CvTWUmZQ2ElLvYNok'; |
||
63 | $expected_ciphertext = 'Jf5p9-ZhJlJy_IQ_byKFmI0Ro7w7G1QiaZpI8OaiVgD8EqoDZHyFKFBupS8iaEeVIgMqWmsuJKuoVgzR3YfzoMd3GxEm3VxNhzWyWtZKX0gxKdy6HgLvqoGNbZCzLjqcpDiF8q2_62EVAbr2uSc2oaxFmFuIQHLcqAHxy51449xkjZ7ewzZaGV3eFqhpco8o4DijXaG5_7kp3h2cajRfDgymuxUbWgLqaeNQaJtvJmSMFuEOSAzw9Hdeb6yhdTynCRmu-kqtO5Dec4lT2OMZKpnxc_F1_4yDJFcqb5CiDSmA-psB2k0JtjxAj4UPI61oONK7zzFIu4gBfjJCndsZfdvG7h8wGjV98QhrKEnR7xKZ3KCr0_qR1B-gxpNk3xWU'; |
||
64 | $expected_tag = 'DKW7jrb4WaRSNfbXVPlT5g'; |
||
65 | |||
66 | $decrypter = DecrypterFactory::createDecrypter(['A256GCMKW', 'A128CBC-HS256']); |
||
67 | |||
68 | $loaded_compact_json = Loader::load($expected_compact_json); |
||
69 | $decrypter->decryptUsingKey($loaded_compact_json, $private_key); |
||
|
|||
70 | |||
71 | $loaded_flattened_json = Loader::load($expected_flattened_json); |
||
72 | $decrypter->decryptUsingKey($loaded_flattened_json, $private_key); |
||
73 | |||
74 | $loaded_json = Loader::load($expected_json); |
||
75 | $decrypter->decryptUsingKey($loaded_json, $private_key); |
||
76 | |||
77 | $this->assertEquals($expected_ciphertext, Base64Url::encode($loaded_compact_json->getCiphertext())); |
||
78 | $this->assertEquals($protected_headers, $loaded_compact_json->getSharedProtectedHeaders()); |
||
79 | $this->assertEquals($expected_iv, Base64Url::encode($loaded_compact_json->getIV())); |
||
80 | $this->assertEquals($expected_encrypted_key, Base64Url::encode($loaded_compact_json->getRecipient(0)->getEncryptedKey())); |
||
81 | $this->assertEquals($expected_tag, Base64Url::encode($loaded_compact_json->getTag())); |
||
82 | |||
83 | $this->assertEquals($expected_ciphertext, Base64Url::encode($loaded_flattened_json->getCiphertext())); |
||
84 | $this->assertEquals($protected_headers, $loaded_flattened_json->getSharedProtectedHeaders()); |
||
85 | $this->assertEquals($expected_iv, Base64Url::encode($loaded_flattened_json->getIV())); |
||
86 | $this->assertEquals($expected_encrypted_key, Base64Url::encode($loaded_flattened_json->getRecipient(0)->getEncryptedKey())); |
||
87 | $this->assertEquals($expected_tag, Base64Url::encode($loaded_flattened_json->getTag())); |
||
88 | |||
89 | $this->assertEquals($expected_ciphertext, Base64Url::encode($loaded_json->getCiphertext())); |
||
90 | $this->assertEquals($protected_headers, $loaded_json->getSharedProtectedHeaders()); |
||
91 | $this->assertEquals($expected_iv, Base64Url::encode($loaded_json->getIV())); |
||
92 | $this->assertEquals($expected_encrypted_key, Base64Url::encode($loaded_json->getRecipient(0)->getEncryptedKey())); |
||
93 | $this->assertEquals($expected_tag, Base64Url::encode($loaded_json->getTag())); |
||
94 | |||
95 | $this->assertEquals($expected_payload, $loaded_compact_json->getPayload()); |
||
96 | $this->assertEquals($expected_payload, $loaded_flattened_json->getPayload()); |
||
97 | $this->assertEquals($expected_payload, $loaded_json->getPayload()); |
||
98 | } |
||
99 | |||
155 |
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.