Back to index

lightning-sunbird  0.9+nobinonly
nsIKeyModule.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Initial Developer of the Original Code is Google Inc.
00015  * Portions created by the Initial Developer are Copyright (C) 2006
00016  * the Initial Developer. All Rights Reserved.
00017  *
00018  * Contributor(s):
00019  *   Tony Chang <tc@google.com>
00020  *
00021  * Alternatively, the contents of this file may be used under the terms of
00022  * either the GNU General Public License Version 2 or later (the "GPL"), or
00023  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00024  * in which case the provisions of the GPL or the LGPL are applicable instead
00025  * of those above. If you wish to allow use of your version of this file only
00026  * under the terms of either the GPL or the LGPL, and not to allow others to
00027  * use your version of this file under the terms of the MPL, indicate your
00028  * decision by deleting the provisions above and replace them with the notice
00029  * and other provisions required by the GPL or the LGPL. If you do not delete
00030  * the provisions above, a recipient may use your version of this file under
00031  * the terms of any one of the MPL, the GPL or the LGPL.
00032  *
00033  * ***** END LICENSE BLOCK ***** */
00034 
00035 #include "nsISupports.idl"
00036 
00037 // An opaque key object.
00038 [scriptable, uuid(4b31f4ed-9424-4710-b946-79b7e33cf3a8)]
00039 interface nsIKeyObject : nsISupports
00040 {
00041   // Key types
00042   const short SYM_KEY = 1;
00043   const short PRIVATE_KEY = 2;
00044   const short PUBLIC_KEY = 3;
00045 
00046   // Algorithm types
00047   const short RC4 = 1;
00048   const short AES_CBC = 2;
00049 
00050   // aAlgorithm is an algorithm type
00051   // aKey is either a PK11SymKey, SECKEYPublicKey, or a SECKEYPrivateKey.
00052   // The nsIKeyObject will take ownership of the key and be responsible
00053   // for freeing the key memory when destroyed.
00054   [noscript] void initKey(in short aAlgorithm, in voidPtr aKey);
00055 
00056   // Return a pointer to the underlying key object
00057   [noscript] voidPtr getKeyObj();
00058 
00059   // Will return NS_ERROR_NOT_INITIALIZED if initKey hasn't been run
00060   short getType();
00061 };
00062 
00063 [scriptable, uuid(264eb54d-e20d-49a0-890c-1a5986ea81c4)]
00064 interface nsIKeyObjectFactory : nsISupports
00065 {
00066   nsIKeyObject lookupKeyByName(in ACString aName);
00067 
00068   nsIKeyObject unwrapKey(in short aAlgorithm,
00069                          [const, array, size_is(aWrappedKeyLen)] in octet aWrappedKey,
00070                          in unsigned long aWrappedKeyLen);
00071 
00072   // TODO: deriveKeyFrom*
00073 
00074 
00075   // DO NOT USE
00076   // This is not FIPS compliant and should not be used.
00077   nsIKeyObject keyFromString(in short aAlgorithm, in ACString aKey);
00078 };