/security/manager/ssl/public/nsIRecentBadCertsService.idl

 1/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 2 *
 3 * ***** BEGIN LICENSE BLOCK *****
 4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 5 *
 6 * The contents of this file are subject to the Mozilla Public License Version
 7 * 1.1 (the "License"); you may not use this file except in compliance with
 8 * the License. You may obtain a copy of the License at
 9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is mozilla.org code.
17 *
18 * The Initial Developer of the Original Code is
19 * Red Hat, Inc.
20 * Portions created by the Initial Developer are Copyright (C) 2006
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 *   Kai Engert <kengert@redhat.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40#include "nsISupports.idl"
41
42interface nsIArray;
43interface nsIX509Cert;
44interface nsISSLStatus;
45
46%{C++
47#define NS_RECENTBADCERTS_CONTRACTID "@mozilla.org/security/recentbadcerts;1"
48%}
49
50/**
51 * This represents a global list of recently seen bad ssl status
52 * including the bad cert.
53 * The implementation will decide how many entries it will hold,
54 * the number is expected to be small.
55 */
56[scriptable, uuid(a5ae8b05-a76e-408f-b0ba-02a831265749)]
57interface nsIRecentBadCertsService : nsISupports {
58
59  /**
60   *  Retrieve the recently seen bad ssl status for the given hostname:port.
61   *  If no SSL cert was recently seen for the given hostname:port, return null.
62   *  If a good cert was seen for the given hostname:port, return null.
63   *
64   *  @param aHostNameWithPort The host:port whose entry should be tested
65   *  @return null or a recently seen bad ssl status with cert
66   */
67  nsISSLStatus getRecentBadCert(in AString aHostNameWithPort);
68
69  /**
70   *  A bad certificate that should be remembered by the service.
71   *  Will be added as the most recently seen cert.
72   *  The service may forget older entries to make room for the new one.
73   *
74   *  @param aHostNameWithPort The host:port whose entry should be tested
75   *  @param aCert The bad ssl status with certificate
76   */
77  void addBadCert(in AString aHostNameWithPort,
78                  in nsISSLStatus aStatus);
79};