Back to index

lightning-sunbird  0.9+nobinonly
nsIPK11Token.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 2001
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Terry Hayes <thayes@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 
00042 [scriptable, uuid(51191434-1dd2-11b2-a17c-e49c4e99a4e3)]
00043 interface nsIPK11Token : nsISupports
00044 {
00045   const long ASK_EVERY_TIME  = -1;
00046   const long ASK_FIRST_TIME  =  0;
00047   const long ASK_EXPIRE_TIME =  1;
00048 
00049   /*
00050    * The name of the token
00051    */
00052   readonly attribute wstring tokenName;
00053 
00054   readonly attribute wstring tokenLabel;
00055   readonly attribute wstring tokenManID;
00056   readonly attribute wstring tokenHWVersion;
00057   readonly attribute wstring tokenFWVersion;
00058   readonly attribute wstring tokenSerialNumber;
00059 
00060   /*
00061    * Login information
00062    */
00063   boolean isLoggedIn();
00064   void login(in boolean force);
00065   void logoutSimple();
00066   void logoutAndDropAuthenticatedResources();
00067 
00068   /*
00069    * Reset password
00070    */
00071   void reset();
00072 
00073   /*
00074    * Password information
00075    */
00076   readonly attribute long minimumPasswordLength;
00077   readonly attribute boolean needsUserInit;
00078   boolean checkPassword(in wstring password);  /* Logs out if check fails */
00079   void initPassword(in wstring initialPassword);
00080   void changePassword(in wstring oldPassword, in wstring newPassword);
00081   long getAskPasswordTimes();
00082   long getAskPasswordTimeout();
00083   void setAskPasswordDefaults([const] in long askTimes, [const] in long timeout);
00084 
00085   /*
00086    * Other attributes
00087    */
00088   boolean isHardwareToken();
00089   boolean needsLogin();
00090   boolean isFriendly();
00091 };
00092