feat(encoding): introduce `Base64\Variant` enum to support encoding/decoding different variants #408

Gashmob · 2023-06-05T16:59:28Z

Closes issue #407

This pr introduces functions url_encode and url_decode in Psl\Encoding\Base64 namespace. Following rfc4648 it uses base64url alphabet to make base64 encoding url safe.

issue azjezz#407 This commit introduces functions url_encode and url_decode in Psl\Encoding\Base64 namespace. Following rfc4648 it uses base64url alphabet to make base64 encoding url safe.

src/Psl/Encoding/Base64/url_decode.php

src/Psl/Encoding/Base64/url_encode.php

src/Psl/Encoding/Base64/url_decode.php

src/Psl/Encoding/Base64/url_encode.php

src/Psl/Encoding/Base64/url_decode.php

Co-authored-by: Saif Eddin Gmati <29315886+azjezz@users.noreply.github.com>

coveralls · 2023-06-08T15:17:55Z

Pull Request Test Coverage Report for Build 5281085370

138 of 144 (95.83%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.1%) to 99.042%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/Psl/Encoding/Base64/Internal/Base64.php	84	90	93.33%

Totals
Change from base Build 5012888631:	-0.1%
Covered Lines:	4137
Relevant Lines:	4177

💛 - Coveralls

In Base64 namespace: For both encode and url_encode, add bool $padding arg to tell if we have or not padding at the end. By default encode is set to true and url_encode to false. For both decode and url_decode, add bool $explicitPadding arg to tell if we check or not padding at the end. By default decode is set to true and url_decode to false.

Run doc/documenter.php

In goal to do dot slash [ordered] encoding, refactor base64 encoding with inspiration from ParagonIE (https://github.com/paragonie/constant_time_encoding).

src/Psl/Encoding/Base64/Internal/Base64DotSlashOrdered.php

src/Psl/Encoding/Base64/Internal/Base64DotSlash.php

src/Psl/Encoding/Base64/Internal/Base64UrlSafe.php

src/Psl/Encoding/Base64/decode.php

src/Psl/Encoding/Base64/encode.php

src/Psl/Encoding/Base64/Internal/Base64.php

src/Psl/Encoding/Base64/Internal/Base64DotSlash.php

src/Psl/Encoding/Base64/Internal/Base64DotSlashOrdered.php

src/Psl/Encoding/Base64/Internal/Base64UrlSafe.php

src/Psl/Encoding/Base64/Internal/Base64.php

azjezz · 2023-06-15T20:28:07Z

@veewee do you think this should start a new major branch ( 3.x ), or should we allow this BC break to go through?

we have before release a minor with a bc break in a non major component, so that won't be new :)

veewee · 2023-06-16T05:29:43Z

@azjezz the way I see this, is that the public signature of the method did not change in a breaking way. The only thing that changed is extra optional arguments and the internal implementation.
I don't think we need a major got that.

Do we need to benchmark the implementation vs PHPs implementation to make sure it's similarly performant and produces the same results?

azjezz · 2023-06-16T12:49:39Z

I don't think we need a major got that.

It did though, we added new Variant $variant argument before the old bool $pad argument, while both are optional, something like Base64\encode($data, true) will fail now.

azjezz · 2023-06-16T12:50:41Z

Do we need to benchmark the implementation vs PHPs implementation to make sure it's similarly performant and produces the same results?

we can, but keep in mind that this implementation while slower ( not sure by how much ), provides constant time encoding/decoding, which the PHP implementation does not provide.

veewee · 2023-06-16T12:57:39Z

I don't think we need a major got that.

It did though, we added new Variant $variant argument before the old bool $pad argument, while both are optional, something like Base64\encode($data, true) will fail now.

Previously we did not provide any padding options though. It was just the encoding/encoded arg

azjezz · 2023-06-16T15:20:09Z

never mind me then :) my brain is not working right.

src/Psl/Encoding/Base64/Internal/Base64.php

src/Psl/Encoding/Base64/Variant.php

src/Psl/Encoding/Base64/Internal/Base64.php

src/Psl/Encoding/Base64/Internal/Base64DotSlash.php

src/Psl/Encoding/Base64/Internal/Base64.php

azjezz · 2023-06-16T15:38:10Z

@Gashmob aside from the comments above, this looks great to me 💪 we can ship it in the next minor soon.

Gashmob · 2023-06-16T17:14:18Z

Ok, I've applied your suggestions and fix errors from checks. Normally all it's done, clean, good 😄

azjezz · 2023-06-16T21:36:39Z

awesome work @Gashmob !

thank you for contributing 🎉

Gashmob added 2 commits June 5, 2023 18:52

feat: Add base64 url_encode and url_decode functions

ddcccd4

