/*

 * COPYRIGHT (c) International Business Machines Corp. 2005-2017

 *

 * This program is provided under the terms of the Common Public License,

 * version 1.0 (CPL-1.0). Any use, reproduction or distribution for this

 * software constitutes recipient's acceptance of CPL-1.0 terms which can be

 * found in the file LICENSE file or at

 * https://opensource.org/licenses/cpl1.0.php

 */

#ifndef _MECH_LIST_TYPES_H

#define _MECH_LIST_TYPES_H

/**

 * These defines are copied over from the pkcs11types.h file found in

 * the openCryptoki package.

 */

/* An unsigned value, at least 32 bits long */

typedef unsigned long int CK_ULONG;

/* A signed value, the same size as a CK_ULONG */

/* CK_LONG is new for v2.0 */

typedef long int          CK_LONG;

/* At least 32 bits; each bit is a Boolean flag */

typedef CK_ULONG          CK_FLAGS;

/* CK_MECHANISM_TYPE is a value that identifies a mechanism

 * type */

typedef CK_ULONG          CK_MECHANISM_TYPE;

/* The following mechanism types are defined: */

#define CKM_RSA_PKCS_KEY_PAIR_GEN      0x00000000

#define CKM_RSA_PKCS                   0x00000001

#define CKM_RSA_9796                   0x00000002

#define CKM_RSA_X_509                  0x00000003

/* CKM_MD2_RSA_PKCS, CKM_MD5_RSA_PKCS, and CKM_SHA1_RSA_PKCS

 * are new for v2.0.  They are mechanisms which hash and sign */

#define CKM_MD2_RSA_PKCS               0x00000004

#define CKM_MD5_RSA_PKCS               0x00000005

#define CKM_SHA1_RSA_PKCS              0x00000006

/* The following are new for v2.11: */

#define CKM_RIPEMD128_RSA_PKCS         0x00000007

#define CKM_RIPEMD160_RSA_PKCS         0x00000008

#define CKM_RSA_PKCS_OAEP              0x00000009

#define CKM_RSA_X9_31_KEY_PAIR_GEN     0x0000000A

#define CKM_RSA_X9_31                  0x0000000B

#define CKM_SHA1_RSA_X9_31             0x0000000C

#define CKM_RSA_PKCS_PSS               0x0000000D

#define CKM_SHA1_RSA_PKCS_PSS          0x0000000E

#define CKM_DSA_KEY_PAIR_GEN           0x00000010

#define CKM_DSA                        0x00000011

#define CKM_DSA_SHA1                   0x00000012

#define CKM_DH_PKCS_KEY_PAIR_GEN       0x00000020

#define CKM_DH_PKCS_DERIVE             0x00000021

/* The following are new for v2.11 */

#define CKM_X9_42_DH_KEY_PAIR_GEN      0x00000030

#define CKM_X9_42_DH_DERIVE            0x00000031

#define CKM_X9_42_DH_HYBRID_DERIVE     0x00000032

#define CKM_X9_42_MQV_DERIVE           0x00000033

#define CKM_RC2_KEY_GEN                0x00000100

#define CKM_RC2_ECB                    0x00000101

#define CKM_RC2_CBC                    0x00000102

#define CKM_RC2_MAC                    0x00000103

/* CKM_RC2_MAC_GENERAL and CKM_RC2_CBC_PAD are new for v2.0 */

#define CKM_RC2_MAC_GENERAL            0x00000104

#define CKM_RC2_CBC_PAD                0x00000105

#define CKM_RC4_KEY_GEN                0x00000110

#define CKM_RC4                        0x00000111

#define CKM_DES_KEY_GEN                0x00000120

#define CKM_DES_ECB                    0x00000121

#define CKM_DES_CBC                    0x00000122

#define CKM_DES_MAC                    0x00000123

/* CKM_DES_MAC_GENERAL and CKM_DES_CBC_PAD are new for v2.0 */

#define CKM_DES_MAC_GENERAL            0x00000124

#define CKM_DES_CBC_PAD                0x00000125

#define CKM_DES2_KEY_GEN               0x00000130

#define CKM_DES3_KEY_GEN               0x00000131

#define CKM_DES3_ECB                   0x00000132

#define CKM_DES3_CBC                   0x00000133

#define CKM_DES3_MAC                   0x00000134

/* CKM_DES3_MAC_GENERAL, CKM_DES3_CBC_PAD, CKM_CDMF_KEY_GEN,

 * CKM_CDMF_ECB, CKM_CDMF_CBC, CKM_CDMF_MAC,

 * CKM_CDMF_MAC_GENERAL, and CKM_CDMF_CBC_PAD are new for v2.0 */

#define CKM_DES3_MAC_GENERAL           0x00000135

#define CKM_DES3_CBC_PAD               0x00000136

#define CKM_DES3_CMAC_GENERAL          0x00000137

#define CKM_DES3_CMAC                  0x00000138

#define CKM_CDMF_KEY_GEN               0x00000140

#define CKM_CDMF_ECB                   0x00000141

#define CKM_CDMF_CBC                   0x00000142

#define CKM_CDMF_MAC                   0x00000143

#define CKM_CDMF_MAC_GENERAL           0x00000144

#define CKM_CDMF_CBC_PAD               0x00000145

#define CKM_MD2                        0x00000200

/* CKM_MD2_HMAC and CKM_MD2_HMAC_GENERAL are new for v2.0 */

#define CKM_MD2_HMAC                   0x00000201

#define CKM_MD2_HMAC_GENERAL           0x00000202

#define CKM_MD5                        0x00000210

/* CKM_MD5_HMAC and CKM_MD5_HMAC_GENERAL are new for v2.0 */

#define CKM_MD5_HMAC                   0x00000211

#define CKM_MD5_HMAC_GENERAL           0x00000212

#define CKM_SHA_1                      0x00000220

/* CKM_SHA_1_HMAC and CKM_SHA_1_HMAC_GENERAL are new for v2.0 */

#define CKM_SHA_1_HMAC                 0x00000221

#define CKM_SHA_1_HMAC_GENERAL         0x00000222

/* The following are new for v2.11 */

#define CKM_RIPEMD128                  0x00000230

#define CKM_RIPEMD128_HMAC             0x00000231

#define CKM_RIPEMD128_HMAC_GENERAL     0x00000232

#define CKM_RIPEMD160                  0x00000240

#define CKM_RIPEMD160_HMAC             0x00000241

#define CKM_RIPEMD160_HMAC_GENERAL     0x00000242

/* All of the following mechanisms are new for v2.0 */

/* Note that CAST128 and CAST5 are the same algorithm */

#define CKM_CAST_KEY_GEN               0x00000300

#define CKM_CAST_ECB                   0x00000301

#define CKM_CAST_CBC                   0x00000302

#define CKM_CAST_MAC                   0x00000303

#define CKM_CAST_MAC_GENERAL           0x00000304

#define CKM_CAST_CBC_PAD               0x00000305

#define CKM_CAST3_KEY_GEN              0x00000310

#define CKM_CAST3_ECB                  0x00000311

#define CKM_CAST3_CBC                  0x00000312

#define CKM_CAST3_MAC                  0x00000313

#define CKM_CAST3_MAC_GENERAL          0x00000314

#define CKM_CAST3_CBC_PAD              0x00000315

#define CKM_CAST5_KEY_GEN              0x00000320

#define CKM_CAST128_KEY_GEN            0x00000320

#define CKM_CAST5_ECB                  0x00000321

#define CKM_CAST128_ECB                0x00000321

#define CKM_CAST5_CBC                  0x00000322

#define CKM_CAST128_CBC                0x00000322

#define CKM_CAST5_MAC                  0x00000323

#define CKM_CAST128_MAC                0x00000323

#define CKM_CAST5_MAC_GENERAL          0x00000324

#define CKM_CAST128_MAC_GENERAL        0x00000324

#define CKM_CAST5_CBC_PAD              0x00000325

#define CKM_CAST128_CBC_PAD            0x00000325

#define CKM_RC5_KEY_GEN                0x00000330

#define CKM_RC5_ECB                    0x00000331

#define CKM_RC5_CBC                    0x00000332

#define CKM_RC5_MAC                    0x00000333

#define CKM_RC5_MAC_GENERAL            0x00000334

#define CKM_RC5_CBC_PAD                0x00000335

#define CKM_IDEA_KEY_GEN               0x00000340

#define CKM_IDEA_ECB                   0x00000341

#define CKM_IDEA_CBC                   0x00000342

#define CKM_IDEA_MAC                   0x00000343

#define CKM_IDEA_MAC_GENERAL           0x00000344

#define CKM_IDEA_CBC_PAD               0x00000345

#define CKM_GENERIC_SECRET_KEY_GEN     0x00000350

#define CKM_CONCATENATE_BASE_AND_KEY   0x00000360

#define CKM_CONCATENATE_BASE_AND_DATA  0x00000362

#define CKM_CONCATENATE_DATA_AND_BASE  0x00000363

#define CKM_XOR_BASE_AND_DATA          0x00000364

