├── .github
└── workflows
│ ├── .editorconfig
│ ├── ci.yml
│ └── static.yml
├── .gitignore
├── LICENSE
├── README.md
├── composer.json
├── phpunit.xml.dist
├── psalm.xml
├── src
├── HiddenString.php
└── MisuseException.php
└── test
└── HiddenStringTest.php
/.github/workflows/.editorconfig:
--------------------------------------------------------------------------------
1 | [*.yml]
2 | indent_size = 2
3 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: Tests
2 | on: [push, pull_request]
3 |
4 | jobs:
5 | build:
6 | name: PHPUnit
7 | runs-on: ubuntu-22.04
8 | strategy:
9 | max-parallel: 10
10 | matrix:
11 | php: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
12 |
13 | steps:
14 | - name: Set up PHP
15 | uses: shivammathur/setup-php@2.9.0
16 | with:
17 | php-version: ${{ matrix.php }}
18 | coverage: none
19 |
20 | - name: Checkout code
21 | uses: actions/checkout@v2
22 |
23 | - name: Download dependencies
24 | env:
25 | PHP_VERSION: ${{ matrix.php }}
26 | run: composer update
27 |
28 | - name: Run tests
29 | run: ./vendor/bin/phpunit
30 |
31 | lowest:
32 | name: Lowest deps
33 | runs-on: ubuntu-latest
34 | steps:
35 | - name: Set up PHP
36 | uses: shivammathur/setup-php@2.1.0
37 | with:
38 | php-version: 7.4
39 | coverage: none
40 |
41 | - name: Checkout code
42 | uses: actions/checkout@v2
43 |
44 | - name: Download dependencies
45 | run: composer update --no-interaction --prefer-dist --prefer-stable --prefer-lowest
46 |
47 | - name: Run tests
48 | run: ./vendor/bin/phpunit
49 |
--------------------------------------------------------------------------------
/.github/workflows/static.yml:
--------------------------------------------------------------------------------
1 | on: [push, pull_request]
2 | name: Static analysis
3 |
4 | jobs:
5 | psalm:
6 | name: Psalm
7 | runs-on: ubuntu-latest
8 | steps:
9 | - name: Checkout code
10 | uses: actions/checkout@v4
11 |
12 | - name: Psalm
13 | uses: docker://vimeo/psalm-github-actions
14 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | /.idea/
3 | /composer.lock
4 | /composer.phar
5 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Mozilla Public License Version 2.0
2 | ==================================
3 |
4 | 1. Definitions
5 | --------------
6 |
7 | 1.1. "Contributor"
8 | means each individual or legal entity that creates, contributes to
9 | the creation of, or owns Covered Software.
10 |
11 | 1.2. "Contributor Version"
12 | means the combination of the Contributions of others (if any) used
13 | by a Contributor and that particular Contributor's Contribution.
14 |
15 | 1.3. "Contribution"
16 | means Covered Software of a particular Contributor.
17 |
18 | 1.4. "Covered Software"
19 | means Source Code Form to which the initial Contributor has attached
20 | the notice in Exhibit A, the Executable Form of such Source Code
21 | Form, and Modifications of such Source Code Form, in each case
22 | including portions thereof.
23 |
24 | 1.5. "Incompatible With Secondary Licenses"
25 | means
26 |
27 | (a) that the initial Contributor has attached the notice described
28 | in Exhibit B to the Covered Software; or
29 |
30 | (b) that the Covered Software was made available under the terms of
31 | version 1.1 or earlier of the License, but not also under the
32 | terms of a Secondary License.
33 |
34 | 1.6. "Executable Form"
35 | means any form of the work other than Source Code Form.
36 |
37 | 1.7. "Larger Work"
38 | means a work that combines Covered Software with other material, in
39 | a separate file or files, that is not Covered Software.
40 |
41 | 1.8. "License"
42 | means this document.
43 |
44 | 1.9. "Licensable"
45 | means having the right to grant, to the maximum extent possible,
46 | whether at the time of the initial grant or subsequently, any and
47 | all of the rights conveyed by this License.
48 |
49 | 1.10. "Modifications"
50 | means any of the following:
51 |
52 | (a) any file in Source Code Form that results from an addition to,
53 | deletion from, or modification of the contents of Covered
54 | Software; or
55 |
56 | (b) any new file in Source Code Form that contains any Covered
57 | Software.
58 |
59 | 1.11. "Patent Claims" of a Contributor
60 | means any patent claim(s), including without limitation, method,
61 | process, and apparatus claims, in any patent Licensable by such
62 | Contributor that would be infringed, but for the grant of the
63 | License, by the making, using, selling, offering for sale, having
64 | made, import, or transfer of either its Contributions or its
65 | Contributor Version.
66 |
67 | 1.12. "Secondary License"
68 | means either the GNU General Public License, Version 2.0, the GNU
69 | Lesser General Public License, Version 2.1, the GNU Affero General
70 | Public License, Version 3.0, or any later versions of those
71 | licenses.
72 |
73 | 1.13. "Source Code Form"
74 | means the form of the work preferred for making modifications.
75 |
76 | 1.14. "You" (or "Your")
77 | means an individual or a legal entity exercising rights under this
78 | License. For legal entities, "You" includes any entity that
79 | controls, is controlled by, or is under common control with You. For
80 | purposes of this definition, "control" means (a) the power, direct
81 | or indirect, to cause the direction or management of such entity,
82 | whether by contract or otherwise, or (b) ownership of more than
83 | fifty percent (50%) of the outstanding shares or beneficial
84 | ownership of such entity.
85 |
86 | 2. License Grants and Conditions
87 | --------------------------------
88 |
89 | 2.1. Grants
90 |
91 | Each Contributor hereby grants You a world-wide, royalty-free,
92 | non-exclusive license:
93 |
94 | (a) under intellectual property rights (other than patent or trademark)
95 | Licensable by such Contributor to use, reproduce, make available,
96 | modify, display, perform, distribute, and otherwise exploit its
97 | Contributions, either on an unmodified basis, with Modifications, or
98 | as part of a Larger Work; and
99 |
100 | (b) under Patent Claims of such Contributor to make, use, sell, offer
101 | for sale, have made, import, and otherwise transfer either its
102 | Contributions or its Contributor Version.
103 |
104 | 2.2. Effective Date
105 |
106 | The licenses granted in Section 2.1 with respect to any Contribution
107 | become effective for each Contribution on the date the Contributor first
108 | distributes such Contribution.
109 |
110 | 2.3. Limitations on Grant Scope
111 |
112 | The licenses granted in this Section 2 are the only rights granted under
113 | this License. No additional rights or licenses will be implied from the
114 | distribution or licensing of Covered Software under this License.
115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a
116 | Contributor:
117 |
118 | (a) for any code that a Contributor has removed from Covered Software;
119 | or
120 |
121 | (b) for infringements caused by: (i) Your and any other third party's
122 | modifications of Covered Software, or (ii) the combination of its
123 | Contributions with other software (except as part of its Contributor
124 | Version); or
125 |
126 | (c) under Patent Claims infringed by Covered Software in the absence of
127 | its Contributions.
128 |
129 | This License does not grant any rights in the trademarks, service marks,
130 | or logos of any Contributor (except as may be necessary to comply with
131 | the notice requirements in Section 3.4).
132 |
133 | 2.4. Subsequent Licenses
134 |
135 | No Contributor makes additional grants as a result of Your choice to
136 | distribute the Covered Software under a subsequent version of this
137 | License (see Section 10.2) or under the terms of a Secondary License (if
138 | permitted under the terms of Section 3.3).
139 |
140 | 2.5. Representation
141 |
142 | Each Contributor represents that the Contributor believes its
143 | Contributions are its original creation(s) or it has sufficient rights
144 | to grant the rights to its Contributions conveyed by this License.
145 |
146 | 2.6. Fair Use
147 |
148 | This License is not intended to limit any rights You have under
149 | applicable copyright doctrines of fair use, fair dealing, or other
150 | equivalents.
151 |
152 | 2.7. Conditions
153 |
154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155 | in Section 2.1.
156 |
157 | 3. Responsibilities
158 | -------------------
159 |
160 | 3.1. Distribution of Source Form
161 |
162 | All distribution of Covered Software in Source Code Form, including any
163 | Modifications that You create or to which You contribute, must be under
164 | the terms of this License. You must inform recipients that the Source
165 | Code Form of the Covered Software is governed by the terms of this
166 | License, and how they can obtain a copy of this License. You may not
167 | attempt to alter or restrict the recipients' rights in the Source Code
168 | Form.
169 |
170 | 3.2. Distribution of Executable Form
171 |
172 | If You distribute Covered Software in Executable Form then:
173 |
174 | (a) such Covered Software must also be made available in Source Code
175 | Form, as described in Section 3.1, and You must inform recipients of
176 | the Executable Form how they can obtain a copy of such Source Code
177 | Form by reasonable means in a timely manner, at a charge no more
178 | than the cost of distribution to the recipient; and
179 |
180 | (b) You may distribute such Executable Form under the terms of this
181 | License, or sublicense it under different terms, provided that the
182 | license for the Executable Form does not attempt to limit or alter
183 | the recipients' rights in the Source Code Form under this License.
184 |
185 | 3.3. Distribution of a Larger Work
186 |
187 | You may create and distribute a Larger Work under terms of Your choice,
188 | provided that You also comply with the requirements of this License for
189 | the Covered Software. If the Larger Work is a combination of Covered
190 | Software with a work governed by one or more Secondary Licenses, and the
191 | Covered Software is not Incompatible With Secondary Licenses, this
192 | License permits You to additionally distribute such Covered Software
193 | under the terms of such Secondary License(s), so that the recipient of
194 | the Larger Work may, at their option, further distribute the Covered
195 | Software under the terms of either this License or such Secondary
196 | License(s).
197 |
198 | 3.4. Notices
199 |
200 | You may not remove or alter the substance of any license notices
201 | (including copyright notices, patent notices, disclaimers of warranty,
202 | or limitations of liability) contained within the Source Code Form of
203 | the Covered Software, except that You may alter any license notices to
204 | the extent required to remedy known factual inaccuracies.
205 |
206 | 3.5. Application of Additional Terms
207 |
208 | You may choose to offer, and to charge a fee for, warranty, support,
209 | indemnity or liability obligations to one or more recipients of Covered
210 | Software. However, You may do so only on Your own behalf, and not on
211 | behalf of any Contributor. You must make it absolutely clear that any
212 | such warranty, support, indemnity, or liability obligation is offered by
213 | You alone, and You hereby agree to indemnify every Contributor for any
214 | liability incurred by such Contributor as a result of warranty, support,
215 | indemnity or liability terms You offer. You may include additional
216 | disclaimers of warranty and limitations of liability specific to any
217 | jurisdiction.
218 |
219 | 4. Inability to Comply Due to Statute or Regulation
220 | ---------------------------------------------------
221 |
222 | If it is impossible for You to comply with any of the terms of this
223 | License with respect to some or all of the Covered Software due to
224 | statute, judicial order, or regulation then You must: (a) comply with
225 | the terms of this License to the maximum extent possible; and (b)
226 | describe the limitations and the code they affect. Such description must
227 | be placed in a text file included with all distributions of the Covered
228 | Software under this License. Except to the extent prohibited by statute
229 | or regulation, such description must be sufficiently detailed for a
230 | recipient of ordinary skill to be able to understand it.
231 |
232 | 5. Termination
233 | --------------
234 |
235 | 5.1. The rights granted under this License will terminate automatically
236 | if You fail to comply with any of its terms. However, if You become
237 | compliant, then the rights granted under this License from a particular
238 | Contributor are reinstated (a) provisionally, unless and until such
239 | Contributor explicitly and finally terminates Your grants, and (b) on an
240 | ongoing basis, if such Contributor fails to notify You of the
241 | non-compliance by some reasonable means prior to 60 days after You have
242 | come back into compliance. Moreover, Your grants from a particular
243 | Contributor are reinstated on an ongoing basis if such Contributor
244 | notifies You of the non-compliance by some reasonable means, this is the
245 | first time You have received notice of non-compliance with this License
246 | from such Contributor, and You become compliant prior to 30 days after
247 | Your receipt of the notice.
248 |
249 | 5.2. If You initiate litigation against any entity by asserting a patent
250 | infringement claim (excluding declaratory judgment actions,
251 | counter-claims, and cross-claims) alleging that a Contributor Version
252 | directly or indirectly infringes any patent, then the rights granted to
253 | You by any and all Contributors for the Covered Software under Section
254 | 2.1 of this License shall terminate.
255 |
256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257 | end user license agreements (excluding distributors and resellers) which
258 | have been validly granted by You or Your distributors under this License
259 | prior to termination shall survive termination.
260 |
261 | ************************************************************************
262 | * *
263 | * 6. Disclaimer of Warranty *
264 | * ------------------------- *
265 | * *
266 | * Covered Software is provided under this License on an "as is" *
267 | * basis, without warranty of any kind, either expressed, implied, or *
268 | * statutory, including, without limitation, warranties that the *
269 | * Covered Software is free of defects, merchantable, fit for a *
270 | * particular purpose or non-infringing. The entire risk as to the *
271 | * quality and performance of the Covered Software is with You. *
272 | * Should any Covered Software prove defective in any respect, You *
273 | * (not any Contributor) assume the cost of any necessary servicing, *
274 | * repair, or correction. This disclaimer of warranty constitutes an *
275 | * essential part of this License. No use of any Covered Software is *
276 | * authorized under this License except under this disclaimer. *
277 | * *
278 | ************************************************************************
279 |
280 | ************************************************************************
281 | * *
282 | * 7. Limitation of Liability *
283 | * -------------------------- *
284 | * *
285 | * Under no circumstances and under no legal theory, whether tort *
286 | * (including negligence), contract, or otherwise, shall any *
287 | * Contributor, or anyone who distributes Covered Software as *
288 | * permitted above, be liable to You for any direct, indirect, *
289 | * special, incidental, or consequential damages of any character *
290 | * including, without limitation, damages for lost profits, loss of *
291 | * goodwill, work stoppage, computer failure or malfunction, or any *
292 | * and all other commercial damages or losses, even if such party *
293 | * shall have been informed of the possibility of such damages. This *
294 | * limitation of liability shall not apply to liability for death or *
295 | * personal injury resulting from such party's negligence to the *
296 | * extent applicable law prohibits such limitation. Some *
297 | * jurisdictions do not allow the exclusion or limitation of *
298 | * incidental or consequential damages, so this exclusion and *
299 | * limitation may not apply to You. *
300 | * *
301 | ************************************************************************
302 |
303 | 8. Litigation
304 | -------------
305 |
306 | Any litigation relating to this License may be brought only in the
307 | courts of a jurisdiction where the defendant maintains its principal
308 | place of business and such litigation shall be governed by laws of that
309 | jurisdiction, without reference to its conflict-of-law provisions.
310 | Nothing in this Section shall prevent a party's ability to bring
311 | cross-claims or counter-claims.
312 |
313 | 9. Miscellaneous
314 | ----------------
315 |
316 | This License represents the complete agreement concerning the subject
317 | matter hereof. If any provision of this License is held to be
318 | unenforceable, such provision shall be reformed only to the extent
319 | necessary to make it enforceable. Any law or regulation which provides
320 | that the language of a contract shall be construed against the drafter
321 | shall not be used to construe this License against a Contributor.
322 |
323 | 10. Versions of the License
324 | ---------------------------
325 |
326 | 10.1. New Versions
327 |
328 | Mozilla Foundation is the license steward. Except as provided in Section
329 | 10.3, no one other than the license steward has the right to modify or
330 | publish new versions of this License. Each version will be given a
331 | distinguishing version number.
332 |
333 | 10.2. Effect of New Versions
334 |
335 | You may distribute the Covered Software under the terms of the version
336 | of the License under which You originally received the Covered Software,
337 | or under the terms of any subsequent version published by the license
338 | steward.
339 |
340 | 10.3. Modified Versions
341 |
342 | If you create software not governed by this License, and you want to
343 | create a new license for such software, you may create and use a
344 | modified version of this License if you rename the license and remove
345 | any references to the name of the license steward (except to note that
346 | such modified license differs from this License).
347 |
348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary
349 | Licenses
350 |
351 | If You choose to distribute Source Code Form that is Incompatible With
352 | Secondary Licenses under the terms of this version of the License, the
353 | notice described in Exhibit B of this License must be attached.
354 |
355 | Exhibit A - Source Code Form License Notice
356 | -------------------------------------------
357 |
358 | This Source Code Form is subject to the terms of the Mozilla Public
359 | License, v. 2.0. If a copy of the MPL was not distributed with this
360 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
361 |
362 | If it is not possible or desirable to put the notice in a particular
363 | file, then You may include the notice in a location (such as a LICENSE
364 | file in a relevant directory) where a recipient would be likely to look
365 | for such a notice.
366 |
367 | You may add additional accurate notices of copyright ownership.
368 |
369 | Exhibit B - "Incompatible With Secondary Licenses" Notice
370 | ---------------------------------------------------------
371 |
372 | This Source Code Form is "Incompatible With Secondary Licenses", as
373 | defined by the Mozilla Public License, v. 2.0.
374 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # HiddenString
2 |
3 | [](https://github.com/paragonie/hidden-string/actions)
4 | [](https://github.com/paragonie/hidden-string/actions)
5 | [](https://packagist.org/packages/paragonie/hidden-string)
6 | [](https://packagist.org/packages/paragonie/hidden-string)
7 | [](https://packagist.org/packages/paragonie/hidden-string)
8 | [](https://packagist.org/packages/paragonie/hidden-string)
9 |
10 | This package extracts the HiddenString class originally used in [Halite](https://github.com/paragonie/halite).
11 | **Requires PHP 7 or newer.**
12 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "paragonie/hidden-string",
3 | "type": "library",
4 | "keywords": [
5 | "hidden",
6 | "string",
7 | "stack trace"
8 | ],
9 | "description": "Encapsulate strings in an object to hide them from stack traces",
10 | "homepage": "https://github.com/paragonie/hidden-string",
11 | "license": "MPL-2.0",
12 | "authors": [
13 | {
14 | "name": "Paragon Initiative Enterprises",
15 | "homepage": "https://paragonie.com",
16 | "email": "info@paragonie.com"
17 | }
18 | ],
19 | "require": {
20 | "php": "^7.4|^8",
21 | "paragonie/constant_time_encoding": "^2|^3"
22 | },
23 | "autoload": {
24 | "psr-4": {
25 | "ParagonIE\\HiddenString\\": "./src"
26 | }
27 | },
28 | "require-dev": {
29 | "phpunit/phpunit": "^9.5",
30 | "vimeo/psalm": "^4"
31 | },
32 | "config": {
33 | "preferred-install": "dist",
34 | "optimize-autoloader": true,
35 | "sort-packages": true
36 | },
37 | "prefer-stable": true
38 | }
39 |
--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
1 |
2 |
9 |
10 |
11 | ./test
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/psalm.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/src/HiddenString.php:
--------------------------------------------------------------------------------
1 | internalStringValue = self::safeStrcpy($value);
59 | $this->disallowInline = $disallowInline;
60 | $this->disallowSerialization = $disallowSerialization;
61 | }
62 |
63 | /**
64 | * @param HiddenString $other
65 | *
66 | * @return bool
67 | *
68 | * @throws TypeError
69 | */
70 | public function equals(HiddenString $other)
71 | {
72 | return hash_equals(
73 | $this->getString(),
74 | $other->getString()
75 | );
76 | }
77 |
78 | /**
79 | * Hide its internal state from var_dump()
80 | *
81 | * Note: The xdebug extension may break this behavior.
82 | * You should not rely on it if you have debugging extensions installed.
83 | *
84 | * @return array
85 | */
86 | public function __debugInfo()
87 | {
88 | return [
89 | 'internalStringValue' =>
90 | '*',
91 | 'attention' =>
92 | 'If you need the value of a HiddenString, ' .
93 | 'invoke getString() instead of dumping it.'
94 | ];
95 | }
96 |
97 | /**
98 | * Wipe it from memory after it's been used.
99 | *
100 | * @return void
101 | */
102 | public function __destruct()
103 | {
104 | if (is_callable('sodium_memzero')) {
105 | try {
106 | sodium_memzero($this->internalStringValue);
107 | return;
108 | } catch (Throwable $ex) {
109 | }
110 | }
111 | if (is_null($this->internalStringValue)) {
112 | return;
113 | }
114 |
115 | // Last-ditch attempt to wipe existing values if libsodium is not
116 | // available. Don't rely on this.
117 | $zero = str_repeat("\0", Binary::safeStrlen($this->internalStringValue));
118 | $this->internalStringValue = $this->internalStringValue ^ (
119 | $zero ^ $this->internalStringValue
120 | );
121 | unset($zero);
122 | unset($this->internalStringValue);
123 | }
124 |
125 | /**
126 | * Explicit invocation -- get the raw string value
127 | *
128 | * @return string
129 | *
130 | * @throws TypeError
131 | */
132 | public function getString(): string
133 | {
134 | return self::safeStrcpy($this->internalStringValue);
135 | }
136 |
137 | /**
138 | * Returns a copy of the string's internal value, which should be zeroed.
139 | * Optionally, it can return an empty string.
140 | *
141 | * @return string
142 | *
143 | * @throws MisuseException
144 | * @throws TypeError
145 | */
146 | public function __toString(): string
147 | {
148 | if (!$this->disallowInline) {
149 | return self::safeStrcpy($this->internalStringValue);
150 | }
151 | throw new MisuseException(
152 | 'This HiddenString object cannot be inlined as a string.'
153 | );
154 | }
155 |
156 | /**
157 | * @return array
158 | *
159 | * @throws MisuseException
160 | */
161 | public function __sleep(): array
162 | {
163 | if (!$this->disallowSerialization) {
164 | return [
165 | 'internalStringValue',
166 | 'disallowInline',
167 | 'disallowSerialization'
168 | ];
169 | }
170 | throw new MisuseException(
171 | 'This HiddenString object cannot be serialized.'
172 | );
173 | }
174 |
175 | /**
176 | * PHP 7 uses interned strings. We don't want altering this one to alter
177 | * the original string.
178 | *
179 | * @param string $string
180 | *
181 | * @return string
182 | *
183 | * @throws TypeError
184 | */
185 | public static function safeStrcpy(
186 | #[\SensitiveParameter]
187 | string $string
188 | ): string {
189 | $length = Binary::safeStrlen($string);
190 | $return = '';
191 | $chunk = $length >> 1;
192 | if ($chunk < 1) {
193 | $chunk = 1;
194 | }
195 | for ($i = 0; $i < $length; $i += $chunk) {
196 | $return .= Binary::safeSubstr($string, $i, $chunk);
197 | }
198 | return $return;
199 | }
200 | }
201 |
--------------------------------------------------------------------------------
/src/MisuseException.php:
--------------------------------------------------------------------------------
1 | getString());
20 | $D = new HiddenString($B->getString());
21 |
22 | $this->assertFalse($A->equals($B));
23 | $this->assertTrue($A->equals($C));
24 | $this->assertFalse($A->equals($D));
25 | $this->assertFalse($B->equals($A));
26 | $this->assertFalse($B->equals($C));
27 | $this->assertTrue($B->equals($D));
28 | $this->assertTrue($C->equals($A));
29 | $this->assertFalse($C->equals($B));
30 | $this->assertFalse($C->equals($D));
31 | $this->assertFalse($D->equals($A));
32 | $this->assertTrue($D->equals($B));
33 | $this->assertFalse($D->equals($C));
34 | }
35 |
36 | /**
37 | * @throws Exception
38 | * @throws TypeError
39 | */
40 | public function testRandomString()
41 | {
42 | $str = Base64UrlSafe::encode(random_bytes(32));
43 |
44 | $sets = [
45 | [true, true],
46 | [true, false],
47 | [false, true],
48 | [false, false]
49 | ];
50 | foreach ($sets as $set) {
51 | $hidden = new HiddenString($str, $set[0], $set[1]);
52 |
53 | \ob_start();
54 | \var_dump($hidden);
55 | $dump = \ob_get_clean();
56 | $this->assertFalse(strpos($dump, $str));
57 |
58 | $print = \print_r($hidden, true);
59 | $this->assertFalse(strpos($print, $str));
60 |
61 | try {
62 | $cast = (string) $hidden;
63 | $this->assertNotFalse(strpos($cast, $str));
64 | } catch (MisuseException $ex) {
65 | $this->assertTrue($set[0]);
66 | }
67 |
68 | try {
69 | $serial = serialize($hidden);
70 | $this->assertNotFalse(strpos($serial, $str));
71 | } catch (MisuseException $ex) {
72 | $this->assertTrue($set[1]);
73 | }
74 | }
75 | }
76 | }
77 |
--------------------------------------------------------------------------------