/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * ***** 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"

[scriptable, uuid(51191434-1dd2-11b2-a17c-e49c4e99a4e3)]
interface nsIPK11Token : nsISupports
{
  const long ASK_EVERY_TIME  = -1;
  const long ASK_FIRST_TIME  =  0;
  const long ASK_EXPIRE_TIME =  1;

  /*
   * The name of the token
   */
  readonly attribute wstring tokenName;

  readonly attribute wstring tokenLabel;
  readonly attribute wstring tokenManID;
  readonly attribute wstring tokenHWVersion;
  readonly attribute wstring tokenFWVersion;
  readonly attribute wstring tokenSerialNumber;

  /*
   * Login information
   */
  boolean isLoggedIn();
  void login(in boolean force);
  void logoutSimple();
  void logoutAndDropAuthenticatedResources();

  /*
   * Reset password
   */
  void reset();

  /*
   * Password information
   */
  readonly attribute long minimumPasswordLength;
  readonly attribute boolean needsUserInit;
  boolean checkPassword(in wstring password);  /* Logs out if check fails */
  void initPassword(in wstring initialPassword);
  void changePassword(in wstring oldPassword, in wstring newPassword);
  long getAskPasswordTimes();
  long getAskPasswordTimeout();
  void setAskPasswordDefaults([const] in long askTimes, [const] in long timeout);

  /*
   * Other attributes
   */
  boolean isHardwareToken();
  boolean needsLogin();
  boolean isFriendly();
};