issue azjezz#407 This commit introduces functions url_encode and url_decode in Psl\Encoding\Base64 namespace. Following rfc4648 it uses base64url alphabet to make base64 encoding url safe.

Rm phpunit cache

2ab40df

veewee reviewed Jun 8, 2023

View reviewed changes

src/Psl/Encoding/Base64/url_decode.php Outdated Show resolved Hide resolved

azjezz reviewed Jun 8, 2023

View reviewed changes

azjezz changed the title ~~Base64 url~~ feat(encoding): introduce Base64\url_encode and Base64\url_decode functions Jun 8, 2023

azjezz assigned Gashmob Jun 8, 2023

azjezz added Priority: Medium This issue may be useful, and needs some attention. Status: In Progress This issue is being worked on, and has someone assigned. Type: Enhancement Most issues will probably ask for additions or changes. labels Jun 8, 2023

Apply suggestions from code review

8c2274c

Co-authored-by: Saif Eddin Gmati <29315886+azjezz@users.noreply.github.com>

Gashmob added 4 commits June 9, 2023 17:17

doc: Add documentation for base64url

325937a

Run doc/documenter.php

refactor: Implement base64 encoding instead of using php implementation

36d1a20

In goal to do dot slash [ordered] encoding, refactor base64 encoding with inspiration from ParagonIE (https://github.com/paragonie/constant_time_encoding).

feat: Add base64 dot slash [ordered] encoding

98d2bcb

azjezz reviewed Jun 15, 2023

View reviewed changes

azjezz requested changes Jun 15, 2023

View reviewed changes

src/Psl/Encoding/Base64/Internal/Base64.php Outdated Show resolved Hide resolved

refactor: Apply requested changes

79888d9

Gashmob requested a review from azjezz June 15, 2023 16:07

azjezz requested changes Jun 16, 2023

View reviewed changes

src/Psl/Encoding/Base64/Internal/Base64.php Outdated Show resolved Hide resolved

src/Psl/Encoding/Base64/Internal/Base64.php Outdated Show resolved Hide resolved

src/Psl/Encoding/Base64/Variant.php Outdated Show resolved Hide resolved

azjezz reviewed Jun 16, 2023

View reviewed changes

src/Psl/Encoding/Base64/Internal/Base64.php Outdated Show resolved Hide resolved

azjezz reviewed Jun 16, 2023

View reviewed changes

src/Psl/Encoding/Base64/Internal/Base64DotSlash.php Outdated Show resolved Hide resolved

azjezz reviewed Jun 16, 2023

View reviewed changes

src/Psl/Encoding/Base64/Internal/Base64.php Outdated Show resolved Hide resolved

azjezz changed the title ~~feat(encoding): introduce Base64\url_encode and Base64\url_decode functions~~ feat(encoding): introduce Base64\Variant enum to support encoding/decoding different variants Jun 16, 2023

fix: apply suggested changes + workflows checks

51a2e92

azjezz merged commit a5466a3 into azjezz:next Jun 16, 2023

Gashmob deleted the base64_url branch June 17, 2023 07:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(encoding): introduce `Base64\Variant` enum to support encoding/decoding different variants #408

feat(encoding): introduce `Base64\Variant` enum to support encoding/decoding different variants #408

Gashmob commented Jun 5, 2023

coveralls commented Jun 8, 2023 •

edited

Loading

azjezz commented Jun 15, 2023

veewee commented Jun 16, 2023

azjezz commented Jun 16, 2023

azjezz commented Jun 16, 2023

veewee commented Jun 16, 2023

azjezz commented Jun 16, 2023 •

edited

Loading

azjezz commented Jun 16, 2023

Gashmob commented Jun 16, 2023

azjezz commented Jun 16, 2023

feat(encoding): introduce Base64\Variant enum to support encoding/decoding different variants #408

feat(encoding): introduce Base64\Variant enum to support encoding/decoding different variants #408

Conversation

Gashmob commented Jun 5, 2023

coveralls commented Jun 8, 2023 • edited Loading

Pull Request Test Coverage Report for Build 5281085370

💛 - Coveralls

azjezz commented Jun 15, 2023

veewee commented Jun 16, 2023

azjezz commented Jun 16, 2023

azjezz commented Jun 16, 2023

veewee commented Jun 16, 2023

azjezz commented Jun 16, 2023 • edited Loading

azjezz commented Jun 16, 2023

Gashmob commented Jun 16, 2023

azjezz commented Jun 16, 2023

feat(encoding): introduce `Base64\Variant` enum to support encoding/decoding different variants #408

feat(encoding): introduce `Base64\Variant` enum to support encoding/decoding different variants #408

coveralls commented Jun 8, 2023 •

edited

Loading

azjezz commented Jun 16, 2023 •

edited

Loading