Back to index

lightning-sunbird  0.9+nobinonly
nsISecretDecoderRing.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   thayes@netscape.com
00024  *   bryner@brianryner.com
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 
00042 /* Buffer type - for storing 8-bit octet values */
00043 [ptr] native buffer(unsigned char);
00044 
00045 [scriptable, uuid(0EC80360-075C-11d4-9FD4-00C04F1B83D8)]
00046 interface nsISecretDecoderRing: nsISupports {
00047 
00048   /* Encrypt a buffer - callable only from C++ */
00049   [noscript] long encrypt(in buffer data, in long dataLen, out buffer result);
00050 
00051   /* Decrypt a buffer - callable only from C++ */
00052   [noscript] long decrypt(in buffer data, in long dataLen, out buffer result);
00053 
00054   /* Encrypt nul-terminated string to BASE64 output */
00055   string encryptString(in string text);
00056 
00057   /* Decrypt BASE64 input to nul-terminated string output */
00058   /* There is no check for embedded nul values in the decrypted output */
00059   string decryptString(in string crypt);
00060 
00061   /* Prompt the user to change the password on the SDR key */
00062   void changePassword();
00063 
00064   /* Logout of the security device that protects the SDR key */
00065   void logout();
00066 
00067   /* Logout of the security device that protects the SDR key
00068      and tear down authenticated objects. */
00069   void logoutAndTeardown();
00070 };
00071 
00072 /*
00073  * Configuration interface for the Secret Decoder Ring
00074  *  - this interface allows setting the window that will be
00075  *    used as parent for dialog windows (such as password prompts)
00076  */
00077 [scriptable, uuid(01D8C0F0-0CCC-11d4-9FDD-000064657374)]
00078 interface nsISecretDecoderRingConfig: nsISupports {
00079   void setWindow(in nsISupports w);
00080 };
00081 
00082