Add convenience XHubSignature256 class to default to SHA-256
Needs ReviewPublic
Actions

Authored by dereckson on Sun, Apr 19, 18:48.

Details

Reviewers: None
Maniphest Tasks: T2310: Support X-Hub-Signature-256

Summary

To update the default algo doesn't a good approach, especially as GitHub
has chosen to update the header from X-Hub-Signature to X-Hub-Signature-256.

This is a weird inheritance case where we would like to impose SHA-256
as algorithm but where the parent class allows algorithm override.

Ref T2310

Diff Detail

Repository

rKERUALD Keruald libraries development repository

Lint

Lint Errors

Severity	Location	Code	Message
Error	github/tests/XHubSignature256Test.php:9	PHPCS.E.PSR1.Classes.ClassDeclaration.MissingNamespace	PSR1.Classes.ClassDeclaration.MissingNamespace
Warning	github/src/XHubSignature256.php:15	PHPCS.W.Generic.CodeAnalysis.UselessOverridingMethod.Found	Generic.CodeAnalysis.UselessOverridingMethod.Found
Warning	github/tests/XHubSignature256Test.php:1	PHPCS.W.PSR1.Files.SideEffects.FoundWithSymbols	PSR1.Files.SideEffects.FoundWithSymbols

Unit

Test Failures

Branch

T2310-X-Hub-Signature-256

Build Status

Buildable 6654
Build 6940: arc lint + arc unit

Unit TestsBroken
View All

	Time	Test
	0 ms	XHubSignature256Test XHubSignature256Test::testValidate Error: Class "Keruald\GitHub\XHubSignature256" not found

Event Timeline

dereckson requested review of this revision.Sun, Apr 19, 18:48

dereckson created this revision.

Harbormaster completed remote builds in B6652: Diff 10689.Sun, Apr 19, 18:48

To put tests in a namespace is certainly a good idea, but that will be in a follow-up commit.

dereckson added a parent revision: D4079: Test X-Hub-Signature-256 documentation values.Sun, Apr 19, 18:50

Algo can be overriden

Harbormaster completed remote builds in B6653: Diff 10690.Sun, Apr 19, 18:52

Algo can be overriden

Harbormaster completed remote builds in B6654: Diff 10691.Sun, Apr 19, 18:53

Unit tests

WindRiver

$ phpunit github
Switching to Composer phpunit:
PHPUnit 12.5-dev by Sebastian Bergmann and contributors.

Runtime:       PHP 8.3.30
Configuration: /home/dereckson/dev/keruald/_monorepo/core/phpunit.xml

........                                                            8 / 8 (100%)

Time: 00:00.016, Memory: 16.00 MB

OK (8 tests, 14 assertions)

Tests seem to require 8111582dd667f98fc11bd50e98b7a9e2d33ff149 to work, but change isn't rebased.

Revision Contents
Changeset List

Path

Size

github/

src/

XHubSignature256.php

66 lines

tests/

XHubSignature256Test.php

39 lines

Diff 10691

View Options

github/src/XHubSignature256.php