EcdsaTokenTest.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  1. <?php
  2. /**
  3. * This file is part of Lcobucci\JWT, a simple library to handle JWT and JWS
  4. *
  5. * @license http://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
  6. */
  7. namespace Lcobucci\JWT\FunctionalTests;
  8. use Lcobucci\JWT\Builder;
  9. use Lcobucci\JWT\Parser;
  10. use Lcobucci\JWT\Signer\Key;
  11. use Lcobucci\JWT\Token;
  12. use Lcobucci\JWT\Signature;
  13. use Lcobucci\JWT\Signer\Ecdsa\Sha256;
  14. use Lcobucci\JWT\Signer\Ecdsa\Sha512;
  15. use Lcobucci\JWT\Signer\Keychain;
  16. use Lcobucci\JWT\Keys;
  17. /**
  18. * @author Luís Otávio Cobucci Oblonczyk <lcobucci@gmail.com>
  19. * @since 2.1.0
  20. */
  21. class EcdsaTokenTest extends \PHPUnit\Framework\TestCase
  22. {
  23. use Keys;
  24. /**
  25. * @var Sha256
  26. */
  27. private $signer;
  28. /**
  29. * @before
  30. */
  31. public function createSigner()
  32. {
  33. $this->signer = new Sha256();
  34. }
  35. /**
  36. * @test
  37. *
  38. * @expectedException \InvalidArgumentException
  39. *
  40. * @covers Lcobucci\JWT\Builder
  41. * @covers Lcobucci\JWT\Token
  42. * @covers Lcobucci\JWT\Signature
  43. * @covers Lcobucci\JWT\Claim\Factory
  44. * @covers Lcobucci\JWT\Claim\Basic
  45. * @covers Lcobucci\JWT\Parsing\Encoder
  46. * @covers Lcobucci\JWT\Signer\Key
  47. * @covers Lcobucci\JWT\Signer\BaseSigner
  48. * @covers Lcobucci\JWT\Signer\Ecdsa
  49. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  50. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  51. * @covers \Lcobucci\JWT\Signer\OpenSSL
  52. */
  53. public function builderShouldRaiseExceptionWhenKeyIsInvalid()
  54. {
  55. $user = (object) ['name' => 'testing', 'email' => 'testing@abc.com'];
  56. (new Builder())->setId(1)
  57. ->setAudience('http://client.abc.com')
  58. ->setIssuer('http://api.abc.com')
  59. ->set('user', $user)
  60. ->getToken($this->signer, new Key('testing'));
  61. }
  62. /**
  63. * @test
  64. *
  65. * @expectedException \InvalidArgumentException
  66. *
  67. * @covers Lcobucci\JWT\Builder
  68. * @covers Lcobucci\JWT\Token
  69. * @covers Lcobucci\JWT\Signature
  70. * @covers Lcobucci\JWT\Claim\Factory
  71. * @covers Lcobucci\JWT\Claim\Basic
  72. * @covers Lcobucci\JWT\Parsing\Encoder
  73. * @covers Lcobucci\JWT\Signer\Key
  74. * @covers Lcobucci\JWT\Signer\BaseSigner
  75. * @covers Lcobucci\JWT\Signer\Ecdsa
  76. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  77. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  78. * @covers \Lcobucci\JWT\Signer\OpenSSL
  79. */
  80. public function builderShouldRaiseExceptionWhenKeyIsNotEcdsaCompatible()
  81. {
  82. $user = (object) ['name' => 'testing', 'email' => 'testing@abc.com'];
  83. (new Builder())->setId(1)
  84. ->setAudience('http://client.abc.com')
  85. ->setIssuer('http://api.abc.com')
  86. ->set('user', $user)
  87. ->getToken($this->signer, static::$rsaKeys['private']);
  88. }
  89. /**
  90. * @test
  91. *
  92. * @covers Lcobucci\JWT\Builder
  93. * @covers Lcobucci\JWT\Token
  94. * @covers Lcobucci\JWT\Signature
  95. * @covers Lcobucci\JWT\Claim\Factory
  96. * @covers Lcobucci\JWT\Claim\Basic
  97. * @covers Lcobucci\JWT\Parsing\Encoder
  98. * @covers Lcobucci\JWT\Signer\Key
  99. * @covers Lcobucci\JWT\Signer\BaseSigner
  100. * @covers Lcobucci\JWT\Signer\Ecdsa
  101. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  102. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  103. * @covers \Lcobucci\JWT\Signer\OpenSSL
  104. */
  105. public function builderCanGenerateAToken()
  106. {
  107. $user = (object) ['name' => 'testing', 'email' => 'testing@abc.com'];
  108. $token = (new Builder())->setId(1)
  109. ->setAudience('http://client.abc.com')
  110. ->setIssuer('http://api.abc.com')
  111. ->set('user', $user)
  112. ->setHeader('jki', '1234')
  113. ->sign($this->signer, static::$ecdsaKeys['private'])
  114. ->getToken();
  115. $this->assertAttributeInstanceOf(Signature::class, 'signature', $token);
  116. $this->assertEquals('1234', $token->getHeader('jki'));
  117. $this->assertEquals('http://client.abc.com', $token->getClaim('aud'));
  118. $this->assertEquals('http://api.abc.com', $token->getClaim('iss'));
  119. $this->assertEquals($user, $token->getClaim('user'));
  120. return $token;
  121. }
  122. /**
  123. * @test
  124. *
  125. * @depends builderCanGenerateAToken
  126. *
  127. * @covers Lcobucci\JWT\Builder
  128. * @covers Lcobucci\JWT\Parser
  129. * @covers Lcobucci\JWT\Token
  130. * @covers Lcobucci\JWT\Signature
  131. * @covers Lcobucci\JWT\Claim\Factory
  132. * @covers Lcobucci\JWT\Claim\Basic
  133. * @covers Lcobucci\JWT\Parsing\Encoder
  134. * @covers Lcobucci\JWT\Parsing\Decoder
  135. * @covers Lcobucci\JWT\Signer\Ecdsa
  136. */
  137. public function parserCanReadAToken(Token $generated)
  138. {
  139. $read = (new Parser())->parse((string) $generated);
  140. $this->assertEquals($generated, $read);
  141. $this->assertEquals('testing', $read->getClaim('user')->name);
  142. }
  143. /**
  144. * @test
  145. *
  146. * @depends builderCanGenerateAToken
  147. *
  148. * @covers Lcobucci\JWT\Builder
  149. * @covers Lcobucci\JWT\Parser
  150. * @covers Lcobucci\JWT\Token
  151. * @covers Lcobucci\JWT\Signature
  152. * @covers Lcobucci\JWT\Parsing\Encoder
  153. * @covers Lcobucci\JWT\Claim\Factory
  154. * @covers Lcobucci\JWT\Claim\Basic
  155. * @covers Lcobucci\JWT\Signer\Key
  156. * @covers Lcobucci\JWT\Signer\BaseSigner
  157. * @covers Lcobucci\JWT\Signer\Ecdsa
  158. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  159. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  160. * @covers \Lcobucci\JWT\Signer\OpenSSL
  161. */
  162. public function verifyShouldReturnFalseWhenKeyIsNotRight(Token $token)
  163. {
  164. $this->assertFalse($token->verify($this->signer, static::$ecdsaKeys['public2']));
  165. }
  166. /**
  167. * @test
  168. *
  169. * @depends builderCanGenerateAToken
  170. *
  171. * @covers Lcobucci\JWT\Builder
  172. * @covers Lcobucci\JWT\Parser
  173. * @covers Lcobucci\JWT\Token
  174. * @covers Lcobucci\JWT\Signature
  175. * @covers Lcobucci\JWT\Parsing\Encoder
  176. * @covers Lcobucci\JWT\Claim\Factory
  177. * @covers Lcobucci\JWT\Claim\Basic
  178. * @covers Lcobucci\JWT\Signer\Key
  179. * @covers Lcobucci\JWT\Signer\BaseSigner
  180. * @covers Lcobucci\JWT\Signer\Ecdsa
  181. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  182. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  183. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha512
  184. * @covers \Lcobucci\JWT\Signer\OpenSSL
  185. */
  186. public function verifyShouldReturnFalseWhenAlgorithmIsDifferent(Token $token)
  187. {
  188. $this->assertFalse($token->verify(new Sha512(), static::$ecdsaKeys['public1']));
  189. }
  190. /**
  191. * @test
  192. *
  193. * @expectedException \InvalidArgumentException
  194. *
  195. * @depends builderCanGenerateAToken
  196. *
  197. * @covers Lcobucci\JWT\Builder
  198. * @covers Lcobucci\JWT\Parser
  199. * @covers Lcobucci\JWT\Token
  200. * @covers Lcobucci\JWT\Signature
  201. * @covers Lcobucci\JWT\Parsing\Encoder
  202. * @covers Lcobucci\JWT\Claim\Factory
  203. * @covers Lcobucci\JWT\Claim\Basic
  204. * @covers Lcobucci\JWT\Signer\Key
  205. * @covers Lcobucci\JWT\Signer\BaseSigner
  206. * @covers Lcobucci\JWT\Signer\Ecdsa
  207. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  208. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  209. * @covers \Lcobucci\JWT\Signer\OpenSSL
  210. */
  211. public function verifyShouldRaiseExceptionWhenKeyIsNotEcdsaCompatible(Token $token)
  212. {
  213. $this->assertFalse($token->verify($this->signer, static::$rsaKeys['public']));
  214. }
  215. /**
  216. * @test
  217. *
  218. * @depends builderCanGenerateAToken
  219. *
  220. * @covers Lcobucci\JWT\Builder
  221. * @covers Lcobucci\JWT\Parser
  222. * @covers Lcobucci\JWT\Token
  223. * @covers Lcobucci\JWT\Signature
  224. * @covers Lcobucci\JWT\Parsing\Encoder
  225. * @covers Lcobucci\JWT\Claim\Factory
  226. * @covers Lcobucci\JWT\Claim\Basic
  227. * @covers Lcobucci\JWT\Signer\Key
  228. * @covers Lcobucci\JWT\Signer\BaseSigner
  229. * @covers Lcobucci\JWT\Signer\Ecdsa
  230. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  231. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  232. * @covers \Lcobucci\JWT\Signer\OpenSSL
  233. */
  234. public function verifyShouldReturnTrueWhenKeyIsRight(Token $token)
  235. {
  236. $this->assertTrue($token->verify($this->signer, static::$ecdsaKeys['public1']));
  237. }
  238. /**
  239. * @test
  240. *
  241. * @covers Lcobucci\JWT\Builder
  242. * @covers Lcobucci\JWT\Token
  243. * @covers Lcobucci\JWT\Signature
  244. * @covers Lcobucci\JWT\Claim\Factory
  245. * @covers Lcobucci\JWT\Claim\Basic
  246. * @covers Lcobucci\JWT\Parsing\Encoder
  247. * @covers Lcobucci\JWT\Signer\Key
  248. * @covers Lcobucci\JWT\Signer\BaseSigner
  249. * @covers Lcobucci\JWT\Signer\Ecdsa
  250. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  251. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha256
  252. * @covers \Lcobucci\JWT\Signer\OpenSSL
  253. */
  254. public function everythingShouldWorkWithAKeyWithParams()
  255. {
  256. $user = (object) ['name' => 'testing', 'email' => 'testing@abc.com'];
  257. $token = (new Builder())->setId(1)
  258. ->setAudience('http://client.abc.com')
  259. ->setIssuer('http://api.abc.com')
  260. ->set('user', $user)
  261. ->setHeader('jki', '1234')
  262. ->sign($this->signer, static::$ecdsaKeys['private-params'])
  263. ->getToken();
  264. $this->assertTrue($token->verify($this->signer, static::$ecdsaKeys['public-params']));
  265. }
  266. /**
  267. * @test
  268. *
  269. * @covers Lcobucci\JWT\Builder
  270. * @covers Lcobucci\JWT\Parser
  271. * @covers Lcobucci\JWT\Token
  272. * @covers Lcobucci\JWT\Signature
  273. * @covers Lcobucci\JWT\Signer\Key
  274. * @covers Lcobucci\JWT\Signer\BaseSigner
  275. * @covers Lcobucci\JWT\Signer\Ecdsa
  276. * @covers \Lcobucci\JWT\Signer\Ecdsa\MultibyteStringConverter
  277. * @covers Lcobucci\JWT\Signer\Ecdsa\Sha512
  278. * @covers \Lcobucci\JWT\Signer\OpenSSL
  279. * @covers Lcobucci\JWT\Signer\Keychain
  280. * @covers Lcobucci\JWT\Claim\Factory
  281. * @covers Lcobucci\JWT\Claim\Basic
  282. * @covers Lcobucci\JWT\Parsing\Encoder
  283. * @covers Lcobucci\JWT\Parsing\Decoder
  284. */
  285. public function everythingShouldWorkWhenUsingATokenGeneratedByOtherLibs()
  286. {
  287. $data = 'eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCJ9.eyJoZWxsbyI6IndvcmxkIn0.'
  288. . 'AQx1MqdTni6KuzfOoedg2-7NUiwe-b88SWbdmviz40GTwrM0Mybp1i1tVtm'
  289. . 'TSQ91oEXGXBdtwsN6yalzP9J-sp2YATX_Tv4h-BednbdSvYxZsYnUoZ--ZU'
  290. . 'dL10t7g8Yt3y9hdY_diOjIptcha6ajX8yzkDGYG42iSe3f5LywSuD6FO5c';
  291. $key = '-----BEGIN PUBLIC KEY-----' . PHP_EOL
  292. . 'MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQAcpkss6wI7PPlxj3t7A1RqMH3nvL4' . PHP_EOL
  293. . 'L5Tzxze/XeeYZnHqxiX+gle70DlGRMqqOq+PJ6RYX7vK0PJFdiAIXlyPQq0B3KaU' . PHP_EOL
  294. . 'e86IvFeQSFrJdCc0K8NfiH2G1loIk3fiR+YLqlXk6FAeKtpXJKxR1pCQCAM+vBCs' . PHP_EOL
  295. . 'mZudf1zCUZ8/4eodlHU=' . PHP_EOL
  296. . '-----END PUBLIC KEY-----';
  297. $keychain = new Keychain();
  298. $token = (new Parser())->parse((string) $data);
  299. $this->assertEquals('world', $token->getClaim('hello'));
  300. $this->assertTrue($token->verify(new Sha512(), $keychain->getPublicKey($key)));
  301. }
  302. }