/* ***************************************************************** *
 * Copyright 1998 International Business Machines Corporation. All   *
 * Rights Reserved.                                                  *
 *                                                                   *
 * Please read this carefully.  Your use of this reference           *
 * implementation of certain of the IETF public-key infrastructure   *
 * specifications ("Software") indicates your acceptance of the      *
 * following.  If you do not agree to the following, do not install  *
 * or use any of the Software.                                       *
 *                                                                   *
 * Permission to use, reproduce, distribute and create derivative    *
 * works from the Software ("Software Derivative Works"), and to     *
 * distribute such Software Derivative Works is hereby granted to    *
 * you by International Business Machines Corporation ("IBM").  This *
 * permission includes a license under the patents of IBM that are   *
 * necessarily infringed by your use of the Software as provided by  *
 * IBM.                                                              *
 *                                                                   *
 * IBM licenses the Software to you on an "AS IS" basis, without     *
 * warranty of any kind.  IBM HEREBY EXPRESSLY DISCLAIMS ALL         *
 * WARRANTIES OR CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING,   *
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF       *
 * MERCHANTABILITY, NON INFRINGEMENT AND FITNESS FOR A PARTICULAR    *
 * PURPOSE.  You are solely responsible for determining the          *
 * appropriateness of using this Software and assume all risks       *
 * associated with the use of this Software, including but not       *
 * limited to the risks of program errors, damage to or loss of      *
 * data, programs or equipment, and unavailability or interruption   *
 * of operations.                                                    *
 *                                                                   *
 * IBM WILL NOT BE LIABLE FOR ANY DIRECT DAMAGES OR FOR ANY SPECIAL, *
 * INCIDENTAL, OR  INDIRECT DAMAGES OR FOR ANY ECONOMIC              *
 * CONSEQUENTIAL DAMAGES (INCLUDING LOST PROFITS OR SAVINGS), EVEN   *
 * IF IBM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  IBM  *
 * will not be liable for the loss of, or damage to, your records or *
 * data, or any damages claimed by you based on a third party claim. *
 *                                                                   *
 * IBM wishes to obtain your feedback to assist in improving the     *
 * Software.  You grant IBM a world-wide, royalty-free right to use, *
 * copy, distribute, sublicense and prepare derivative works based   *
 * upon any feedback, including materials, error corrections,        *
 * Software Derivatives, enhancements, suggestions and the like that *
 * you provide to IBM relating to the Software (this does not        *
 * include products for which you charge a royalty and distribute to *
 * IBM under other terms and conditions).                            *
 *                                                                   *
 * You agree to distribute the Software and any Software Derivatives *
 * under a license agreement that: 1) is sufficient to notify all    *
 * licensees of the Software and Software Derivatives that IBM       *
 * assumes no liability for any claim that may arise regarding the   *
 * Software or Software Derivatives, and 2) that disclaims all       *
 * warranties, both express and implied, from IBM regarding the      *
 * Software and Software Derivatives.  (If you include this          *
 * Agreement with any distribution of the Software or Software       *
 * Derivatives you will have met this requirement.)  You agree that  *
 * you will not delete any copyright notices in the Software.        *
 *                                                                   *
 * This Agreement is the exclusive statement of your rights in the   *
 * Software as provided by IBM.   Except for the rights granted to   *
 * you in the second paragraph above, You are not granted any other  *
 * patent rights, including but not limited to the right to make     *
 * combinations of the Software with products that infringe IBM      *
 * patents. You agree to comply with all applicable laws and         *
 * regulations, including all export and import laws and regulation. *
 * This Agreement is governed by the laws of the State of New York.  *
 * This Agreement supersedes all other communications,               *
 * understandings or agreements we may have had prior to this        *
 * Agreement.                                                        *
 * ***************************************************************** */

#ifndef CYLINK_SPI_HPP
#define CYLINK_SPI_HPP

// Cryptographic Functions

CSSM_RETURN CSSMAPI DecryptData(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	const CSSM_DATA_PTR pCssmCipherBufs,
	uint32 CssmCipherBufCount,
	CSSM_DATA_PTR pCssmClearBufs,
	uint32 CssmClearBufCount,
	uint32 *pCssmBytesDecrypted,
	CSSM_DATA_PTR pCssmRemData);
