Event-Federation/wordpress-activitypub
Event-Federation/wordpress-activitypub
7
1
Fork 0
Code Issues 3 Pull requests Projects Releases Wiki Activity Actions

some phpdoc

Browse source
This commit is contained in:
Matthias Pfefferle 2023-06-01 11:05:47 +02:00
parent b834666eda
commit 00dd5d2c52
1 changed files with 26 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
includes/class-signature.php
View file

@ -247,9 +247,9 @@ class Signature {
/** /**
* Get public key from key_id * Get public key from key_id
* *
* @param string $key_id * @param string $key_id The URL to the public key.
* *
* @return string $publicKeyPem * @return string The public key.
*/ */
public static function get_remote_key( $key_id ) { // phpcs:ignore public static function get_remote_key( $key_id ) { // phpcs:ignore
$actor = \Activitypub\get_remote_metadata_by_actor( strtok( strip_fragment_from_url( $key_id ), '?' ) ); // phpcs:ignore $actor = \Activitypub\get_remote_metadata_by_actor( strtok( strip_fragment_from_url( $key_id ), '?' ) ); // phpcs:ignore
@ -267,7 +267,7 @@ class Signature {
* *
* @param array $signature_block * @param array $signature_block
* *
* @return string algorithm * @return string The signature algorithm.
*/ */
public static function get_signature_algorithm( $signature_block ) { public static function get_signature_algorithm( $signature_block ) {
if ( $signature_block['algorithm'] ) { if ( $signature_block['algorithm'] ) {
@ -284,39 +284,39 @@ class Signature {
/** /**
* Parses the Signature header * Parses the Signature header
* *
* @param array $header * @param array $header The signature header.
* *
* @return array signature parts * @return array signature parts
*/ */
public static function parse_signature_header( $header ) { public static function parse_signature_header( $header ) {
$ret = array(); $parsed_header = array();
$matches = array(); $matches = array();
$h_string = \implode( ',', (array) $header[0] ); $h_string = \implode( ',', (array) $header[0] );
if ( \preg_match( '/keyId="(.*?)"/ism', $h_string, $matches ) ) { if ( \preg_match( '/keyId="(.*?)"/ism', $h_string, $matches ) ) {
$ret['keyId'] = $matches[1]; $parsed_header['keyId'] = $matches[1];
} }
if ( \preg_match( '/created=([0-9]*)/ism', $h_string, $matches ) ) { if ( \preg_match( '/created=([0-9]*)/ism', $h_string, $matches ) ) {
$ret['(created)'] = $matches[1]; $parsed_header['(created)'] = $matches[1];
} }
if ( \preg_match( '/expires=([0-9]*)/ism', $h_string, $matches ) ) { if ( \preg_match( '/expires=([0-9]*)/ism', $h_string, $matches ) ) {
$ret['(expires)'] = $matches[1]; $parsed_header['(expires)'] = $matches[1];
} }
if ( \preg_match( '/algorithm="(.*?)"/ism', $h_string, $matches ) ) { if ( \preg_match( '/algorithm="(.*?)"/ism', $h_string, $matches ) ) {
$ret['algorithm'] = $matches[1]; $parsed_header['algorithm'] = $matches[1];
} }
if ( \preg_match( '/headers="(.*?)"/ism', $h_string, $matches ) ) { if ( \preg_match( '/headers="(.*?)"/ism', $h_string, $matches ) ) {
$ret['headers'] = \explode( ' ', $matches[1] ); $parsed_header['headers'] = \explode( ' ', $matches[1] );
} }
if ( \preg_match( '/signature="(.*?)"/ism', $h_string, $matches ) ) { if ( \preg_match( '/signature="(.*?)"/ism', $h_string, $matches ) ) {
$ret['signature'] = \base64_decode( preg_replace( '/\s+/', '', $matches[1] ) ); // phpcs:ignore $parsed_header['signature'] = \base64_decode( preg_replace( '/\s+/', '', $matches[1] ) ); // phpcs:ignore
} }
if ( ( $ret['signature'] ) && ( $ret['algorithm'] ) && ( ! $ret['headers'] ) ) { if ( ( $parsed_header['signature'] ) && ( $parsed_header['algorithm'] ) && ( ! $parsed_header['headers'] ) ) {
$ret['headers'] = array( 'date' ); $parsed_header['headers'] = array( 'date' );
} }
return $ret; return $parsed_header;
} }
/** /**
@ -326,7 +326,7 @@ class Signature {
* @param array $signature_block (pseudo-headers) * @param array $signature_block (pseudo-headers)
* @param array $headers (http headers) * @param array $headers (http headers)
* *
* @return signed headers for comparison * @return string signed headers for comparison
*/ */
public static function get_signed_data( $signed_headers, $signature_block, $headers ) { public static function get_signed_data( $signed_headers, $signature_block, $headers ) {
$signed_data = ''; $signed_data = '';
@ -377,6 +377,13 @@ class Signature {
return \rtrim( $signed_data, "\n" ); return \rtrim( $signed_data, "\n" );
} }
/**
* Generates the digest for a HTTP Request
*
* @param string $body The body of the request.
*
* @return string The digest.
*/
public static function generate_digest( $body ) { public static function generate_digest( $body ) {
$digest = \base64_encode( \hash( 'sha256', $body, true ) ); // phpcs:ignore $digest = \base64_encode( \hash( 'sha256', $body, true ) ); // phpcs:ignore
return "SHA-256=$digest"; return "SHA-256=$digest";
@ -386,9 +393,9 @@ class Signature {
* Formats the $_SERVER to resemble the WP_REST_REQUEST array, * Formats the $_SERVER to resemble the WP_REST_REQUEST array,
* for use with verify_http_signature() * for use with verify_http_signature()
* *
* @param array $_SERVER * @param array $_SERVER The $_SERVER array.
* *
* @return array $request * @return array $request The formatted request array.
*/ */
public static function format_server_request( $server ) { public static function format_server_request( $server ) {
$request = array(); $request = array();