plugins/OStatus/lib/salmon.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A sample module to show best practices for StatusNet plugins
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @package   StatusNet
  24  * @author    James Walker <james@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  27  * @link      http://status.net/
  28  */
  29 class Salmon
  30 {
  31     const REL_SALMON = 'salmon';
  32     const REL_MENTIONED = 'mentioned';
  33
  34     // XXX: these are deprecated
  35     const NS_REPLIES = "http://salmon-protocol.org/ns/salmon-replies";
  36     const NS_MENTIONS = "http://salmon-protocol.org/ns/salmon-mention";
  37
  38     /**
  39      * Sign and post the given Atom entry as a Salmon message.
  40      *
  41      * Side effects: may generate a keypair on-demand for the given user,
  42      * which can be very slow on some systems.
  43      *
  44      * @param string $endpoint_uri
  45      * @param string $xml string representation of payload
  46      * @param Profile $actor local user profile whose keys to sign with
  47      * @return boolean success
  48      */
  49     public function post($endpoint_uri, $xml, $actor)
  50     {
  51         if (empty($endpoint_uri)) {
  52             return false;
  53         }
  54
  55         foreach ($this->formatClasses() as $class) {
  56             try {
  57                 $envelope = $this->createMagicEnv($xml, $actor, $class);
  58             } catch (Exception $e) {
  59                 common_log(LOG_ERR, "Salmon unable to sign: " . $e->getMessage());
  60                 return false;
  61             }
  62
  63             $headers = array('Content-Type: application/magic-envelope+xml');
  64
  65             try {
  66                 $client = new HTTPClient();
  67                 $client->setBody($envelope);
  68                 $response = $client->post($endpoint_uri, $headers);
  69             } catch (HTTP_Request2_Exception $e) {
  70                 common_log(LOG_ERR, "Salmon ($class) post to $endpoint_uri failed: " . $e->getMessage());
  71                 continue;
  72             }
  73             if ($response->getStatus() != 200) {
  74                 common_log(LOG_ERR, "Salmon ($class) at $endpoint_uri returned status " .
  75                     $response->getStatus() . ': ' . $response->getBody());
  76                 continue;
  77             }
  78
  79             // Success!
  80             return true;
  81         }
  82         return false;
  83     }
  84
  85     /**
  86      * List the magic envelope signature class variants in the order we try them.
  87      * Multiples are needed for backwards-compat with StatusNet prior to 0.9.7,
  88      * which used a draft version of the magic envelope spec.
  89      */
  90     protected function formatClasses() {
  91         return array('MagicEnvelope', 'MagicEnvelopeCompat');
  92     }
  93
  94     /**
  95      * Encode the given string as a signed MagicEnvelope XML document,
  96      * using the keypair for the given local user profile.
  97      *
  98      * Side effects: will create and store a keypair on-demand if one
  99      * hasn't already been generated for this user. This can be very slow
 100      * on some systems.
 101      *
 102      * @param string $text XML fragment to sign, assumed to be Atom
 103      * @param Profile $actor Profile of a local user to use as signer
 104      * @param string $class to override the magic envelope signature version, pass a MagicEnvelope subclass here
 105      *
 106      * @return string XML string representation of magic envelope
 107      *
 108      * @throws Exception on bad profile input or key generation problems
 109      * @fixme if signing fails, this seems to return the original text without warning. Is there a reason for this?
 110      */
 111     public function createMagicEnv($text, $actor, $class='MagicEnvelope')
 112     {
 113         $magic_env = new $class();
 114
 115         $user = User::staticGet('id', $actor->id);
 116         if ($user->id) {
 117             // Use local key
 118             $magickey = Magicsig::staticGet('user_id', $user->id);
 119             if (!$magickey) {
 120                 // No keypair yet, let's generate one.
 121                 $magickey = new Magicsig();
 122                 $magickey->generate($user->id);
 123             }
 124         } else {
 125             // TRANS: Exception.
 126             throw new Exception(_m('Salmon invalid actor for signing.'));
 127         }
 128
 129         try {
 130             $env = $magic_env->signMessage($text, 'application/atom+xml', $magickey->toString());
 131         } catch (Exception $e) {
 132             return $text;
 133         }
 134         return $magic_env->toXML($env);
 135     }
 136
 137     /**
 138      * Check if the given magic envelope is well-formed and correctly signed.
 139      * Needs to have network access to fetch public keys over the web.
 140      * Both current and back-compat signature formats will be checked.
 141      *
 142      * Side effects: exceptions and caching updates may occur during network
 143      * fetches.
 144      *
 145      * @param string $text XML fragment of magic envelope
 146      * @return boolean
 147      *
 148      * @throws Exception on bad profile input or key generation problems
 149      * @fixme could hit fatal errors or spew output on invalid XML
 150      */
 151     public function verifyMagicEnv($text)
 152     {
 153         foreach ($this->formatClasses() as $class) {
 154             $magic_env = new $class();
 155
 156             $env = $magic_env->parse($text);
 157
 158             if ($magic_env->verify($env)) {
 159                 return true;
 160             }
 161         }
 162
 163         return false;
 164     }
 165 }