src/Security/OAuth1/Signature/OAuthSignatureMethod_PLAINTEXT.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Security\OAuth1\Signature;
  23
  24 use Friendica\Security\OAuth1\OAuthRequest;
  25 use Friendica\Security\OAuth1\OAuthUtil;
  26
  27 /**
  28  * The PLAINTEXT method does not provide any security protection and SHOULD only be used
  29  * over a secure channel such as HTTPS. It does not use the Signature Base String.
  30  *   - Chapter 9.4 ("PLAINTEXT")
  31  */
  32 class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod
  33 {
  34         public function get_name()
  35         {
  36                 return "PLAINTEXT";
  37         }
  38
  39         /**
  40          * oauth_signature is set to the concatenated encoded values of the Consumer Secret and
  41          * Token Secret, separated by a '&' character (ASCII code 38), even if either secret is
  42          * empty. The result MUST be encoded again.
  43          *   - Chapter 9.4.1 ("Generating Signatures")
  44          *
  45          * Please note that the second encoding MUST NOT happen in the SignatureMethod, as
  46          * OAuthRequest handles this!
  47          *
  48          * @param $request
  49          * @param $consumer
  50          * @param $token
  51          *
  52          * @return string
  53          */
  54         public function build_signature(OAuthRequest $request, \Friendica\Security\OAuth1\OAuthConsumer $consumer, \Friendica\Security\OAuth1\OAuthToken $token = null)
  55         {
  56                 $key_parts = [
  57                         $consumer->secret,
  58                         ($token) ? $token->secret : "",
  59                 ];
  60
  61                 $key_parts            = OAuthUtil::urlencode_rfc3986($key_parts);
  62                 $key                  = implode('&', $key_parts);
  63                 $request->base_string = $key;
  64
  65                 return $key;
  66         }
  67 }