/security/manager/ssl/public/nsIPKCS11Slot.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 * Netscape Communications Corporation.
20 * Portions created by the Initial Developer are Copyright (C) 1998
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 *   Javier Delgadillo <javi@netscape.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 nsIPK11Token;
43
44[scriptable, uuid(c2d4f296-ee60-11d4-998b-00b0d02354a0)]
45interface nsIPKCS11Slot : nsISupports {
46
47  readonly attribute wstring name;
48  readonly attribute wstring desc;
49  readonly attribute wstring manID;
50  readonly attribute wstring HWVersion;
51  readonly attribute wstring FWVersion;
52
53  const unsigned long SLOT_DISABLED      = 0;
54  const unsigned long SLOT_NOT_PRESENT   = 1;
55  const unsigned long SLOT_UNINITIALIZED = 2;
56  const unsigned long SLOT_NOT_LOGGED_IN = 3;
57  const unsigned long SLOT_LOGGED_IN     = 4;
58  const unsigned long SLOT_READY         = 5;
59  readonly attribute unsigned long status;
60
61  /* This is really a workaround for now.  All of the "slot" functions
62   * (isTokenPresent(), etc.) are in nsIPK11Token.  For now, return the
63   * token and handle those things there.
64   */
65  nsIPK11Token getToken();
66
67  /* more fun with workarounds - we're referring to everything by token name */
68  readonly attribute wstring tokenName;
69
70};
71