CSSM_RETURN CSSMAPI DecryptDataInit(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI DecryptDataInitSymmetric(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI DecryptDataInitAsymmetric(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI DecryptDataUpdate(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_DATA_PTR pCssmCipherBufs,
	uint32 CssmCipherBufCount,
	CSSM_DATA_PTR pCssmClearBufs,
	uint32 CssmClearBufCount,
	uint32 *pCssmBytesDecrypted);
CSSM_RETURN CSSMAPI DecryptDataFinal(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	CSSM_DATA_PTR pCssmRemData);    

CSSM_RETURN CSSMAPI DigestData(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	const CSSM_DATA_PTR pCssmDataBufs,
	uint32 CssmDataBufCount,
	CSSM_DATA_PTR pCssmDigest);
CSSM_RETURN CSSMAPI DigestDataInit(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI DigestDataUpdate(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_DATA_PTR pCssmDataBufs,
	uint32 CssmDataBufCount);
CSSM_RETURN CSSMAPI DigestDataFinal(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	CSSM_DATA_PTR pCssmDigest);

CSSM_RETURN CSSMAPI EncryptData(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	const CSSM_DATA_PTR pCssmClearBufs,
	uint32 CssmClearBufCount,
	CSSM_DATA_PTR pCssmCipherBufs,
	uint32 CssmCipherBufCount,
	uint32 *pCssmBytesEncrypted,
	CSSM_DATA_PTR pCssmRemData);
CSSM_RETURN CSSMAPI EncryptDataInit(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI EncryptDataInitSymmetric(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI EncryptDataInitAsymmetric(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI EncryptDataUpdate(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_DATA_PTR pCssmClearBufs,
	uint32 CssmClearBufCount,
	CSSM_DATA_PTR pCssmCipherBufs,
	uint32 CssmCipherBufCount,
	uint32 *pCssmBytesEncrypted);
CSSM_RETURN CSSMAPI EncryptDataFinal(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	CSSM_DATA_PTR RemData);

CSSM_RETURN CSSMAPI GenerateKey(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	uint32 KeyUsage,
    uint32 KeyAttr,
	const CSSM_DATA_PTR KeyLabel,
	CSSM_KEY_PTR pCssmKey);	

CSSM_RETURN CSSMAPI GenerateKeyPair(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	uint32 CssmPublicKeyUsage,
    uint32 CssmPublicKeyAttr,
	const CSSM_DATA_PTR pCssmPublicKeyLabel,
	CSSM_KEY_PTR pCssmPublicKey,
	uint32 CssmPrivateKeyUsage,
    uint32 CssmPrivateKeyAttr,
	const CSSM_DATA_PTR pCssmPrivateKeyLabel,
	CSSM_KEY_PTR pCssmPrivateKey);

CSSM_RETURN CSSMAPI GenerateRSAKeyPair(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	CSSM_KEY_PTR pCssmPublicKey,
	CSSM_KEY_PTR pCssmPrivateKey,
	uint32		pubKeyAttr,
	uint32		pubKeyUsage,
	uint32		privKeyAttr,
	uint32		privKeyUsage);

CSSM_RETURN CSSMAPI GenerateDSAKeyPair(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	CSSM_KEY_PTR pCssmPublicKey,
	CSSM_KEY_PTR pCssmPrivateKey,
	CSSM_BOOL	 BSafeFormat,
	uint32		pubKeyAttr,
	uint32		pubKeyUsage,
	uint32		privKeyAttr,
	uint32		privKeyUsage);

CSSM_RETURN CSSMAPI GenerateDHKeyPair(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	uint32 CssmPublicKeyUsage,
    uint32 CssmPublicKeyAttr,
	const CSSM_DATA_PTR pCssmPublicKeyLabel,
	CSSM_KEY_PTR pCssmPublicKey,
	uint32 CssmPrivateKeyUsage,
    uint32 CssmPrivateKeyAttr,
	const CSSM_DATA_PTR pCssmPrivateKeyLabel,
	CSSM_KEY_PTR pCssmPrivateKey);				// THT001

CSSM_RETURN CSSMAPI GenerateAlgorithmParams(
	CSSM_CSP_HANDLE CssmCSPHandle,
    CSSM_CC_HANDLE CssmCCHandle,
    const CSSM_CONTEXT_PTR pCssmContext,
    uint32 CssmParamBits,
	CSSM_DATA_PTR pCssmParam);

CSSM_RETURN CSSMAPI DeriveKey(
	CSSM_CSP_HANDLE CssmCSPHandle,
    CSSM_CC_HANDLE CssmCCHandle,
    const CSSM_CONTEXT_PTR pCssmContext,
    const CSSM_KEY_PTR pCssmBaseKey,
    void* pCssmParam,
    uint32 CssmKeyUsage,
    uint32 CssmKeyAttr,
    const CSSM_DATA_PTR pCssmKeyLabel,
    CSSM_KEY_PTR pCssmDerivedKey);

CSSM_RETURN CSSMAPI GenerateRandom(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	CSSM_DATA_PTR pCssmRandomNumber);

CSSM_RETURN CSSMAPI Initialize(
	CSSM_MODULE_HANDLE Handle,
	uint32 VerMajor,
    uint32 VerMinor);
CSSM_RETURN CSSMAPI Terminate(CSSM_MODULE_HANDLE Handle);
CSSM_RETURN CSSMAPI EventNotify (
	CSSM_MODULE_HANDLE Handle,
    const CSSM_EVENT_TYPE Event,
    const uint32 Param);

CSSM_RETURN CSSMAPI SignData(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	const CSSM_DATA_PTR pCssmDataBufs,
	uint32 CssmDataBufCount,
	CSSM_DATA_PTR pCssmSignature);
CSSM_RETURN CSSMAPI SignDataInit(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);
CSSM_RETURN CSSMAPI SignDataUpdate(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_DATA_PTR pCssmDataBufs,
	uint32 CssmDataBufCount);
CSSM_RETURN CSSMAPI SignDataFinal(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	CSSM_DATA_PTR pCssmSignature);

CSSM_BOOL CSSMAPI VerifyData(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext,
	const CSSM_DATA_PTR pCssmDataBufs,
	uint32 CssmDataBufCount,
	const CSSM_DATA_PTR pCssmSignature);

CSSM_RETURN CSSMAPI VerifyDataInit(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_CONTEXT_PTR pCssmContext);

CSSM_RETURN CSSMAPI VerifyDataUpdate(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_DATA_PTR pCssmDataBufs,
	uint32 CssmDataBufCount);

CSSM_BOOL CSSMAPI VerifyDataFinal(
	CSSM_CSP_HANDLE CssmCSPHandle,
	CSSM_CC_HANDLE CssmCCHandle,
	const CSSM_DATA_PTR Signature);

CSSM_RETURN CSSMAPI QueryKeySizeInBits(
	CSSM_CSP_HANDLE CSPHandle,
	CSSM_CC_HANDLE CCHandle,
	CSSM_KEY_SIZE_PTR KeySize);

#endif //CYLINK_SPI_HPP
