pkcs11constants.java

java 实现的签名方案

/* Copyright  (c) 2002 Graz University of Technology. All rights reserved.
 *
 * Redistribution and use in  source and binary forms, with or without 
 * modification, are permitted  provided that the following conditions are met:
 *
 * 1. Redistributions of  source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in  binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  
 * 3. The end-user documentation included with the redistribution, if any, must
 *    include the following acknowledgment:
 * 
 *    "This product includes software developed by IAIK of Graz University of
 *     Technology."
 * 
 *    Alternately, this acknowledgment may appear in the software itself, if 
 *    and wherever such third-party acknowledgments normally appear.
 *  
 * 4. The names "Graz University of Technology" and "IAIK of Graz University of
 *    Technology" must not be used to endorse or promote products derived from 
 *    this software without prior written permission.
 *  
 * 5. Products derived from this software may not be called 
 *    "IAIK PKCS Wrapper", nor may "IAIK" appear in their name, without prior 
 *    written permission of Graz University of Technology.
 *  
 *  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE LICENSOR BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 *  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 *  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY  OF SUCH DAMAGE.
 */

package iaik.pkcs.pkcs11.wrapper;



/**
 * This interface holds constants of the PKCS#11 v2.11 standard.
 * This is mainly the content of the 'pkcs11t.h' header file.
 *
 * Mapping of primitiv data types to Java types:
 * <pre>
 *   TRUE .......................................... true
 *   FALSE ......................................... false
 *   CK_BYTE ....................................... byte
 *   CK_CHAR ....................................... char
 *   CK_UTF8CHAR ................................... char
 *   CK_BBOOL ...................................... boolean
 *   CK_ULONG ...................................... long
 *   CK_LONG ....................................... long
 *   CK_FLAGS ...................................... long
 *   CK_NOTIFICATION ............................... long
 *   CK_SLOT_ID .................................... long
 *   CK_SESSION_HANDLE ............................. long
 *   CK_USER_TYPE .................................. long
 *   CK_SESSION_HANDLE ............................. long
 *   CK_STATE ...................................... long
 *   CK_OBJECT_HANDLE .............................. long
 *   CK_OBJECT_CLASS ............................... long
 *   CK_HW_FEATURE_TYPE ............................ long
 *   CK_KEY_TYPE ................................... long
 *   CK_CERTIFICATE_TYPE ........................... long
 *   CK_ATTRIBUTE_TYPE ............................. long
 *   CK_VOID_PTR ................................... Object[]
 *   CK_BYTE_PTR ................................... byte[]
 *   CK_CHAR_PTR ................................... char[]
 *   CK_UTF8CHAR_PTR ............................... char[]
 *   CK_MECHANISM_TYPE ............................. long
 *   CK_RV ......................................... long
 *   CK_RSA_PKCS_OAEP_MGF_TYPE ..................... long
 *   CK_RSA_PKCS_OAEP_SOURCE_TYPE .................. long
 *   CK_RC2_PARAMS ................................. long
 *   CK_MAC_GENERAL_PARAMS ......................... long
 *   CK_EXTRACT_PARAMS ............................. long
 *   CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE .... long
 *   CK_PKCS5_PBKDF2_SALT_SOURCE_TYPE .............. long
 *   CK_EC_KDF_TYPE ................................ long
 *   CK_X9_42_DH_KDF_TYPE .......................... long
 * </pre>
 *
 * @author <a href="mailto:[e-mail]"> Karl Scheibelhofer </a>
 * @version 1.0
 * @invariants
 */
public interface PKCS11Constants {

  public static final boolean TRUE = true;

  public static final boolean FALSE = false;

  public static final Object NULL_PTR = null;

  /* some special values for certain CK_ULONG variables */
  public static final long CK_UNAVAILABLE_INFORMATION = 4294967295L;
  public static final long CK_EFFECTIVELY_INFINITE = 0L;

  /* The following value is always invalid if used as a session */
  /* handle or object handle */
  public static final long CK_INVALID_HANDLE = 0L;

  /* CK_NOTIFICATION enumerates the types of notifications that
   * Cryptoki provides to an application */
  /* CK_NOTIFICATION has been changed from an enum to a CK_ULONG
   * for v2.0 */
  public static final long CKN_SURRENDER = 0L;

  /* flags: bit flags that provide capabilities of the slot
   *      Bit Flag              Mask        Meaning
   */
  public static final long CKF_TOKEN_PRESENT = 0x00000001L;
  public static final long CKF_REMOVABLE_DEVICE = 0x00000002L;
  public static final long CKF_HW_SLOT = 0x00000004L;

  /* The flags parameter is defined as follows:
   *      Bit Flag                    Mask        Meaning
   */
  /* has random # generator */
  public static final long  CKF_RNG                     = 0x00000001L;

  /* token is write-protected */
  public static final long  CKF_WRITE_PROTECTED         = 0x00000002L;

  /* user must login */
  public static final long  CKF_LOGIN_REQUIRED          = 0x00000004L;

  /* normal user's PIN is set */
  public static final long  CKF_USER_PIN_INITIALIZED    = 0x00000008L;

  /* CKF_RESTORE_KEY_NOT_NEEDED is new for v2.0.  If it is set,
   * that means that *every* time the state of cryptographic
   * operations of a session is successfully saved, all keys
   * needed to continue those operations are stored in the state */
  public static final long  CKF_RESTORE_KEY_NOT_NEEDED  = 0x00000020L;

  /* CKF_CLOCK_ON_TOKEN is new for v2.0.  If it is set, that means
   * that the token has some sort of clock.  The time on that
   * clock is returned in the token info structure */
  public static final long  CKF_CLOCK_ON_TOKEN          = 0x00000040L;

