netwerk/base/public/nsISecretDecoderRing.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   thayes@netscape.com
  24  *   bryner@brianryner.com
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41
  42 /**
  43  * Buffer type - for storing 8-bit octet values.
  44  */
  45 [ptr] native buffer(unsigned char);
  46
  47 [scriptable, uuid(0EC80360-075C-11d4-9FD4-00C04F1B83D8)]
  48 interface nsISecretDecoderRing: nsISupports {
  49
  50   /**
  51    * Encrypt a buffer - callable only from C++.
  52    *
  53    * @return The length of the data in the output buffer.
  54    */
  55   [noscript] long encrypt(in buffer data, in long dataLen, out buffer result);
  56
  57   /**
  58    * Decrypt a buffer - callable only from C++.
  59    *
  60    * @return The length of the data in the output buffer.
  61    */
  62   [noscript] long decrypt(in buffer data, in long dataLen, out buffer result);
  63
  64   /**
  65    * Encrypt nul-terminated string to BASE64 output.
  66    */
  67   string encryptString(in string text);
  68
  69   /**
  70    * Decrypt BASE64 input to nul-terminated string output.  There is
  71    * no check for embedded nul values in the decrypted output.
  72    */
  73   string decryptString(in string crypt);
  74
  75   /**
  76    * Prompt the user to change the password on the SDR key.
  77    */
  78   void changePassword();
  79
  80   /**
  81    * Logout of the security device that protects the SDR key.
  82    */
  83   void logout();
  84
  85   /**
  86    * Logout of the security device that protects the SDR key and tear
  87    * down authenticated objects.
  88    */
  89   void logoutAndTeardown();
  90 };
  91
  92 /**
  93  * Configuration interface for the Secret Decoder Ring
  94  *  - this interface allows setting the window that will be
  95  *    used as parent for dialog windows (such as password prompts)
  96  */
  97 [scriptable, uuid(01D8C0F0-0CCC-11d4-9FDD-000064657374)]
  98 interface nsISecretDecoderRingConfig: nsISupports {
  99   void setWindow(in nsISupports w);
 100 };