iaik.pkcs.pkcs11.wrapper.CK_TOKEN_INFO Maven / Gradle / Ivy

Go to download
// Copyright (c) 2002 Graz University of Technology. All rights reserved.
// License IAIK PKCS#11 Wrapper License.

package iaik.pkcs.pkcs11.wrapper;

/**
 * class CK_TOKEN_INFO provides information about a token.
 * 
 * PKCS#11 structure:
 *
 * 
 * typedef struct CK_TOKEN_INFO {
 *   CK_UTF8CHAR  label[32];
 *   CK_UTF8CHAR  manufacturerID[32];
 *   CK_UTF8CHAR  model[16];
 *   CK_CHAR      serialNumber[16];
 *   CK_FLAGS     flags;
 *   CK_ULONG     ulMaxSessionCount;
 *   CK_ULONG     ulSessionCount;
 *   CK_ULONG     ulMaxRwSessionCount;
 *   CK_ULONG     ulRwSessionCount;
 *   CK_ULONG     ulMaxPinLen;
 *   CK_ULONG     ulMinPinLen;
 *   CK_ULONG     ulTotalPublicMemory;
 *   CK_ULONG     ulFreePublicMemory;
 *   CK_ULONG     ulTotalPrivateMemory;
 *   CK_ULONG     ulFreePrivateMemory;
 *   CK_VERSION   hardwareVersion;
 *   CK_VERSION   firmwareVersion;
 *   CK_CHAR      utcTime[16];
 * } CK_TOKEN_INFO;
 *
 * 
 *
 * @author Karl Scheibelhofer (SIC)
 * @author Martin Schläffer (SIC)
 */
public class CK_TOKEN_INFO {

  /*
   * label, manufacturerID, and model have been changed from CK_CHAR to CK_UTF8CHAR for v2.11.
   */
  /**
   * must be blank padded and only the first 32 chars will be used
   * 
   * PKCS#11:
   *
   * 
   *   CK_UTF8CHAR label[32];
   * 
   */
  public char[] label; /* blank padded */

  /**
   * must be blank padded and only the first 32 chars will be used
   * 
   * PKCS#11:
   *
   * 
   *   CK_UTF8CHAR manufacturerID[32];
   * 
   */
  public char[] manufacturerID; /* blank padded */

  /**
   * must be blank padded and only the first 16 chars will be used
   * 
   * PKCS#11:
   *
   * 
   *   CK_UTF8CHAR model[16];
   * 
   */
  public char[] model; /* blank padded */

  /**
   * must be blank padded and only the first 16 chars will be used
   * 
   * PKCS#11:
   *
   * 
   *   CK_CHAR serialNumber[16];
   * 
   */
  public char[] serialNumber; /* blank padded */

  /**
   * PKCS#11:
   *
   *    * CK_FLAGS flags;
   * 
   */
  public long flags; /* see below */

  /*
   * ulMaxSessionCount, ulSessionCount, ulMaxRwSessionCount, ulRwSessionCount, ulMaxPinLen, and
   * ulMinPinLen have all been changed from CK_USHORT to CK_ULONG for v2.0
   */
  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulMaxSessionCount;
   * 
   */
  public long ulMaxSessionCount; /* max open sessions */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulSessionCount;
   * 
   */
  public long ulSessionCount; /* session now open */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulMaxRwSessionCount;
   * 
   */
  public long ulMaxRwSessionCount; /* max R/W sessions */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulRwSessionCount;
   * 
   */
  public long ulRwSessionCount; /* R/W session now open */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulMaxPinLen;
   * 
   */
  public long ulMaxPinLen; /* in bytes */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulMinPinLen;
   * 
   */
  public long ulMinPinLen; /* in bytes */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulTotalPublicMemory;
   * 
   */
  public long ulTotalPublicMemory; /* in bytes */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulFreePublicMemory;
   * 
   */
  public long ulFreePublicMemory; /* in bytes */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulTotalPrivateMemory;
   * 
   */
  public long ulTotalPrivateMemory; /* in bytes */

  /**
   * PKCS#11:
   *
   *    * CK_ULONG ulFreePrivateMemory;
   * 
   */
  public long ulFreePrivateMemory; /* in bytes */

  /*
   * hardwareVersion, firmwareVersion, and time are new for v2.0
   */
  /**
   * PKCS#11:
   *
   *    * CK_VERSION hardwareVersion;
   * 
   */
  public CK_VERSION hardwareVersion; /* version of hardware */

  /**
   * PKCS#11:
   *
   *    * CK_VERSION firmwareVersion;
   * 
   */
  public CK_VERSION firmwareVersion; /* version of firmware */

  /**
   * only the first 16 chars will be used PKCS#11:
   *
   *    *   CK_CHAR utcTime[16];
   * 
   */
  public char[] utcTime; /* time */

}