*/
public function getKeyPair(Profile $profile, $discovery=false) {
$magicsig = Magicsig::getKV('user_id', $profile->id);
+
if ($discovery && !$magicsig instanceof Magicsig) {
- $signer_uri = $profile->getUri();
- if (empty($signer_uri)) {
- throw new ServerException(sprintf('Profile missing URI (id==%d)', $profile->id));
- }
- $magicsig = $this->discoverKeyPair($signer_uri);
- // discoverKeyPair should've thrown exception if it failed
- assert($magicsig instanceof Magicsig);
+ // Throws exception on failure, but does not try to _load_ the keypair string.
+ $keypair = $this->discoverKeyPair($profile);
+
+ $magicsig = new Magicsig();
+ $magicsig->user_id = $profile->id;
+ $magicsig->importKeys($keypair);
+ // save the public key for this profile in our database.
+ // TODO: If the profile generates a new key remotely, we must be able to replace
+ // this (of course after callback-verification).
+ $magicsig->insert();
} elseif (!$magicsig instanceof Magicsig) { // No discovery request, so we'll give up.
throw new ServerException(sprintf('No public key found for profile (id==%d)', $profile->id));
}
+
+ assert($magicsig->publicKey instanceof Crypt_RSA);
+
return $magicsig;
}
/**
- * Get the Salmon keypair from a URI, uses XRD Discovery etc.
+ * Get the Salmon keypair from a URI, uses XRD Discovery etc. Reasonably
+ * you'll only get the public key ;)
+ *
+ * The string will (hopefully) be formatted as described in Magicsig specification:
+ * https://salmon-protocol.googlecode.com/svn/trunk/draft-panzer-magicsig-01.html#anchor13
*
- * @return Magicsig with loaded keypair
+ * @return string formatted as Magicsig keypair
*/
- public function discoverKeyPair($signer_uri)
+ public function discoverKeyPair(Profile $profile)
{
+ $signer_uri = $profile->getUri();
+ if (empty($signer_uri)) {
+ throw new ServerException(sprintf('Profile missing URI (id==%d)', $profile->id));
+ }
+
$disco = new Discovery();
// Throws exception on lookup problems
throw new Exception(_m('Incorrectly formatted public key element.'));
}
- $magicsig = Magicsig::fromString($keypair);
- if (!$magicsig instanceof Magicsig) {
- common_debug('Salmon error: unable to parse keypair: '.var_export($keypair,true));
- // TRANS: Exception when public key was properly formatted but not parsable.
- throw new ServerException(_m('Retrieved Salmon keypair could not be parsed.'));
- }
-
- return $magicsig;
+ return $keypair;
}
/**
* @param <type> $text
* @param <type> $mimetype
* @param Magicsig $magicsig Magicsig with private key available.
+ *
* @return MagicEnvelope object with all properties set
+ *
+ * @throws Exception of various kinds on signing failure
*/
- public static function signMessage($text, $mimetype, Magicsig $magicsig)
+ public function signMessage($text, $mimetype, Magicsig $magicsig)
{
- $magic_env = new MagicEnvelope();
+ assert($magicsig->privateKey instanceof Crypt_RSA);
// Prepare text and metadata for signing
- $magic_env->data = Magicsig::base64_url_encode($text);
- $magic_env->data_type = $mimetype;
- $magic_env->encoding = self::ENCODING;
- $magic_env->alg = $magicsig->getName();
- // Get the actual signature
- $magic_env->sig = $magicsig->sign($magic_env->signingText());
+ $this->data = Magicsig::base64_url_encode($text);
+ $this->data_type = $mimetype;
+ $this->encoding = self::ENCODING;
+ $this->alg = $magicsig->getName();
- return $magic_env;
+ // Get the actual signature
+ $this->sig = $magicsig->sign($this->signingText());
}
/**
$xs->element('me:data', array('type' => $this->data_type), $this->data);
$xs->element('me:encoding', null, $this->encoding);
$xs->element('me:alg', null, $this->alg);
- $xs->element('me:sig', null, $this->sig);
+ $xs->element('me:sig', null, $this->getSignature());
$xs->elementEnd('me:env');
$string = $xs->getString();
- common_debug('MagicEnvelope XML: ' . $string);
return $string;
}
$prov->appendChild($enc);
$alg = $dom->createElementNS(self::NS, 'me:alg', $this->alg);
$prov->appendChild($alg);
- $sig = $dom->createElementNS(self::NS, 'me:sig', $this->sig);
+ $sig = $dom->createElementNS(self::NS, 'me:sig', $this->getSignature());
$prov->appendChild($sig);
$dom->documentElement->appendChild($prov);
return $dom;
}
+ public function getSignature()
+ {
+ return $this->sig;
+ }
+
/**
* Find the author URI referenced in the payload Atom entry.
*
*
* Details of failure conditions are dumped to output log and not exposed to caller.
*
- * @param Profile $profile optional profile used to get locally cached public signature key.
+ * @param Profile $profile profile used to get locally cached public signature key
+ * or if necessary perform discovery on.
*
* @return boolean
*/
- public function verify(Profile $profile=null)
+ public function verify(Profile $profile)
{
if ($this->alg != 'RSA-SHA256') {
- common_log(LOG_DEBUG, "Salmon error: bad algorithm");
+ common_debug("Salmon error: bad algorithm");
return false;
}
if ($this->encoding != self::ENCODING) {
- common_log(LOG_DEBUG, "Salmon error: bad encoding");
+ common_debug("Salmon error: bad encoding");
return false;
}
try {
- if ($profile instanceof Profile) {
- $magicsig = $this->getKeyPair($profile, true); // Do discovery too if necessary
- } else {
- $signer_uri = $this->getAuthorUri();
- $magicsig = $this->discoverKeyPair($signer_uri);
- }
+ $magicsig = $this->getKeyPair($profile, true); // Do discovery too if necessary
} catch (Exception $e) {
- common_log(LOG_DEBUG, "Salmon error: ".$e->getMessage());
+ common_debug("Salmon error: ".$e->getMessage());
return false;
}
- return $magicsig->verify($this->signingText(), $this->sig);
+ return $magicsig->verify($this->signingText(), $this->getSignature());
}
/**
* on some systems.
*
* @param string $text XML fragment to sign, assumed to be Atom
- * @param Profile $actor Profile of a local user to use as signer
+ * @param User $user User who cryptographically signs $text
*
- * @return string XML string representation of magic envelope
+ * @return MagicEnvelope object complete with signature
*
* @throws Exception on bad profile input or key generation problems
- * @fixme if signing fails, this seems to return the original text without warning. Is there a reason for this?
*/
- public static function signForProfile($text, Profile $actor)
+ public static function signAsUser($text, User $user)
{
- // We only generate keys for our local users of course, so let
- // getUser throw an exception if the profile is not local.
- $user = $actor->getUser();
-
// Find already stored key
$magicsig = Magicsig::getKV('user_id', $user->id);
if (!$magicsig instanceof Magicsig) {
- // No keypair yet, let's generate one.
- $magicsig = new Magicsig();
- $magicsig->generate($user->id);
+ $magicsig = Magicsig::generate($user);
}
+ assert($magicsig instanceof Magicsig);
+ assert($magicsig->privateKey instanceof Crypt_RSA);
- $magic_env = self::signMessage($text, 'application/atom+xml', $magicsig);
-
- assert($magic_env instanceof MagicEnvelope);
+ $magic_env = new MagicEnvelope();
+ $magic_env->signMessage($text, 'application/atom+xml', $magicsig);
return $magic_env;
}
projects / quix0rs-gnu-social.git / blobdiff