mediawiki/oauthclient-php
PHP OAuth client to use with Wikipedia and other MediaWiki-based wikis running the OAuth extension.
Loading...
Searching...
No Matches
MediaWiki\OAuthClient\SignatureMethod\HmacSha1 Class Reference

The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104] where the Signature Base String is the text and the key is the concatenated values (each first encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&' character (ASCII code 38) even if empty. More...

+ Inheritance diagram for MediaWiki\OAuthClient\SignatureMethod\HmacSha1:
+ Collaboration diagram for MediaWiki\OAuthClient\SignatureMethod\HmacSha1:

Public Member Functions

 getName ()
 
 buildSignature (Request $request, Consumer $consumer, ?Token $token=null)
 
- Public Member Functions inherited from MediaWiki\OAuthClient\SignatureMethod
 checkSignature (Request $request, Consumer $consumer, $token, $signature)
 Verifies that a given signature is correct.
 

Detailed Description

The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104] where the Signature Base String is the text and the key is the concatenated values (each first encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&' character (ASCII code 38) even if empty.

  • Chapter 9.2 ("HMAC-SHA1")

Member Function Documentation

◆ buildSignature()

MediaWiki\OAuthClient\SignatureMethod\HmacSha1::buildSignature ( Request $request,
Consumer $consumer,
?Token $token = null )
Parameters
Request$request
Consumer$consumer
Token | null$token
Returns
string

Reimplemented from MediaWiki\OAuthClient\SignatureMethod.

◆ getName()

MediaWiki\OAuthClient\SignatureMethod\HmacSha1::getName ( )
Returns
string

Reimplemented from MediaWiki\OAuthClient\SignatureMethod.


The documentation for this class was generated from the following file: