From 1197829d87732e1cae18ee64eefe44f0a6cb391f Mon Sep 17 00:00:00 2001

From: Ingo Franzki <ifranzki@linux.ibm.com>

Date: Wed, 16 Feb 2022 10:09:10 +0100

Subject: [PATCH 12/34] EP11: Update EP11 host library header files

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>

---

 usr/lib/ep11_stdll/ep11.h    | 1345 +++++++++++++++++++++++++-----------------

 usr/lib/ep11_stdll/ep11adm.h |  305 +++-------

 2 files changed, 911 insertions(+), 739 deletions(-)

diff --git a/usr/lib/ep11_stdll/ep11.h b/usr/lib/ep11_stdll/ep11.h

index cd4f11e5..c68dd045 100644

--- a/usr/lib/ep11_stdll/ep11.h

+++ b/usr/lib/ep11_stdll/ep11.h

@@ -16,7 +16,6 @@

 #if !defined(XCP_H__)

 #define XCP_H__

-

 #if !defined(CKR_OK)

 #include "pkcs11.h"

 #endif

@@ -25,195 +24,10 @@

 #error "We need 64-bit <stdint.h> types, please include before this file."

 #endif

-// SHA224 etc. are additions to PKCS#11 2.20

-// remove these if host migrates beyond 2.20 as base minimum [unlikely]

-//

-#if !defined(CKM_SHA224)

-#define  CKM_SHA224                 0x00000255

-#define  CKM_SHA224_HMAC            0x00000256

-#define  CKM_SHA224_HMAC_GENERAL    0x00000257

-#define  CKM_SHA224_RSA_PKCS        0x00000046

-#define  CKM_SHA224_RSA_PKCS_PSS    0x00000047

-#define  CKM_SHA224_KEY_DERIVATION  0x00000396

-#define  CKM_AES_CTR                0x00001086

-#define  CKG_MGF1_SHA224            0x00000005

-#endif

-

-#if !defined(CKM_AES_CMAC)

-#define  CKM_AES_CMAC               0x0000108a

-#endif

-

-#if !defined(CKM_DES3_CMAC)

-#define  CKM_DES3_CMAC              0x00000138

-#endif

-

-

-

-// max value for target groups

-#define XCP_MAX_GRPIDX 1024u

-//

-// current version of XCP_Module structure; host code SHOULD interact with

-// future/past versions, MUST be set by caller before using m_add_module()

-// valid versions are all >0

-#define  XCP_MOD_VERSION  2

 //

 // used for internal and external paths/addresses

 #define  MAX_FNAME_CHARS  256

-// macros for setting/checking and removing domains from (tgt.mgmt) domain mask

-#define XCPTGTMASK_SET_DOM(mask, domain)      \

-                           mask[((domain)/8)] |=   (1 << (7-(domain)%8))

-#define XCPTGTMASK_DOM_IS_SET(mask, domain)   \

-                           (mask[((domain)/8)] &   (1 << (7-(domain)%8)))

-#define XCPTGTMASK_CLR_DOM(mask, domain)      \

-                           mask[((domain)/8)] &=  ~(1 << (7-(domain)%8))

-//

-

-

-/* flags that can be set for the target tokens

- *

- * This flags are domain specific and are therefore called domain flags

- *

- * start of flags is >16 Bit. Max value for domains is 0xFF. Should be enough

- * room for extensions

- */

-#define XCP_TGTFL_WCAP     0x10000000  /* Capture wire request in output buffer

-                                        * without sending it to the module

-                                        */

-#define XCP_TGTFL_WCAP_SQ  0x20000000  /* Size query: Return size of request in

-                                        * output buffer length field

-                                        */

-#define XCP_TGTFL_SET_SCMD 0x40000000  /* Protected key special command: Set the

-                                        * special command flag in the CPRB

-                                        * header

-                                        */

-#define XCP_TGTFL_API_CHKD 0x80000000  /* supported API version of modules in

-                                        * target (group) has been checked

-                                        */

-

-#define XCP_TGTFL_NO_LOCK 0x01000000   /* target token ignores sequential locks

-                                        * for target probing

-                                        */

-#define XCP_TGTFL_SET_ACMD 0x04000000  /* add CPRB admin flag to CPRB header */

-

-//--------------------------------------

-// socket use only

-#define  XCP_MAXCONNECTIONS 64       /* max value for active connections */

-#define  XCP_MAX_PORT     0xffff

-

-// hostname and port value fore one module

-typedef struct XCP_ModuleSocket {

-	char host[ MAX_FNAME_CHARS +1 ];

-	uint32_t port;

-} *XCP_ModuleSocket_t ;

-

-

-//--------------------------------------

-// diagnostics use only

-typedef struct XCP_DomainPerf {

-	/* perf value of last request per domain

-	 *

-	 * At the moment unused

-	 * */

-	unsigned int lastperf[ 256 ];

-} *XCP_DomainPerf_t;

-

-

-//--------------------------------------

-// subsequent communications with a module MAY skip infrastructure-specific

-// fields, such as a query not reporting device handles etc., even if they

-// have been supplied originally when the module has been registered.

-//

-typedef struct XCP_Module {

-	uint32_t version;     /* >0 for supported API versions */

-

-	uint64_t flags;       /* see XCP_Module_Flags */

-

-	uint32_t domains;     /* max# addressable under this module;

-	                       * cached from OS

-	                       *

-	                       * when callers set domains  to 0, the library

-	                       * returns the module-claimed domain count.

-	                       */

-

-	unsigned char domainmask[ 256 /8 ];

-	                      /* higher domain# through future flags (none

-	                       * currently defined) which would add things

-	                       * like 'FLAG_256_1023' etc. at the same time,

-	                       * we would add domainmask2[] etc.

-	                       * corresponding new fields.

-	                       *

-	                       * new fields would then store mask for

-	                       * domains 256+ etc.

-	                       *

-	                       * domain #0 is bit x80 of 1st byte,

-	                       * #255 is bit 0x01 of last byte.

-	                       */

-

-		// when a domainmask is supplied, with bits set beyond

-		// what the module supports, the bitmask is trimmed to

-		// the supported range, but this is NOT reported as an

-		// error, unless XCP_MFL_STRICT is also supplied.

-		//

-		// without XCP_MFL_STRICT, callers are expected to check

-		// at least the returned domain count.

-

-			/* used only when flags includes XCP_MFL_SOCKET */

-	struct XCP_ModuleSocket socket;

-

-			/* used when system exposes modules through an

-			 * array of transparent pipes, or similar abstraction

-			 * (such as mainframe AP Queues, or other Linux

-			 * 'device-minor' numbers etc.). Interpretation

-			 * is platform-dependent.

-			 *

-			 * used only when flags includes XCP_MFL_MODULE

-			 */

-	uint32_t module_nr;

-

-			/* used by systems which associate devices with

-			 * device handles/structs/etc. persistent state.

-			 * opaque pointer, usually a const pointer to

-			 * such aux structs, MAY be stored here.

-			 *

-			 * interpretation is platform-dependent.

-			 * used only when flags includes XCP_MFL_MHANDLE

-			 */

-	void *mhandle;

-			/* diagnostics use only, when XCP_MFL_PERF is set */

-	struct XCP_DomainPerf perf;

-	//-----  end of v1 fields  -------------------------------------------

-

-	uint32_t api; /* module api version*/

-	//-----  end of v2 fields  -------------------------------------------

-} *XCP_Module_t ;

-

-typedef enum {

-	XCP_MFL_SOCKET       =    1,  /* backend is socket-attached */

-	XCP_MFL_MODULE       =    2,  /* backends identified in

-	                                 array-of-modules */

-	XCP_MFL_MHANDLE      =    4,  /* backends uses 'module handle' field */

-	XCP_MFL_PERF         =    8,  /* performance statistics collected

-	                               * for this module, see .perf

-	                               */

-	XCP_MFL_VIRTUAL      = 0x10,  /* queried 'target' is a load-balancer,

-	                               * other other group.

-	                               */

-	XCP_MFL_STRICT       = 0x20,  /* enable aggressive error checking,

-	                               * see field descriptions for effect

-	                               */

-	XCP_MFL_PROBE        = 0x40,  /* send api query to module, to check if

-	                               * target(s) can be used

-	                               */

-	XCP_MFL_ALW_TGT_ADD  = 0x80,  /* Allows it to use a target in any

-	                               * functional and admin call without

-	                               * adding it beforehand with

-	                               * m_add_module()

-	                               */

-	XCP_MFL_MAX          = 0xff

-} XCP_Module_Flags;

-

-

 // Error Values for functions that do not return CK_RV

 // general errors

 #define XCP_OK                   0  /* function successful

