security/manager/ssl/nsIClientAuthDialogs.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6
   7 interface nsIArray;
   8 interface nsIInterfaceRequestor;
   9
  10 /**
  11  * Provides UI for SSL client-auth dialogs.
  12  */
  13 [scriptable, uuid(fa4c7520-1433-11d5-ba24-00108303b117)]
  14 interface nsIClientAuthDialogs : nsISupports
  15 {
  16   /**
  17    * Called when a user is asked to choose a certificate for client auth.
  18    *
  19    * @param hostname Hostname of the server.
  20    * @param port Port of the server.
  21    * @param organization Organization field of the server cert.
  22    * @param issuerOrg Organization field of the issuer cert of the server cert.
  23    * @param certList List of certificates the user can choose from.
  24    * @param selectedIndex Index of the cert in |certList| that the user chose.
  25    *                      Ignored if the return value is false.
  26    * @param rememberClientAuthCertificate Whether to remember selection.
  27    * @return true if a certificate was chosen. false if the user canceled.
  28    */
  29   [must_use]
  30   boolean chooseCertificate(in AUTF8String hostname,
  31                             in long port,
  32                             in AUTF8String organization,
  33                             in AUTF8String issuerOrg,
  34                             in nsIArray certList,
  35                             out unsigned long selectedIndex,
  36                             out boolean rememberClientAuthCertificate);
  37 };
  38
  39 %{C++
  40 #define NS_CLIENTAUTHDIALOGS_CONTRACTID "@mozilla.org/nsClientAuthDialogs;1"
  41 %}