windows-nt/Source/XPSP1/NT/ds/security/inc/crypttls.h
2020-09-26 16:20:57 +08:00

274 lines
7.9 KiB
C

//+-------------------------------------------------------------------------
// Microsoft Windows
//
// Copyright (C) Microsoft Corporation, 1996 - 1999
//
// File: crypttls.h
//
// Contents: Crypt Thread Local Storage (TLS) and OssGlobal "world"
// installation and allocation functions
//
// APIs:
// I_CryptAllocTls
// I_CryptFreeTls
// I_CryptGetTls
// I_CryptSetTls
// I_CryptDetachTls
// I_CryptInstallOssGlobal
// I_CryptUninstallOssGlobal
// I_CryptGetOssGlobal
//
// I_CryptInstallAsn1Module
// I_CryptUninstallAsn1Module
// I_CryptGetAsn1Encoder
// I_CryptGetAsn1Decoder
//
//
// History: 17-Nov-96 philh created
//--------------------------------------------------------------------------
#ifndef __CRYPTTLS_H__
#define __CRYPTTLS_H__
#include "msasn1.h"
#include "ossglobl.h"
#include <wincrypt.h>
#ifdef __cplusplus
extern "C" {
#endif
// Handle to an allocated Crypt TLS entry
typedef DWORD HCRYPTTLS;
// Handle to an installed OssGlobal table
typedef DWORD HCRYPTOSSGLOBAL;
// Pointer to OssGlobal. Returned by I_CryptGetOssGlobal()
typedef OssGlobal *POssGlobal;
// Handle to an installed Asn1 module
typedef DWORD HCRYPTASN1MODULE;
//+-------------------------------------------------------------------------
// Install a thread local storage entry and return a handle for future access.
//--------------------------------------------------------------------------
HCRYPTTLS
WINAPI
I_CryptAllocTls();
//+-------------------------------------------------------------------------
// Called at DLL_PROCESS_DETACH to free a thread local storage entry.
// Optionally, calls the callback for each thread having a non-NULL pvTls.
//--------------------------------------------------------------------------
BOOL
WINAPI
I_CryptFreeTls(
IN HCRYPTTLS hCryptTls,
IN OPTIONAL PFN_CRYPT_FREE pfnFree
);
//+-------------------------------------------------------------------------
// Get the thread specific pointer specified by the
// hCryptTls returned by I_CryptAllocTls().
//
// Returns NULL for an error or uninitialized pointer.
//--------------------------------------------------------------------------
void *
WINAPI
I_CryptGetTls(
IN HCRYPTTLS hCryptTls
);
//+-------------------------------------------------------------------------
// Set the thread specific pointer specified by the
// hCryptTls returned by I_CryptAllocTls().
//
// Returns FALSE for an invalid handle or unable to allocate memory.
//--------------------------------------------------------------------------
BOOL
WINAPI
I_CryptSetTls(
IN HCRYPTTLS hCryptTls,
IN void *pvTls
);
//+-------------------------------------------------------------------------
// Called at DLL_THREAD_DETACH to free the thread's
// TLS entry specified by the hCryptTls. Returns the thread specific pointer
// to be freed by the caller.
//
// Note, at DLL_PROCESS_DETACH, I_CryptFreeTls should be called instead.
//--------------------------------------------------------------------------
void *
WINAPI
I_CryptDetachTls(
IN HCRYPTTLS hCryptTls
);
//+-------------------------------------------------------------------------
// Install an OssGlobal entry and return a handle for future access.
//
// Each thread has its own copy of OssGlobal. Allocation and
// initialization are deferred until first referenced by the thread.
//
// The parameter, pvCtlTbl is passed to ossinit() to initialize the OssGlobal.
//
// I_CryptGetOssGlobal must be called with the handled returned by
// I_CryptInstallOssGlobal to get the thread specific OssGlobal.
//
// Currently, dwFlags and pvReserved aren't used and must be set to 0.
//--------------------------------------------------------------------------
HCRYPTOSSGLOBAL
WINAPI
I_CryptInstallOssGlobal(
IN void *pvCtlTbl,
IN DWORD dwFlags,
IN void *pvReserved
);
//+-------------------------------------------------------------------------
// Called at DLL_PROCESS_DETACH to uninstall an OssGlobal entry. Iterate
// through the threads and frees their allocated copy of OssGlobal.
//--------------------------------------------------------------------------
BOOL
WINAPI
I_CryptUninstallOssGlobal(
IN HCRYPTOSSGLOBAL hOssGlobal
);
//+-------------------------------------------------------------------------
// Get the thread specific pointer to the OssGlobal specified by the
// hOssGlobal returned by CryptInstallOssGlobal. If the
// OssGlobal doesn't exist, then, its allocated and initialized using
// the pvCtlTbl associated with hOssGlobal.
//--------------------------------------------------------------------------
POssGlobal
WINAPI
I_CryptGetOssGlobal(
IN HCRYPTOSSGLOBAL hOssGlobal
);
//+-------------------------------------------------------------------------
// Install an Asn1 module entry and return a handle for future access.
//
// Each thread has its own copy of the decoder and encoder associated
// with the Asn1 module. Creation is deferred until first referenced by
// the thread.
//
// I_CryptGetAsn1Encoder or I_CryptGetAsn1Decoder must be called with the
// handle returned by I_CryptInstallAsn1Module to get the thread specific
// Asn1 encoder or decoder.
//
// Currently, dwFlags and pvReserved aren't used and must be set to 0.
//--------------------------------------------------------------------------
#ifdef OSS_CRYPT_ASN1
__inline
HCRYPTASN1MODULE
WINAPI
I_CryptInstallAsn1Module(
IN void *pvCtlTbl,
IN DWORD dwFlags,
IN void *pvReserved
)
{
return (HCRYPTASN1MODULE) I_CryptInstallOssGlobal(
pvCtlTbl, dwFlags, pvReserved);
}
#else
HCRYPTASN1MODULE
WINAPI
I_CryptInstallAsn1Module(
IN ASN1module_t pMod,
IN DWORD dwFlags,
IN void *pvReserved
);
#endif // OSS_CRYPT_ASN1
//+-------------------------------------------------------------------------
// Called at DLL_PROCESS_DETACH to uninstall an hAsn1Module entry. Iterates
// through the threads and frees their created Asn1 encoders and decoders.
//--------------------------------------------------------------------------
#ifdef OSS_CRYPT_ASN1
__inline
BOOL
WINAPI
I_CryptUninstallAsn1Module(
IN HCRYPTASN1MODULE hAsn1Module
)
{
return I_CryptUninstallOssGlobal((HCRYPTOSSGLOBAL) hAsn1Module);
}
#else
BOOL
WINAPI
I_CryptUninstallAsn1Module(
IN HCRYPTASN1MODULE hAsn1Module
);
#endif // OSS_CRYPT_ASN1
//+-------------------------------------------------------------------------
// Get the thread specific pointer to the Asn1 encoder specified by the
// hAsn1Module returned by CryptInstallAsn1Module. If the
// encoder doesn't exist, then, its created using the Asn1 module
// associated with hAsn1Module.
//--------------------------------------------------------------------------
#ifdef OSS_CRYPT_ASN1
__inline
ASN1encoding_t
WINAPI
I_CryptGetAsn1Encoder(
IN HCRYPTASN1MODULE hAsn1Module
)
{
return (ASN1encoding_t) I_CryptGetOssGlobal((HCRYPTOSSGLOBAL) hAsn1Module);
}
#else
ASN1encoding_t
WINAPI
I_CryptGetAsn1Encoder(
IN HCRYPTASN1MODULE hAsn1Module
);
#endif // OSS_CRYPT_ASN1
//+-------------------------------------------------------------------------
// Get the thread specific pointer to the Asn1 decoder specified by the
// hAsn1Module returned by CryptInstallAsn1Module. If the
// decoder doesn't exist, then, its created using the Asn1 module
// associated with hAsn1Module.
//--------------------------------------------------------------------------
#ifdef OSS_CRYPT_ASN1
__inline
ASN1decoding_t
WINAPI
I_CryptGetAsn1Decoder(
IN HCRYPTASN1MODULE hAsn1Module
)
{
return (ASN1decoding_t) I_CryptGetOssGlobal((HCRYPTOSSGLOBAL) hAsn1Module);
}
#else
ASN1decoding_t
WINAPI
I_CryptGetAsn1Decoder(
IN HCRYPTASN1MODULE hAsn1Module
);
#endif // OSS_CRYPT_ASN1
#ifdef __cplusplus
} // Balance extern "C" above
#endif
#endif