├── src ├── Models │ ├── ErrorResponse.php │ └── Response.php └── v_6_0 │ ├── Bankid_6_0_dev.php │ └── Bankid_6_0_prod.php ├── composer.json ├── README.md └── LICENSE /src/Models/ErrorResponse.php: -------------------------------------------------------------------------------- 1 | =7.2.0 | 8.*", 26 | "guzzlehttp/guzzle": ">=7.8" 27 | }, 28 | "keywords": [ 29 | "hajarrashidi", 30 | "bankid", 31 | "bank-id", 32 | "v6" 33 | ] 34 | } 35 | -------------------------------------------------------------------------------- /src/Models/Response.php: -------------------------------------------------------------------------------- 1 | hydrate($response); 12 | } 13 | 14 | /** 15 | * Populate the object with data from HTTP ResponseInterface->getBody()->getContents() 16 | * 17 | * @param ResponseInterface|null $response 18 | * @return void 19 | */ 20 | public function hydrate(?ResponseInterface $response): void 21 | { 22 | if ($response) { 23 | $responseBody = $response->getBody()->getContents(); 24 | $responseArray = json_decode($responseBody, true); 25 | 26 | foreach ($responseArray as $key => $value) { 27 | $this->{$key} = $value; 28 | } 29 | } 30 | } 31 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # BankID 2 | 3 | ### Packagist.org 4 | https://packagist.org/packages/hajarrashidi/bankid 5 | ```bash 6 | composer require hajarrashidi/bankid 7 | ``` 8 | 9 | ## Description: 10 | 11 | PHP Composer package for BankID, supports v6.0 with QR and App link support. 12 | 13 | ## [Web service API:](https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/webbservice-api) 14 | - **BankID v6.0 production** 15 | - **BankID v6.0 development** 16 | 17 | ## Requirements: 18 | 19 | * [Composer](https://getcomposer.org/) 20 | * PHP >= 7.2 21 | 22 | ## [Interface description:](https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/webbservice-api) 23 | 24 | - [x] /auth 25 | - [x] /collect 26 | - [x] /cancel 27 | - [x] /sign 28 | - [x] /phone/auth 29 | - [x] /phone/sign 30 | 31 | ## Helper methods: 32 | 33 | - [x] QR-code generator 34 | - [x] App-link generator 35 | 36 | --- 37 | 38 | ## Code example: 39 | ```php 40 | false, 48 | 'headers' => [ 49 | 'Content-Type' => 'application/json', 50 | ], 51 | 'cert' => __DIR__ . '/bankid_test_cert.pem' 52 | ]); 53 | 54 | $response = $bankid->auth([ 'endUserIp' => "127.0.0.1" ]); 55 | //$response = $bankid->sign([ 'endUserIp' => "127.0.0.1", 'userVisibleData' => base64_encode("hello") ]); 56 | //$response = $bankid->phoneSign([ 'personalNumber' => "111122334444", "userVisibleData" => base64_encode("hello"), "callInitiator" => "user"]); 57 | //$response = $bankid->phoneAuth([ 'personalNumber' => "111122334444", "callInitiator" => "user"]); 58 | 59 | var_dump($response); 60 | ``` 61 | 62 | ### financial support: 63 | 64 | [Github Sponsor](https://github.com/sponsors/hajarrashidi) 65 | 66 | [Patreon](https://patreon.com/hajarrashidi) 67 | -------------------------------------------------------------------------------- /src/v_6_0/Bankid_6_0_dev.php: -------------------------------------------------------------------------------- 1 | guzzleClient = new Client($guzzleOptions); 22 | } 23 | 24 | /** 25 | * @param array $authParameters [ 'endUserIp' => "127.0.0.1" ] 26 | * @return ErrorResponse|Response 27 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/auth 28 | */ 29 | public function auth(array $authParameters) 30 | { 31 | return $this->request("auth", $authParameters); 32 | } 33 | 34 | /** 35 | * @param array $signParameters 36 | * [ 'endUserIp' => "127.0.0.1", 'userVisibleData' => base64_encode("hello") ] 37 | * @return ErrorResponse|Response 38 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/sign 39 | */ 40 | public function sign(array $signParameters) 41 | { 42 | return $this->request("sign", $signParameters); 43 | } 44 | 45 | /** 46 | * @param array $phoneAuthParameters 47 | * [ 'personalNumber' => "199603235789", "callInitiator" => "user"] 48 | * @return ErrorResponse|Response 49 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/phone-auth 50 | */ 51 | public function phoneAuth(array $phoneAuthParameters) 52 | { 53 | return $this->request("phone/auth", $phoneAuthParameters); 54 | } 55 | 56 | /** 57 | * @param array $phoneSignParameters 58 | * [ 'personalNumber' => "199605245894", "userVisibleData" => base64_encode("hello"), "callInitiator" => "user"] 59 | * @return ErrorResponse|Response 60 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/phone-sign 61 | */ 62 | public function phoneSign(array $phoneSignParameters) 63 | { 64 | return $this->request("phone/sign", $phoneSignParameters); 65 | } 66 | 67 | /** 68 | * @param string $orderRef 69 | * @return ErrorResponse|Response 70 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/collect 71 | */ 72 | public function collect(string $orderRef) 73 | { 74 | return $this->request("collect", ['orderRef' => $orderRef]); 75 | } 76 | 77 | /** 78 | * @param string $orderRef 79 | * @return ErrorResponse|Response 80 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/cancel 81 | */ 82 | public function cancel(string $orderRef) 83 | { 84 | return $this->request("cancel", ['orderRef' => $orderRef]); 85 | } 86 | 87 | /** 88 | * @param string $bankidMethod 89 | * @param array $parameters 90 | * @return ErrorResponse|Response 91 | */ 92 | private function request(string $bankidMethod, array $parameters) 93 | { 94 | $guzzleOptions = [ 95 | 'body' => json_encode($parameters), 96 | ]; 97 | 98 | try { 99 | $response = $this->guzzleClient->post( 100 | (self::API_BASE_URL . $bankidMethod), 101 | $guzzleOptions 102 | ); 103 | } catch (ClientException $e) { 104 | return new ErrorResponse($e->getResponse()); 105 | } 106 | 107 | return new Response($response); 108 | } 109 | 110 | /** 111 | * @param string $qrStartToken 112 | * @param int $elapsedTime 113 | * @param string $qrStartSecret 114 | * @return string 115 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/qrkoder 116 | */ 117 | public function getQrCode(string $qrStartToken, int $elapsedTime, string $qrStartSecret): string 118 | { 119 | return sprintf( 120 | 'bankid.%s.%d.%s', 121 | $qrStartToken, 122 | $elapsedTime, 123 | hash_hmac('sha256', $elapsedTime, $qrStartSecret) 124 | ); 125 | } 126 | 127 | /** 128 | * @param string $autostarttoken 129 | * @return string 130 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/programstart 131 | */ 132 | public function getAppLink(string $autostarttoken): string 133 | { 134 | return sprintf('bankid:///?autostarttoken=%s', $autostarttoken); 135 | } 136 | 137 | } -------------------------------------------------------------------------------- /src/v_6_0/Bankid_6_0_prod.php: -------------------------------------------------------------------------------- 1 | guzzleClient = new Client($guzzleOptions); 22 | } 23 | 24 | /** 25 | * @param array $authParameters [ 'endUserIp' => "127.0.0.1" ] 26 | * @return ErrorResponse|Response 27 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/auth 28 | */ 29 | public function auth(array $authParameters) 30 | { 31 | return $this->request("auth", $authParameters); 32 | } 33 | 34 | /** 35 | * @param array $signParameters 36 | * [ 'endUserIp' => "127.0.0.1", 'userVisibleData' => base64_encode("hello") ] 37 | * @return ErrorResponse|Response 38 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/sign 39 | */ 40 | public function sign(array $signParameters) 41 | { 42 | return $this->request("sign", $signParameters); 43 | } 44 | 45 | /** 46 | * @param array $phoneAuthParameters 47 | * [ 'personalNumber' => "199603235789", "callInitiator" => "user"] 48 | * @return ErrorResponse|Response 49 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/phone-auth 50 | */ 51 | public function phoneAuth(array $phoneAuthParameters) 52 | { 53 | return $this->request("phone/auth", $phoneAuthParameters); 54 | } 55 | 56 | /** 57 | * @param array $phoneSignParameters 58 | * [ 'personalNumber' => "199605245894", "userVisibleData" => base64_encode("hello"), "callInitiator" => "user"] 59 | * @return ErrorResponse|Response 60 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/phone-sign 61 | */ 62 | public function phoneSign(array $phoneSignParameters) 63 | { 64 | return $this->request("phone/sign", $phoneSignParameters); 65 | } 66 | 67 | /** 68 | * @param string $orderRef 69 | * @return ErrorResponse|Response 70 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/collect 71 | */ 72 | public function collect(string $orderRef) 73 | { 74 | return $this->request("collect", ['orderRef' => $orderRef]); 75 | } 76 | 77 | /** 78 | * @param string $orderRef 79 | * @return ErrorResponse|Response 80 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/graenssnittsbeskrivning/cancel 81 | */ 82 | public function cancel(string $orderRef) 83 | { 84 | return $this->request("cancel", ['orderRef' => $orderRef]); 85 | } 86 | 87 | /** 88 | * @param string $bankidMethod 89 | * @param array $parameters 90 | * @return ErrorResponse|Response 91 | */ 92 | private function request(string $bankidMethod, array $parameters) 93 | { 94 | $guzzleOptions = [ 95 | 'body' => json_encode($parameters), 96 | ]; 97 | 98 | try { 99 | $response = $this->guzzleClient->post( 100 | (self::API_BASE_URL . $bankidMethod), 101 | $guzzleOptions 102 | ); 103 | } catch (ClientException $e) { 104 | return new ErrorResponse($e->getResponse()); 105 | } 106 | 107 | return new Response($response); 108 | } 109 | 110 | /** 111 | * @param string $qrStartToken 112 | * @param int $elapsedTime 113 | * @param string $qrStartSecret 114 | * @return string 115 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/qrkoder 116 | */ 117 | public function getQrCode(string $qrStartToken, int $elapsedTime, string $qrStartSecret): string 118 | { 119 | return sprintf( 120 | 'bankid.%s.%d.%s', 121 | $qrStartToken, 122 | $elapsedTime, 123 | hash_hmac('sha256', $elapsedTime, $qrStartSecret) 124 | ); 125 | } 126 | 127 | /** 128 | * @param string $autostarttoken 129 | * @return string 130 | * @link https://www.bankid.com/utvecklare/guider/teknisk-integrationsguide/programstart 131 | */ 132 | public function getAppLink(string $autostarttoken): string 133 | { 134 | return sprintf('bankid:///?autostarttoken=%s', $autostarttoken); 135 | } 136 | 137 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------