Back to index

lightning-sunbird  0.9+nobinonly
nsICRLManager.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 interface nsIURI;
00042 interface nsIArray;
00043 interface nsICRLInfo;
00044 
00045 %{C++
00046 #define NS_CRLMANAGER_CID { /* 5b256c10-22d8-4109-af92-1253035e9fcb */ \
00047     0x5b256c10, \
00048     0x22d8, \
00049     0x4109, \
00050     {0xaf, 0x92, 0x12, 0x53, 0x03, 0x5e, 0x9f, 0xcb} \
00051   }
00052 
00053 #define NS_CRLMANAGER_CONTRACTID "@mozilla.org/security/crlmanager;1"
00054 %}
00055 
00056 
00057 
00058 [scriptable, uuid(486755db-627a-4678-a21b-f6a63bb9c56a)]
00059 interface nsICRLManager : nsISupports {
00060   /*
00061    * importCrl
00062    *
00063    * Import a CRL into the certificate database.
00064    */
00065   void importCrl([array, size_is(length)] in octet data,
00066                  in unsigned long length,
00067                  in nsIURI uri,
00068                  in unsigned long type,
00069                  in boolean doSilentDownload,
00070                  in wstring crlKey);
00071 
00072   
00073   /*
00074    * update crl from url
00075    * update an existing crl from the last fetched url. Needed for the update
00076    * button in crl manager
00077    */
00078   boolean updateCRLFromURL(in wstring url, in wstring key);
00079 
00080 
00081   /*
00082    * getCrls
00083    *
00084    * Get a list of Crl entries in the DB.
00085    */
00086   nsIArray getCrls();
00087 
00088   /*
00089    * deleteCrl
00090    *
00091    * Delete the crl.
00092    */
00093   void deleteCrl(in unsigned long crlIndex);
00094 
00095 
00096   /* This would reschedule the autoupdate of crls with auto update enable.
00097    * Most likely to be called when update prefs are changed, or when a crl
00098    * is deleted, etc. However, this might not be the most relevant place for
00099    * this api, but unless we have a separate crl handler object....
00100    */
00101   void rescheduleCRLAutoUpdate();
00102 
00103 
00104   const unsigned long TYPE_AUTOUPDATE_TIME_BASED     = 1;
00105   const unsigned long TYPE_AUTOUPDATE_FREQ_BASED     = 2;
00106 
00107   wstring computeNextAutoUpdateTime(in nsICRLInfo info,
00108                                     in unsigned long autoUpdateType,
00109                                     in double noOfDays);
00110 };