#define CKM_EXTRACT_KEY_FROM_KEY       0x00000365

#define CKM_SSL3_PRE_MASTER_KEY_GEN    0x00000370

#define CKM_SSL3_MASTER_KEY_DERIVE     0x00000371

#define CKM_SSL3_KEY_AND_MAC_DERIVE    0x00000372

/* The following are new for v2.11 */

#define CKM_SSL3_MASTER_KEY_DERIVE_DH  0x00000373

#define CKM_TLS_PRE_MASTER_KEY_GEN     0x00000374

#define CKM_TLS_MASTER_KEY_DERIVE      0x00000375

#define CKM_TLS_KEY_AND_MAC_DERIVE     0x00000376

#define CKM_TLS_MASTER_KEY_DERIVE_DH   0x00000377

#define CKM_SSL3_MD5_MAC               0x00000380

#define CKM_SSL3_SHA1_MAC              0x00000381

#define CKM_MD5_KEY_DERIVATION         0x00000390

#define CKM_MD2_KEY_DERIVATION         0x00000391

#define CKM_SHA1_KEY_DERIVATION        0x00000392

#define CKM_PBE_MD2_DES_CBC            0x000003A0

#define CKM_PBE_MD5_DES_CBC            0x000003A1

#define CKM_PBE_MD5_CAST_CBC           0x000003A2

#define CKM_PBE_MD5_CAST3_CBC          0x000003A3

#define CKM_PBE_MD5_CAST5_CBC          0x000003A4

#define CKM_PBE_MD5_CAST128_CBC        0x000003A4

#define CKM_PBE_SHA1_CAST5_CBC         0x000003A5

#define CKM_PBE_SHA1_CAST128_CBC       0x000003A5

#define CKM_PBE_SHA1_RC4_128           0x000003A6

#define CKM_PBE_SHA1_RC4_40            0x000003A7

#define CKM_PBE_SHA1_DES3_EDE_CBC      0x000003A8

#define CKM_PBE_SHA1_DES2_EDE_CBC      0x000003A9

#define CKM_PBE_SHA1_RC2_128_CBC       0x000003AA

#define CKM_PBE_SHA1_RC2_40_CBC        0x000003AB

/* CKM_PKCS5_PBKD2 is new for v2.11 */

#define CKM_PKCS5_PBKD2                0x000003B0

#define CKM_PBA_SHA1_WITH_SHA1_HMAC    0x000003C0

#define CKM_KEY_WRAP_LYNKS             0x00000400

#define CKM_KEY_WRAP_SET_OAEP          0x00000401

/* Fortezza mechanisms */

#define CKM_SKIPJACK_KEY_GEN           0x00001000

#define CKM_SKIPJACK_ECB64             0x00001001

#define CKM_SKIPJACK_CBC64             0x00001002

#define CKM_SKIPJACK_OFB64             0x00001003

#define CKM_SKIPJACK_CFB64             0x00001004

#define CKM_SKIPJACK_CFB32             0x00001005

#define CKM_SKIPJACK_CFB16             0x00001006

#define CKM_SKIPJACK_CFB8              0x00001007

#define CKM_SKIPJACK_WRAP              0x00001008

#define CKM_SKIPJACK_PRIVATE_WRAP      0x00001009

#define CKM_SKIPJACK_RELAYX            0x0000100a

#define CKM_KEA_KEY_PAIR_GEN           0x00001010

#define CKM_KEA_KEY_DERIVE             0x00001011

#define CKM_FORTEZZA_TIMESTAMP         0x00001020

#define CKM_BATON_KEY_GEN              0x00001030

#define CKM_BATON_ECB128               0x00001031

#define CKM_BATON_ECB96                0x00001032

#define CKM_BATON_CBC128               0x00001033

#define CKM_BATON_COUNTER              0x00001034

#define CKM_BATON_SHUFFLE              0x00001035

#define CKM_BATON_WRAP                 0x00001036

/* CKM_ECDSA_KEY_PAIR_GEN is deprecated in v2.11,

 * CKM_EC_KEY_PAIR_GEN is preferred. */

#define CKM_ECDSA_KEY_PAIR_GEN         0x00001040

#define CKM_EC_KEY_PAIR_GEN            0x00001040

#define CKM_ECDSA                      0x00001041

#define CKM_ECDSA_SHA1                 0x00001042

/* The following are new for v2.3 */

#define CKM_ECDSA_SHA224               0x00001043

#define CKM_ECDSA_SHA256               0x00001044

#define CKM_ECDSA_SHA384               0x00001045

#define CKM_ECDSA_SHA512               0x00001046

/* The following are new for v2.11 */

#define CKM_ECDH1_DERIVE               0x00001050

#define CKM_ECDH1_COFACTOR_DERIVE      0x00001051

#define CKM_ECMQV_DERIVE               0x00001052

#define CKM_JUNIPER_KEY_GEN            0x00001060

#define CKM_JUNIPER_ECB128             0x00001061

#define CKM_JUNIPER_CBC128             0x00001062

#define CKM_JUNIPER_COUNTER            0x00001063

#define CKM_JUNIPER_SHUFFLE            0x00001064

#define CKM_JUNIPER_WRAP               0x00001065

#define CKM_FASTHASH                   0x00001070

/* The following are new for v2.11 */

#define CKM_AES_KEY_GEN                0x00001080

#define CKM_AES_ECB                    0x00001081

#define CKM_AES_CBC                    0x00001082

#define CKM_AES_MAC                    0x00001083

#define CKM_AES_MAC_GENERAL            0x00001084

#define CKM_AES_CBC_PAD                0x00001085

#define CKM_AES_CMAC_GENERAL           0x00001089

#define CKM_AES_CMAC                   0x0000108A

#define CKM_DSA_PARAMETER_GEN          0x00002000

#define CKM_DH_PKCS_PARAMETER_GEN      0x00002001

#define CKM_X9_42_DH_PARAMETER_GEN     0x00002002

#define CKM_VENDOR_DEFINED             0x80000000

#define CK_PTR *

typedef void        CK_PTR   CK_VOID_PTR;

typedef CK_VOID_PTR CK_PTR CK_VOID_PTR_PTR;

/* CK_MECHANISM is a structure that specifies a particular

 * mechanism  */

typedef struct CK_MECHANISM {

  CK_MECHANISM_TYPE mechanism;

  CK_VOID_PTR       pParameter;

  CK_ULONG          ulParameterLen;  /* in bytes */

} CK_MECHANISM;

typedef CK_MECHANISM CK_PTR CK_MECHANISM_PTR;

/* CK_MECHANISM_INFO provides information about a particular

 * mechanism */

typedef struct CK_MECHANISM_INFO {

    CK_ULONG    ulMinKeySize;

    CK_ULONG    ulMaxKeySize;

    CK_FLAGS    flags;

} CK_MECHANISM_INFO;

/* The flags are defined as follows:

 *      Bit Flag               Mask        Meaning */

#define CKF_HW                 0x00000001  /* performed by HW */

/* The flags CKF_ENCRYPT, CKF_DECRYPT, CKF_DIGEST, CKF_SIGN,

 * CKG_SIGN_RECOVER, CKF_VERIFY, CKF_VERIFY_RECOVER,

 * CKF_GENERATE, CKF_GENERATE_KEY_PAIR, CKF_WRAP, CKF_UNWRAP,

 * and CKF_DERIVE are new for v2.0.  They specify whether or not

 * a mechanism can be used for a particular task */

#define CKF_ENCRYPT            0x00000100

#define CKF_DECRYPT            0x00000200

#define CKF_DIGEST             0x00000400

#define CKF_SIGN               0x00000800

#define CKF_SIGN_RECOVER       0x00001000

#define CKF_VERIFY             0x00002000

#define CKF_VERIFY_RECOVER     0x00004000

#define CKF_GENERATE           0x00008000

#define CKF_GENERATE_KEY_PAIR  0x00010000

#define CKF_WRAP               0x00020000

#define CKF_UNWRAP             0x00040000

#define CKF_DERIVE             0x00080000

/* The following are new for v2.11 */

#define CKF_EC_F_P             0x00100000

#define CKF_EC_F_2M            0x00200000

#define CKF_EC_ECPARAMETERS    0x00400000

#define CKF_EC_NAMEDCURVE      0x00800000

#define CKF_EC_UNCOMPRESS      0x01000000

#define CKF_EC_COMPRESS        0x02000000

#define CKF_EXTENSION          0x80000000  /* FALSE for 2.01 */

typedef CK_MECHANISM_INFO CK_PTR CK_MECHANISM_INFO_PTR;

#define CKR_MECHANISM_INVALID                 0x00000070

#define CKR_MECHANISM_PARAM_INVALID           0x00000071

/* From common/host_defs.h in openCryptoki */

typedef struct _MECH_LIST_ELEMENT

{

   CK_MECHANISM_TYPE    mech_type;

   CK_MECHANISM_INFO    mech_info;

} MECH_LIST_ELEMENT;

struct mech_list;

struct mech_list {

  struct mech_list *next;

  MECH_LIST_ELEMENT element;

};

#endif