@@ -282,17 +96,15 @@ typedef enum {

                                       * flag is not active

                                       */

-

 /*--------------------------------------------------------------------------*/

 #define XCP_COMMON_PUBLIC_H__

-#define  XCP_API_VERSION  0x071d     /* major[8] minor[8] */

+#define  XCP_API_VERSION  0x0810     /* major[8] minor[8] */

 #define  XCP_API_ORDINAL  0x0004

                        /* increment this with every major/minor change */

-#define  XCP_HOST_API_VER  0x030100   /* major[8] minor[8] fixpack[8] */

-#define  XCP_RPM_VERSION   XCP_HOST_API_VER   /* deprecated */

+#define  XCP_HOST_API_VER  0x040000   /* major[8] minor[8] fixpack[8] */

 /* HSM connection information; not for PKCS11 user consumption */

 #define  XCP_HSM_AGENT_ID   0x5843           /* ASCII "XC" */

@@ -375,6 +187,8 @@ typedef enum {

 #define  CKR_IBM_TARGET_INVALID     (CKR_VENDOR_DEFINED +0x10030)

+#define  CKR_IBM_PQC_PARAMS_NOT_SUPPORTED  (CKR_VENDOR_DEFINED +0x10031)

+

 // Error returned if internal verification of crypto engines fail

 #define CKR_IBM_ERROR_STATE       (CKR_VENDOR_DEFINED +0x10101)

@@ -445,12 +259,18 @@ typedef enum {

 #define  CKM_IBM_ED448_SHA3                 (CKM_VENDOR_DEFINED +0x1001f)

+// round counts are passed as mechanism parameters

+#define  CKM_IBM_SIPHASH                    (CKM_VENDOR_DEFINED +0x10021)

+

+

 // these need a strength definition

 // XCP_U32_VALUE_BITS/CKA_VALUE_BITS would be sufficient; strength->K/L mapping

 //

 // umbrella mech for PQC/Crystals variants

 #define  CKM_IBM_DILITHIUM                  (CKM_VENDOR_DEFINED +0x10023)

          // ^^^ sign/verify plus keygen only

+#define  CKM_IBM_KYBER                      (CKM_VENDOR_DEFINED +0x10024)

+         // ^^^ en/decrypt, keygen, key transport, and (hybrid) key derivation

 // SHA-3 HMAC variants

 #define  CKM_IBM_SHA3_224_HMAC              (CKM_VENDOR_DEFINED +0x10025)

@@ -481,6 +301,10 @@ typedef enum {

 	ECSG_IBM_MAX                = ECSG_IBM_ECSDSA_COMPR_MULTI,

 } ECSG_Var_t;

+#define  CK_IBM_ECSG_IBM_ECSDSA_S256             ECSG_IBM_ECSDSA_S256

+#define  CK_IBM_ECSG_IBM_ECDSA_COMPR_MULTI_S256  ECSG_IBM_ECDSA_COMPR_MULTI_S256

+#define  CK_IBM_ECSG_IBM_MAX                     ECSG_IBM_MAX

+

 //---  transport additions  --------------------------------------------------

 #define  CKM_IBM_CLEARKEY_TRANSPORT    (CKM_VENDOR_DEFINED +0x20001)

@@ -565,6 +389,12 @@ typedef enum {

 #define CKA_IBM_PQC_PARAMS (CKA_VENDOR_DEFINED +0x1000e)

+// query or modify login session an object is bound to

+#define  CKA_IBM_LOGIN_SESSION     (CKA_VENDOR_DEFINED +0x1000f)

+

+// query MAC'd spki from a private key

+#define  CKA_IBM_MACED_PUBLIC_KEY_INFO (CKA_VENDOR_DEFINED +0x20002)

+

 // direct access to attributes' wire form

 // parameters of this attribute, if it's the only one present,

 // inserted verbatim into request package

@@ -574,6 +404,9 @@ typedef enum {

 // matches the key type constant for clear key Dilithium with ICSF

 #define CKK_IBM_PQC_DILITHIUM      (CKK_VENDOR_DEFINED +0x10023)

+#define CKK_IBM_PQC_KYBER          (CKK_VENDOR_DEFINED +0x10024)

+

+

@@ -583,6 +416,7 @@ typedef enum {

 #define XCP_MOD_ERROR_STATE_SYSTEST_CMD       0x00000003

 #define XCP_MOD_ERROR_STATE_TRNG_HEALTH       0x00000004

+

 /*----------------------------------------------------------------------------

  * sizes related to blobs and host-visible entities

  *

@@ -599,10 +433,10 @@ typedef enum {

 #define  XCP_BLOBCLRATTR_BYTES           8  /* clear blob attr's bytecount    */

                                             /* keep in sync with objattr_t    */

 #define  XCP_BLOBCLRMODE_BYTES           8  /* clear blob modefield bytecount */

-#define  MOD_WRAP_BLOCKSIZE ((size_t) (128 /8)) /* blob crypt block bytecount */

+#define  XCP_WRAP_BLOCKSIZE ((size_t) (128 /8)) /* blob crypt block bytecount */

 #define  XCP_MACKEY_BYTES       (256 /8)   /* derived from controlling WK     */

 //

-#define  XCP_PIN_SALT_BYTES  MOD_WRAP_BLOCKSIZE

+#define  XCP_PIN_SALT_BYTES  XCP_WRAP_BLOCKSIZE

 #define  XCP_PINBLOB_BYTES  \

         (XCP_WK_BYTES +XCP_PIN_SALT_BYTES +XCP_HMAC_BYTES)

@@ -664,6 +498,18 @@ typedef enum {

 #define  XCP_BTC_VERSION  1

+#define  XCP_KYBER_KEM_VERSION  0

+

+#define  XCP_KYBER_KEM_MIN_WIRE_BYTES (4 + 4 + 4 + 4 + 4 + 4) /* version[32] ||

+                                                                 kdf[32]     ||

+                                                                 mode[32]    ||

+                                                                 cphr[32]    ||

+                                                                 shrd[32]    ||

+                                                                 blob  [32] */

+

+#define  XCP_KYBER_RAW_BYTES  32

+

+

 #define  XCP_ECDH1_DERIVE_MAX_PUBLIC_BYTES 1024 /* limit public data length to

                                                    reasonable number of bytes */

 //

@@ -698,6 +544,8 @@ typedef enum {

 	                             // related to the protected-key capability

 	                             // see also CKA_IBM_PROTKEY_* description

+	CKF_IBM_HW_DUAL_OA = 0x1000, // module supports dual OA certs/signatures

+	                             // see CK_IBM_XCPXQ_OA_CAP for more details

 } XCP_CK_EXTFLAGS_t;

 // these numbers apply to current version, subject to change

@@ -720,7 +568,7 @@ typedef enum {

 // ~arbitrary limit on acceptable admin. certificates

 // additional limits, such as transport-bytecount, may restrict further

-#define  XCP_CERT_MAX_BYTES   ((size_t) 4096)

+#define  XCP_CERT_MAX_BYTES   ((size_t) 12288) /* fits dil certs (8k + meta) */

 #define  XCP_CERTHASH_BYTES   (256/8)

       /* hash or SKI of public key, or other hash-identified things; SHA-256 */

@@ -734,6 +582,9 @@ typedef enum {

 		/* ^^^ increase this when policy moves beyond shorter curves */

 #define  XCP_MAX_EC_CURVE_BITS   521

+#define  XCP_MAX_DIL_SIGNATURE_BYTES 4668 /* max. length of dil. 8-7 sigs    */

+#define  XCP_MAX_SINFO_META_BYTES     100 /* signer info framework bytes     */

+

 /* bytecount of raw (generic) keys, not key schedules */

 #define  MOD_MAX_SYMMKEY_BYTES   256

@@ -754,8 +605,20 @@ typedef enum {

 	/* trailing big-endian bitcount field after UnwrapKey() checksum */

 /* card(OA) signature bytecount: SKI-identified SignerInfo,

-   4096-bit RSA signature, with SHA-256 hash */

-#define  XCP_RSPSIG_MAX_BYTES    (75 +4096/8)

+ * Non quantum safe: Must contain space for either:

+ *  - 4096-bit RSA signature, hash OID, encr. OID and SKI

+ *  - EC-P521 signature, hash OID, encr. OID and SKI

+ */

+#define  XCP_RSPSIG_RSA          (4096 / 8)

+#define  XCP_RSPSIG_MAX_BYTES    (XCP_MAX_SINFO_META_BYTES + \

+                                  XCP_RSPSIG_RSA)

+

+/* card(OA) signature bytecount: SKI-identified SignerInfo,

+ * Quantum safe: Must contain space for:

+ *  - DIL signature, hash OID, encr. OID and SKI

+ */

+#define  XCP_RSPSIG_QS_MAX_BYTES (XCP_MAX_SINFO_META_BYTES + \

+                                  XCP_MAX_DIL_SIGNATURE_BYTES)

 /* minimal padding for raw RSA enc/dec/sign/ver/wr/unwr

  * Used for example in CKM_RSA_PKCS. See RFC 2313 chapter 8 for a complete

@@ -772,84 +635,85 @@ typedef enum {

       /* indicates particular events, not generic event types/categories, */

       /* if bits in this region are non-zero                              */

-typedef enum {       /* functionality categories: keep within uint16_t range */

-	XCP_LOGEV_QUERY        =  0,

-	XCP_LOGEV_FUNCTION     =  1,

-	XCP_LOGEV_ADMFUNCTION  =  2,

-	XCP_LOGEV_STARTUP      =  3,

-	XCP_LOGEV_SHUTDOWN     =  4,

-	XCP_LOGEV_SELFTEST     =  5,

-	XCP_LOGEV_DOM_IMPORT   =  6, /* import sec-relevant data to domain */

-	XCP_LOGEV_DOM_EXPORT   =  7, /* export sec-relevant data from domain */

-	XCP_LOGEV_FAILURE      =  8,

-	XCP_LOGEV_GENERATE     =  9,

-	XCP_LOGEV_REMOVE       = 10,

-	XCP_LOGEV_SPECIFIC     = 11, /* obtain meaning elsewhere */

-	XCP_LOGEV_STATE_IMPORT = 12, /* import to card/multiple domains */

-	XCP_LOGEV_STATE_EXPORT = 13, /* export from card/multiple domains */

-	                             /* [after successful export] */

-	XCP_LOGEV_IMPORT       = 14, /* key/state import (UnwrapKey) */

-	                             /* fields provide more context */

-	XCP_LOGEV_EXPORT       = 15, /* key/state import (WrapKey) */

-	                             /* fields provide more context */

-

-	    /*---  specific events (any including XCP_LOGEV_SPEC)  ---------*/

-

-	XCP_LOGSPEV_TRANSACT_ZEROIZE  = XCP_LOGEV_SPEC +1,

-	                               /* zeroize card by transaction */

-

-	XCP_LOGSPEV_KAT_FAILED        = XCP_LOGEV_SPEC +2,

-	                               /* algorithm selftest failed */

-

-	XCP_LOGSPEV_KAT_COMPLETED     = XCP_LOGEV_SPEC +3,

-	                               /* algorithm selftests completed */

-	                               /* redundant; logged only to     */

-	                               /* provide specific event        */

-

-	XCP_LOGSPEV_EARLY_Q_START     = XCP_LOGEV_SPEC +4,

-	                               /* subsequent events were found  */

-	                               /* in the early-event queue.     */

-	                               /* their timestamps are only     */

-	                               /* approximate; order is correct */

-

-	XCP_LOGSPEV_EARLY_Q_END       = XCP_LOGEV_SPEC +5,

-				       /* early-even queue processing ends. */

-	                               /* subsequent events are through     */

-	                               /* regular auditing, with valid      */

-	                               /* timestamps and ordering.          */

-

-	XCP_LOGSPEV_AUDIT_NEWCHAIN    = XCP_LOGEV_SPEC +6,

-				       /* audit state is corrupted; removed. */

-				       /* generating new instance and start  */

-				       /* new chain as a replacement         */

-

-	XCP_LOGSPEV_TIMECHG_BEFORE    = XCP_LOGEV_SPEC +7,

-				       /* time change: original time */

-

-	XCP_LOGSPEV_TIMECHG_AFTER     = XCP_LOGEV_SPEC +8,

-				       /* time change: updated time  */

-

-	XCP_LOGSPEV_MODSTIMPORT_START = XCP_LOGEV_SPEC +9,

-	                               /* accepted full-state import */

-	                               /* data structure             */

-	                               /* starting update procedure  */

-

-	XCP_LOGSPEV_MODSTIMPORT_FAIL  = XCP_LOGEV_SPEC +10,

-	                               /* rejected import structure    */

-	                               /* issued after initial verify; */

-	                               /* indicates some inconsistency */

-	                               /* of import data structures    */

-

-	XCP_LOGSPEV_MODSTIMPORT_END   = XCP_LOGEV_SPEC +11,

-	                               /* completed full-state import */

-

-	XCP_LOGSPEV_MODSTEXPORT_START = XCP_LOGEV_SPEC +12,

-	                               /* started full-state export */

-	                               /* see also: XCP_LOGEV_STATE_EXPORT */

-

-	XCP_LOGSPEV_MODSTEXPORT_FAIL  = XCP_LOGEV_SPEC +13

-	                               /* full-state export did not complete */

-} XCP_LogEvent_t;

+                     /* functionality categories: keep within uint16_t range */

+#define  XCP_LOGEV_QUERY                0

+#define  XCP_LOGEV_FUNCTION             1

+#define  XCP_LOGEV_ADMFUNCTION          2

+#define  XCP_LOGEV_STARTUP              3

+#define  XCP_LOGEV_SHUTDOWN             4

+#define  XCP_LOGEV_SELFTEST             5

+#define  XCP_LOGEV_DOM_IMPORT           6 /* import sec-relevant data to */

+                                          /* domain */

+#define  XCP_LOGEV_DOM_EXPORT           7 /* export sec-relevant data from */

+                                          /* domain */

+#define  XCP_LOGEV_FAILURE              8

+#define  XCP_LOGEV_GENERATE             9

+#define  XCP_LOGEV_REMOVE              10

+#define  XCP_LOGEV_SPECIFIC            11 /* obtain meaning elsewhere */

+#define  XCP_LOGEV_STATE_IMPORT        12 /* import to card/multiple domains */

+#define  XCP_LOGEV_STATE_EXPORT        13 /* export from card/multiple */

+                                          /* domains */

+                                          /* [after successful export] */

+#define  XCP_LOGEV_IMPORT              14 /* key/state import (UnwrapKey) */

+                                          /* fields provide more context */

+#define  XCP_LOGEV_EXPORT              15 /* key/state import (WrapKey) */

+                                          /* fields provide more context */

+

+            /*---  specific events (any including XCP_LOGEV_SPEC)  ---------*/

+

+#define  XCP_LOGSPEV_TRANSACT_ZEROIZE  (XCP_LOGEV_SPEC +1)

+                                       /* zeroize card by transaction */

+

+#define  XCP_LOGSPEV_KAT_FAILED        (XCP_LOGEV_SPEC +2)

+                                       /* algorithm selftest failed */

+

+#define  XCP_LOGSPEV_KAT_COMPLETED     (XCP_LOGEV_SPEC +3)

+                                       /* algorithm selftests completed */

+                                       /* redundant; logged only to     */

+                                       /* provide specific event        */

+

+#define  XCP_LOGSPEV_EARLY_Q_START     (XCP_LOGEV_SPEC +4)

+                                       /* subsequent events were found  */

+                                       /* in the early-event queue.     */

+                                       /* their timestamps are only     */

+                                       /* approximate; order is correct */

+

+#define  XCP_LOGSPEV_EARLY_Q_END       (XCP_LOGEV_SPEC +5)

+                                       /* early-even queue processing ends. */

+                                       /* subsequent events are through     */

+                                       /* regular auditing, with valid      */

+                                       /* timestamps and ordering.          */

+

+#define  XCP_LOGSPEV_AUDIT_NEWCHAIN    (XCP_LOGEV_SPEC +6)

+                                       /* audit state is corrupted; removed. */

+                                       /* generating new instance and start  */

+                                       /* new chain as a replacement         */

+

+#define  XCP_LOGSPEV_TIMECHG_BEFORE    (XCP_LOGEV_SPEC +7)

+                                       /* time change: original time */

+

+#define  XCP_LOGSPEV_TIMECHG_AFTER     (XCP_LOGEV_SPEC +8)

+                                       /* time change: updated time  */

+

+#define  XCP_LOGSPEV_MODSTIMPORT_START (XCP_LOGEV_SPEC +9)

+                                       /* accepted full-state import */

+                                       /* data structure             */

+                                       /* starting update procedure  */

+

+#define  XCP_LOGSPEV_MODSTIMPORT_FAIL  (XCP_LOGEV_SPEC +10)

+                                       /* rejected import structure    */

+                                       /* issued after initial verify; */

+                                       /* indicates some inconsistency */

+                                       /* of import data structures    */

+

+#define  XCP_LOGSPEV_MODSTIMPORT_END   (XCP_LOGEV_SPEC +11)

+                                       /* completed full-state import */

+

+#define  XCP_LOGSPEV_MODSTEXPORT_START (XCP_LOGEV_SPEC +12)

+                                       /* started full-state export */

+                                       /* see also: XCP_LOGEV_STATE_EXPORT */

+

+#define  XCP_LOGSPEV_MODSTEXPORT_FAIL  (XCP_LOGEV_SPEC +13)

 typedef enum {

@@ -863,21 +727,19 @@ typedef enum {

 } XCP_LogSystem_t;

 /* bitmask of audit-event flags (mainly optional fields) */

-typedef enum {

-	XCP_LOGFL_WK_PRESENT         = 0x80000000,

-	XCP_LOGFL_COMPLIANCE_PRESENT = 0x40000000,  /* ...of hosting domain */

-	XCP_LOGFL_FINALWK_PRESENT    = 0x20000000,

-	XCP_LOGFL_KEYREC0_PRESENT    = 0x10000000,

-	XCP_LOGFL_KEYREC0_COMPL      = 0x08000000,  /* key0 compliance */

-	XCP_LOGFL_KEYREC1_PRESENT    = 0x04000000,

-	XCP_LOGFL_KEYREC2_PRESENT    = 0x02000000,

-	XCP_LOGFL_FINTIME_PRESENT    = 0x01000000,

-	XCP_LOGFL_SALT0_PRESENT      = 0x00800000,

-	XCP_LOGFL_SALT1_PRESENT      = 0x00400000,

-	XCP_LOGFL_SALT2_PRESENT      = 0x00200000,

-	XCP_LOGFL_REASON_PRESENT     = 0x00100000,

-	XCP_LOGFL_SEQPRF_PRESENT     = 0x00080000

-} XCP_LogFlags_t;

+#define  XCP_LOGFL_WK_PRESENT          0x80000000

+#define  XCP_LOGFL_COMPLIANCE_PRESENT  0x40000000  /* ...of hosting domain */

+#define  XCP_LOGFL_FINALWK_PRESENT     0x20000000

+#define  XCP_LOGFL_KEYREC0_PRESENT     0x10000000

+#define  XCP_LOGFL_KEYREC0_COMPL       0x08000000  /* key0 compliance */

+#define  XCP_LOGFL_KEYREC1_PRESENT     0x04000000

+#define  XCP_LOGFL_KEYREC2_PRESENT     0x02000000

+#define  XCP_LOGFL_FINTIME_PRESENT     0x01000000

+#define  XCP_LOGFL_SALT0_PRESENT       0x00800000

+#define  XCP_LOGFL_SALT1_PRESENT       0x00400000

+#define  XCP_LOGFL_SALT2_PRESENT       0x00200000

+#define  XCP_LOGFL_REASON_PRESENT      0x00100000

+#define  XCP_LOGFL_SEQPRF_PRESENT      0x00080000

@@ -885,16 +747,26 @@ typedef enum {

 typedef enum {

 	XCP_IMPRKEY_RSA_2048    = 0,

 	XCP_IMPRKEY_RSA_4096    = 1,

-	XCP_IMPRKEY_EC_P256     = 2,    /* EC, NIST P-256        */

-	XCP_IMPRKEY_EC_P521     = 3,    /* EC, NIST P-521        */

-	XCP_IMPRKEY_EC_BP256r   = 4,    /* EC, Brainpool BP-256r */

-	XCP_IMPRKEY_EC_BP320r   = 5,    /* EC, Brainpool BP-320r */

-	XCP_IMPRKEY_EC_BP512r   = 6,    /* EC, Brainpool BP-512r */

+	XCP_IMPRKEY_EC_P256     = 2,    /* EC, NIST P-256                     */

+	XCP_IMPRKEY_EC_P521     = 3,    /* EC, NIST P-521                     */

+	XCP_IMPRKEY_EC_BP256r   = 4,    /* EC, Brainpool BP-256r              */

+	XCP_IMPRKEY_EC_BP320r   = 5,    /* EC, Brainpool BP-320r              */

+	XCP_IMPRKEY_EC_BP512r   = 6,    /* EC, Brainpool BP-512r              */

 	XCP_IMPRKEY_RSA_3072    = 7,

-	XCP_IMPRKEY_MAX         = XCP_IMPRKEY_RSA_3072

+	XCP_IMPRKEY_EC_P521_TKE = 8,    /* EC, NIST P-521 (TKE propr. sign.)  */

+	XCP_IMPRKEY_MAX         = XCP_IMPRKEY_EC_P521_TKE

 } XCP_IMPRKEY_t;

+//---  OA key types  ----------------------------------------------------

+typedef enum {

+	XCP_OAKEY_RSA_4096      = 1,    /* RSA 4096 bit          */

+	XCP_OAKEY_ECC_P521      = 2,    /* ECC NIST P-521        */

+	XCP_OAKEY_DIL_87R2      = 3,    /* DIL 8-7 R2            */

+	XCP_OAKEY_MAX           = XCP_OAKEY_DIL_87R2

+} XCP_OAKEY_t;

+

+

 //---  retained key structures  ---------------------------

 // initial loading:

@@ -914,6 +786,7 @@ typedef struct CK_RETAINEDKEY_PARAMS {

+

 //---  operation categories (perf. measurement)  -----------------------------

 typedef enum {

 	XCP_OPCAT_ASYMM_SLOW   = 1,

@@ -951,7 +824,12 @@ typedef enum {

 	                               /* never be enabled due to      */

 	                               /* policy-minimum restrictions. */

-	CK_IBM_XCPQ_MAX         = CK_IBM_XCPQ_CP_BLACKLIST

+        CK_IBM_XCPQ_PQC_STRENGTHS

+                                = 14,  /* supported quantum safe levels*/

+                                       /* of strength                  */

+                                       /* see: XCP_PQCStrength_t       */

+

+	CK_IBM_XCPQ_MAX         = CK_IBM_XCPQ_PQC_STRENGTHS

 } CK_IBM_XCPQUERY_t;

 //---  module sub-query sub-types  --------------------------------------------

@@ -966,6 +844,9 @@ typedef enum {

 	                                 /* attributes bitmask           */

 	CK_IBM_XCPMSQ_ATTRS       =  6,  /* number of supported          */

 	                                 /* administrative attributes    */

+	CK_IBM_XCPMSQ_MOD_V2      =  7,  /* add version two fields to    */

+	                                 /* module query                 */

+	CK_IBM_XCPMSQ_MAX         =  CK_IBM_XCPMSQ_MOD_V2

 } CK_IBM_XCPMSUBQUERY_t;

 // byte sizes of queries which are not represented as structures

@@ -976,48 +857,34 @@ typedef enum {

 #define CK_IBM_XCP_HOSTQ_IDX  0xff000000  /* host-only queries index, min. */

-typedef enum {

-	CK_IBM_XCPHQ_COUNT    = 0xff000000, /* number of host-query indexes   */

-	                                    /* including this type itself     */

-	CK_IBM_XCPHQ_VERSION  = 0xff000001, /* host-specific package version  */

-	                                    /* such as packaging library ID   */

-	CK_IBM_XCPHQ_VERSION_HASH = 0xff000002,

-	                                    /* assumed-unique identifier of   */

-	                                    /* host code, such as version-    */

-	                                    /* identifying cryptographic hash */

-	                                    /* (library signature field...)   */

-	CK_IBM_XCPHQ_DIAGS    = 0xff000003, /* host code diagnostic level     */

-	                                    /* 0 if non-diagnostics host code */

-	CK_IBM_XCPHQ_HVERSION = 0xff000004, /* human-readable host version    */

-	                                    /* identification (recommended:   */

-	                                    /* UTF-8 string)                  */

-	CK_IBM_XCPHQ_TGT_MODE = 0xff000005, /* host targeting modes           */

-	                                    /* returns supported target modes */

-	                                    /* as bitmask                     */

-	                                    /* if not available only compat   */

-	                                    /* target mode is in use          */

-	                                    /* See CK_IBM_XCPHQ_TGT_MODES_t   */

-	CK_IBM_XCPHQ_ECDH_DERPRM = 0xff000006,

-	                                    /* ECDH DeriveKey parameter usage */

-	                                    /* is being enforced with hostlib */

-	                                    /* version                        */

-	                                    /**/

-	CK_IBM_XCPHQ_TOL_MODES = 0xff000007,/* check if toleration mode for   */

-	                                    /* key attribute checking is      */

-	                                    /* enabled                        */

-	                                    /* If it is, some attribute values*/

-	                                    /* are always set to correct      */

-	                                    /* values automatically -         */

-	CK__IBM_XCPHQ_MAX = CK_IBM_XCPHQ_TGT_MODE

-} CK_IBM_XCPHQUERY_t;

-

-#define CK_IBM_XCPHQ_ATTR_TOL_ENABLED  0x00000001

-                                         /* flag to indicate that toleration  */

-                                         /* mode for key attribute checking   */

-                                         /* is enabled i.e. all attributes    */

-                                         /* that may no longer be set CK_TRUE */

-                                         /* using a CEX8S HSM will be reset   */

-                                         /* to CK_FALSE automatically         */

+#define CK_IBM_XCPHQ_COUNT        0xff000000 /* number of host-query indexes  */

+                                             /* including this type itself    */

+#define CK_IBM_XCPHQ_VERSION      0xff000001 /* host-specific package version */

+                                             /* such as packaging library ID  */

+#define CK_IBM_XCPHQ_VERSION_HASH 0xff000002

+                                             /* assumed-unique identifier of  */

+                                             /* host code, such as version-   */

+                                             /* identifying cryptographic hash*/

+                                             /* (library signature field...)  */

+#define CK_IBM_XCPHQ_DIAGS        0xff000003 /* host code diagnostic level    */

+                                             /* 0 if non-diagnostics host code*/

+#define CK_IBM_XCPHQ_HVERSION     0xff000004 /* human-readable host version   */

+                                             /* identification (recommended:  */

+                                             /* UTF-8 string)                 */

+#define CK_IBM_XCPHQ_TGT_MODE     0xff000005 /* host targeting modes          */

+                                             /* returns supported target modes*/

+                                             /* as bitmask                    */