security/manager/ssl/public/nsIDataSignatureVerifier.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the mozilla.org code.
  15  *
  16  * The Initial Developer of the Original Code is Ben Goodger.
  17  * Portions created by the Initial Developer are Copyright (C) 2004
  18  * the Initial Developer. All Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *  Dave Townsend <dtownsend@oxymoronical.com>
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37
  38 #include "nsISupports.idl"
  39
  40 /**
  41  * An interface for verifying that a given string of data was signed by the
  42  * private key matching the given public key.
  43  */
  44 [scriptable, uuid(0a84b3d5-6ba9-432d-89da-4fbd0b0f2aec)]
  45 interface nsIDataSignatureVerifier : nsISupports
  46 {
  47   /**
  48    * Verifies that the data matches the data that was used to generate the
  49    * signature.
  50    *
  51    * @param aData      The data to be tested.
  52    * @param aSignature The signature of the data, base64 encoded.
  53    * @param aPublicKey The public part of the key used for signing, DER encoded
  54    *                   then base64 encoded.
  55    * @returns true if the signature matches the data, false if not.
  56    */
  57   boolean verifyData(in ACString aData, in ACString aSignature, in ACString aPublicKey);
  58 };