├── .gitattributes ├── .github └── workflows │ └── gradle.yml ├── .gitignore ├── LICENCE.txt ├── README.md ├── _config.yml ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── ideaShared └── copyright │ ├── GPLv3.xml │ └── profiles_settings.xml ├── settings.gradle ├── sonatype.gradle └── src ├── main └── java │ └── io │ └── github │ └── novacrypto │ ├── ProxyCharSequence.java │ ├── SecureByteBuffer.java │ ├── SecureCharBuffer.java │ └── ToStringStrategy.java └── test └── java └── io └── github └── novacrypto ├── CharSequenceMethodTests.java ├── CharSequenceSubSequenceBoundsTests.java ├── CharSequenceSubSequenceTests.java ├── CharSequenceSubSequenceToStringTests.java ├── SecureByteBufferBoundsTests.java ├── SecureByteBufferTests.java ├── SecureByteBufferWhiteBoxTests.java ├── SecureCharBufferBoundsTests.java ├── SecureCharBufferTests.java ├── SecureCharBufferWhiteBoxTests.java ├── TestHelpers.java ├── ToStringStrategyTests.java ├── ToStringTests.java └── WhiteBox.java /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@v2 11 | - name: Set up JDK 11 12 | uses: actions/setup-java@v2 13 | with: 14 | java-version: '11' 15 | distribution: 'adopt' 16 | - name: Validate Gradle wrapper 17 | uses: gradle/wrapper-validation-action@e6e38bacfdf1a337459f332974bb2327a31aaf4b 18 | - name: Build and check with Gradle 19 | uses: gradle/gradle-build-action@4137be6a8bf7d7133955359dbd952c0ca73b1021 20 | with: 21 | arguments: check build 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | .gradle/ 3 | .idea/ 4 | out/ 5 | -------------------------------------------------------------------------------- /LICENCE.txt: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Download](https://api.bintray.com/packages/novacrypto/SecureString/SecureString/images/download.svg)](https://bintray.com/novacrypto/SecureString/SecureString/_latestVersion) [![Travis](https://travis-ci.org/NovaCrypto/SecureString.svg?branch=master)](https://travis-ci.org/NovaCrypto/SecureString) [![codecov](https://codecov.io/gh/NovaCrypto/SecureString/branch/master/graph/badge.svg)](https://codecov.io/gh/NovaCrypto/SecureString) 2 | 3 | Read the motivation here: [Protecting Strings in JVM memory](https://medium.com/@_west_on/protecting-strings-in-jvm-memory-84c365f8f01c) 4 | 5 | # Install 6 | 7 | Using: 8 | 9 | ``` 10 | repositories { 11 | mavenCentral() 12 | } 13 | ``` 14 | 15 | Add dependency: 16 | 17 | ``` 18 | dependencies { 19 | implementation 'io.github.novacrypto:SecureString:2022.01.17@jar' 20 | } 21 | ``` 22 | 23 | # Usage 24 | ## Create 25 | 26 | ``` 27 | new SecureCharBuffer() 28 | ``` 29 | 30 | For default capacity of 512 chars, or specify capacity with: 31 | 32 | ``` 33 | SecureCharBuffer.withCapacity(30) 34 | ``` 35 | 36 | ## Append 37 | 38 | ``` 39 | buffer.append('a') 40 | buffer.append("abc") 41 | buffer.append(charSequence) 42 | ``` 43 | 44 | ## Read 45 | 46 | Can be used wherever a `CharSequence` can, so you can access the buffer one char at a time like so: 47 | 48 | ``` 49 | final int length = buffer.length(); 50 | for (int i = 0; i < length; i++) { 51 | buffer.get(i) 52 | } 53 | ``` 54 | 55 | It supports `CharSequence#subSequence` by creating a proxy. This means that you do not need to worry about sub-sequences leaking string data. Sub-sequences of sub-sequences are also cleared. 56 | 57 | ``` 58 | buffer = new SecureBuffer(); 59 | buffer.append('a'); 60 | buffer.append('b'); 61 | buffer.append('c'); 62 | CharSequence subBuffer = buffer.subSequence(1, 2); 63 | CharSequence subSubBuffer = subBuffer.subSequence(0, 1); 64 | buffer.close(); // subBuffer and subSubBuffer are also cleared 65 | ``` 66 | 67 | It does however refuse to allow `toString` as that defeats the point, so you will get a `UnsupportedOperationException` if you try. If you have to for whatever reason, then you can get a proxy that allows it by: 68 | 69 | ``` 70 | CharSequence iCanToString = secureBuffer.toStringAble(); 71 | System.out.println(iCanToString.toString()); 72 | ``` 73 | 74 | This `toString` generates on the demand, and does not cache the string value. 75 | 76 | ## Clear 77 | 78 | ``` 79 | buffer.close() 80 | ``` 81 | 82 | ## Changelog 83 | 84 | 2019.01.27 contains a bug fix for characters outside standard ASCII range 0..127 which would not have been read correctly before. 85 | 2022.01.17 uses static `SecureRandom` on the advice of Spotbugs, and while it was a false positive intended for `Random` use warning, it's not a bad thing to do anyway. 86 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-cayman -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | * 18 | * Original source: https://github.com/NovaCrypto/SecureString 19 | * You can contact the authors via github issues. 20 | */ 21 | 22 | plugins { 23 | id 'com.github.spotbugs' version '5.0.4' 24 | 25 | // Generate a dependency version update report for release 26 | // ./gradlew dependencyUpdates -Drevision=release -DoutputFormatter=plain 27 | // https://github.com/ben-manes/gradle-versions-plugin 28 | id 'com.github.ben-manes.versions' version '0.41.0' 29 | } 30 | 31 | description = "Obfuscated/clearable in memory string management" 32 | 33 | apply plugin: 'java-library' 34 | apply from: 'sonatype.gradle' 35 | 36 | spotbugsMain { 37 | reports { 38 | html { 39 | required = true 40 | outputLocation = file("$buildDir/reports/spotbugs/main/spotbugs.html") 41 | stylesheet = 'fancy-hist.xsl' 42 | } 43 | } 44 | } 45 | 46 | repositories { 47 | mavenCentral() 48 | } 49 | 50 | compileJava { 51 | sourceCompatibility = '1.7' 52 | targetCompatibility = '1.7' 53 | } 54 | 55 | dependencies { 56 | testImplementation 'junit:junit:4.13.2' 57 | testImplementation 'org.assertj:assertj-core:3.22.0' 58 | } 59 | 60 | compileJava.options.encoding = 'UTF-8' 61 | compileTestJava.options.encoding = 'UTF-8' 62 | javadoc.options.encoding = 'UTF-8' 63 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # 2 | # SecureString library, Obfuscated/clearable in memory string management 3 | # 4 | # Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | # 19 | # Original source: https://github.com/NovaCrypto/SecureString 20 | # You can contact the authors via github issues. 21 | # 22 | 23 | org.gradle.jvmargs=-Dfile.encoding=UTF-8 24 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NovaCrypto/SecureString/b9536cd0f4777af28e7880ae61adea39bc909ebb/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2017-2022 Alan Evans, NovaCrypto 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | # 17 | # Original source: https://github.com/NovaCrypto/SecureString 18 | # You can contact the authors via github issues. 19 | # 20 | 21 | distributionBase=GRADLE_USER_HOME 22 | distributionPath=wrapper/dists 23 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip 24 | distributionSha256Sum=b586e04868a22fd817c8971330fec37e298f3242eb85c374181b12d637f80302 25 | zipStoreBase=GRADLE_USER_HOME 26 | zipStorePath=wrapper/dists 27 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or 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 | # http://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 UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | # Determine the Java command to use to start the JVM. 86 | if [ -n "$JAVA_HOME" ] ; then 87 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 88 | # IBM's JDK on AIX uses strange locations for the executables 89 | JAVACMD="$JAVA_HOME/jre/sh/java" 90 | else 91 | JAVACMD="$JAVA_HOME/bin/java" 92 | fi 93 | if [ ! -x "$JAVACMD" ] ; then 94 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 95 | 96 | Please set the JAVA_HOME variable in your environment to match the 97 | location of your Java installation." 98 | fi 99 | else 100 | JAVACMD="java" 101 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 102 | 103 | Please set the JAVA_HOME variable in your environment to match the 104 | location of your Java installation." 105 | fi 106 | 107 | # Increase the maximum file descriptors if we can. 108 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 109 | MAX_FD_LIMIT=`ulimit -H -n` 110 | if [ $? -eq 0 ] ; then 111 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 112 | MAX_FD="$MAX_FD_LIMIT" 113 | fi 114 | ulimit -n $MAX_FD 115 | if [ $? -ne 0 ] ; then 116 | warn "Could not set maximum file descriptor limit: $MAX_FD" 117 | fi 118 | else 119 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 120 | fi 121 | fi 122 | 123 | # For Darwin, add options to specify how the application appears in the dock 124 | if $darwin; then 125 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 126 | fi 127 | 128 | # For Cygwin, switch paths to Windows format before running java 129 | if $cygwin ; then 130 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 131 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 132 | JAVACMD=`cygpath --unix "$JAVACMD"` 133 | 134 | # We build the pattern for arguments to be converted via cygpath 135 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 136 | SEP="" 137 | for dir in $ROOTDIRSRAW ; do 138 | ROOTDIRS="$ROOTDIRS$SEP$dir" 139 | SEP="|" 140 | done 141 | OURCYGPATTERN="(^($ROOTDIRS))" 142 | # Add a user-defined pattern to the cygpath arguments 143 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 144 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 145 | fi 146 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 147 | i=0 148 | for arg in "$@" ; do 149 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 150 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 151 | 152 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 153 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 154 | else 155 | eval `echo args$i`="\"$arg\"" 156 | fi 157 | i=$((i+1)) 158 | done 159 | case $i in 160 | (0) set -- ;; 161 | (1) set -- "$args0" ;; 162 | (2) set -- "$args0" "$args1" ;; 163 | (3) set -- "$args0" "$args1" "$args2" ;; 164 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 165 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 166 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 167 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 168 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 169 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 170 | esac 171 | fi 172 | 173 | # Escape application args 174 | save () { 175 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 176 | echo " " 177 | } 178 | APP_ARGS=$(save "$@") 179 | 180 | # Collect all arguments for the java command, following the shell quoting and substitution rules 181 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 182 | 183 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 184 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 185 | cd "$(dirname "$0")" 186 | fi 187 | 188 | exec "$JAVACMD" "$@" 189 | -------------------------------------------------------------------------------- /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 http://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 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 33 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 34 | 35 | @rem Find java.exe 36 | if defined JAVA_HOME goto findJavaFromJavaHome 37 | 38 | set JAVA_EXE=java.exe 39 | %JAVA_EXE% -version >NUL 2>&1 40 | if "%ERRORLEVEL%" == "0" goto init 41 | 42 | echo. 43 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 44 | echo. 45 | echo Please set the JAVA_HOME variable in your environment to match the 46 | echo location of your Java installation. 47 | 48 | goto fail 49 | 50 | :findJavaFromJavaHome 51 | set JAVA_HOME=%JAVA_HOME:"=% 52 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 53 | 54 | if exist "%JAVA_EXE%" goto init 55 | 56 | echo. 57 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 58 | echo. 59 | echo Please set the JAVA_HOME variable in your environment to match the 60 | echo location of your Java installation. 61 | 62 | goto fail 63 | 64 | :init 65 | @rem Get command-line arguments, handling Windows variants 66 | 67 | if not "%OS%" == "Windows_NT" goto win9xME_args 68 | 69 | :win9xME_args 70 | @rem Slurp the command line arguments. 71 | set CMD_LINE_ARGS= 72 | set _SKIP=2 73 | 74 | :win9xME_args_slurp 75 | if "x%~1" == "x" goto execute 76 | 77 | set CMD_LINE_ARGS=%* 78 | 79 | :execute 80 | @rem Setup the command line 81 | 82 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 83 | 84 | @rem Execute Gradle 85 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 86 | 87 | :end 88 | @rem End local scope for the variables with windows NT shell 89 | if "%ERRORLEVEL%"=="0" goto mainEnd 90 | 91 | :fail 92 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 93 | rem the _cmd.exe /c_ return code! 94 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 95 | exit /b 1 96 | 97 | :mainEnd 98 | if "%OS%"=="Windows_NT" endlocal 99 | 100 | :omega 101 | -------------------------------------------------------------------------------- /ideaShared/copyright/GPLv3.xml: -------------------------------------------------------------------------------- 1 | 22 | 23 | 24 | 25 | 28 | -------------------------------------------------------------------------------- /ideaShared/copyright/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | * 18 | * Original source: https://github.com/NovaCrypto/SecureString 19 | * You can contact the authors via github issues. 20 | */ 21 | 22 | rootProject.name = 'SecureString' 23 | 24 | -------------------------------------------------------------------------------- /sonatype.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * ToRuntime library, Java promotions of checked exceptions to runtime exceptions 3 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | * 18 | * Original source: https://github.com/NovaCrypto/ToRuntime 19 | * You can contact the authors via github issues. 20 | */ 21 | 22 | apply plugin: 'maven-publish' 23 | apply plugin: 'signing' 24 | apply plugin: 'jacoco' 25 | 26 | java { 27 | withJavadocJar() 28 | withSourcesJar() 29 | } 30 | 31 | jacoco { 32 | toolVersion = '0.8.7' 33 | } 34 | 35 | jacocoTestReport { 36 | reports { 37 | xml.enabled = true 38 | html.enabled = false 39 | } 40 | } 41 | 42 | check.dependsOn jacocoTestReport 43 | 44 | dependencyUpdates { 45 | resolutionStrategy { 46 | componentSelection { rules -> 47 | rules.all { selection -> 48 | boolean rejected = ['alpha', 'beta', 'rc', 'cr', 'm', 'preview'].any { qualifier -> 49 | selection.candidate.version ==~ /(?i).*[.-]${qualifier}[.\d-]*/ 50 | } 51 | if (rejected) { 52 | selection.reject('Release candidate') 53 | } 54 | } 55 | } 56 | } 57 | outputFormatter = { result -> 58 | if (!result.outdated.dependencies.isEmpty()) { 59 | throw new RuntimeException('Abort, there are dependencies to update.') 60 | } 61 | } 62 | } 63 | 64 | task('installSharedIdea', type: Copy) { 65 | description = "Copy the shared intellij files into local .idea/" 66 | from 'ideaShared/' 67 | into '.idea/' 68 | } 69 | 70 | def hasMavenCentralCredentials = hasProperty('ossrhUsername') 71 | def hasSigningDetails = hasProperty('signing.keyId') 72 | 73 | publishing { 74 | publications { 75 | mavenJava(MavenPublication) { 76 | groupId = 'io.github.novacrypto' 77 | artifactId = project.name 78 | version = '2022.01.17' 79 | 80 | from components.java 81 | versionMapping { 82 | usage('java-api') { 83 | fromResolutionOf('runtimeClasspath') 84 | } 85 | usage('java-runtime') { 86 | fromResolutionResult() 87 | } 88 | } 89 | pom { 90 | name = project.name 91 | description = project.description 92 | url = "https://github.com/NovaCrypto/${project.name}" 93 | licenses { 94 | license { 95 | name = 'GNU General Public License v3' 96 | url = 'https://www.gnu.org/licenses/gpl-3.0.html' 97 | } 98 | } 99 | developers { 100 | developer { 101 | id = 'westonal' 102 | name = 'Alan Evans' 103 | email = 'thealanevans@gmail.com' 104 | } 105 | } 106 | scm { 107 | connection = "scm:git:git://github.com/NovaCrypto/${project.name}.git" 108 | developerConnection = "scm:git:ssh://github.com/NovaCrypto/${project.name}.git" 109 | url = "https://github.com/NovaCrypto/${project.name}" 110 | } 111 | } 112 | } 113 | } 114 | if (hasMavenCentralCredentials) { 115 | repositories { 116 | maven { 117 | def stagingRepoUrl = 'https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/' 118 | def snapshotsRepoUrl = 'https://s01.oss.sonatype.org/content/repositories/snapshots/' 119 | def staging = !version.endsWith('SNAPSHOT') 120 | url = staging ? stagingRepoUrl : snapshotsRepoUrl 121 | tasks.create('displayPublishLocation') { 122 | doLast { 123 | println("Publishing $version to${staging ? " staging" : ""} $url") 124 | if (staging) { 125 | println("You will need to promote to a release at https://s01.oss.sonatype.org/#stagingRepositories") 126 | } 127 | } 128 | } 129 | credentials { 130 | // defined in the global local gradle.properties 131 | username = ossrhUsername 132 | password = ossrhPassword 133 | } 134 | } 135 | } 136 | } 137 | } 138 | 139 | afterEvaluate { 140 | if (hasMavenCentralCredentials) { 141 | publish.dependsOn(displayPublishLocation) 142 | } 143 | } 144 | 145 | if (hasSigningDetails) { 146 | signing { 147 | sign publishing.publications.mavenJava 148 | } 149 | } 150 | 151 | check.dependsOn(dependencyUpdates) 152 | generatePomFileForMavenJavaPublication.dependsOn(check) 153 | -------------------------------------------------------------------------------- /src/main/java/io/github/novacrypto/ProxyCharSequence.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | final class ProxyCharSequence implements CharSequence { 26 | private final CharSequence parent; 27 | private final int start; 28 | private final int end; 29 | private final ToStringStrategy toStringStrategy; 30 | 31 | static CharSequence secureSubSequenceProxy( 32 | final CharSequence parent, 33 | final int start, 34 | final int end, 35 | final ToStringStrategy toStringStrategy) { 36 | final int length = parent.length(); 37 | if ((start > end) || (start < 0) || (end > length)) 38 | throw new StringIndexOutOfBoundsException(); 39 | return new ProxyCharSequence(parent, start, end, toStringStrategy); 40 | } 41 | 42 | private ProxyCharSequence( 43 | final CharSequence parent, 44 | final int start, 45 | final int end, 46 | final ToStringStrategy toStringStrategy) { 47 | this.parent = parent; 48 | this.start = start; 49 | this.end = end; 50 | this.toStringStrategy = toStringStrategy; 51 | } 52 | 53 | public int length() { 54 | return end - start; 55 | } 56 | 57 | public char charAt(int index) { 58 | if (index < 0 || index >= length()) 59 | throw new IndexOutOfBoundsException(); 60 | return parent.charAt(index + start); 61 | } 62 | 63 | public CharSequence subSequence(int start, int end) { 64 | if (start == 0 && end == length()) 65 | return this; 66 | return secureSubSequenceProxy(parent, 67 | this.start + start, 68 | this.start + end, 69 | toStringStrategy); 70 | } 71 | 72 | @Override 73 | public String toString() { 74 | return toStringStrategy.toString(this); 75 | } 76 | } -------------------------------------------------------------------------------- /src/main/java/io/github/novacrypto/SecureByteBuffer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import java.io.Closeable; 26 | import java.nio.ByteBuffer; 27 | import java.security.SecureRandom; 28 | import java.util.Arrays; 29 | 30 | /** 31 | * A store of char data that is encrypted with a one-time-pad. 32 | * Data is pinned outside of garbage collected heap. 33 | */ 34 | public final class SecureByteBuffer implements Closeable { 35 | 36 | /** 37 | * This is threadsafe, and most of the time has no contention issues. 38 | */ 39 | private static final SecureRandom SECURE_RANDOM = new SecureRandom(); 40 | 41 | /** 42 | * @param capacity maximum number of chars for buffer to store 43 | * @return a new {@link SecureByteBuffer} instance 44 | */ 45 | public static SecureByteBuffer withCapacity(int capacity) { 46 | return new SecureByteBuffer(capacity); 47 | } 48 | 49 | private final ByteBuffer data; 50 | private final ByteBuffer key; 51 | 52 | private SecureByteBuffer(int capacity) { 53 | data = allocatePinnedBuffer(capacity); 54 | key = allocatePinnedBuffer(capacity); 55 | populateBufferWithSecureKeyData(key); 56 | } 57 | 58 | /** 59 | * Direct buffers are outside of garbage collection. 60 | */ 61 | private static ByteBuffer allocatePinnedBuffer(int capacity) { 62 | return ByteBuffer.allocateDirect(capacity); 63 | } 64 | 65 | private static void populateBufferWithSecureKeyData(ByteBuffer key) { 66 | final byte[] bytes = new byte[key.capacity()]; 67 | SECURE_RANDOM.nextBytes(bytes); 68 | key.put(bytes); 69 | Arrays.fill(bytes, (byte) 0); 70 | } 71 | 72 | public SecureByteBuffer() { 73 | this(1024); 74 | } 75 | 76 | public void append(byte b) { 77 | data.put((byte) (b ^ key.get(data.position()))); 78 | } 79 | 80 | public int length() { 81 | return data.position(); 82 | } 83 | 84 | public byte get(int i) { 85 | if (i >= length()) 86 | throw new IndexOutOfBoundsException(); 87 | return (byte) (data.get(i) ^ key.get(i)); 88 | } 89 | 90 | public int capacity() { 91 | return data.capacity(); 92 | } 93 | 94 | public void close() { 95 | data.position(0); 96 | key.position(0); 97 | data.put(key); 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /src/main/java/io/github/novacrypto/SecureCharBuffer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import java.io.Closeable; 26 | 27 | /** 28 | * A store of char data that is encrypted with a one-time-pad. 29 | * Data is pinned outside of garbage collected heap. 30 | */ 31 | public final class SecureCharBuffer implements Closeable, CharSequence { 32 | 33 | /** 34 | * @param capacity maximum number of chars for buffer to store 35 | * @return a new {@link SecureCharBuffer} instance 36 | */ 37 | public static SecureCharBuffer withCapacity(int capacity) { 38 | return new SecureCharBuffer(capacity); 39 | } 40 | 41 | private final SecureByteBuffer buffer; 42 | 43 | private SecureCharBuffer(int capacity) { 44 | buffer = SecureByteBuffer.withCapacity(capacity * 2); 45 | } 46 | 47 | public SecureCharBuffer() { 48 | this(512); 49 | } 50 | 51 | public void append(char c) { 52 | final byte msb = (byte) (c >> 8); 53 | final byte lsb = (byte) (c & 0xff); 54 | buffer.append(msb); 55 | buffer.append(lsb); 56 | } 57 | 58 | public void append(final CharSequence data) { 59 | final int length = data.length(); 60 | for (int i = 0; i < length; i++) { 61 | append(data.charAt(i)); 62 | } 63 | } 64 | 65 | public int length() { 66 | return buffer.length() / 2; 67 | } 68 | 69 | public char charAt(int index) { 70 | final int position = index * 2; 71 | final byte msb = buffer.get(position); 72 | final byte lsb = buffer.get(position + 1); 73 | return (char) (msb << 8 | lsb & 0xff); 74 | } 75 | 76 | /** 77 | * Same as {@link #charAt}, provides indexer syntax in Kotlin 78 | * 79 | * @param index 0-based index of char to fetch 80 | * @return char at that index 81 | */ 82 | public char get(int index) { 83 | return charAt(index); 84 | } 85 | 86 | public CharSequence subSequence(final int start, final int end) { 87 | if (start == 0 && end == length()) 88 | return this; 89 | return ProxyCharSequence 90 | .secureSubSequenceProxy(this, 91 | start, 92 | end, 93 | ToStringStrategy.RESTRICT); 94 | } 95 | 96 | public CharSequence toStringAble() { 97 | return ProxyCharSequence 98 | .secureSubSequenceProxy(this, 0, length(), 99 | ToStringStrategy.ALLOW); 100 | } 101 | 102 | public int capacity() { 103 | return buffer.capacity() / 2; 104 | } 105 | 106 | public void close() { 107 | buffer.close(); 108 | } 109 | 110 | @Override 111 | public String toString() { 112 | throw new UnsupportedOperationException(); 113 | } 114 | } -------------------------------------------------------------------------------- /src/main/java/io/github/novacrypto/ToStringStrategy.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | enum ToStringStrategy { 26 | 27 | RESTRICT { 28 | @Override 29 | public String toString(final CharSequence charSequence) { 30 | throw new UnsupportedOperationException(); 31 | } 32 | }, 33 | 34 | ALLOW { 35 | @Override 36 | public String toString(final CharSequence charSequence) { 37 | final int length = charSequence.length(); 38 | final char[] chars = new char[length]; 39 | for (int i = 0; i < length; i++) { 40 | chars[i] = charSequence.charAt(i); 41 | } 42 | return new String(chars); 43 | } 44 | }; 45 | 46 | abstract String toString(final CharSequence charSequence); 47 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/CharSequenceMethodTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.givenSecureCharBuffer; 28 | import static org.junit.Assert.assertEquals; 29 | 30 | public final class CharSequenceMethodTests { 31 | 32 | @Test 33 | public void length() { 34 | CharSequence charSequence = givenSecureCharBuffer("abcd"); 35 | assertEquals(4, charSequence.length()); 36 | } 37 | 38 | @Test 39 | public void charAt() { 40 | CharSequence charSequence = givenSecureCharBuffer("abcd"); 41 | assertEquals('a', charSequence.charAt(0)); 42 | assertEquals('b', charSequence.charAt(1)); 43 | assertEquals('c', charSequence.charAt(2)); 44 | assertEquals('d', charSequence.charAt(3)); 45 | } 46 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/CharSequenceSubSequenceBoundsTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.givenSecureCharBuffer; 28 | 29 | public final class CharSequenceSubSequenceBoundsTests { 30 | 31 | @Test(expected = IndexOutOfBoundsException.class) 32 | public void charAtNegative1() { 33 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 34 | CharSequence subSequence = buffer.subSequence(1, 4); 35 | subSequence.charAt(-1); 36 | } 37 | 38 | @Test(expected = IndexOutOfBoundsException.class) 39 | public void charAtNegative2() { 40 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 41 | CharSequence subSequence = buffer.subSequence(3, 8); 42 | subSequence.charAt(-2); 43 | } 44 | 45 | @Test(expected = IndexOutOfBoundsException.class) 46 | public void charAtLength() { 47 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 48 | CharSequence subSequence = buffer.subSequence(1, 4); 49 | subSequence.charAt(subSequence.length()); 50 | } 51 | 52 | @Test(expected = IndexOutOfBoundsException.class) 53 | public void charAtAboveLength() { 54 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 55 | CharSequence subSequence = buffer.subSequence(1, 4); 56 | subSequence.charAt(subSequence.length() + 1); 57 | } 58 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/CharSequenceSubSequenceTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.asString; 28 | import static io.github.novacrypto.TestHelpers.givenSecureCharBuffer; 29 | import static org.junit.Assert.assertEquals; 30 | import static org.junit.Assert.assertSame; 31 | 32 | public final class CharSequenceSubSequenceTests { 33 | 34 | @Test 35 | public void wholeSequence() { 36 | SecureCharBuffer buffer = givenSecureCharBuffer("Hello World!"); 37 | CharSequence subSequence = buffer.subSequence(0, 12); 38 | assertSame(buffer, subSequence); 39 | } 40 | 41 | @Test 42 | public void wholeSequenceEmpty() { 43 | SecureCharBuffer buffer = new SecureCharBuffer(); 44 | CharSequence subSequence = buffer.subSequence(0, 0); 45 | assertSame(buffer, subSequence); 46 | } 47 | 48 | @Test 49 | public void wholeSubSequence() { 50 | SecureCharBuffer buffer = givenSecureCharBuffer("Hello World!"); 51 | CharSequence subSequence = buffer.subSequence(3, 5); 52 | assertSame(subSequence, subSequence.subSequence(0, 2)); 53 | } 54 | 55 | @Test 56 | public void subSequence1() { 57 | SecureCharBuffer buffer = givenSecureCharBuffer("Hello World!"); 58 | CharSequence subSequence = buffer.subSequence(6, 11); 59 | assertEquals("Hello World!".subSequence(6, 11), asString(subSequence)); 60 | } 61 | 62 | @Test 63 | public void subSequence2() { 64 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 65 | CharSequence subSequence = buffer.subSequence(0, 4); 66 | assertEquals("NovaCrypto".subSequence(0, 4), asString(subSequence)); 67 | } 68 | 69 | @Test 70 | public void subSequenceClearsWithParent() { 71 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 72 | CharSequence subSequence = buffer.subSequence(0, 4); 73 | buffer.close(); 74 | assertEquals("\0\0\0\0", asString(subSequence)); 75 | } 76 | 77 | @Test 78 | public void subSequenceOfSubSequence1() { 79 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 80 | CharSequence subSequence = buffer 81 | .subSequence(1, 10) 82 | .subSequence(3, 9); 83 | assertEquals("NovaCrypto" 84 | .subSequence(1, 10) 85 | .subSequence(3, 9), 86 | asString(subSequence)); 87 | } 88 | 89 | @Test 90 | public void subSequenceOfSubSequence2() { 91 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 92 | CharSequence subSequence = buffer 93 | .subSequence(2, 9) 94 | .subSequence(2, 7); 95 | assertEquals("NovaCrypto" 96 | .subSequence(2, 9) 97 | .subSequence(2, 7), 98 | asString(subSequence)); 99 | } 100 | 101 | @Test(expected = StringIndexOutOfBoundsException.class) 102 | public void subSequenceEndOutOfBounds() { 103 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 104 | buffer.subSequence(0, 11); 105 | } 106 | 107 | @Test(expected = StringIndexOutOfBoundsException.class) 108 | public void subSequenceStartOutOfBounds() { 109 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 110 | buffer.subSequence(11, 10); 111 | } 112 | 113 | @Test(expected = StringIndexOutOfBoundsException.class) 114 | public void startAheadOfEnd() { 115 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 116 | buffer.subSequence(5, 4); 117 | } 118 | 119 | @Test(expected = StringIndexOutOfBoundsException.class) 120 | public void negativeStart() { 121 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 122 | buffer.subSequence(-1, 4); 123 | } 124 | 125 | @Test 126 | public void zeroChars() { 127 | SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 128 | assertEquals("NovaCrypto".subSequence(5, 5), 129 | asString(buffer.subSequence(5, 5))); 130 | } 131 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/CharSequenceSubSequenceToStringTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.asString; 28 | import static io.github.novacrypto.TestHelpers.givenSecureCharBuffer; 29 | import static org.junit.Assert.assertEquals; 30 | import static org.assertj.core.api.Java6Assertions.assertThatThrownBy; 31 | 32 | public final class CharSequenceSubSequenceToStringTests { 33 | 34 | @Test 35 | public void cantToStringOnSubSequence() { 36 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 37 | final CharSequence subSequence = buffer.subSequence(1, 2); 38 | //noinspection ResultOfMethodCallIgnored 39 | assertThatThrownBy(subSequence::toString).isInstanceOf(UnsupportedOperationException.class); 40 | } 41 | 42 | @Test 43 | public void cantToStringOnSubSequenceOfSubSequence() { 44 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 45 | final CharSequence subSequence = buffer.subSequence(1, 5).subSequence(0, 2); 46 | //noinspection ResultOfMethodCallIgnored 47 | assertThatThrownBy(subSequence::toString).isInstanceOf(UnsupportedOperationException.class); 48 | } 49 | 50 | @Test 51 | public void canToStringOnSubSequence() { 52 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 53 | assertEquals("ovaC", 54 | buffer.toStringAble() 55 | .subSequence(1, 5) 56 | .toString()); 57 | } 58 | 59 | @Test 60 | public void canToStringOnSubSequenceOfSubSequence() { 61 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 62 | assertEquals("C", 63 | buffer.toStringAble() 64 | .subSequence(1, 5) 65 | .subSequence(3, 4) 66 | .toString()); 67 | } 68 | 69 | @Test 70 | public void afterClose() { 71 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 72 | final CharSequence subSequence = buffer.subSequence(0, 4); 73 | buffer.close(); 74 | assertEquals("\0\0\0\0", asString(subSequence)); 75 | } 76 | 77 | @Test 78 | public void afterCloseToStringAble() { 79 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 80 | final CharSequence subSequence = buffer.toStringAble().subSequence(0, 4); 81 | buffer.close(); 82 | assertEquals("\0\0\0\0", subSequence.toString()); 83 | } 84 | 85 | @Test 86 | public void afterCloseSubSequenceOfSubSequence() { 87 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 88 | final CharSequence subSequence = buffer.subSequence(0, 4).subSequence(0, 2); 89 | buffer.close(); 90 | assertEquals("\0\0", asString(subSequence)); 91 | } 92 | 93 | @Test 94 | public void afterCloseToStringAbleSubSequenceOfSubSequence() { 95 | final SecureCharBuffer buffer = givenSecureCharBuffer("NovaCrypto"); 96 | final CharSequence subSequence = buffer.toStringAble().subSequence(0, 4).subSequence(0, 2); 97 | buffer.close(); 98 | assertEquals("\0\0", subSequence.toString()); 99 | } 100 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/SecureByteBufferBoundsTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.appendASCIIString; 28 | 29 | public final class SecureByteBufferBoundsTests { 30 | 31 | @Test(expected = IndexOutOfBoundsException.class) 32 | public void getNegative1() { 33 | SecureByteBuffer buffer = new SecureByteBuffer(); 34 | appendASCIIString(buffer, "abc"); 35 | buffer.get(-1); 36 | } 37 | 38 | @Test(expected = IndexOutOfBoundsException.class) 39 | public void getNegative2() { 40 | SecureByteBuffer buffer = new SecureByteBuffer(); 41 | appendASCIIString(buffer, "abc"); 42 | buffer.get(-2); 43 | } 44 | 45 | @Test(expected = IndexOutOfBoundsException.class) 46 | public void getAtLength() { 47 | SecureByteBuffer buffer = new SecureByteBuffer(); 48 | appendASCIIString(buffer, "abc"); 49 | buffer.get(buffer.length()); 50 | } 51 | 52 | @Test(expected = IndexOutOfBoundsException.class) 53 | public void getAboveLength() { 54 | SecureByteBuffer buffer = new SecureByteBuffer(); 55 | appendASCIIString(buffer, "abc"); 56 | buffer.get(buffer.length() + 1); 57 | } 58 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/SecureByteBufferTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.*; 28 | import static org.junit.Assert.assertEquals; 29 | 30 | public final class SecureByteBufferTests { 31 | 32 | @Test 33 | public void initialLengthIsZero() { 34 | SecureByteBuffer buffer = new SecureByteBuffer(); 35 | assertEquals(0, buffer.length()); 36 | } 37 | 38 | @Test 39 | public void defaultCapacity() { 40 | SecureByteBuffer buffer = new SecureByteBuffer(); 41 | assertEquals(1024, buffer.capacity()); 42 | } 43 | 44 | @Test 45 | public void canSpecifyCapacity() { 46 | SecureByteBuffer buffer = SecureByteBuffer.withCapacity(10); 47 | assertEquals(10, buffer.capacity()); 48 | } 49 | 50 | @Test 51 | public void capacityIsNumberOfBytes() { 52 | SecureByteBuffer buffer = SecureByteBuffer.withCapacity(1); 53 | buffer.append((byte) 1); 54 | } 55 | 56 | @Test 57 | public void appendIncreasesLength() { 58 | SecureByteBuffer buffer = new SecureByteBuffer(); 59 | buffer.append((byte) 1); 60 | assertEquals(1, buffer.length()); 61 | } 62 | 63 | @Test 64 | public void twoAppendsIncreaseLength() { 65 | SecureByteBuffer buffer = new SecureByteBuffer(); 66 | buffer.append((byte) 1); 67 | buffer.append((byte) 2); 68 | assertEquals(2, buffer.length()); 69 | } 70 | 71 | @Test 72 | public void afterAppendCanReadBufferContents() { 73 | SecureByteBuffer buffer = new SecureByteBuffer(); 74 | buffer.append((byte) 10); 75 | assertEquals(1, buffer.length()); 76 | assertEquals(10, buffer.get(0)); 77 | } 78 | 79 | @Test 80 | public void afterAppendCanReadBufferContentsZ() { 81 | SecureByteBuffer buffer = new SecureByteBuffer(); 82 | buffer.append((byte) 26); 83 | assertEquals(1, buffer.length()); 84 | assertEquals(26, buffer.get(0)); 85 | } 86 | 87 | @Test 88 | public void canReadManyChars() { 89 | SecureByteBuffer buffer = new SecureByteBuffer(); 90 | appendASCIIString(buffer, "abc"); 91 | assertEquals("abc", asASCIIString(readWholeBufferAsByteArray(buffer))); 92 | } 93 | 94 | @Test 95 | public void dataIsZeroedOutAfterClose() { 96 | SecureByteBuffer buffer = new SecureByteBuffer(); 97 | appendASCIIString(buffer, "abc"); 98 | buffer.close(); 99 | byte[] read = readWholeBufferAsByteArray(buffer); 100 | assertEquals(1024, buffer.length()); 101 | assertEquals(1024, read.length); 102 | for (byte b : read) { 103 | assertEquals(0, b); 104 | } 105 | } 106 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/SecureByteBufferWhiteBoxTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import java.nio.ByteBuffer; 28 | 29 | import static io.github.novacrypto.TestHelpers.*; 30 | import static io.github.novacrypto.WhiteBox.getFromPrivateField; 31 | import static org.junit.Assert.*; 32 | 33 | public final class SecureByteBufferWhiteBoxTests { 34 | 35 | @Test 36 | public void whiteBoxTest_keyBufferIsDirect() { 37 | SecureByteBuffer buffer = new SecureByteBuffer(); 38 | assertTrue(getKeyBuffer(buffer).isDirect()); 39 | } 40 | 41 | @Test 42 | public void whiteBoxTest_dataBufferIsNotDirect() { 43 | SecureByteBuffer buffer = new SecureByteBuffer(); 44 | assertTrue(getDataBuffer(buffer).isDirect()); 45 | } 46 | 47 | @Test 48 | public void whiteBoxTest_dataInBufferIsObscured() { 49 | SecureByteBuffer buffer = new SecureByteBuffer(); 50 | appendASCIIString(buffer, "plain text"); 51 | assertNotEquals("plain text", asString(getDataBuffer(buffer))); 52 | } 53 | 54 | @Test 55 | public void whiteBoxTest_dataInBufferIsEncryptedWithKey() { 56 | SecureByteBuffer buffer = new SecureByteBuffer(); 57 | appendASCIIString(buffer, "plain text"); 58 | assertEquals("plain text", 59 | asASCIIString( 60 | xorDecrypt( 61 | asByteArray(getDataBuffer(buffer)), 62 | asByteArray(getKeyBuffer(buffer) 63 | )))); 64 | } 65 | 66 | private static ByteBuffer getDataBuffer(SecureByteBuffer buffer) { 67 | return (ByteBuffer) getFromPrivateField(buffer, "data"); 68 | } 69 | 70 | private static ByteBuffer getKeyBuffer(SecureByteBuffer buffer) { 71 | return (ByteBuffer) getFromPrivateField(buffer, "key"); 72 | } 73 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/SecureCharBufferBoundsTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.givenSecureCharBuffer; 28 | 29 | public final class SecureCharBufferBoundsTests { 30 | 31 | @Test(expected = IndexOutOfBoundsException.class) 32 | public void getNegative1() { 33 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 34 | buffer.get(-1); 35 | } 36 | 37 | @Test(expected = IndexOutOfBoundsException.class) 38 | public void getNegative2() { 39 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 40 | buffer.get(-2); 41 | } 42 | 43 | @Test(expected = IndexOutOfBoundsException.class) 44 | public void getAtLength() { 45 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 46 | buffer.get(buffer.length()); 47 | } 48 | 49 | @Test(expected = IndexOutOfBoundsException.class) 50 | public void getAboveLength() { 51 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 52 | buffer.get(buffer.length() + 1); 53 | } 54 | 55 | @Test(expected = IndexOutOfBoundsException.class) 56 | public void charAtNegative1() { 57 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 58 | buffer.charAt(-1); 59 | } 60 | 61 | @Test(expected = IndexOutOfBoundsException.class) 62 | public void charAtNegative2() { 63 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 64 | buffer.charAt(-2); 65 | } 66 | 67 | @Test(expected = IndexOutOfBoundsException.class) 68 | public void charAtLength() { 69 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 70 | buffer.charAt(buffer.length()); 71 | } 72 | 73 | @Test(expected = IndexOutOfBoundsException.class) 74 | public void charAtAboveLength() { 75 | SecureCharBuffer buffer = givenSecureCharBuffer("abc"); 76 | buffer.charAt(buffer.length() + 1); 77 | } 78 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/SecureCharBufferTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static io.github.novacrypto.TestHelpers.readWholeBufferAsString; 28 | import static org.junit.Assert.assertEquals; 29 | 30 | public final class SecureCharBufferTests { 31 | 32 | @Test 33 | public void initialLengthIsZero() { 34 | SecureCharBuffer buffer = new SecureCharBuffer(); 35 | assertEquals(0, buffer.length()); 36 | } 37 | 38 | @Test 39 | public void defaultCapacity() { 40 | SecureCharBuffer buffer = new SecureCharBuffer(); 41 | assertEquals(512, buffer.capacity()); 42 | } 43 | 44 | @Test 45 | public void canSpecifyCapacity() { 46 | SecureCharBuffer buffer = SecureCharBuffer.withCapacity(10); 47 | assertEquals(10, buffer.capacity()); 48 | } 49 | 50 | @Test 51 | public void capacityIsNumberOfChars() { 52 | SecureCharBuffer buffer = SecureCharBuffer.withCapacity(1); 53 | buffer.append('a'); 54 | } 55 | 56 | @Test 57 | public void appendIncreasesLength() { 58 | SecureCharBuffer buffer = new SecureCharBuffer(); 59 | buffer.append('a'); 60 | assertEquals(1, buffer.length()); 61 | } 62 | 63 | @Test 64 | public void twoAppendsIncreaseLength() { 65 | SecureCharBuffer buffer = new SecureCharBuffer(); 66 | buffer.append('a'); 67 | buffer.append('b'); 68 | assertEquals(2, buffer.length()); 69 | } 70 | 71 | @Test 72 | public void afterAppendCanReadBufferContents() { 73 | SecureCharBuffer buffer = new SecureCharBuffer(); 74 | buffer.append('a'); 75 | assertEquals(1, buffer.length()); 76 | final int i = 0; 77 | assertEquals('a', readCharAt(buffer, i)); 78 | } 79 | 80 | @Test 81 | public void afterAppendCanReadBufferContentsZ() { 82 | SecureCharBuffer buffer = new SecureCharBuffer(); 83 | buffer.append('z'); 84 | assertEquals(1, buffer.length()); 85 | assertEquals('z', readCharAt(buffer, 0)); 86 | } 87 | 88 | @Test 89 | public void canAppendCharSequences() { 90 | SecureCharBuffer buffer = new SecureCharBuffer(); 91 | buffer.append("abc"); 92 | final CharSequence def = "def"; 93 | buffer.append(def); 94 | assertEquals("abcdef", readWholeBufferAsString(buffer)); 95 | } 96 | 97 | @Test 98 | public void canReadManyChars() { 99 | SecureCharBuffer buffer = new SecureCharBuffer(); 100 | buffer.append("abc"); 101 | assertEquals("abc", readWholeBufferAsString(buffer)); 102 | } 103 | 104 | @Test 105 | public void dataIsZeroedOutAfterClose() { 106 | SecureCharBuffer buffer = new SecureCharBuffer(); 107 | buffer.append("abc"); 108 | buffer.close(); 109 | final String read = readWholeBufferAsString(buffer); 110 | assertEquals(512, buffer.length()); 111 | assertEquals(512, read.length()); 112 | for (int i = 0; i < read.length(); i++) { 113 | assertEquals('\0', read.charAt(i)); 114 | } 115 | } 116 | 117 | @Test 118 | public void readAndWriteAllBasicASCII() { 119 | SecureCharBuffer buffer = new SecureCharBuffer(); 120 | for (int i = 0; i < 128; i++) { 121 | buffer.append((char) i); 122 | } 123 | assertEquals(128, buffer.length()); 124 | for (int i = 0; i < 128; i++) { 125 | assertEquals((char) i, readCharAt(buffer, i)); 126 | } 127 | } 128 | 129 | @Test 130 | public void readAndWriteAllExtendedAscii() { 131 | SecureCharBuffer buffer = new SecureCharBuffer(); 132 | for (int i = 128; i < 256; i++) { 133 | buffer.append((char) i); 134 | } 135 | assertEquals(128, buffer.length()); 136 | for (int i = 128; i < 256; i++) { 137 | assertEquals((char) i, readCharAt(buffer, i - 128)); 138 | } 139 | } 140 | 141 | @Test 142 | public void readAndWriteAllLargeChars() { 143 | SecureCharBuffer buffer = SecureCharBuffer.withCapacity(255 * 256); 144 | for (int i = 256; i < 256 * 256; i++) { 145 | buffer.append((char) i); 146 | } 147 | assertEquals(255 * 256, buffer.length()); 148 | for (int i = 256; i < 257; i++) { 149 | assertEquals((char) i, readCharAt(buffer, i - 256)); 150 | } 151 | } 152 | 153 | private static char readCharAt(SecureCharBuffer buffer, int index) { 154 | final char c1 = buffer.get(index); 155 | final char c2 = buffer.charAt(index); 156 | assertEquals(c1, c2); 157 | return c1; 158 | } 159 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/SecureCharBufferWhiteBoxTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import java.nio.ByteBuffer; 28 | 29 | import static io.github.novacrypto.TestHelpers.*; 30 | import static io.github.novacrypto.WhiteBox.getFromPrivateField; 31 | import static org.junit.Assert.assertEquals; 32 | import static org.junit.Assert.assertNotEquals; 33 | 34 | public final class SecureCharBufferWhiteBoxTests { 35 | 36 | @Test 37 | public void whiteBoxTest_dataInBufferIsObscured() { 38 | SecureCharBuffer buffer = givenSecureCharBuffer("plain text"); 39 | assertNotEquals("plain text", asString(getDataBuffer(buffer))); 40 | } 41 | 42 | @Test 43 | public void whiteBoxTest_dataInBufferIsEncryptedWithKey() { 44 | SecureCharBuffer buffer = givenSecureCharBuffer("plain text"); 45 | assertEquals("plain text", 46 | TestHelpers.asString( 47 | xorDecrypt(asByteArray(getDataBuffer(buffer)), 48 | asByteArray(getKeyBuffer(buffer))))); 49 | } 50 | 51 | private static ByteBuffer getDataBuffer(SecureCharBuffer buffer) { 52 | return (ByteBuffer) getFromPrivateField(buffer, "buffer.data"); 53 | } 54 | 55 | private static ByteBuffer getKeyBuffer(SecureCharBuffer buffer) { 56 | return (ByteBuffer) getFromPrivateField(buffer, "buffer.key"); 57 | } 58 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/TestHelpers.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import java.nio.ByteBuffer; 26 | 27 | import static org.junit.Assert.assertEquals; 28 | import static org.junit.Assert.assertTrue; 29 | 30 | final class TestHelpers { 31 | 32 | private TestHelpers() { 33 | } 34 | 35 | static SecureCharBuffer givenSecureCharBuffer(String data) { 36 | SecureCharBuffer buffer = new SecureCharBuffer(); 37 | buffer.append(data); 38 | return buffer; 39 | } 40 | 41 | /** 42 | * This is just a helper function in tests because using managed array defeats the security benefits of {@link SecureByteBuffer}. 43 | */ 44 | static byte[] asByteArray(ByteBuffer buffer) { 45 | byte[] bytes = new byte[buffer.position()]; 46 | for (int i = 0; i < bytes.length; i++) { 47 | bytes[i] = buffer.get(i); 48 | } 49 | return bytes; 50 | } 51 | 52 | /** 53 | * This is just a helper function in tests because using String defeats the security benefits of {@link SecureByteBuffer}. 54 | */ 55 | static String asString(ByteBuffer buffer) { 56 | return asString(asByteArray(buffer)); 57 | } 58 | 59 | /** 60 | * Reads bytes in pairs, so contains full width {@link char} data. 61 | */ 62 | static String asString(byte[] bytes) { 63 | assertEquals("Expect to be even", 0, bytes.length % 2); 64 | char[] chars = new char[bytes.length / 2]; 65 | for (int i = 0; i < chars.length; i++) { 66 | chars[i] = (char) (bytes[i * 2] << 8 | bytes[i * 2 + 1] & 0xff); 67 | } 68 | return new String(chars); 69 | } 70 | 71 | static String asString(CharSequence subSequence) { 72 | StringBuilder sb = new StringBuilder(); 73 | for (int i = 0; i < subSequence.length(); i++) { 74 | sb.append(subSequence.charAt(i)); 75 | } 76 | return sb.toString(); 77 | } 78 | 79 | static byte[] xorDecrypt(byte[] data, byte[] key) { 80 | assertTrue(data.length <= key.length); 81 | byte[] bytes = new byte[data.length]; 82 | for (int i = 0; i < bytes.length; i++) { 83 | bytes[i] = (byte) (data[i] ^ key[i]); 84 | } 85 | return bytes; 86 | } 87 | 88 | /** 89 | * Write the least significant byte of each {@link char} to the buffer. 90 | * If the string is just ASCII, this will not lose any data. 91 | */ 92 | static void appendASCIIString(SecureByteBuffer buffer, CharSequence data) { 93 | int length = data.length(); 94 | for (int i = 0; i < length; i++) { 95 | buffer.append((byte) (data.charAt(i))); 96 | } 97 | } 98 | 99 | /** 100 | * Read bytes as least significant chars of a {@link char}. 101 | */ 102 | static String asASCIIString(byte[] bytes) { 103 | char[] chars = new char[bytes.length]; 104 | for (int i = 0; i < chars.length; i++) { 105 | chars[i] = (char) (bytes[i]); 106 | } 107 | return new String(chars); 108 | } 109 | 110 | static byte[] readWholeBufferAsByteArray(SecureByteBuffer buffer) { 111 | byte[] bytes = new byte[buffer.length()]; 112 | for (int i = 0; i < bytes.length; i++) { 113 | bytes[i] = buffer.get(i); 114 | } 115 | return bytes; 116 | } 117 | 118 | /** 119 | * This is just a helper function in tests because using String defeats the security benefits of {@link SecureCharBuffer}. 120 | */ 121 | static String readWholeBufferAsString(SecureCharBuffer buffer) { 122 | char[] chars = new char[buffer.length()]; 123 | for (int i = 0; i < chars.length; i++) { 124 | chars[i] = buffer.get(i); 125 | } 126 | return new String(chars); 127 | } 128 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/ToStringStrategyTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static org.junit.Assert.assertEquals; 28 | 29 | public final class ToStringStrategyTests { 30 | 31 | @Test 32 | public void values() { 33 | ToStringStrategy[] values = ToStringStrategy.values(); 34 | assertEquals(2, values.length); 35 | assertEquals(ToStringStrategy.RESTRICT, values[0]); 36 | assertEquals(ToStringStrategy.ALLOW, values[1]); 37 | } 38 | 39 | @Test 40 | public void valueOfRestrict() { 41 | ToStringStrategy values = ToStringStrategy.valueOf("RESTRICT"); 42 | assertEquals(ToStringStrategy.RESTRICT, values); 43 | } 44 | 45 | @Test 46 | public void valueOfAllow() { 47 | ToStringStrategy values = ToStringStrategy.valueOf("ALLOW"); 48 | assertEquals(ToStringStrategy.ALLOW, values); 49 | } 50 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/ToStringTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import org.junit.Test; 26 | 27 | import static org.assertj.core.api.Java6Assertions.assertThatThrownBy; 28 | import static org.junit.Assert.assertEquals; 29 | import static org.junit.Assert.assertNotSame; 30 | 31 | public final class ToStringTests { 32 | 33 | @Test 34 | public void cantToString() { 35 | final SecureCharBuffer buffer = new SecureCharBuffer(); 36 | buffer.append("NovaCrypto"); 37 | //noinspection ResultOfMethodCallIgnored 38 | assertThatThrownBy(buffer::toString).isInstanceOf(UnsupportedOperationException.class); 39 | } 40 | 41 | @Test 42 | public void canToStringIfMadeToStringAble() { 43 | final SecureCharBuffer buffer = new SecureCharBuffer(); 44 | buffer.append("NovaCrypto"); 45 | CharSequence sequence = buffer.toStringAble(); 46 | assertEquals("NovaCrypto", sequence.toString()); 47 | } 48 | 49 | @Test 50 | public void canToStringIfAppendedTwiceAndMadeToStringAble() { 51 | final SecureCharBuffer buffer = new SecureCharBuffer(); 52 | buffer.append("NovaCrypto"); 53 | buffer.append("!"); 54 | CharSequence sequence = buffer.toStringAble(); 55 | assertEquals("NovaCrypto!", sequence.toString()); 56 | } 57 | 58 | @Test 59 | public void toStringingTwiceDoesNotReturnsTheSameEnsuringNotCached() { 60 | final SecureCharBuffer buffer = new SecureCharBuffer(); 61 | buffer.append("NovaCrypto"); 62 | CharSequence sequence = buffer.toStringAble(); 63 | assertNotSame(sequence.toString(), sequence.toString()); 64 | } 65 | 66 | @Test 67 | public void toStringingAfterCloseDoesNotReturnsTheStringEnsuringCalculatedOnDemand() { 68 | final SecureCharBuffer buffer = new SecureCharBuffer(); 69 | buffer.append("NovaCrypto"); 70 | CharSequence sequence = buffer.toStringAble(); 71 | final String first = sequence.toString(); 72 | buffer.close(); 73 | assertEquals("NovaCrypto", first); 74 | assertEquals("\0\0\0\0\0\0\0\0\0\0", sequence.toString()); 75 | } 76 | 77 | @Test 78 | public void subBufferOfStringAble() { 79 | final SecureCharBuffer buffer = new SecureCharBuffer(); 80 | buffer.append("NovaCrypto"); 81 | CharSequence sequence = buffer 82 | .toStringAble() 83 | .subSequence(4, 9); 84 | assertEquals("Crypt", sequence.toString()); 85 | } 86 | 87 | @Test 88 | public void subBufferOfSubBufferStringAble() { 89 | final SecureCharBuffer buffer = new SecureCharBuffer(); 90 | buffer.append("NovaCrypto"); 91 | CharSequence sequence = buffer 92 | .toStringAble() 93 | .subSequence(4, 9) 94 | .subSequence(0, 3); 95 | assertEquals("Cry", sequence.toString()); 96 | } 97 | } -------------------------------------------------------------------------------- /src/test/java/io/github/novacrypto/WhiteBox.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SecureString library, Obfuscated/clearable in memory string management 3 | * 4 | * Copyright (C) 2017-2022 Alan Evans, NovaCrypto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | * Original source: https://github.com/NovaCrypto/SecureString 20 | * You can contact the authors via github issues. 21 | */ 22 | 23 | package io.github.novacrypto; 24 | 25 | import java.lang.reflect.Field; 26 | 27 | /** 28 | * Reflection helpers for white-box tests. 29 | */ 30 | final class WhiteBox { 31 | 32 | private WhiteBox() { 33 | } 34 | 35 | /** 36 | * Finds the contents of a private field. 37 | * If path includes one of more '.' will do so recursively. 38 | * Restores fields accessible state. 39 | */ 40 | static Object getFromPrivateField(final Object object, final String fieldNamePath) { 41 | Object result = object; 42 | for (String fieldName : fieldNamePath.split("\\.")) { 43 | result = getPrivateFieldValue(result, fieldName); 44 | } 45 | return result; 46 | } 47 | 48 | private static Object getPrivateFieldValue(final Object object, final String fieldName) { 49 | try { 50 | final Field declaredField = object.getClass().getDeclaredField(fieldName); 51 | final boolean wasAccessible = declaredField.isAccessible(); 52 | declaredField.setAccessible(true); 53 | try { 54 | return declaredField.get(object); 55 | } finally { 56 | declaredField.setAccessible(wasAccessible); 57 | } 58 | } catch (Exception e) { 59 | throw new RuntimeException(e); 60 | } 61 | } 62 | } 63 | --------------------------------------------------------------------------------