/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

%{ C++
#include "mozilla/OriginAttributes.h"

#define NS_CLIENTAUTHREMEMBERSERVICE_CONTRACTID "@mozilla.org/security/clientAuthRememberService;1"
%}

interface nsIX509Cert;

[ref] native const_OriginAttributesRef(const mozilla::OriginAttributes);

[scriptable, uuid(e92825af-7e81-4b5c-b412-8e1dd36d14fe)]
interface nsIClientAuthRememberRecord : nsISupports
{
  readonly attribute ACString asciiHost;
  readonly attribute ACString dbKey;
  readonly attribute ACString entryKey;
};

[scriptable, uuid(1dbc6eb6-0972-4bdb-9dc4-acd0abf72369)]
interface nsIClientAuthRememberService : nsISupports
{
  cenum Duration : 8 {
    Once = 0,
    Permanent = 1,
    Session = 2,
  };

  [must_use]
  void forgetRememberedDecision(in ACString key);


  [must_use]
  Array<nsIClientAuthRememberRecord> getDecisions();


  /**
   * Remember the use of a particular client certificate for a particular
   * hostname in the context of a given OriginAttributes for the given
   * duration. The certificate may be null, indicating that no certificate was
   * used.
   */
  [must_use, noscript]
  void rememberDecision(in ACString aHostName,
                        in const_OriginAttributesRef aOriginAttributes,
                        in nsIX509Cert aClientCert,
                        in nsIClientAuthRememberService_Duration aDuration);

  [implicit_jscontext]
  void rememberDecisionScriptable(in ACString aHostName,
                                  in jsval originAttributes,
                                  in nsIX509Cert aClientCert,
                                  in nsIClientAuthRememberService_Duration aDuration);

  [must_use, noscript]
  boolean hasRememberedDecision(in ACString aHostName,
                                in const_OriginAttributesRef aOriginAttributes,
                                out ACString aCertDBKey);

  [implicit_jscontext]
  boolean hasRememberedDecisionScriptable(in ACString aHostName,
                                          in jsval originAttributes,
                                          out ACString aCertDBKey);

  [must_use]
  void clearRememberedDecisions();

  [implicit_jscontext]
  void deleteDecisionsByHost(in ACString aHostName,
                             in jsval aOriginAttributes);
};