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         $classes = array('MagicEnvelope', 'MagicEnvelopeCompat');
  56         foreach ($classes as $class) {
  57             try {
  58                 $envelope = $this->createMagicEnv($xml, $actor, $class);
  59             } catch (Exception $e) {
  60                 common_log(LOG_ERR, "Salmon unable to sign: " . $e->getMessage());
  61                 return false;
  62             }
  63
  64             $headers = array('Content-Type: application/magic-envelope+xml');
  65
  66             try {
  67                 $client = new HTTPClient();
  68                 $client->setBody($envelope);
  69                 $response = $client->post($endpoint_uri, $headers);
  70             } catch (HTTP_Request2_Exception $e) {
  71                 common_log(LOG_ERR, "Salmon ($class) post to $endpoint_uri failed: " . $e->getMessage());
  72                 continue;
  73             }
  74             if ($response->getStatus() != 200) {
  75                 common_log(LOG_ERR, "Salmon ($class) at $endpoint_uri returned status " .
  76                     $response->getStatus() . ': ' . $response->getBody());
  77                 continue;
  78             }
  79
  80             // Success!
  81             return true;
  82         }
  83         return false;
  84     }
  85
  86     /**
  87      * Encode the given string as a signed MagicEnvelope XML document,
  88      * using the keypair for the given local user profile.
  89      *
  90      * Side effects: will create and store a keypair on-demand if one
  91      * hasn't already been generated for this user. This can be very slow
  92      * on some systems.
  93      *
  94      * @param string $text XML fragment to sign, assumed to be Atom
  95      * @param Profile $actor Profile of a local user to use as signer
  96      * @param string $class to override the magic envelope signature version, pass a MagicEnvelope subclass here
  97      *
  98      * @return string XML string representation of magic envelope
  99      *
 100      * @throws Exception on bad profile input or key generation problems
 101      * @fixme if signing fails, this seems to return the original text without warning. Is there a reason for this?
 102      */
 103     public function createMagicEnv($text, $actor, $class='MagicEnvelope')
 104     {
 105         $magic_env = new $class();
 106
 107         $user = User::staticGet('id', $actor->id);
 108         if ($user->id) {
 109             // Use local key
 110             $magickey = Magicsig::staticGet('user_id', $user->id);
 111             if (!$magickey) {
 112                 // No keypair yet, let's generate one.
 113                 $magickey = new Magicsig();
 114                 $magickey->generate($user->id);
 115             }
 116         } else {
 117             // TRANS: Exception.
 118             throw new Exception(_m('Salmon invalid actor for signing.'));
 119         }
 120
 121         try {
 122             $env = $magic_env->signMessage($text, 'application/atom+xml', $magickey->toString());
 123         } catch (Exception $e) {
 124             return $text;
 125         }
 126         return $magic_env->toXML($env);
 127     }
 128
 129     /**
 130      * Check if the given magic envelope is well-formed and correctly signed.
 131      * Needs to have network access to fetch public keys over the web.
 132      *
 133      * Side effects: exceptions and caching updates may occur during network
 134      * fetches.
 135      *
 136      * @param string $text XML fragment of magic envelope
 137      * @return boolean
 138      *
 139      * @throws Exception on bad profile input or key generation problems
 140      * @fixme could hit fatal errors or spew output on invalid XML
 141      */
 142     public function verifyMagicEnv($text)
 143     {
 144         $magic_env = new MagicEnvelope();
 145
 146         $env = $magic_env->parse($text);
 147
 148         return $magic_env->verify($env);
 149     }
 150 }