Funzione CryptGetProvParam (wincrypt.h)

Sintassi

BOOL CryptGetProvParam(
  [in]      HCRYPTPROV hProv,
  [in]      DWORD      dwParam,
  [out]     BYTE       *pbData,
  [in, out] DWORD      *pdwDataLen,
  [in]      DWORD      dwFlags
);

Parametri

[in] hProv

Handle della destinazione CSP della query. Questo handle deve essere stato creato usando la funzione CryptAcquireContext .

[in] dwParam

Natura della query. Le query seguenti sono definite.

[out] pbData

Puntatore a un buffer per ricevere i dati. La forma di questi dati varia a seconda del valore di dwParam. Quando dwParam è impostato su PP_USE_HARDWARE_RNG, pbData deve essere impostato su NULL.

Questo parametro può essere NULL per impostare le dimensioni di queste informazioni per scopi di allocazione della memoria. Per altre informazioni, vedere Recupero dei dati di lunghezza sconosciuta.

[in, out] pdwDataLen

Puntatore a un valore DWORD che specifica le dimensioni, in byte, del buffer a cui punta il parametro pbData . Quando la funzione restituisce, il valore DWORD contiene il numero di byte archiviati o da archiviare nel buffer.

[in] dwFlags

Se dwParam è PP_KEYSET_SEC_DESCR, il descrittore di sicurezza nel contenitore di chiavi in cui vengono archiviate le chiavi viene recuperato. In questo caso, dwFlags viene usato per passare i flag di bit SECURITY_INFORMATION che indicano le informazioni di sicurezza richieste, come definito in Platform SDK. SECURITY_INFORMATION flag di bit possono essere combinati con un'operazione OR bit per bit.

I valori seguenti vengono definiti per l'uso con PP_KEYSET_SEC_DESCR.

I valori seguenti vengono definiti per l'uso con PP_ENUMALGS, PP_ENUMALGS_EX e PP_ENUMCONTAINERS.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero (TRUE).

Se la funzione ha esito negativo, il valore restituito è zero (FALSE). Per informazioni sugli errori estesi, chiamare GetLastError.

I codici di errore preceduti dall'NTE vengono generati dal CSP specifico usato. Di seguito sono riportati alcuni possibili codici di errore.

Commenti

Questa funzione non deve essere usata in un thread di un programma multithreading.

I valori seguenti vengono restituiti in pbData se dwParam è PP_IMPTYPE.

Il parametro dwFlags viene usato per passare i flag di bit SECURITY_INFORMATION che indicano le informazioni di sicurezza richieste. Il puntatore al descrittore di sicurezza viene restituito nel parametro pbData e la lunghezza del descrittore di sicurezza viene restituita nel parametro pdwDataLen . La sicurezza key-container viene gestita con SetFileSecurity e GetFileSecurity.

È possibile determinare la classe di un algoritmo enumerato con dwParam impostato su PP_ENUMALGS o PP_ENUMALGS_EX. Questa operazione può essere eseguita per visualizzare un elenco di algoritmi di crittografia supportati e ignorare il resto. La macro GET_ALG_CLASS(x) accetta un identificatore di algoritmo come argomento e restituisce un codice che indica la classe generale di tale algoritmo. I valori restituiti possibili includono:

• ALG_CLASS_DATA_ENCRYPT
• ALG_CLASS_HASH
• ALG_CLASS_KEY_EXCHANGE
• ALG_CLASS_SIGNATURE

Nella tabella seguente sono elencati gli algoritmi supportati dal provider di crittografia di base Microsoft insieme alla classe di ogni algoritmo.

Le applicazioni non devono usare un algoritmo con un identificatore di algoritmo non riconosciuto. L'uso di un algoritmo di crittografia sconosciuto può produrre risultati imprevedibili.

Esempio

Nell'esempio seguente viene illustrato come trovare il nome del CSP associato a un handle del provider di servizi di crittografia e il nome del contenitore di chiavi associato all'handle. Per il contesto completo per questo esempio, vedere Esempio di programma C: Uso di CryptAcquireContext.

Per un altro esempio che usa questa funzione, vedere Esempio di programma C: enumerazione di provider CSP e tipi di provider.

//-----------------------------------------------------------------
//  Declare and initialize variables.

HCRYPTPROV hCryptProv;
BYTE       pbData[1000];       // 1000 will hold the longest 
                               // key container name.
DWORD cbData;

//-------------------------------------------------------------------
// An HCRYPTPROV must be acquired before using code like that in 
// "Example C Program Using CryptAcquireContext."

//-------------------------------------------------------------------
// Read the name of the default CSP.

cbData = 1000;
if(CryptGetProvParam(
    hCryptProv, 
    PP_NAME, 
    pbData, 
    &cbData, 
    0))
{
    printf("CryptGetProvParam succeeded.\n");
    printf("Provider name: %s\n", pbData);
}
else
{
    printf("Error reading CSP name. \n");
    exit(1);
}
//--------------------------------------------------------------------
// Read the name of the default key container.

cbData = 1000;
if(CryptGetProvParam(
    hCryptProv, 
    PP_CONTAINER, 
    pbData, 
    &cbData, 
    0))
{
    printf("CryptGetProvParam succeeded. \n");
    printf("Key Container name: %s\n", pbData);
}
else
{
    printf("Error reading key container name. \n");
    exit(1);
}

Requisiti

Vedi anche

Descrittori di sicurezza assoluti e Self-Relative

Cryptacquirecontext

CryptCreateHash

CryptDeriveKey

CryptGenKey

CryptGetKeyParam

CryptSetProvParam

Funzioni del provider di servizi