Initial community commit

Src/nprt_plugin/gecko/1.8/win/idl/nsICertificateDialogs.idl

@@ -0,0 +1,132 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is
+ * Netscape Communications Corporation.
+ * Portions created by the Initial Developer are Copyright (C) 2001
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Terry Hayes <thayes@netscape.com>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+#include "nsISupports.idl"
+
+interface nsIInterfaceRequestor;
+interface nsIX509Cert;
+interface nsICRLInfo;
+
+/**
+ * Functions that implement user interface dialogs to manage certificates.
+ *
+ * @status FROZEN
+ */
+[scriptable, uuid(a03ca940-09be-11d5-ac5d-000064657374)]
+interface nsICertificateDialogs : nsISupports
+{
+  /**
+   *  UI shown when a user is asked to download a new CA cert.
+   *  Provides user with ability to choose trust settings for the cert.
+   *  Asks the user to grant permission to import the certificate.
+   *
+   *  @param ctx A user interface context.
+   *  @param cert The certificate that is about to get installed.
+   *  @param trust a bit mask of trust flags, 
+   *               see nsIX509CertDB for possible values.
+   *
+   *  @return true if the user allows to import the certificate.
+   */
+  boolean confirmDownloadCACert(in nsIInterfaceRequestor ctx, 
+                         in nsIX509Cert cert,
+                         out unsigned long trust);
+
+  /**
+   *  UI shown when a web site has delivered a CA certificate to
+   *  be imported, but the certificate is already contained in the
+   *  user's storage.
+   *
+   *  @param ctx A user interface context.
+   */
+  void notifyCACertExists(in nsIInterfaceRequestor ctx);
+
+  /**
+   *  UI shown when a user's personal certificate is going to be
+   *  exported to a backup file.
+   *  The implementation of this dialog should make sure 
+   *  to prompt the user to type the password twice in order to
+   *  confirm correct input.
+   *  The wording in the dialog should also motivate the user 
+   *  to enter a strong password.
+   *
+   *  @param ctx A user interface context.
+   *  @param password The password provided by the user.
+   *
+   *  @return false if the user requests to cancel.
+   */
+  boolean setPKCS12FilePassword(in nsIInterfaceRequestor ctx, 
+                                out AString password);
+
+  /**
+   *  UI shown when a user is about to restore a personal
+   *  certificate from a backup file.
+   *  The user is requested to enter the password
+   *  that was used in the past to protect that backup file.
+   *
+   *  @param ctx A user interface context.
+   *  @param password The password provided by the user.
+   *
+   *  @return false if the user requests to cancel.
+   */
+  boolean getPKCS12FilePassword(in nsIInterfaceRequestor ctx, 
+                                out AString password);
+
+  /**
+   *  UI shown when a certificate needs to be shown to the user.
+   *  The implementation should try to display as many attributes
+   *  as possible.
+   *
+   *  @param ctx A user interface context.
+   *  @param cert The certificate to be shown to the user.
+   */
+  void viewCert(in nsIInterfaceRequestor ctx, 
+                in nsIX509Cert cert);
+
+  /**
+   *  UI shown after a Certificate Revocation List (CRL) has been
+   *  successfully imported.
+   *
+   *  @param ctx A user interface context.
+   *  @param crl Information describing the CRL that was imported.
+   */
+  void crlImportStatusDialog(in nsIInterfaceRequestor ctx, 
+                             in nsICRLInfo crl);
+};
+
+%{C++
+#define NS_CERTIFICATEDIALOGS_CONTRACTID "@mozilla.org/nsCertificateDialogs;1"
+%}