  /* CKF_PROTECTED_AUTHENTICATION_PATH is new for v2.0.  If it is
   * set, that means that there is some way for the user to login
   * without sending a PIN through the Cryptoki library itself */
  public static final long  CKF_PROTECTED_AUTHENTICATION_PATH = 0x00000100L;

  /* CKF_DUAL_CRYPTO_OPERATIONS is new for v2.0.  If it is true,
   * that means that a single session with the token can perform
   * dual simultaneous cryptographic operations (digest and
   * encrypt; decrypt and digest; sign and encrypt; and decrypt
   * and sign) */
  public static final long  CKF_DUAL_CRYPTO_OPERATIONS  = 0x00000200L;

  /* CKF_TOKEN_INITIALIZED if new for v2.10. If it is true, the
   * token has been initialized using C_InitializeToken or an
   * equivalent mechanism outside the scope of PKCS #11.
   * Calling C_InitializeToken when this flag is set will cause
   * the token to be reinitialized. */
  public static final long  CKF_TOKEN_INITIALIZED       = 0x00000400L;

  /* CKF_SECONDARY_AUTHENTICATION if new for v2.10. If it is
   * true, the token supports secondary authentication for
   * private key objects. */
  public static final long  CKF_SECONDARY_AUTHENTICATION  = 0x00000800L;

  /* CKF_USER_PIN_COUNT_LOW if new for v2.10. If it is true, an
   * incorrect user login PIN has been entered at least once
   * since the last successful authentication. */
  public static final long  CKF_USER_PIN_COUNT_LOW       = 0x00010000L;

  /* CKF_USER_PIN_FINAL_TRY if new for v2.10. If it is true,
   * supplying an incorrect user PIN will it to become locked. */
  public static final long  CKF_USER_PIN_FINAL_TRY       = 0x00020000L;

  /* CKF_USER_PIN_LOCKED if new for v2.10. If it is true, the
   * user PIN has been locked. User login to the token is not
   * possible. */
  public static final long  CKF_USER_PIN_LOCKED          = 0x00040000L;

  /* CKF_USER_PIN_TO_BE_CHANGED if new for v2.10. If it is true,
   * the user PIN value is the default value set by token
   * initialization or manufacturing. */
  public static final long  CKF_USER_PIN_TO_BE_CHANGED   = 0x00080000L;

  /* CKF_SO_PIN_COUNT_LOW if new for v2.10. If it is true, an
   * incorrect SO login PIN has been entered at least once since
   * the last successful authentication. */
  public static final long  CKF_SO_PIN_COUNT_LOW         = 0x00100000L;

  /* CKF_SO_PIN_FINAL_TRY if new for v2.10. If it is true,
   * supplying an incorrect SO PIN will it to become locked. */
  public static final long  CKF_SO_PIN_FINAL_TRY         = 0x00200000L;

  /* CKF_SO_PIN_LOCKED if new for v2.10. If it is true, the SO
   * PIN has been locked. SO login to the token is not possible.
   */
  public static final long  CKF_SO_PIN_LOCKED            = 0x00400000L;

  /* CKF_SO_PIN_TO_BE_CHANGED if new for v2.10. If it is true,
   * the SO PIN value is the default value set by token
   * initialization or manufacturing. */
  public static final long  CKF_SO_PIN_TO_BE_CHANGED     = 0x00800000L;


  /* CK_USER_TYPE enumerates the types of Cryptoki users */
  /* CK_USER_TYPE has been changed from an enum to a CK_ULONG for
   * v2.0 */
  /* Security Officer */
  public static final long CKU_SO = 0L;
  /* Normal user */
  public static final long CKU_USER = 1L;

  /* CK_STATE enumerates the session states */
  /* CK_STATE has been changed from an enum to a CK_ULONG for
   * v2.0 */
  public static final long  CKS_RO_PUBLIC_SESSION = 0L;
  public static final long  CKS_RO_USER_FUNCTIONS = 1L;
  public static final long  CKS_RW_PUBLIC_SESSION = 2L;
  public static final long  CKS_RW_USER_FUNCTIONS = 3L;
  public static final long  CKS_RW_SO_FUNCTIONS   = 4L;


  /* The flags are defined in the following table:
   *      Bit Flag                Mask        Meaning
   */
  public static final long  CKF_RW_SESSION        = 0x00000002L;  /* session is r/w */
  public static final long  CKF_SERIAL_SESSION    = 0x00000004L;  /* no parallel */


  /* The following classes of objects are defined: */
  /* CKO_HW_FEATURE is new for v2.10 */
  /* CKO_DOMAIN_PARAMETERS is new for v2.11 */
  public static final long  CKO_DATA              = 0x00000000L;
  public static final long  CKO_CERTIFICATE       = 0x00000001L;
  public static final long  CKO_PUBLIC_KEY        = 0x00000002L;
  public static final long  CKO_PRIVATE_KEY       = 0x00000003L;
  public static final long  CKO_SECRET_KEY        = 0x00000004L;
  public static final long  CKO_HW_FEATURE        = 0x00000005L;
  public static final long  CKO_DOMAIN_PARAMETERS = 0x00000006L;
  public static final long  CKO_VENDOR_DEFINED    = 0x80000000L;


  /* The following hardware feature types are defined */
  public static final long  CKH_MONOTONIC_COUNTER = 0x00000001L;
  public static final long  CKH_CLOCK             = 0x00000002L;
  public static final long  CKH_VENDOR_DEFINED    = 0x80000000L;


  /* the following key types are defined: */