├── .gitignore ├── LICENSE ├── README.md └── samples ├── c# └── TestAPIClient │ ├── TestAPIClient.sln │ ├── src │ ├── AuthHelper.cs │ ├── Program.cs │ └── TestAPIClient.csproj │ └── test │ ├── AuthHelperTest.cs │ └── TestAPIClient.Tests.csproj ├── c ├── ModulrApiAuth.c ├── ModulrApiAuth.h └── sample.c ├── cpp ├── ModulrApiAuth.cpp └── sample.cpp ├── go ├── go.mod ├── go.sum ├── hmac │ ├── hmac.go │ ├── hmac_test.go │ ├── signature │ │ ├── signatureGenerator.go │ │ └── signature_test.go │ └── validate_hmac_input.go └── main.go ├── java ├── build.gradle ├── gradle │ └── wrapper │ │ ├── gradle-wrapper.jar │ │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src │ ├── main │ └── java │ │ └── com │ │ └── modulr │ │ ├── api │ │ ├── ModulrApiAuth.java │ │ └── TestAPI.java │ │ └── hmac │ │ └── Hmac.java │ └── test │ └── java │ └── com │ └── modulr │ └── api │ └── ModulrApiAuthTest.java ├── kotlin ├── build.gradle.kts ├── gradle │ └── wrapper │ │ ├── gradle-wrapper.jar │ │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle.kts └── src │ ├── main │ └── kotlin │ │ └── com │ │ └── modulr │ │ └── api │ │ ├── Example.kt │ │ └── Signature.kt │ └── test │ └── kotlin │ └── com │ └── modulr │ └── api │ └── SignatureTest.kt ├── nodejs ├── .gitignore ├── index.js ├── package.json ├── signature.js └── test │ └── singature-test.js ├── postman ├── pre-request-script.js └── screenshots │ ├── postman_env_variables.png │ └── postman_headers.png ├── python ├── example.py ├── modulr_hmac │ ├── __init__.py │ └── api_auth.py └── tests │ └── api_auth.py ├── ruby ├── Gemfile ├── Gemfile.lock ├── Rakefile ├── example.rb ├── lib │ └── api_auth.rb └── test │ └── api_auth_test.rb └── scala ├── build.sbt ├── project └── build.properties └── src └── main └── scala ├── Main.scala └── Signature.scala /.gitignore: -------------------------------------------------------------------------------- 1 | **.idea/ 2 | .gradle/ 3 | .vscode/ 4 | **out/ 5 | samples/java/.classpath 6 | samples/java/.project 7 | samples/java/.settings/ 8 | samples/java/bin/ 9 | samples/java/build/ 10 | samples/kotlin/build/ 11 | **__pycache__ 12 | samples/c#/**/bin/ 13 | samples/c#/**/obj/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Modulr Finance HMAC 2 | 3 | ## Authentication process 4 | 5 | An in-depth documentation of the whole authentication process can be found at [Authentication](https://modulr.readme.io/docs/authentication) 6 | 7 | ## Samples 8 | 9 | Please note the samples are designed to be self contained to demonstrate hmac signature usage. 10 | 11 | Samples directory contain sample code for the following languages: 12 | 13 | - [Java](#java) 14 | - [Scala](#scala) 15 | - [Kotlin](#kotlin) 16 | - [NodeJS](#nodejs) 17 | - [Postman](#postman-pre-request-script) 18 | - [Python](#python) 19 | - [Ruby](#ruby) 20 | - [C](#c) 21 | - [C++](#cpp) 22 | - [C\#](#c-2) 23 | - [Golang](#golang) 24 | --- 25 | 26 | ### Java 27 | 28 | #### [com.modulr.api.ModulrApiAuth.java](samples/java/src/main/java/com/modulr/api/ModulrApiAuth.java) 29 | 30 | This class is a helper that can generate required headers for a given value of API key and secret. It generates the following headers: 31 | 32 | - Authorization 33 | - Date 34 | - x-mod-nonce 35 | - x-mod-retry 36 | 37 | To use this class instantiate it using your API key and secret. 38 | 39 | ```java 40 | ModulrApiAuth modulrAuth = new ModulrApiAuth("KNOWN-TOKEN", "SECRET-TOKEN"); 41 | ``` 42 | `` 43 | Then use one of the generateXXX methods to get a map of headers with the header name as the key. 44 | 45 | ```java 46 | Map headers = modulrAuth.generateApiAuthHeaders("NONCE"); // replace NONCE with correct nonce to be used 47 | 48 | headers.forEach((key, value) -> System.out.println(key + ": " + value)); 49 | ``` 50 | 51 | OR 52 | 53 | ```java 54 | Map headers = modulrAuth.generateRetryApiAuthHeaders(); // reuses the nonce used on the last generateApiAuthHeaders call 55 | 56 | headers.forEach((key, value) -> System.out.println(key + ": " + value)); 57 | ``` 58 | 59 | #### [com.modulr.hmac.Hmac.java](samples/java/src/main/java/com/modulr/hmac/Hmac.java) 60 | 61 | This class demonstrates how to use the ModulrApiAuth class. 62 | 63 | --- 64 | 65 | ### Scala 66 | 67 | #### [Signature.scala](samples/scala/src/main/scala/Signature.scala) 68 | 69 | This class is a helper that can generate required headers for a given value of API key and secret. It generates the following headers: 70 | 71 | - Authorization 72 | - Date 73 | - x-mod-nonce 74 | 75 | You can start by creating an instance of Signature class 76 | ```scala 77 | val signature: Signature = new Signature("key", "secret") 78 | ``` 79 | Then you can get your Auth headers by simply calling `.buildHeaders()`. In that case a nonce will be a random UUID and Date will default to current 80 | ```scala 81 | val headersDefault: Map[String, String] = signature.buildHeaders() 82 | ``` 83 | OR with custom nonce 84 | ```scala 85 | val headersCustomNonce: Map[String, String] = signature.buildHeaders("nonceValue") 86 | ``` 87 | OR with both custom nonce and custom date 88 | ```scala 89 | val headersCustomAll: Map[String, String] = signature.buildHeaders("nonceValue", Calendar.getInstance().getTime) 90 | ``` 91 | 92 | You can see all of it in action in [Main.scala](samples/scala/src/main/scala/Main.scala) class example 93 | 94 | --- 95 | 96 | ### Kotlin 97 | 98 | #### [com.modulr.api.Signature.kt](samples/kotlin/src/main/kotlin/com/modulr/api/Signature.kt) 99 | 100 | This class is a helper that can generate required headers for a given value of API key and secret. It generates the following headers: 101 | 102 | - Authorization 103 | - Date 104 | - x-mod-nonce 105 | 106 | To use this class instantiate it using your API key and secret. 107 | 108 | ```kotlin 109 | val signature = Singature(API_KEY, API_SECRET) 110 | ``` 111 | 112 | Then use the calculate() to get generated headers. 113 | 114 | ```kotlin 115 | val result = signature.calculate() 116 | val headers = result.headers 117 | ``` 118 | 119 | OR with a specific nonce and date 120 | 121 | ```kotlin 122 | val date = Date.from(ZonedDateTime.of(LocalDateTime.parse("2016-07-25T16:36:07"), ZoneId.of("Z")).toInstant()) 123 | 124 | val result = signature.calculate("28154b2-9c62b93cc22a-24c9e2-5536d7d", date) 125 | val headers = result.headers 126 | ``` 127 | 128 | #### [com.modulr.api.Example.kt](samples/kotlin/src/main/kotlin/com/modulr/api/Example.kt) 129 | 130 | This object demonstrates how to use the Signature class. 131 | 132 | --- 133 | 134 | ### NodeJS 135 | 136 | #### [signature.js](samples/nodejs/signature.js) 137 | 138 | This class can generate required headers for a given value of API key and secret. It generates the following headers: 139 | 140 | - Authorization 141 | - Date 142 | - x-mod-nonce 143 | 144 | To use this class, instantiate it using your API key and secret. 145 | 146 | ```javascript 147 | const signatureHelper = new signature(API_KEY,API_SECRET); 148 | ``` 149 | 150 | Then use the calculate() to get generated headers. 151 | 152 | ```javascript 153 | var result = signatureHelper.calculate(); 154 | var headers = result.getHTTPHeaders(); 155 | ``` 156 | OR with a specific nonce and date 157 | 158 | ```javascript 159 | var result = signatureHelper.calculate('28154b2-9c62b93cc22a-24c9e2-5536d7d','Mon, 25 Jul 2016 16:36:07 GMT'); 160 | var headers = result.getHTTPHeaders(); 161 | ``` 162 | 163 | 164 | To run the sample, make sure that you have 165 | 166 | - NodeJS installed 167 | - Updated the API_KEY and API_SECRET in [index.js](samples/nodejs/index.js) to your API key and secret 168 | 169 | Then call from your shell: 170 | 171 | ```bash 172 | npm i 173 | npm run start 174 | ``` 175 | 176 | --- 177 | 178 | ### Postman pre-request script 179 | 180 | #### [pre-request-script.js](samples/postman/pre-request-script.js) 181 | 182 | This script is used to generate the Authorisation, Nonce and Date headers required to successfully call the Modulr Sandbox API using HMAC 183 | 184 | In order to make use of this script, you will need to initialise the environment variables required first which are: 185 | - **api_key** - defaulted to the api key Modulr will give you when you sign up for a sandbox account 186 | - **api_secret** - defaulted to the api key Modulr will give you when you sign up for a sandbox account 187 | - **authorization** - empty on default 188 | - **nonce** - empty on default 189 | - **date** - empty on default 190 | 191 | For further information on environment variables in Postman, see https://learning.postman.com/docs/postman/variables-and-environments/variables/ 192 | 193 | Once your variables have been set up, you should see something like this: 194 | ![Environment Variables Example](samples/postman/screenshots/postman_env_variables.png) 195 | 196 | When creating a new http call, select the "Pre-request Script" tab and paste the [pre-request-script.js](samples/postman/pre-request-script.js) 197 | file into the text area 198 | 199 | Finally, create a new set of headers in the Headers tab in Postman: 200 | ``` 201 | Authorization:{{authorization}} 202 | x-mod-nonce:{{nonce}} 203 | Date:{{date}} 204 | ``` 205 | they should look something like this: 206 | 207 | ![Headers](samples/postman/screenshots/postman_headers.png) 208 | 209 | Postman should now be set up to make HMAC requests to Modulr's Sandbox APIs 210 | 211 | ### Python 212 | 213 | This sample is based on https://stackoverflow.com/a/56805800/4473028 courtsey of [vekerdyb](https://stackoverflow.com/users/1617748/vekerdyb) 214 | 215 | 216 | #### [modulr_hmac.Signature](samples/python/modulr_hmac/api_auth.py) 217 | 218 | This class can generate required headers for a given value of API key and secret. It generates the following headers: 219 | 220 | - Authorization 221 | - Date 222 | - x-mod-nonce 223 | 224 | To use this class, instantiate it using your API key and secret. 225 | 226 | ```python 227 | signature = Signature(API_KEY,API_SECRET) 228 | ``` 229 | 230 | Then use the calculate() to get generated headers. 231 | 232 | ```python 233 | result = signature.calculate() 234 | headers = result.get_http_headers() 235 | ``` 236 | OR with a specific nonce and date 237 | 238 | ```python 239 | result = signature.calculate('28154b2-9c62b93cc22a-24c9e2-5536d7d','Mon, 25 Jul 2016 16:36:07 GMT') 240 | headers = result.get_http_headers() 241 | ``` 242 | 243 | 244 | To run the sample, make sure that you have 245 | 246 | - Installed [Requests: HTTP For Humans](https://requests.readthedocs.io/en/master/) 247 | - Updateded the API_KEY and API_SECRET in [example.py](samples/python/example.py) to your API key and secret 248 | 249 | Then call from your shell: 250 | 251 | ```bash 252 | python samples/python/example.py 253 | ``` 254 | 255 | --- 256 | 257 | ### Ruby 258 | 259 | #### [api_auth.Signature](samples/ruby/lib/api_auth.rb) 260 | 261 | This class can generate required headers for a given value of API key and secret. It generates the following headers: 262 | 263 | - Authorization 264 | - Date 265 | - x-mod-nonce 266 | 267 | To use this class, instantiate it using your API key and secret. 268 | 269 | ```ruby 270 | signature = Signature.new(api_key: API_KEY, api_secret: API_SECRET) 271 | ``` 272 | 273 | Then use the calculate() to get generated headers. 274 | 275 | ```ruby 276 | result = signature.calculate 277 | headers = result.headers 278 | ``` 279 | OR with a specific nonce and date 280 | 281 | ```ruby 282 | result = signature.calculate(nonce: '28154b2-9c62b93cc22a-24c9e2-5536d7d', timestamp: 'Mon, 25 Jul 2016 16:36:07 GMT') 283 | headers = result.headers 284 | ``` 285 | 286 | To run the sample, make sure that you have 287 | 288 | - Updateded the API_KEY and API_SECRET in [example.rb](samples/ruby/example.rb) to your API key and secret 289 | 290 | Then call from your shell: 291 | 292 | ```bash 293 | cd samples/ruby 294 | bundle install 295 | rake run 296 | ``` 297 | 298 | --- 299 | 300 | ### C 301 | 302 | #### [sample.c](samples/c/sample.c) 303 | 304 | To compile and run the sample: 305 | 306 | ```bash 307 | gcc -o sample sample.c ModulrApiAuth.c -lcrypto -lssl -lcurl 308 | ./sample 309 | ``` 310 | 311 | #### Libraries 312 | 313 | You will need to install the following libraries 314 | 315 | - OpenSSL 316 | - Libcurl 317 | 318 | To install these in Ubuntu, for example: 319 | 320 | ```bash 321 | sudo apt install libssl-dev 322 | sudo apt install libcurl4-openssl-dev 323 | ``` 324 | 325 | --- 326 | 327 | 328 | ### C++ 329 | 330 | #### [sample.cpp](samples/cpp/sample.cpp) 331 | 332 | To compile and run the sample: 333 | 334 | ```bash 335 | g++ -o sample sample.cpp ModulrApiAuth.cpp -lcrypto -lssl -lcurl 336 | ./sample 337 | ``` 338 | 339 | #### Libraries 340 | 341 | You will need to install the following libraries 342 | 343 | - OpenSSL 344 | - Libcurl 345 | 346 | To install these in Ubuntu, for example: 347 | 348 | ```bash 349 | sudo apt install libssl-dev 350 | sudo apt install libcurl4-openssl-dev 351 | ``` 352 | 353 | --- 354 | 355 | ### C\# 356 | 357 | Note: These examples were written for .NET Core, but should be easy enough to port to .NET Framework. 358 | 359 | #### [AuthHelper.cs](samples/c%23/TestAPIClient/src/AuthHelper.cs) 360 | 361 | This class is a helper that can generate the required headers for a given API key and secret. It generates the following headers: 362 | 363 | - Authorization 364 | - Date 365 | - x-mod-nonce 366 | - x-mod-retry 367 | 368 | To use this class instantiate it using your API key and secret. 369 | 370 | ```csharp 371 | AuthHelper authHelper = new AuthHelper("YOUR_API_KEY", "YOUR_API_SECRET"); 372 | ``` 373 | 374 | Replacing `"NONCE"` with the correct nonce to be used, call one of the `GetHeaders` methods to get a dictionary of headers, with the header name as the key. 375 | 376 | ```csharp 377 | Dictionary headers = authHelper.GetHeaders("NONCE"); 378 | ``` 379 | 380 | #### [Program.cs](samples/c%23/TestAPIClient/src/Program.cs) 381 | 382 | This class gives a working example of how to use the `AuthHelper` class. 383 | To run, replace the API key and secret with your values and then use `dotnet run` or your prefered IDE. 384 | 385 | ### Golang 386 | 387 | #### [hmac.go](samples/go/hmac/hmac.go) 388 | 389 | This file generates the required headers outlined below for a given API key and secret 390 | 391 | - Authorization 392 | - Date 393 | - x-mod-nonce 394 | - x-mod-retry 395 | 396 | To use this function, invoke it using your API key and secret. There's an example of this in [main.go](samples/go/main.go) 397 | 398 | ```golang 399 | headers, error := hmac.GenerateHeaders("API_KEY", "API_SECRET", "OPTIONAL_NONCE", false) 400 | ``` 401 | 402 | If successful, this will generate a standard map with the keys being the headers mentioned previously 403 | 404 | ```golang 405 | for key, element := range headers { 406 | fmt.Println(key, ":", element) 407 | } 408 | ``` 409 | -------------------------------------------------------------------------------- /samples/c#/TestAPIClient/TestAPIClient.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.26124.0 5 | MinimumVisualStudioVersion = 15.0.26124.0 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestAPIClient", "src\TestAPIClient.csproj", "{29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}" 7 | EndProject 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestAPIClient.Tests", "test\TestAPIClient.Tests.csproj", "{96479F1A-B9B9-453A-83B1-CCE639E8B41F}" 9 | EndProject 10 | Global 11 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 12 | Debug|Any CPU = Debug|Any CPU 13 | Debug|x64 = Debug|x64 14 | Debug|x86 = Debug|x86 15 | Release|Any CPU = Release|Any CPU 16 | Release|x64 = Release|x64 17 | Release|x86 = Release|x86 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 23 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 24 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Debug|Any CPU.Build.0 = Debug|Any CPU 25 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Debug|x64.ActiveCfg = Debug|Any CPU 26 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Debug|x64.Build.0 = Debug|Any CPU 27 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Debug|x86.ActiveCfg = Debug|Any CPU 28 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Debug|x86.Build.0 = Debug|Any CPU 29 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Release|Any CPU.ActiveCfg = Release|Any CPU 30 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Release|Any CPU.Build.0 = Release|Any CPU 31 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Release|x64.ActiveCfg = Release|Any CPU 32 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Release|x64.Build.0 = Release|Any CPU 33 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Release|x86.ActiveCfg = Release|Any CPU 34 | {29F6CEF7-3BBD-4FC0-A313-A036FFF8AF6F}.Release|x86.Build.0 = Release|Any CPU 35 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 36 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Debug|Any CPU.Build.0 = Debug|Any CPU 37 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Debug|x64.ActiveCfg = Debug|Any CPU 38 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Debug|x64.Build.0 = Debug|Any CPU 39 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Debug|x86.ActiveCfg = Debug|Any CPU 40 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Debug|x86.Build.0 = Debug|Any CPU 41 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Release|Any CPU.ActiveCfg = Release|Any CPU 42 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Release|Any CPU.Build.0 = Release|Any CPU 43 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Release|x64.ActiveCfg = Release|Any CPU 44 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Release|x64.Build.0 = Release|Any CPU 45 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Release|x86.ActiveCfg = Release|Any CPU 46 | {96479F1A-B9B9-453A-83B1-CCE639E8B41F}.Release|x86.Build.0 = Release|Any CPU 47 | EndGlobalSection 48 | EndGlobal 49 | -------------------------------------------------------------------------------- /samples/c#/TestAPIClient/src/AuthHelper.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Net; 4 | using System.Security.Cryptography; 5 | using System.Text; 6 | 7 | namespace TestAPIClient { 8 | public class AuthHelper { 9 | 10 | private readonly string apiKey; 11 | private readonly string secret; 12 | 13 | public AuthHelper(string apiKey, string secret) { 14 | this.apiKey = apiKey; 15 | this.secret = secret; 16 | } 17 | public Dictionary GetHeaders(string nonce) { 18 | return GetHeaders(nonce, DateTime.UtcNow, false); 19 | } 20 | 21 | public Dictionary GetHeaders(string nonce, DateTime dateTime, bool asRetry) { 22 | var signature = GenerateSignature(nonce, dateTime); 23 | 24 | var headers = new Dictionary(); 25 | headers.Add("Authorization", GenerateAuthHeaderContent(apiKey, signature)); 26 | headers.Add("Date", dateTime.ToString("R")); 27 | headers.Add("x-mod-nonce", nonce); 28 | headers.Add("x-mod-retry", asRetry.ToString().ToLower()); 29 | 30 | return headers; 31 | } 32 | 33 | private String GenerateAuthHeaderContent(String apiKey, String signature) { 34 | return $"Signature keyId=\"{apiKey}\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"{signature}\""; 35 | } 36 | 37 | private string GenerateSignature(string nonce, DateTime dateTime) { 38 | return HashAndEncode($"date: {dateTime:R}\nx-mod-nonce: {nonce}", secret); 39 | } 40 | 41 | private static string HashAndEncode(string message, string secret) { 42 | var ascii = Encoding.ASCII; 43 | HMACSHA1 hmac = new HMACSHA1(ascii.GetBytes(secret)); 44 | hmac.Initialize(); 45 | 46 | byte[] messageBuffer = ascii.GetBytes(message); 47 | byte[] hash = hmac.ComputeHash(messageBuffer); 48 | 49 | return WebUtility.UrlEncode(Convert.ToBase64String(hash)); 50 | } 51 | } 52 | } -------------------------------------------------------------------------------- /samples/c#/TestAPIClient/src/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Net.Http; 3 | using System.Net.Http.Headers; 4 | using System.Threading.Tasks; 5 | 6 | namespace TestAPIClient { 7 | // A simple demonstation program that calls the Customers endpoint on the Modult sandbox. 8 | // Replace the API_KEY and API_SECRET constants with yout values before running 9 | class Program { 10 | private const string API_KEY = "YOUR_API_KEY"; 11 | private const string API_SECRET = "YOUR_API_SECRET"; 12 | 13 | private static readonly HttpClient client = BuildHttpClient(); 14 | private static readonly AuthHelper authHelper = new AuthHelper(API_KEY, API_SECRET); 15 | 16 | static async Task Main(string[] args) { 17 | await GetCusotmers(); 18 | } 19 | 20 | private static HttpClient BuildHttpClient() { 21 | var httpClient = new HttpClient(); 22 | httpClient.DefaultRequestHeaders.Accept.Clear(); 23 | httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); 24 | httpClient.DefaultRequestHeaders.Add("User-Agent", "Test API Client"); 25 | 26 | return httpClient; 27 | } 28 | 29 | private static async Task GetCusotmers() { 30 | var request = new HttpRequestMessage { 31 | Method = HttpMethod.Get, 32 | RequestUri = new Uri("https://api-sandbox.modulrfinance.com/api-sandbox/customers") 33 | }; 34 | 35 | // Generate a Nonce and add the Modulr headers to the request. 36 | // A more practical approach may be to implement a Custom Message Handler to automatically 37 | // add these, rather than repeating the steps for each endpoint 38 | string nonce = Guid.NewGuid().ToString(); 39 | foreach(var header in authHelper.GetHeaders(nonce)) { 40 | request.Headers.Add(header.Key, header.Value); 41 | } 42 | 43 | var response = client.SendAsync(request).Result; 44 | 45 | // For the purpose of this demonstartion we will just output the response as a string 46 | var jsonString = await response.Content.ReadAsStringAsync(); 47 | Console.WriteLine(jsonString); 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /samples/c#/TestAPIClient/src/TestAPIClient.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | netcoreapp3.1 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /samples/c#/TestAPIClient/test/AuthHelperTest.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Xunit; 3 | 4 | namespace TestAPIClient.Tests { 5 | public class AuthHelperTest { 6 | private AuthHelper underTest = new AuthHelper("KNOWN-TOKEN","NzAwZmIwMGQ0YTJiNDhkMzZjYzc3YjQ5OGQyYWMzOTI="); 7 | 8 | [Fact] 9 | public void GetHeaders_ForKnownInputs_ReturnsKnownHeaders() { 10 | string nonce = "28154b2-9c62b93cc22a-24c9e2-5536d7d"; 11 | string expectedDateText = "Mon, 25 Jul 2016 16:36:07 GMT"; 12 | string expectedAuthorisation = "Signature keyId=\"KNOWN-TOKEN\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"WBMr%2FYdhysbmiIEkdTrf2hP7SfA%3D\""; 13 | 14 | DateTime dateTime = DateTimeOffset.Parse(expectedDateText).UtcDateTime; 15 | 16 | var headers = underTest.GetHeaders(nonce, dateTime, false); 17 | 18 | Assert.True(headers["x-mod-retry"] == "false", "x-mod-retry header incorrect"); 19 | Assert.True(headers["x-mod-nonce"] == nonce, "x-mod-nonce header incorrect"); 20 | Assert.True(headers["Date"] == expectedDateText, "Date header incorrect"); 21 | Assert.True(headers["Authorization"] == expectedAuthorisation, "Authorization header incorrect"); 22 | } 23 | 24 | [Fact] 25 | public void GetHeaders_WhenNotProvided_DefaultsToCurrentDateTimeAndRetryFalse() { 26 | string nonce = Guid.NewGuid().ToString(); 27 | DateTime expectedDateTime = DateTime.UtcNow; 28 | 29 | var headers = underTest.GetHeaders(nonce); 30 | 31 | Assert.True(headers["x-mod-retry"] == "false", "x-mod-retry header incorrect"); 32 | Assert.True(headers["x-mod-nonce"] == nonce, "x-mod-nonce header incorrect"); 33 | 34 | DateTime headerDateTime = DateTimeOffset.Parse(headers["Date"]).UtcDateTime; 35 | int secondsDiff = expectedDateTime.Subtract(headerDateTime).Seconds; 36 | Assert.True(secondsDiff == 0, "Date header incorrect"); 37 | } 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /samples/c#/TestAPIClient/test/TestAPIClient.Tests.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | netcoreapp3.1 5 | 6 | false 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /samples/c/ModulrApiAuth.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include "openssl/hmac.h" 7 | #include "openssl/evp.h" 8 | #include "ModulrApiAuth.h" 9 | 10 | static unsigned char buf[512]; 11 | 12 | struct Header *generateApiAuthHeaders(const char *key, const char *secret, char *nonce) { 13 | 14 | char *date = generateDate(); 15 | if (!date) { 16 | fprintf(stderr, "Unable to generate date\n"); 17 | return NULL; 18 | } 19 | 20 | char *authHeader = buildAuthHeader(key, secret, nonce, date); 21 | if (!authHeader) { 22 | fprintf(stderr, "Unable to build auth header\n"); 23 | free(date); 24 | return NULL; 25 | } 26 | 27 | struct Header *headers = calloc(NUM_HEADERS + 1, sizeof(struct Header)); 28 | if (!headers) { 29 | fprintf(stderr, "Unable to build headers\n"); 30 | free(date); 31 | free(authHeader); 32 | return NULL; 33 | } 34 | 35 | headers[0].key = strdup("Date"); 36 | headers[0].value = date; 37 | 38 | headers[1].key = strdup("x-mod-nonce"); 39 | headers[1].value = strdup(nonce); 40 | 41 | headers[2].key = strdup("Authorization"); 42 | headers[2].value = authHeader; 43 | 44 | return headers; 45 | } 46 | 47 | void freeHeaders(struct Header *headers) { 48 | struct Header *h = headers; 49 | while (h->key != NULL) { 50 | freeHeader(*h); 51 | h++; 52 | } 53 | 54 | free(headers); 55 | } 56 | 57 | char *buildAuthHeader(const char *key, const char *secret, char *nonce, char *date) { 58 | char *sigString = buildSigString(nonce, date); 59 | if (!sigString) { 60 | fprintf(stderr, "Unable to build sigString\n"); 61 | return NULL; 62 | } 63 | 64 | unsigned char* digest = HMAC(EVP_sha1(), secret, strlen(secret), (unsigned char*)sigString, strlen(sigString), NULL, NULL); 65 | char *encoded = base64UrlEncode(digest); 66 | if (!encoded) { 67 | fprintf(stderr, "Unable to build url encoded sig string\n"); 68 | free(sigString); 69 | return NULL; 70 | } 71 | 72 | free(sigString); 73 | sprintf(buf, "Signature keyId=\"%s\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"%s\"", key, encoded); 74 | free(encoded); 75 | return strdup(buf); 76 | } 77 | 78 | 79 | char *buildSigString(char *nonce, char *date) { 80 | sprintf(buf, "date: %s\nx-mod-nonce: %s", date, nonce); 81 | return strdup(buf); 82 | } 83 | 84 | 85 | char *generateDate() { 86 | time_t now = time(0); 87 | struct tm tm = *gmtime(&now); 88 | strftime(buf, sizeof buf, "%a, %d %b %Y %H:%M:%S %Z", &tm); 89 | return strdup(buf); 90 | } 91 | 92 | char *base64UrlEncode(unsigned char *data) { 93 | CURL *curl = curl_easy_init(); 94 | if (!curl) { 95 | fprintf(stderr, "Error initialising curl\n"); 96 | return NULL; 97 | } 98 | 99 | // Base 64 encode 100 | EVP_EncodeBlock(buf, data, 20); 101 | 102 | // URL encode 103 | char *enc = curl_easy_escape(curl, buf, 0); 104 | char *ret = strdup(enc); 105 | 106 | curl_free(enc); 107 | curl_easy_cleanup(curl); 108 | return ret; 109 | } 110 | 111 | void freeHeader(struct Header h) { 112 | free(h.key); 113 | free(h.value); 114 | } 115 | -------------------------------------------------------------------------------- /samples/c/ModulrApiAuth.h: -------------------------------------------------------------------------------- 1 | #ifndef MODULR_API_AUTH_H 2 | #define MODULR_API_AUTH_H 3 | 4 | #define NUM_HEADERS 3 5 | 6 | struct Header { 7 | char *key; 8 | char *value; 9 | }; 10 | 11 | // public 12 | struct Header *generateApiAuthHeaders(const char *, const char *, char *); 13 | void freeHeaders(struct Header *); 14 | 15 | // private 16 | char *buildAuthHeader(const char *, const char *, char *, char *); 17 | char *buildSigString(char *, char *); 18 | char *base64UrlEncode(unsigned char *); 19 | char *generateDate(); 20 | void freeHeader(struct Header); 21 | 22 | 23 | #endif 24 | 25 | -------------------------------------------------------------------------------- /samples/c/sample.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | #include "ModulrApiAuth.h" 5 | 6 | int main(void) { 7 | 8 | const char key[] = ""; 9 | const char secret[] = ""; 10 | 11 | struct Header *headers = generateApiAuthHeaders(key, secret, "NONCE"); 12 | 13 | struct Header *h = headers; 14 | while (h->key != NULL) { 15 | printf("%s: %s\n", h->key, h->value); 16 | h++; 17 | } 18 | 19 | freeHeaders(headers); 20 | 21 | return 0; 22 | } 23 | -------------------------------------------------------------------------------- /samples/cpp/ModulrApiAuth.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include "openssl/hmac.h" 9 | #include "openssl/evp.h" 10 | 11 | using namespace std; 12 | 13 | class ModulrApiAuth { 14 | 15 | public: 16 | ModulrApiAuth(string key, string secret) : key_(key), secret_(secret) { } 17 | 18 | map generateApiAuthHeaders(string nonce) { 19 | map headers; 20 | string date = generateDate(); 21 | headers["Date"] = date; 22 | headers["x-mod-nonce"] = nonce; 23 | string authHeader = buildAuthHeader(nonce, date); 24 | headers["Authorization"] = authHeader; 25 | return headers; 26 | } 27 | 28 | private: 29 | string generateDate() { 30 | time_t now = time(0); 31 | struct tm tm = *gmtime(&now); 32 | strftime(buf_, sizeof buf_, "%a, %d %b %Y %H:%M:%S %Z", &tm); 33 | return string(buf_); 34 | } 35 | 36 | string buildSigString(string nonce, string date) { 37 | stringstream fmt; 38 | fmt << "date: " << date << "\nx-mod-nonce: " << nonce; 39 | return fmt.str(); 40 | } 41 | 42 | string buildAuthHeader(string nonce, string date) { 43 | string sigString = buildSigString(nonce, date); 44 | unsigned char* digest = HMAC(EVP_sha1(), secret_.c_str(), strlen(secret_.c_str()), (unsigned char*)sigString.c_str(), strlen(sigString.c_str()), NULL, NULL); 45 | string encoded = base64UrlEncode(digest); 46 | stringstream fmt; 47 | fmt << "Signature keyId=\"" << key_ << "\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"" << encoded << "\""; 48 | return fmt.str(); 49 | } 50 | 51 | string base64UrlEncode(unsigned char *data) { 52 | CURL *curl = curl_easy_init(); 53 | if (!curl) { 54 | cerr << "Error initialising curl\n"; 55 | return NULL; 56 | } 57 | 58 | // Base 64 encode 59 | EVP_EncodeBlock((unsigned char *)buf_, data, 20); 60 | 61 | // URL encode 62 | char *enc = curl_easy_escape(curl, buf_, 0); 63 | string result(enc); 64 | 65 | curl_free(enc); 66 | curl_easy_cleanup(curl); 67 | 68 | return result; 69 | } 70 | 71 | string key_; 72 | string secret_; 73 | char buf_[512]; 74 | }; 75 | -------------------------------------------------------------------------------- /samples/cpp/sample.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include "ModulrApiAuth.cpp" 6 | 7 | using namespace std; 8 | 9 | int main(void) { 10 | 11 | string key = ""; 12 | string secret = ""; 13 | 14 | ModulrApiAuth apiAuth(key, secret); 15 | 16 | map headers = apiAuth.generateApiAuthHeaders("NONCE"); 17 | 18 | map::iterator it = headers.begin(); 19 | while (it != headers.end()) { 20 | cout << it->first << ": " << it->second << endl; 21 | it++; 22 | } 23 | 24 | return 0; 25 | } 26 | -------------------------------------------------------------------------------- /samples/go/go.mod: -------------------------------------------------------------------------------- 1 | module github.com/Modulr-finance/modulr-hmac 2 | 3 | go 1.15 4 | 5 | require ( 6 | github.com/google/uuid v1.6.0 7 | github.com/stretchr/testify v1.9.0 8 | ) 9 | -------------------------------------------------------------------------------- /samples/go/go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= 2 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 3 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 4 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 5 | github.com/google/uuid v1.1.2 h1:EVhdT+1Kseyi1/pUmXKaFxYsDNy9RQYkMWRH68J/W7Y= 6 | github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 7 | github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= 8 | github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 9 | github.com/google/uuid v1.3.1 h1:KjJaJ9iWZ3jOFZIf1Lqf4laDRCasjl0BCmnEGxkdLb4= 10 | github.com/google/uuid v1.3.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 11 | github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4= 12 | github.com/google/uuid v1.4.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 13 | github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= 14 | github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 15 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 16 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 17 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 18 | github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= 19 | github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= 20 | github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= 21 | github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= 22 | github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 23 | github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 24 | github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= 25 | github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= 26 | github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= 27 | github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= 28 | github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= 29 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 30 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 31 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= 32 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 33 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 34 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 35 | -------------------------------------------------------------------------------- /samples/go/hmac/hmac.go: -------------------------------------------------------------------------------- 1 | package hmac 2 | 3 | import ( 4 | "github.com/Modulr-finance/modulr-hmac/hmac/signature" 5 | "github.com/google/uuid" 6 | "time" 7 | ) 8 | 9 | const ( 10 | AuthorizationHeader = "Authorization" 11 | DateHeader = "Date" 12 | EmptyString = "" 13 | NonceHeader = "x-mod-nonce" 14 | Retry = "x-mod-retry" 15 | RetryTrue = "true" 16 | RetryFalse = "false" 17 | ) 18 | 19 | var dateNow = time.Now 20 | 21 | func GenerateHeaders(apiKey string, apiSecret string, nonce string, hasRetry bool) (map[string]string, *ValidationError) { 22 | validationError := validateInput(apiKey, apiSecret) 23 | 24 | if validationError != nil { 25 | return nil, validationError 26 | } 27 | return constructHeadersMap(apiKey, apiSecret, nonce, hasRetry), nil 28 | } 29 | 30 | func constructHeadersMap(apiKey string, apiSecret string, nonce string, hasRetry bool) map[string]string { 31 | headers := make(map[string]string) 32 | date := dateNow().UTC().Format(time.RFC1123) 33 | nonce = generateNonceIfEmpty(nonce) 34 | 35 | headers[DateHeader] = date 36 | headers[AuthorizationHeader] = signature.Build(apiKey, apiSecret, nonce, date) 37 | headers[NonceHeader] = nonce 38 | headers[Retry] = parseRetryBool(hasRetry) 39 | return headers 40 | } 41 | 42 | func generateNonceIfEmpty(nonce string) string { 43 | if nonce == EmptyString { 44 | nonce = uuid.New().String() 45 | } 46 | return nonce 47 | } 48 | 49 | func parseRetryBool(hasRetry bool) string { 50 | if hasRetry { 51 | return RetryTrue 52 | } 53 | return RetryFalse 54 | } 55 | -------------------------------------------------------------------------------- /samples/go/hmac/hmac_test.go: -------------------------------------------------------------------------------- 1 | package hmac 2 | 3 | import ( 4 | "github.com/stretchr/testify/assert" 5 | "testing" 6 | "time" 7 | ) 8 | 9 | func TestGenerateReturnsAnHMACString(t *testing.T) { 10 | headers, _ := GenerateHeaders("api_key", "api_secret", "", false) 11 | expectedSignature := "Signature keyId=\"api_key\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"" 12 | assert.Equal(t, expectedSignature, headers["Authorization"][0:86], "generate should return the hmac headers") 13 | } 14 | 15 | func TestGenerateReturnsADateHeaderUTC(t *testing.T) { 16 | injectMockUTCDate() 17 | headers, _ := GenerateHeaders("api_key", "api_secret", "", false) 18 | expectedDate := "Thu, 02 Jan 2020 15:04:05 GMT" 19 | assert.Equal(t, expectedDate, headers["Date"]) 20 | } 21 | 22 | func TestGenerateReturnsADateHeaderNonUTC(t *testing.T) { 23 | injectMockNonUTCDate() 24 | headers, _ := GenerateHeaders("api_key", "api_secret", "", false) 25 | expectedDate := "Thu, 02 Jan 2020 14:04:05 GMT" 26 | assert.Equal(t, expectedDate, headers["Date"]) 27 | } 28 | 29 | func TestGenerateReturnsANonceHeaderWithExpectedValue(t *testing.T) { 30 | nonce := "thisIsTheNonce" 31 | headers, _ := GenerateHeaders("api_key", "api_secret", nonce, false) 32 | assert.Equal(t, nonce, headers["x-mod-nonce"]) 33 | } 34 | 35 | func TestGenerateReturnsARetryHeaderWithTrueIfRetryIsExpected(t *testing.T) { 36 | headers, _ := GenerateHeaders("api_key", "api_secret", "", true) 37 | assert.Equal(t, "true", headers["x-mod-retry"]) 38 | } 39 | 40 | func TestGenerateReturnsARetryHeaderWithFalseIfRetryIsNotExpected(t *testing.T) { 41 | headers, _ := GenerateHeaders("api_key", "api_secret", "", false) 42 | assert.Equal(t, "false", headers["x-mod-retry"]) 43 | } 44 | 45 | func TestGenerateReturnsAGeneratedNonceHeaderIfNonceIsEmpty(t *testing.T) { 46 | headers, _ := GenerateHeaders("api_key", "api_secret", "", false) 47 | assert.True(t, headers["x-mod-nonce"] != "", "x-mod-nonce header should have been populated") 48 | } 49 | 50 | func TestGenerateThrowsErrorIfApiKeyIsNull(t *testing.T) { 51 | _, err := GenerateHeaders("", "api_secret", "", false) 52 | assert.Equal(t, "api_key cannot be empty", err.Message) 53 | } 54 | 55 | func TestGenerateThrowsErrorIfApiSecretIsNull(t *testing.T) { 56 | _, err := GenerateHeaders("api_key", "", "", false) 57 | assert.Equal(t, "api_secret cannot be empty", err.Message) 58 | } 59 | 60 | func injectMockUTCDate() { 61 | dateNow = func() time.Time { 62 | now, _ := time.Parse(time.RFC1123, "Mon, 02 Jan 2020 15:04:05 GMT") 63 | return now 64 | } 65 | } 66 | 67 | func injectMockNonUTCDate() { 68 | dateNow = func() time.Time { 69 | now, _ := time.Parse(time.RFC1123, "Mon, 02 Jan 2020 15:04:05 CET") 70 | return now 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /samples/go/hmac/signature/signatureGenerator.go: -------------------------------------------------------------------------------- 1 | package signature 2 | 3 | import ( 4 | "crypto/hmac" 5 | "crypto/sha1" 6 | "encoding/base64" 7 | "net/url" 8 | ) 9 | 10 | const ( 11 | Algorithm = "algorithm=\"hmac-sha1\"," 12 | DatePrefix = "date: " 13 | Headers = "headers=\"date x-mod-nonce\"," 14 | SignaturePrefix = "signature=\"" 15 | SignatureSuffix = "\"" 16 | Newline = "\n" 17 | Nonce = "x-mod-nonce: " 18 | KeyIdPrefix = "Signature keyId=\"" 19 | ) 20 | 21 | func Build(apiKey string, apiSecret string, nonce string, date string) string { 22 | return buildKeyId(apiKey) + Algorithm + Headers + generateEncodedSignature(apiSecret, nonce, date) 23 | } 24 | 25 | func buildKeyId(apiKey string) string { 26 | return KeyIdPrefix + apiKey + "\"," 27 | } 28 | 29 | func generateEncodedSignature(apiSecret string, nonce string, date string) string { 30 | encodedSig := encodeSignature(DatePrefix + date + Newline + Nonce + nonce, apiSecret) 31 | return SignaturePrefix + encodedSig + SignatureSuffix 32 | } 33 | 34 | func encodeSignature(plainSignature string, apiSecret string) string { 35 | mac := hmac.New(sha1.New, []byte(apiSecret)) 36 | mac.Write([]byte(plainSignature)) 37 | encodedMac := mac.Sum(nil) 38 | base64Encoded := base64.StdEncoding.EncodeToString(encodedMac) 39 | return url.QueryEscape(base64Encoded) 40 | } 41 | -------------------------------------------------------------------------------- /samples/go/hmac/signature/signature_test.go: -------------------------------------------------------------------------------- 1 | package signature 2 | 3 | import ( 4 | "github.com/stretchr/testify/assert" 5 | "strings" 6 | "testing" 7 | "time" 8 | ) 9 | 10 | func TestGenerateReturnsSignatureWithKeyId(t *testing.T) { 11 | signature := Build("api_key", "api_secret", "", date()) 12 | expectedPrefix := "Signature keyId=\"api_key\"," 13 | hasKeyId := strings.HasPrefix(signature, expectedPrefix) 14 | assert.True(t, hasKeyId, "HMAC signature must contain the keyId") 15 | } 16 | 17 | func TestGenerateReturnsSignatureWithAlgorithm(t *testing.T) { 18 | signature := Build("api_key", "api_secret", "", date()) 19 | expectedAlgorithm := "algorithm=\"hmac-sha1\"," 20 | actualValue := signature[26:48] 21 | assert.Equal(t, expectedAlgorithm, actualValue, "HMAC signature must contain the algorithm used") 22 | } 23 | 24 | func TestGenerateReturnsSignatureWithHeaders(t *testing.T) { 25 | signature := Build("api_key", "api_secret", "", date()) 26 | expectedHeaders := "headers=\"date x-mod-nonce\"," 27 | actualValue := signature[48:75] 28 | assert.Equal(t, expectedHeaders, actualValue, "HMAC signature must contain the headers") 29 | } 30 | 31 | func TestGenerateReturnsSignatureWithSignatureValue(t *testing.T) { 32 | signature := Build("api_key", "api_secret", "", date()) 33 | expectedSignature := "signature=\"" 34 | actualValue := signature[75:86] 35 | assert.Equal(t, expectedSignature, actualValue, "HMAC signature must contain the signature") 36 | } 37 | 38 | func TestGenerateReturnsHashedSignature(t *testing.T) { 39 | signature := Build("api_key", "api_secret", "", date()) 40 | actualValue := signature[86:117] 41 | assert.True(t, actualValue != "", "Encoded HMAC signature should be present") 42 | } 43 | 44 | func TestGenerateAcceptsANonce(t *testing.T) { 45 | signature := Build("api_key", "api_secret", "nonce", date()) 46 | actualValue := signature[86:116] 47 | expected := "9V8gi5Mp9MsL%2FO7mV6qZlBM9%2FR" 48 | assert.Equal(t, expected, actualValue, "HMAC signature must contain the signature") 49 | } 50 | 51 | func date() string { 52 | now, _ := time.Parse(time.RFC1123, "Mon, 02 Jan 2020 15:04:05 GMT") 53 | return now.String() 54 | } 55 | -------------------------------------------------------------------------------- /samples/go/hmac/validate_hmac_input.go: -------------------------------------------------------------------------------- 1 | package hmac 2 | 3 | type ValidationError struct { 4 | Message string 5 | } 6 | 7 | func validateInput(apiKey string, apiSecret string) *ValidationError { 8 | if apiKey == "" { 9 | return &ValidationError{"api_key cannot be empty"} 10 | } 11 | 12 | if apiSecret == "" { 13 | return &ValidationError{"api_secret cannot be empty"} 14 | } 15 | 16 | return nil 17 | } 18 | -------------------------------------------------------------------------------- /samples/go/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "github.com/Modulr-finance/modulr-hmac/hmac" 6 | ) 7 | 8 | func main() { 9 | headers, _ := hmac.GenerateHeaders("api-key", "api-secret", "", false) 10 | 11 | for key, element := range headers { 12 | fmt.Println(key, ":", element) 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /samples/java/build.gradle: -------------------------------------------------------------------------------- 1 | group 'com.modulr' 2 | version '1.0' 3 | 4 | apply plugin: 'java' 5 | 6 | java { 7 | sourceCompatibility = 1.8 8 | } 9 | 10 | repositories { 11 | mavenCentral() 12 | } 13 | 14 | dependencies { 15 | testImplementation group: 'junit', name: 'junit', version: '4.13.2' 16 | implementation group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.14' 17 | testImplementation 'org.mockito:mockito-core:5.11.0' 18 | } 19 | -------------------------------------------------------------------------------- /samples/java/gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Modulr-finance/modulr-hmac/4a37a505cbd22193f6b83161db3e44627b46456d/samples/java/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /samples/java/gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /samples/java/gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | -------------------------------------------------------------------------------- /samples/java/gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 1>&2 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 48 | echo. 1>&2 49 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 50 | echo location of your Java installation. 1>&2 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 1>&2 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 62 | echo. 1>&2 63 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 64 | echo location of your Java installation. 1>&2 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /samples/java/settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'hmac' 2 | 3 | -------------------------------------------------------------------------------- /samples/java/src/main/java/com/modulr/api/ModulrApiAuth.java: -------------------------------------------------------------------------------- 1 | package com.modulr.api; 2 | 3 | import javax.crypto.Mac; 4 | import javax.crypto.spec.SecretKeySpec; 5 | import java.io.UnsupportedEncodingException; 6 | import java.net.URLEncoder; 7 | import java.security.InvalidKeyException; 8 | import java.security.NoSuchAlgorithmException; 9 | import java.security.SignatureException; 10 | import java.text.DateFormat; 11 | import java.text.SimpleDateFormat; 12 | import java.util.*; 13 | import java.util.function.Supplier; 14 | 15 | public class ModulrApiAuth { 16 | private static final String HMAC_SHA1_ALGORITHM = "HmacSHA1"; 17 | private static final String DATE_PATTERN = "EEE, dd MMM yyyy HH:mm:ss z"; 18 | private final String secret; 19 | private final String token; 20 | private Date date; 21 | private Supplier dateSupplier; 22 | 23 | private String lastUsedNonce; 24 | 25 | 26 | public ModulrApiAuth(String token, String secret) { 27 | this(token, secret, Date::new); 28 | } 29 | 30 | public ModulrApiAuth(String token, String secret, Supplier dateSupplier) { 31 | this.token = (token != null) ? token.trim() : null; 32 | this.secret = secret.trim(); 33 | this.dateSupplier = dateSupplier; 34 | } 35 | 36 | public Map generateApiAuthHeaders(String nonce) throws SignatureException { 37 | return buildHeaders(nonce, false); 38 | } 39 | 40 | public Map generateRetryApiAuthHeaders() throws SignatureException { 41 | return buildHeaders(this.lastUsedNonce, true); 42 | } 43 | 44 | private Map buildHeaders(String nonce, Boolean retry) throws SignatureException { 45 | final Map headerParams = new HashMap<>(); 46 | String hmac = generateHmac(nonce); 47 | 48 | headerParams.put("Authorization", formatAuthHeader(this.token, hmac)); 49 | headerParams.put("Date", getFormattedDate(this.getDate())); 50 | headerParams.put("x-mod-nonce", nonce); 51 | headerParams.put("x-mod-retry", String.valueOf(retry)); 52 | 53 | this.lastUsedNonce = nonce; 54 | 55 | return headerParams; 56 | } 57 | 58 | public String generateHmac(String nonce) throws SignatureException { 59 | validateFields(); 60 | this.date = dateSupplier.get(); 61 | String data = String.format("date: %s\nx-mod-nonce: %s", getFormattedDate(this.getDate()), nonce); 62 | return calculateHmac(data); 63 | } 64 | 65 | public Date getDate() { 66 | return date; 67 | } 68 | 69 | public String getSecret() { 70 | return secret; 71 | } 72 | 73 | public String getToken() { 74 | return token; 75 | } 76 | 77 | private String formatAuthHeader(String token, String signature) { 78 | return String.format("Signature keyId=\"%s\",algorithm=\"%s\",headers=\"date x-mod-nonce\",signature=\"%s\"", token, "hmac-sha1", signature); 79 | } 80 | 81 | private String calculateHmac(final String content) throws SignatureException { 82 | try { 83 | final SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(), HMAC_SHA1_ALGORITHM); 84 | Mac mac = Mac.getInstance(HMAC_SHA1_ALGORITHM); 85 | mac.init(signingKey); 86 | 87 | // compute the hmac on input data bytes 88 | byte[] rawHmac = mac.doFinal(content.getBytes()); 89 | 90 | // base64-encode the hmac 91 | String hmac = Base64.getEncoder().encodeToString(rawHmac); 92 | return URLEncoder.encode(hmac, "UTF-8"); 93 | } catch (NoSuchAlgorithmException | InvalidKeyException | UnsupportedEncodingException e) { 94 | throw new SignatureException("Failed to generate HMAC : " + e.getMessage(), e); 95 | } 96 | } 97 | 98 | private String getFormattedDate(Date date) { 99 | DateFormat sdf = new SimpleDateFormat(DATE_PATTERN,Locale.ENGLISH); 100 | sdf.setTimeZone(TimeZone.getTimeZone("GMT")); 101 | return sdf.format(date); 102 | } 103 | 104 | private void validateFields() { 105 | if (this.secret == null) { 106 | throw new IllegalStateException("Secret required for Modulr API Auth"); 107 | } 108 | if (this.dateSupplier == null) { 109 | throw new IllegalStateException("A date supplier is required for Modulr API Auth"); 110 | } 111 | } 112 | 113 | } 114 | -------------------------------------------------------------------------------- /samples/java/src/main/java/com/modulr/api/TestAPI.java: -------------------------------------------------------------------------------- 1 | package com.modulr.api; 2 | 3 | import java.io.IOException; 4 | import java.security.SignatureException; 5 | import java.util.Map; 6 | import java.util.UUID; 7 | 8 | 9 | import org.apache.http.client.methods.CloseableHttpResponse; 10 | import org.apache.http.client.methods.HttpUriRequest; 11 | import org.apache.http.client.methods.RequestBuilder; 12 | import org.apache.http.impl.client.CloseableHttpClient; 13 | import org.apache.http.impl.client.HttpClients; 14 | import org.apache.http.util.EntityUtils; 15 | 16 | // Small demo program to perform a API get call on an account on the Modulr sanbox. 17 | // Replace the api key value with your api-key. 18 | // Replace the secret with your secret key. 19 | // Replace the account id with your account id. 20 | // This can be run from your favorite IDE. 21 | public class TestAPI { 22 | 23 | private static final String accountId = ""; // Will be of the format A120940C 24 | private static final String MODULR_URL = "https://api-sandbox.modulrfinance.com/api-sandbox/accounts/" + accountId; 25 | private static final String api_key = ""; 26 | private static final String secret = ""; 27 | 28 | public static void main(String[] args) throws SignatureException { 29 | ModulrApiAuth auth = new ModulrApiAuth(api_key, secret); 30 | String nonce = UUID.randomUUID().toString(); 31 | Map headers = auth.generateApiAuthHeaders(nonce); 32 | 33 | CloseableHttpClient client = HttpClients.createDefault(); 34 | RequestBuilder builder = RequestBuilder.get() 35 | .setUri(MODULR_URL); 36 | headers.keySet().forEach(k -> { 37 | builder.addHeader(k, headers.get(k)); 38 | }); 39 | headers.keySet().forEach(k-> { 40 | System.out.println(k + " " + headers.get(k)); 41 | }); 42 | HttpUriRequest request = builder.build(); 43 | try { 44 | CloseableHttpResponse response = client.execute(request); 45 | System.out.println(response.getStatusLine()); 46 | System.out.println(EntityUtils.toString(response.getEntity())); 47 | } catch (IOException e) { 48 | e.printStackTrace(); 49 | } 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /samples/java/src/main/java/com/modulr/hmac/Hmac.java: -------------------------------------------------------------------------------- 1 | package com.modulr.hmac; 2 | 3 | import com.modulr.api.ModulrApiAuth; 4 | 5 | import java.util.Map; 6 | import java.security.SignatureException; 7 | 8 | public class Hmac { 9 | public static void main(String... args) throws SignatureException{ 10 | ModulrApiAuth modulrAuth = new ModulrApiAuth("KNOWN-TOKEN", "SECRET-TOKEN"); 11 | 12 | /* Generate required headers for the given API key, hmac secret and nonce*/ 13 | Map headers = modulrAuth.generateApiAuthHeaders("NONCE"); 14 | 15 | headers.forEach((key, value) -> System.out.println(key + ": " + value)); 16 | 17 | /* Generate required headers for the given API key, hmac secret and last used nonce*/ 18 | Map retryHeaders = modulrAuth.generateRetryApiAuthHeaders(); 19 | 20 | retryHeaders.forEach((key, value) -> System.out.println(key + ": " + value)); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /samples/java/src/test/java/com/modulr/api/ModulrApiAuthTest.java: -------------------------------------------------------------------------------- 1 | package com.modulr.api; 2 | 3 | import org.junit.Test; 4 | import org.junit.runner.RunWith; 5 | import org.mockito.Mock; 6 | import org.mockito.junit.MockitoJUnitRunner; 7 | 8 | import java.security.SignatureException; 9 | import java.time.LocalDateTime; 10 | import java.time.ZoneId; 11 | import java.time.ZonedDateTime; 12 | import java.util.Date; 13 | import java.util.Map; 14 | import static org.mockito.Mockito.spy; 15 | import static org.mockito.Mockito.when; 16 | import java.time.format.DateTimeFormatter; 17 | import java.util.function.Supplier; 18 | 19 | 20 | import static org.junit.Assert.*; 21 | 22 | @RunWith(MockitoJUnitRunner.class) 23 | public class ModulrApiAuthTest { 24 | 25 | /* Test Data*/ 26 | private static final String DATE_STR = "2016-09-25T16:36:07"; 27 | private static final String API_TOKEN = "KNOWN-TOKEN"; 28 | private static final String HMAC_SECRET = "NzAwZmIwMGQ0YTJiNDhkMzZjYzc3YjQ5OGQyYWMzOTI="; 29 | private static final String NONCE = "28154b2-9c62b93cc22a-24c9e2-5536d7d"; 30 | private static final String EXPECTED_HMAC_SIGNATURE = "z1X8UZJq9jwLPi9peycdHfy3SIY%3D"; 31 | 32 | @Mock 33 | Supplier dateSupplier; 34 | 35 | private ModulrApiAuth underTest; 36 | 37 | @Test 38 | public void testHmacGeneratorWithNonNullToken() throws SignatureException { 39 | underTest = spy(new ModulrApiAuth(API_TOKEN, HMAC_SECRET)); 40 | 41 | LocalDateTime dateTime = LocalDateTime.parse(DATE_STR); 42 | ZonedDateTime utcDateTime = ZonedDateTime.of(dateTime,ZoneId.of("Z")); 43 | 44 | Date date = Date.from(utcDateTime.toInstant()); 45 | 46 | /* Generate headers and assert they are as expected */ 47 | when(underTest.getDate()).thenReturn(date); 48 | Map headers = underTest.generateApiAuthHeaders(NONCE); 49 | assertEquals(headers.size(), 4); 50 | assertEquals(NONCE, headers.get("x-mod-nonce")); 51 | assertEquals(DateTimeFormatter.RFC_1123_DATE_TIME.format(utcDateTime), headers.get("Date")); 52 | assertEquals("false", headers.get("x-mod-retry")); 53 | assertEquals("Signature keyId=\""+ API_TOKEN+ "\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"" + EXPECTED_HMAC_SIGNATURE + "\"", headers.get("Authorization")); 54 | 55 | /* Generate retry headers and assert they are as expected 56 | * x-mod-retry should be true 57 | * Date should not be same as previous 58 | * Nonce should be same as previous 59 | * Signature will be different because the date has changed */ 60 | when(underTest.getDate()).thenCallRealMethod(); 61 | Map headersWithRetryOn = underTest.generateRetryApiAuthHeaders(); 62 | assertEquals("true", headersWithRetryOn.get("x-mod-retry")); 63 | assertEquals(headers.get("x-mod-nonce"), headersWithRetryOn.get("x-mod-nonce")); 64 | assertNotEquals(headers.get("Date"), headersWithRetryOn.get("Date")); 65 | assertNotEquals(headers.get("Authorization"), headersWithRetryOn.get("Authorization")); 66 | } 67 | 68 | @Test 69 | public void testHmacGeneratorWithNullToken() throws SignatureException { 70 | LocalDateTime dateTime = LocalDateTime.parse(DATE_STR); 71 | ZonedDateTime utcDateTime = ZonedDateTime.of(dateTime,ZoneId.of("Z")); 72 | 73 | Date date = Date.from(utcDateTime.toInstant()); 74 | underTest = spy(new ModulrApiAuth(null, HMAC_SECRET, () -> date)); 75 | 76 | assertEquals(EXPECTED_HMAC_SIGNATURE, underTest.generateHmac(NONCE)); 77 | } 78 | 79 | 80 | @Test 81 | public void testHmacGeneratorWithDatSupplier() throws SignatureException { 82 | 83 | LocalDateTime dateTime = LocalDateTime.parse(DATE_STR); 84 | ZonedDateTime utcDateTime = ZonedDateTime.of(dateTime,ZoneId.of("Z")); 85 | 86 | Date date = Date.from(utcDateTime.toInstant()); 87 | when(dateSupplier.get()).thenReturn(date).thenReturn(new Date()); 88 | 89 | underTest = new ModulrApiAuth(API_TOKEN, HMAC_SECRET, dateSupplier); 90 | 91 | /* Generate headers and assert they are as expected */ 92 | Map headers = underTest.generateApiAuthHeaders(NONCE); 93 | assertEquals(headers.size(), 4); 94 | assertEquals(NONCE, headers.get("x-mod-nonce")); 95 | assertEquals(DateTimeFormatter.RFC_1123_DATE_TIME.format(utcDateTime), headers.get("Date")); 96 | assertEquals("false", headers.get("x-mod-retry")); 97 | assertEquals("Signature keyId=\""+ API_TOKEN+ "\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"" + EXPECTED_HMAC_SIGNATURE + "\"", headers.get("Authorization")); 98 | 99 | /* Generate retry headers and assert they are as expected 100 | * x-mod-retry should be true 101 | * Date should not be same as previous 102 | * Nonce should be same as previous 103 | * Signature will be different because the date has changed */ 104 | Map headersWithRetryOn = underTest.generateRetryApiAuthHeaders(); 105 | assertEquals("true", headersWithRetryOn.get("x-mod-retry")); 106 | assertEquals(headers.get("x-mod-nonce"), headersWithRetryOn.get("x-mod-nonce")); 107 | assertNotEquals(headers.get("Date"), headersWithRetryOn.get("Date")); 108 | assertNotEquals(headers.get("Authorization"), headersWithRetryOn.get("Authorization")); 109 | } 110 | } -------------------------------------------------------------------------------- /samples/kotlin/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | kotlin("jvm") version "1.9.23" 3 | } 4 | 5 | group = "com.modulr" 6 | version = "1.0" 7 | 8 | repositories { 9 | gradlePluginPortal() 10 | mavenCentral() 11 | } 12 | 13 | dependencies { 14 | implementation("org.apache.httpcomponents:httpclient:4.5.14") 15 | implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8") 16 | 17 | testImplementation("junit:junit:4.13.2") 18 | testImplementation("org.mockito:mockito-core:5.11.0") 19 | testImplementation("com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0") 20 | } 21 | -------------------------------------------------------------------------------- /samples/kotlin/gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Modulr-finance/modulr-hmac/4a37a505cbd22193f6b83161db3e44627b46456d/samples/kotlin/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /samples/kotlin/gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /samples/kotlin/gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | -------------------------------------------------------------------------------- /samples/kotlin/gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 1>&2 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 48 | echo. 1>&2 49 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 50 | echo location of your Java installation. 1>&2 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 1>&2 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 62 | echo. 1>&2 63 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 64 | echo location of your Java installation. 1>&2 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /samples/kotlin/settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "hmac" 2 | -------------------------------------------------------------------------------- /samples/kotlin/src/main/kotlin/com/modulr/api/Example.kt: -------------------------------------------------------------------------------- 1 | package com.modulr.api 2 | 3 | import org.apache.http.client.methods.CloseableHttpResponse 4 | import org.apache.http.client.methods.HttpUriRequest 5 | import org.apache.http.client.methods.RequestBuilder 6 | import org.apache.http.impl.client.CloseableHttpClient 7 | import org.apache.http.impl.client.HttpClients 8 | import org.apache.http.util.EntityUtils 9 | 10 | object Example { 11 | 12 | private const val API_KEY = "" 13 | private const val API_SECRET = "" 14 | 15 | private const val URL = "https://api-sandbox.modulrfinance.com/api-sandbox/customers" 16 | 17 | @JvmStatic 18 | fun main(args: Array) { 19 | // Set up signature helper 20 | val signature = Signature(API_KEY, API_SECRET) 21 | 22 | // Calculate HMAC signature with current date time and random nonce 23 | val result = signature.calculate() 24 | 25 | // Call the API with required headers 26 | val client: CloseableHttpClient = HttpClients.createDefault() 27 | val builder: RequestBuilder = RequestBuilder.get() 28 | .setUri(URL) 29 | 30 | result.headers.forEach { (key, value) -> builder.addHeader(key, value) } 31 | 32 | val request: HttpUriRequest = builder.build() 33 | val response: CloseableHttpResponse = client.execute(request) 34 | 35 | val statusCode = response.statusLine.statusCode 36 | val body = EntityUtils.toString(response.entity) 37 | 38 | if (statusCode != 200) { 39 | println("Unsuccessful API call, code: $statusCode, body: $body") 40 | } else { 41 | println(body) 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /samples/kotlin/src/main/kotlin/com/modulr/api/Signature.kt: -------------------------------------------------------------------------------- 1 | package com.modulr.api 2 | 3 | import java.net.URLEncoder 4 | import java.nio.charset.StandardCharsets 5 | import java.text.SimpleDateFormat 6 | import java.util.Base64 7 | import java.util.Date 8 | import java.util.Locale 9 | import java.util.TimeZone 10 | import java.util.UUID 11 | import javax.crypto.Mac 12 | import javax.crypto.spec.SecretKeySpec 13 | 14 | class Signature( 15 | private val apiKey: String, 16 | private val apiSecret: String 17 | ) { 18 | 19 | fun calculate(nonce: String = UUID.randomUUID().toString(), date: Date = Date()): Result { 20 | val timestamp = formatDate(date) 21 | val message = "date: ${timestamp}\nx-mod-nonce: $nonce" 22 | 23 | val signature = try { 24 | val signingKey = SecretKeySpec(apiSecret.toByteArray(), HMAC_SHA1_ALGORITHM) 25 | val mac = Mac.getInstance(HMAC_SHA1_ALGORITHM) 26 | mac.init(signingKey) 27 | 28 | // compute the hmac on input data bytes 29 | val rawHmac = mac.doFinal(message.toByteArray()) 30 | 31 | // base64-encode the hmac 32 | val hmac = Base64.getEncoder().encodeToString(rawHmac) 33 | URLEncoder.encode(hmac, StandardCharsets.UTF_8.name()) 34 | } catch (e: Exception) { 35 | throw RuntimeException("Failed to generate HMAC signature", e) 36 | } 37 | 38 | return Result(apiKey, nonce, signature, timestamp) 39 | } 40 | 41 | companion object { 42 | 43 | private const val DATE_PATTERN = "EEE, dd MMM yyyy HH:mm:ss z" 44 | private const val HMAC_SHA1_ALGORITHM = "HmacSHA1" 45 | 46 | private fun formatDate(date: Date): String { 47 | val sdf = SimpleDateFormat(DATE_PATTERN, Locale.ENGLISH) 48 | sdf.timeZone = TimeZone.getTimeZone("GMT") 49 | return sdf.format(date) 50 | } 51 | } 52 | } 53 | 54 | data class Result( 55 | private val apiKey: String, 56 | val nonce: String, 57 | val signature: String, 58 | val timestamp: String 59 | ) { 60 | 61 | val headers: Map 62 | get() = mapOf( 63 | "Authorization" to "Signature keyId=\"$apiKey\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"$signature\"", 64 | "Date" to timestamp, 65 | "x-mod-nonce" to nonce 66 | ) 67 | } -------------------------------------------------------------------------------- /samples/kotlin/src/test/kotlin/com/modulr/api/SignatureTest.kt: -------------------------------------------------------------------------------- 1 | package com.modulr.api 2 | 3 | import java.time.LocalDateTime 4 | import java.time.ZoneId 5 | import java.time.ZonedDateTime 6 | import java.util.Date 7 | import org.junit.Assert.assertEquals 8 | import org.junit.Assert.assertNotNull 9 | import org.junit.Test 10 | 11 | class SignatureTest { 12 | 13 | private val signature = Signature(API_KEY, API_SECRET) 14 | 15 | @Test 16 | fun testHmacGeneration() { 17 | val result = signature.calculate() 18 | 19 | assertNotNull(result.nonce) 20 | assertNotNull(result.signature) 21 | assertNotNull(result.timestamp) 22 | 23 | val headers = result.headers 24 | 25 | assertNotNull(headers["Authorization"]) 26 | assertNotNull(headers["Date"]) 27 | assertNotNull(headers["x-mod-nonce"]) 28 | } 29 | 30 | @Test 31 | fun testHmacGenerationWithKnownNonceAndDate() { 32 | val result = signature.calculate("28154b2-9c62b93cc22a-24c9e2-5536d7d", toDate("2016-09-25T16:36:07")) 33 | 34 | assertEquals("28154b2-9c62b93cc22a-24c9e2-5536d7d", result.nonce) 35 | assertEquals("z1X8UZJq9jwLPi9peycdHfy3SIY%3D", result.signature) 36 | assertEquals("Sun, 25 Sep 2016 16:36:07 GMT", result.timestamp) 37 | 38 | val headers = result.headers 39 | 40 | assertEquals("Signature keyId=\"${API_KEY}\",algorithm=\"hmac-sha1\",headers=\"date x-mod-nonce\",signature=\"z1X8UZJq9jwLPi9peycdHfy3SIY%3D\"", headers["Authorization"]) 41 | assertEquals("Sun, 25 Sep 2016 16:36:07 GMT", headers["Date"]) 42 | assertEquals("28154b2-9c62b93cc22a-24c9e2-5536d7d", headers["x-mod-nonce"]) 43 | } 44 | 45 | private fun toDate(str: String): Date { 46 | val dateTime = LocalDateTime.parse(str) 47 | val utcDateTime = ZonedDateTime.of(dateTime, ZoneId.of("Z")) 48 | 49 | return Date.from(utcDateTime.toInstant()) 50 | } 51 | 52 | companion object { 53 | 54 | private const val API_KEY = "KNOWN-TOKEN" 55 | private const val API_SECRET = "NzAwZmIwMGQ0YTJiNDhkMzZjYzc3YjQ5OGQyYWMzOTI=" 56 | } 57 | } -------------------------------------------------------------------------------- /samples/nodejs/.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json -------------------------------------------------------------------------------- /samples/nodejs/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | const signature = require(`./signature`); 3 | 4 | const API_KEY = ""; 5 | const API_SECRET = ""; 6 | 7 | const signatureHelper = new signature(API_KEY,API_SECRET); 8 | const signatureResult = signatureHelper.calculate(); 9 | 10 | async function getCustomers(){ 11 | try { 12 | const response = await fetch('https://api-sandbox.modulrfinance.com/api-sandbox/customers', 13 | { 14 | headers: signatureResult.getHTTPHeaders() 15 | }) 16 | 17 | const jsonBody = await response.json(); 18 | 19 | if (response.ok) { 20 | console.log('OK response from API, body: ', jsonBody); 21 | } else { 22 | console.error('Unsuccessful API call, code: ', response.status, ', body: ', jsonBody); 23 | } 24 | }catch(error){ 25 | console.error('Error calling API', error); 26 | } 27 | } 28 | 29 | getCustomers(); -------------------------------------------------------------------------------- /samples/nodejs/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "modulr-client", 3 | "version": "1.0.0", 4 | "description": "Demo for calling Modulr API", 5 | "main": "index.js", 6 | "scripts": { 7 | "start": "node .", 8 | "test": "mocha" 9 | }, 10 | "author": "Jenya Y.", 11 | "license": "ISC", 12 | "dependencies": { 13 | "crypto-js": "^4.1.1", 14 | "uuid": "^9.0.0" 15 | }, 16 | "devDependencies": { 17 | "chai": "^4.3.7", 18 | "mocha": "^10.2.0" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /samples/nodejs/signature.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const uuid = require('uuid'); 4 | const crypto = require('crypto-js'); 5 | 6 | class Signature { 7 | constructor(apiKey, apiSecret) { 8 | if (this.apikey || this.apiSecret) { 9 | throw new Error('apikey and apiSecret must be suppiled to calculate signature'); 10 | } 11 | this.apikey = apiKey; 12 | this.apiSecret = apiSecret; 13 | } 14 | 15 | 16 | calculate(nonce, timestamp){ 17 | if (!nonce){ 18 | nonce = uuid.v4(); 19 | } 20 | 21 | if (!timestamp){ 22 | timestamp = new Date().toUTCString(); 23 | } 24 | 25 | // format raw signature 26 | const signature = `date: ${timestamp}\nx-mod-nonce: ${nonce}`; 27 | console.debug(`Raw signature string is:\n-----------\n${signature}\n-----------`); 28 | 29 | // sign and encode signature 30 | const signatureSigned = crypto.HmacSHA1(signature, this.apiSecret); 31 | const signatureEncoded = encodeURIComponent(crypto.enc.Base64.stringify(signatureSigned)); 32 | console.debug(`Signed signature is [${signatureSigned}] and encoded is [${signatureEncoded}]`); 33 | 34 | return new Result(this.apikey, timestamp, nonce, signatureEncoded); 35 | } 36 | 37 | } 38 | 39 | class Result { 40 | constructor(key, timestamp, nonce, encodedSignature){ 41 | this.timestamp = timestamp; 42 | this.nonce = nonce; 43 | this.encodedSignature = encodedSignature; 44 | this.authorisation = `Signature keyId="${key}",algorithm="hmac-sha1",headers="date x-mod-nonce",signature="${encodedSignature}"`; 45 | } 46 | 47 | getTimeStamp(){ 48 | return this.timestamp; 49 | } 50 | 51 | getHTTPHeaders(){ 52 | return { 53 | 'Date': this.timestamp, 54 | 'x-mod-nonce': this.nonce, 55 | 'Authorization': this.authorisation 56 | }; 57 | } 58 | 59 | getSignature(){ 60 | return this.encodedSignature; 61 | } 62 | } 63 | 64 | module.exports = Signature, Result; -------------------------------------------------------------------------------- /samples/nodejs/test/singature-test.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const expect = require('chai').expect; 4 | const signature = require(`../signature`); 5 | 6 | const signatureHelper = new signature('KNOWN-TOKEN','NzAwZmIwMGQ0YTJiNDhkMzZjYzc3YjQ5OGQyYWMzOTI='); 7 | 8 | describe('Signature Test', function(){ 9 | 10 | it('HMAC generation', function(done){ 11 | var result = signatureHelper.calculate(); 12 | expect(result.getSignature()).to.not.undefined; 13 | 14 | var headers = result.getHTTPHeaders(); 15 | 16 | expect(headers['Date']).to.not.undefined; 17 | expect(headers['x-mod-nonce']).to.not.undefined; 18 | expect(headers['Authorization']).to.not.undefined; 19 | done(); 20 | }); 21 | 22 | it('HMAC generation with known nonce and date', function(done){ 23 | var result = signatureHelper.calculate('28154b2-9c62b93cc22a-24c9e2-5536d7d','Mon, 25 Jul 2016 16:36:07 GMT'); 24 | expect(result.getSignature()).to.equal('WBMr%2FYdhysbmiIEkdTrf2hP7SfA%3D'); 25 | 26 | var headers = result.getHTTPHeaders(); 27 | 28 | expect(headers['Date']).to.equal('Mon, 25 Jul 2016 16:36:07 GMT'); 29 | expect(headers['x-mod-nonce']).to.equal('28154b2-9c62b93cc22a-24c9e2-5536d7d'); 30 | expect(headers['Authorization']).to.equal('Signature keyId="KNOWN-TOKEN",algorithm="hmac-sha1",headers="date x-mod-nonce",signature="WBMr%2FYdhysbmiIEkdTrf2hP7SfA%3D"'); 31 | done(); 32 | }); 33 | 34 | }); -------------------------------------------------------------------------------- /samples/postman/pre-request-script.js: -------------------------------------------------------------------------------- 1 | const uuid = require('uuid'); 2 | const moment = require('moment'); 3 | const crypto = require('crypto-js'); 4 | const DATE_TIME_FORMAT = 'ddd, DD MMM YYYY HH:mm:ss'; 5 | const TIMEZONE = ' GMT'; 6 | 7 | 8 | pm.variables.set('authorization', generateAuthorisationHeader()); 9 | 10 | function generateAuthorisationHeader() { 11 | const key = pm.variables.get('api_key'); 12 | const secret = pm.variables.get('api_secret'); 13 | 14 | return secret === "" ? key : generateHMAC(key, secret); 15 | } 16 | 17 | function generateHMAC(key, secret) { 18 | const nonce = uuid(); 19 | const date = moment.utc().format(DATE_TIME_FORMAT) + TIMEZONE; 20 | setEnvironmentVariables(nonce, date); 21 | 22 | const signaturePlain = "date: " + date + "\nx-mod-nonce: " + nonce; 23 | const hmac = crypto.HmacSHA1(signaturePlain, secret); 24 | const hmacEncoded = encodeURIComponent(hmac.toString(crypto.enc.Base64)); 25 | 26 | return 'Signature keyId="' + key + '",algorithm="hmac-sha1",headers="date x-mod-nonce",signature="' + hmacEncoded + '"'; 27 | } 28 | 29 | function setEnvironmentVariables(nonce, date) { 30 | pm.variables.set('nonce', nonce); 31 | pm.variables.set('date', date); 32 | } 33 | -------------------------------------------------------------------------------- /samples/postman/screenshots/postman_env_variables.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Modulr-finance/modulr-hmac/4a37a505cbd22193f6b83161db3e44627b46456d/samples/postman/screenshots/postman_env_variables.png -------------------------------------------------------------------------------- /samples/postman/screenshots/postman_headers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Modulr-finance/modulr-hmac/4a37a505cbd22193f6b83161db3e44627b46456d/samples/postman/screenshots/postman_headers.png -------------------------------------------------------------------------------- /samples/python/example.py: -------------------------------------------------------------------------------- 1 | import requests 2 | from modulr_hmac.api_auth import Signature 3 | 4 | API_KEY = "57502612d1bb2c00010000256c9568f1f7d540e085052b425d46d233" 5 | API_SECRET = "Y2Q0MzhmZDE2OWIzNDVkNGE5ZTczOTU3ZTAxZWY5NTc=" 6 | 7 | url = f'https://api-sandbox.modulrfinance.com/api-sandbox/customers' 8 | 9 | 10 | # Set up signature helper 11 | signature = Signature(API_KEY, API_SECRET) 12 | 13 | # calculate mhac signature with current date time and random nonce 14 | result = signature.calculate() 15 | 16 | # call the api with requireed headers 17 | response = requests.get(url, headers=result.get_http_headers()) 18 | 19 | if response.status_code != 200: 20 | print(f'Unsuccessful API call, code: {response.status_code}, body: {response.text}') 21 | else: 22 | print(response.text) 23 | 24 | -------------------------------------------------------------------------------- /samples/python/modulr_hmac/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Modulr-finance/modulr-hmac/4a37a505cbd22193f6b83161db3e44627b46456d/samples/python/modulr_hmac/__init__.py -------------------------------------------------------------------------------- /samples/python/modulr_hmac/api_auth.py: -------------------------------------------------------------------------------- 1 | import codecs 2 | import hashlib 3 | import hmac 4 | import secrets 5 | import urllib.parse 6 | from datetime import datetime 7 | from time import mktime 8 | from wsgiref.handlers import format_date_time 9 | 10 | 11 | class Signature: 12 | api_key = "" 13 | api_secret = "" 14 | 15 | def __init__(self, api_key, api_secret): 16 | self.api_key = api_key 17 | self.api_secret = api_secret 18 | 19 | 20 | def calculate(self, nonce = None, timestamp = None): 21 | 22 | if nonce is None: 23 | # Generates a secure random string for the nonce 24 | nonce = secrets.token_urlsafe(30) 25 | 26 | if timestamp is None: 27 | # Getting current time 28 | now = datetime.now() 29 | stamp = mktime(now.timetuple()) 30 | 31 | # Formats time into this format --> Mon, 25 Jul 2016 16:36:07 GMT 32 | formatted_time = format_date_time(stamp) 33 | else: 34 | formatted_time = timestamp 35 | 36 | # Combines date and nonce into a single string that will be signed 37 | signature_string = 'date' + ': ' + formatted_time + '\n' + 'x-mod-nonce' + ': ' + nonce 38 | 39 | # Encodes secret and message into a format that can be signed 40 | secret = bytes(self.api_secret, encoding='utf-8') 41 | message = bytes(signature_string, encoding='utf-8') 42 | 43 | # Signing process 44 | digester = hmac.new(secret, message, hashlib.sha1) 45 | 46 | # Converts to hex 47 | hex_code = digester.hexdigest() 48 | 49 | # Decodes the signed string in hex into base64 50 | b64 = codecs.encode(codecs.decode(hex_code, 'hex'), 'base64').decode().strip() 51 | 52 | # Encodes the string so it is safe for URL 53 | url_safe_code = urllib.parse.quote(b64, safe='') 54 | 55 | return Result(formatted_time, nonce, self.api_key, url_safe_code) 56 | 57 | 58 | class Result: 59 | timestamp = "" 60 | nonce = "" 61 | encoded_signature = "" 62 | authorisation = '' 63 | 64 | def __init__(self, timestamp, nonce, api_key, encoded_signature): 65 | self.timestamp = timestamp 66 | self.nonce = nonce 67 | self.encoded_signature = encoded_signature 68 | 69 | # Adds the key and signed response 70 | self.authorisation = f'Signature keyId="{api_key}",algorithm="hmac-sha1",headers="date x-mod-nonce",signature="{encoded_signature}"' 71 | 72 | 73 | def get_timestamp(self): 74 | return self.timestamp 75 | 76 | def get_nonce(self): 77 | return self.nonce 78 | 79 | def get_http_headers(self): 80 | return { 81 | 'Authorization': self.authorisation, # Authorisation header 82 | 'Date': self.timestamp, # Date header 83 | 'x-mod-nonce': self.nonce, # Adds nonce 84 | } 85 | 86 | def get_signature(self): 87 | return self.encoded_signature 88 | -------------------------------------------------------------------------------- /samples/python/tests/api_auth.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | from modulr_hmac.api_auth import Signature 3 | 4 | class TestSignature(unittest.TestCase): 5 | 6 | signature = Signature('KNOWN-TOKEN','NzAwZmIwMGQ0YTJiNDhkMzZjYzc3YjQ5OGQyYWMzOTI=') 7 | 8 | def test_hmac_generation(self): 9 | result = self.signature.calculate() 10 | headers = result.get_http_headers() 11 | 12 | self.assertIsNotNone(headers['Date']) 13 | self.assertIsNotNone(headers['x-mod-nonce']) 14 | self.assertIsNotNone(headers['Authorization']) 15 | 16 | 17 | def test_hmac_known_nonce_date(self): 18 | result = self.signature.calculate('28154b2-9c62b93cc22a-24c9e2-5536d7d','Mon, 25 Jul 2016 16:36:07 GMT') 19 | headers = result.get_http_headers() 20 | 21 | self.assertEqual(headers['Date'], 'Mon, 25 Jul 2016 16:36:07 GMT') 22 | self.assertEqual(headers['x-mod-nonce'], '28154b2-9c62b93cc22a-24c9e2-5536d7d') 23 | self.assertEqual(headers['Authorization'], 'Signature keyId="KNOWN-TOKEN",algorithm="hmac-sha1",headers="date x-mod-nonce",signature="WBMr%2FYdhysbmiIEkdTrf2hP7SfA%3D"') 24 | -------------------------------------------------------------------------------- /samples/ruby/Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gem 'minitest' 4 | gem 'rake' 5 | -------------------------------------------------------------------------------- /samples/ruby/Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | minitest (5.22.3) 5 | rake (13.2.1) 6 | 7 | PLATFORMS 8 | ruby 9 | x64-mingw32 10 | 11 | DEPENDENCIES 12 | minitest 13 | rake 14 | 15 | BUNDLED WITH 16 | 2.1.4 17 | -------------------------------------------------------------------------------- /samples/ruby/Rakefile: -------------------------------------------------------------------------------- 1 | task default: %w[test] 2 | 3 | task :run do 4 | ruby 'example.rb' 5 | end 6 | 7 | task :test do 8 | ruby 'test/api_auth_test.rb' 9 | end 10 | -------------------------------------------------------------------------------- /samples/ruby/example.rb: -------------------------------------------------------------------------------- 1 | require 'net/http' 2 | require_relative 'lib/api_auth' 3 | 4 | API_KEY = "" 5 | API_SECRET = "" 6 | 7 | uri = URI('https://api-sandbox.modulrfinance.com/api-sandbox/customers') 8 | 9 | # Set up signature helper 10 | signature = Signature.new(api_key: API_KEY, api_secret: API_SECRET) 11 | 12 | # calculate mhac signature with current date time and random nonce 13 | result = signature.calculate 14 | 15 | # call the api with required headers 16 | res = nil 17 | 18 | Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http| 19 | req = Net::HTTP::Get.new(uri) 20 | 21 | result.headers.each do |header| 22 | req.[]=(header[0], header[1]) 23 | end 24 | 25 | res = http.request(req) 26 | end 27 | 28 | if res.code != "200" 29 | puts "Unsuccessful API call, code: #{res.code}, body: #{res.body}" 30 | else 31 | puts res.body 32 | end 33 | -------------------------------------------------------------------------------- /samples/ruby/lib/api_auth.rb: -------------------------------------------------------------------------------- 1 | require 'base64' 2 | require 'date' 3 | require 'erb' 4 | require 'openssl' 5 | require 'securerandom' 6 | 7 | class Signature 8 | def initialize(api_key:, api_secret:) 9 | @api_key = api_key 10 | @api_secret = api_secret 11 | end 12 | 13 | def calculate(nonce: SecureRandom.base64(30), timestamp: DateTime.now.httpdate) 14 | # Combines date and nonce into a single string that will be signed 15 | signature_string = "date: #{timestamp}\nx-mod-nonce: #{nonce}" 16 | 17 | # Sign the message using the secret 18 | digest = OpenSSL::HMAC.digest('SHA1', @api_secret.force_encoding('UTF-8'), signature_string.force_encoding('UTF-8')) 19 | 20 | # Decodes the signed string into base64 21 | b64 = Base64.encode64(digest) 22 | 23 | # Encodes the string so it is safe for URL 24 | url_safe_code = ERB::Util.url_encode(b64.strip) 25 | 26 | Result.new(api_key: @api_key, nonce: nonce, signature: url_safe_code, timestamp: timestamp) 27 | end 28 | end 29 | 30 | class Result 31 | attr_reader :nonce, :signature, :timestamp 32 | 33 | def initialize(api_key:, nonce:, signature:, timestamp:) 34 | @nonce = nonce 35 | @signature = signature 36 | @timestamp = timestamp 37 | 38 | # Adds the key and signed response 39 | @authorisation = %(Signature keyId="#{api_key}",algorithm="hmac-sha1",headers="date x-mod-nonce",signature="#{signature}") 40 | end 41 | 42 | def headers 43 | { 44 | 'Authorization': @authorisation, # Authorisation header 45 | 'Date': @timestamp, # Date header 46 | 'x-mod-nonce': @nonce # Adds nonce 47 | } 48 | end 49 | end 50 | -------------------------------------------------------------------------------- /samples/ruby/test/api_auth_test.rb: -------------------------------------------------------------------------------- 1 | require 'minitest/autorun' 2 | require_relative '../lib/api_auth' 3 | 4 | class TestSignature < Minitest::Test 5 | def setup 6 | @signature = Signature.new(api_key: 'KNOWN-TOKEN', api_secret: 'NzAwZmIwMGQ0YTJiNDhkMzZjYzc3YjQ5OGQyYWMzOTI=') 7 | end 8 | 9 | def test_hmac_generation 10 | result = @signature.calculate 11 | headers = result.headers 12 | 13 | refute_nil headers[:'Date'] 14 | refute_nil headers[:'x-mod-nonce'] 15 | refute_nil headers[:'Authorization'] 16 | end 17 | 18 | def test_hmac_known_nonce_date 19 | result = @signature.calculate(nonce: '28154b2-9c62b93cc22a-24c9e2-5536d7d', timestamp: 'Mon, 25 Jul 2016 16:36:07 GMT') 20 | headers = result.headers 21 | 22 | assert_equal 'Mon, 25 Jul 2016 16:36:07 GMT', headers[:'Date'] 23 | assert_equal '28154b2-9c62b93cc22a-24c9e2-5536d7d', headers[:'x-mod-nonce'] 24 | assert_equal 'Signature keyId="KNOWN-TOKEN",algorithm="hmac-sha1",headers="date x-mod-nonce",signature="WBMr%2FYdhysbmiIEkdTrf2hP7SfA%3D"', headers[:'Authorization'] 25 | end 26 | end 27 | -------------------------------------------------------------------------------- /samples/scala/build.sbt: -------------------------------------------------------------------------------- 1 | scalaVersion := "2.13.13" 2 | 3 | name := "modulr-hmac-example" 4 | organization := "ch.epfl.scala" 5 | version := "1.0" 6 | 7 | libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" % "2.3.0" -------------------------------------------------------------------------------- /samples/scala/project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=1.9.9 2 | -------------------------------------------------------------------------------- /samples/scala/src/main/scala/Main.scala: -------------------------------------------------------------------------------- 1 | import java.util.Calendar 2 | 3 | object Main extends App { 4 | val signature: Signature = new Signature("key", "secret") 5 | 6 | //Option A: call with no input. Nonce will be a random UUID and Date will default to current 7 | val headersDefault: Map[String, String] = signature.buildHeaders() 8 | 9 | //Option B: Provide your own nonce, Date will be defaulted to current 10 | val headersCustomNonce: Map[String, String] = signature.buildHeaders("nonceValue") 11 | 12 | //Option C: Provide your own nonce and Date 13 | val headersCustomAll: Map[String, String] = signature.buildHeaders("nonceValue", Calendar.getInstance().getTime) 14 | 15 | headersDefault.foreach(println) 16 | headersCustomNonce.foreach(println) 17 | headersCustomAll.foreach(println) 18 | } -------------------------------------------------------------------------------- /samples/scala/src/main/scala/Signature.scala: -------------------------------------------------------------------------------- 1 | import java.net.URLEncoder 2 | import java.nio.charset.StandardCharsets 3 | import java.text.SimpleDateFormat 4 | import java.util.{Base64, Calendar, Date, Locale, TimeZone, UUID} 5 | 6 | import javax.crypto.Mac 7 | import javax.crypto.spec.SecretKeySpec 8 | 9 | class Signature(val apiKey: String, val apiSecret: String) { 10 | 11 | private val DatePattern: String = "EEE, dd MMM yyyy HH:mm:ss z" 12 | private val HmacSha1Algorithm: String = "HmacSHA1" 13 | private val AutorizationHeader: String = "Authorization" 14 | private val DateHeader: String = "Date" 15 | private val NonceHeader: String = "x-mod-nonce" 16 | 17 | def buildHeaders(nonce: String = UUID.randomUUID().toString, 18 | date: Date = Calendar.getInstance().getTime): Map[String, String] = { 19 | val timestamp = formatDate(date) 20 | val signatureString = s"date: $timestamp\nx-mod-nonce: $nonce" 21 | 22 | val hmacSignature = calculateHmac(signatureString) 23 | 24 | Map(AutorizationHeader -> formatAuthHeader(apiKey, hmacSignature), 25 | DateHeader -> timestamp, 26 | NonceHeader -> nonce) 27 | } 28 | 29 | private def formatAuthHeader(key: String, signature: String): String = { 30 | s"Signature keyId= ${'"'}$key${'"'}," + 31 | s"algorithm=${'"'}hmac-sha1${'"'}," + 32 | s"headers=${'"'}date x-mod-nonce${'"'}," + 33 | s"signature=${'"'}$signature${'"'}" 34 | } 35 | 36 | private def calculateHmac(message: String): String = { 37 | val signingKey = new SecretKeySpec(apiSecret.getBytes, HmacSha1Algorithm) 38 | 39 | val mac = Mac.getInstance(HmacSha1Algorithm) 40 | mac.init(signingKey) 41 | 42 | val rawHmac = mac.doFinal(message.getBytes()) 43 | val hmac = Base64.getEncoder.encodeToString(rawHmac) 44 | URLEncoder.encode(hmac, StandardCharsets.UTF_8.name()) 45 | } 46 | 47 | private def formatDate(date: Date): String = { 48 | val simpleDateFormat = new SimpleDateFormat(DatePattern, Locale.UK) 49 | simpleDateFormat.setTimeZone(TimeZone.getTimeZone("GMT")) 50 | simpleDateFormat.format(date) 51 | } 52 | } --------------------------------------------------------------------------------