├── .github └── workflows │ └── python-lib.yml ├── .gitignore ├── LICENSE ├── MANIFEST ├── requirements.txt ├── setup.py ├── src └── adyen_cse_python │ ├── __init__.py │ └── encrypter.py ├── tests ├── __init__.py └── test_encrypter.py └── tox.ini /.github/workflows/python-lib.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a single version of Python 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python package 5 | 6 | on: 7 | push: 8 | branches: [ master, dev ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | python: [3.8, 3.9] 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Setup Python 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: ${{ matrix.python }} 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install flake8 pytest 30 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 31 | - name: Lint with flake8 32 | run: | 33 | # stop the build if there are Python syntax errors or undefined names 34 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 35 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 36 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 37 | - name: Run Tox 38 | # Run tox using the version of Python in `PATH` 39 | run: tox -e py 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | 55 | # Sphinx documentation 56 | docs/_build/ 57 | 58 | # PyBuilder 59 | target/ 60 | 61 | # Virtualenv 62 | bin/ 63 | include/ 64 | pip-selfcheck.json 65 | 66 | # Project Specific Files 67 | .idea/ 68 | app.db 69 | 70 | # MacOS 71 | .DS_Store 72 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /MANIFEST: -------------------------------------------------------------------------------- 1 | # file GENERATED by distutils, do NOT edit 2 | setup.py 3 | src/adyen_cse_python/__init__.py 4 | src/adyen_cse_python/encrypter.py 5 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | asn1crypto==1.4.0 2 | attrs==21.2.0 3 | backports.entry-points-selectable==1.1.0 4 | cffi==1.14.6 5 | cryptography==3.4.8 6 | distlib==0.3.2 7 | enum34==1.1.10 8 | filelock==3.0.12 9 | future==0.18.2 10 | idna==3.2 11 | iniconfig==1.1.1 12 | ipaddress==1.0.23 13 | packaging==21.0 14 | platformdirs==2.2.0 15 | pluggy==0.13.1 16 | py==1.10.0 17 | pycparser==2.20 18 | pyparsing==2.4.7 19 | pytest==6.2.4 20 | pytz==2021.1 21 | six==1.16.0 22 | toml==0.10.2 23 | tox==3.24.3 24 | virtualenv==20.7.2 25 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import os 4 | import sys 5 | from setuptools import setup 6 | 7 | base_dir = os.path.dirname(__file__) 8 | src_dir = os.path.join(base_dir, "src") 9 | 10 | # When executing the setup.py, we need to be able to import ourselves, this 11 | # means that we need to add the src/ directory to the sys.path. 12 | sys.path.insert(0, src_dir) 13 | 14 | requirements = [ 15 | 'cryptography (>=3.4.0, <4.0.0)', 16 | 'future (>=0.18.2)', 17 | 'pytz (>=2019.3)' 18 | ] 19 | 20 | setup(name='adyen-cse-python', 21 | version='0.3.1', 22 | description='[UNOFFICIAL] Adyen Client-side encryption library for Python', 23 | author='Michael Cheah', 24 | author_email='michael@cheah.xyz', 25 | url='https://github.com/cheah/adyen-cse-python', 26 | packages=['adyen_cse_python'], 27 | package_dir={'': 'src'}, 28 | install_requires=requirements 29 | ) 30 | -------------------------------------------------------------------------------- /src/adyen_cse_python/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cheah/adyen-cse-python/920903c576efad1c78a0af3aad3a309a15e87cbf/src/adyen_cse_python/__init__.py -------------------------------------------------------------------------------- /src/adyen_cse_python/encrypter.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | from builtins import bytes 3 | from builtins import object 4 | from cryptography.hazmat.backends import default_backend 5 | from cryptography.hazmat.primitives.asymmetric import rsa, padding 6 | from cryptography.hazmat.primitives.ciphers.aead import AESCCM 7 | from os import urandom 8 | import pytz 9 | import json 10 | import base64 11 | 12 | 13 | class ClientSideEncrypter(object): 14 | def __init__(self, adyen_public_key): 15 | self.adyen_public_key = adyen_public_key 16 | 17 | def generate_adyen_nonce(self, name, pan, cvc, expiry_month, expiry_year): 18 | """ 19 | Generate Adyen Nonce from the provided card data. 20 | 21 | Adyen Nonce Format: 22 | 23 | "adyenan" + "0_1_1" + "$" + "Base64-Encoded encrypted_aes_key" + "$" + "Base64-Encoded encrypted_card_component" 24 | """ 25 | 26 | plain_card_data = self.generate_card_data_json(name, pan, cvc, expiry_month, expiry_year) 27 | card_data_json_string = json.dumps(plain_card_data, sort_keys=True) 28 | 29 | # Encrypt the actual card data with symmetric encryption 30 | aes_key = self._generate_aes_key() 31 | nonce = self._generate_nonce() 32 | encrypted_card_data = self._encrypt_with_aes_key(aes_key, nonce, bytes(card_data_json_string, encoding='utf-8')) 33 | encrypted_card_component = nonce + encrypted_card_data 34 | 35 | # Encrypt the AES Key with asymmetric encryption 36 | public_key = self.decode_adyen_public_key(self.adyen_public_key) 37 | encrypted_aes_key = self._encrypt_with_public_key(public_key, aes_key) 38 | 39 | return "{}{}${}${}".format("adyenan", 40 | "0_1_1", 41 | base64.standard_b64encode(encrypted_aes_key).decode(), 42 | base64.standard_b64encode(encrypted_card_component).decode()) 43 | 44 | @staticmethod 45 | def generate_card_data_json(name, pan, cvc, expiry_month, expiry_year): 46 | generation_time = datetime.now(tz=pytz.timezone('UTC')).strftime('%Y-%m-%dT%H:%M:%S.000Z') 47 | return { 48 | "holderName": name, 49 | "number": pan, 50 | "cvc": cvc, 51 | "expiryMonth": expiry_month, 52 | "expiryYear": expiry_year, 53 | "generationtime": generation_time 54 | } 55 | 56 | @staticmethod 57 | def decode_adyen_public_key(encoded_public_key): 58 | backend = default_backend() 59 | key_components = encoded_public_key.split("|") 60 | public_number = rsa.RSAPublicNumbers(int(key_components[0], 16), int(key_components[1], 16)) 61 | return backend.load_rsa_public_numbers(public_number) 62 | 63 | @staticmethod 64 | def _encrypt_with_public_key(public_key, plaintext): 65 | ciphertext = public_key.encrypt(plaintext, padding.PKCS1v15()) 66 | return ciphertext 67 | 68 | @staticmethod 69 | def _generate_aes_key(): 70 | return AESCCM.generate_key(256) 71 | 72 | @staticmethod 73 | def _encrypt_with_aes_key(aes_key, nonce, plaintext): 74 | cipher = AESCCM(aes_key, tag_length=8) 75 | ciphertext = cipher.encrypt(nonce, plaintext, None) 76 | return ciphertext 77 | 78 | @staticmethod 79 | def _generate_nonce(): 80 | return urandom(12) 81 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cheah/adyen-cse-python/920903c576efad1c78a0af3aad3a309a15e87cbf/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_encrypter.py: -------------------------------------------------------------------------------- 1 | import codecs 2 | 3 | from cryptography.hazmat.primitives.ciphers.aead import AESCCM 4 | 5 | from adyen_cse_python.encrypter import ClientSideEncrypter 6 | 7 | PUB_EXPONENT = "10001" 8 | MODULUS = "9201EBD5DC974FDE613A85AFF2728627FD2C227F18CF1C864FBBA3781908BB7BD72C818FC37D0B70EF8708705C623D" \ 9 | "F4A9427A051B3C8205631716AAAC3FCB76114D91036E0CAEFA454254D135A1A197C1706A55171D26A2CC3E9371B86A725458" \ 10 | "E82AB82C848AB03F4F0AF3127E7B2857C3B131D52B02F9A408F4635DA7121B5B4A53CEDE687D213F696D3116EB682A4CEFE6" \ 11 | "EDFC54D25B7C57D345F990BB5D8D0C92033639FAC27AD232D9D474896668572F494065BC7747FF4B809FE3084A5E947F72E5" \ 12 | "9309EDEAA5F2D81027429BF4827FB62006F763AFB2153C4A959E579390679FFD7ADE1DFE627955628DC6F2669A321626D699" \ 13 | "A094FFF98243A7C105" 14 | 15 | 16 | def test_generate_card_data_json(): 17 | cse = ClientSideEncrypter(PUB_EXPONENT + "|" + MODULUS) 18 | json = cse.generate_card_data_json("Test Name", "4111111111111111", "737", "01", "2018") 19 | assert json['holderName'] == "Test Name" 20 | assert json['expiryYear'] == "2018" 21 | 22 | 23 | def test_decode_adyen_public_key(): 24 | cse = ClientSideEncrypter(PUB_EXPONENT + "|" + MODULUS) 25 | decoded_pub_key = cse.decode_adyen_public_key(PUB_EXPONENT + "|" + MODULUS) 26 | public_number = decoded_pub_key.public_numbers() 27 | 28 | assert decoded_pub_key.key_size == 2048 29 | assert public_number.e == int(PUB_EXPONENT, 16) 30 | assert public_number.n == int(MODULUS, 16) 31 | 32 | 33 | def test_generate_adyen_nonce(): 34 | cse = ClientSideEncrypter(PUB_EXPONENT + "|" + MODULUS) 35 | adyen_nonce = cse.generate_adyen_nonce("Test Name", "4111111111111111", "737", "08", "2018") 36 | assert adyen_nonce.startswith("adyenan0_1_1$") 37 | 38 | 39 | # https://github.com/bcgit/bc-java/blob/master/prov/src/test/java/org/bouncycastle/jce/provider/test/AESTest.java 40 | def test_java_bouncy_castle_ccm_matching(): 41 | K = codecs.decode(b"404142434445464748494a4b4c4d4e4f", "hex") 42 | N = codecs.decode(b"10111213141516", "hex") 43 | P = codecs.decode(b"68656c6c6f20776f726c642121", "hex") 44 | C = codecs.decode(b"39264f148b54c456035de0a531c8344f46db12b388", "hex") 45 | 46 | cipher = AESCCM(K, tag_length=8) 47 | ciphertext = cipher.encrypt(N, P, None) 48 | 49 | assert ciphertext == C 50 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # Tox (https://tox.readthedocs.io/) is a tool for running tests 2 | # in multiple virtualenvs. This configuration file will run the 3 | # test suite on all supported python versions. To use it, "pip install tox" 4 | # and then run "tox" from this directory. 5 | 6 | [tox] 7 | envlist = py38,py39 8 | 9 | [testenv] 10 | commands = pytest 11 | deps = 12 | pytest 13 | 14 | 15 | [pytest] 16 | testpaths = tests 17 | --------------------------------------------------------------------------------