Função QueryCredentialsAttributesA (sspi.h)

Artigo
07/16/2024

Recupera os atributos de umade credencial , como o nome associado à credencial. As informações são válidas para qualquer contexto de segurança criado com a credencial especificada.

Sintaxe

SECURITY_STATUS SEC_ENTRY QueryCredentialsAttributesA(
  [in]  PCredHandle   phCredential,
  [in]  unsigned long ulAttribute,
  [out] void          *pBuffer
);

Parâmetros

[in] phCredential

Um identificador das credenciais a serem consultadas.

[in] ulAttribute

Especifica o atributo para consulta. Esse parâmetro pode ser qualquer um dos atributos a seguir.

Valor	Significado
SECPKG_CRED_ATTR_CERT	Retorna a impressão digital do certificado em um de pbuffer do tipo SecPkgCredentials_Cert. Esse atributo só tem suporte do Kerberos. Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 e Windows XP: Este atributo não está disponível.
SECPKG_CRED_ATTR_NAMES	Retorna o nome de uma credencial em uma de pbuffer do tipo SecPkgCredentials_Names. Esse atributo não tem suporte do Schannel no modo WOW64.
SECPKG_ATTR_SUPPORTED_ALGS	Retorna os algoritmos com suporte em um de pbuffer do tipo SecPkgCred_SupportedAlgs. Todos os algoritmos com suporte são incluídos, independentemente de serem compatíveis com o certificado fornecido ou habilitados no computador local. Esse atributo tem suporte apenas pelo Schannel.
SECPKG_ATTR_CIPHER_STRENGTHS	Retorna os pontos fortes de criptografia em um de pbuffer do tipo SecPkgCred_CipherStrengths. Esse atributo tem suporte apenas pelo Schannel.
SECPKG_ATTR_SUPPORTED_PROTOCOLS	Retorna os algoritmos com suporte em um de pbuffer do tipo SecPkgCred_SupportedProtocols. Todos os protocolos com suporte são incluídos, independentemente de serem compatíveis com o certificado fornecido ou habilitados no computador local. Esse atributo tem suporte apenas pelo Schannel.

[out] pBuffer

Um ponteiro para um buffer que recebe o atributo solicitado. O tipo de estrutura retornada depende do valor de ulAttribute.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será SEC_E_OK.

Se a função falhar, o valor retornado poderá ser um dos seguintes códigos de erro.

Código de retorno	Descrição
SEC_E_INVALID_HANDLE	O identificador passado para a função não é válido.
SEC_E_UNSUPPORTED_FUNCTION	O atributo especificado não é suportado pelo Schannel. Esse valor retornado só será retornado quando o SSP do Schannel estiver sendo usado.
SEC_E_INSUFFICIENT_MEMORY	A memória disponível não é suficiente para concluir a solicitação.

Observações

A função QueryCredentialsAttributes permite que um aplicativo determine várias características de uma credencial, incluindo o nome associado às credenciais especificadas.

Consultar o atributo SECPKG_ATTR_CIPHER_STRENGTHS retorna uma estrutura SecPkgCred_CipherStrengths. A força da criptografia nessa estrutura é a mesma que a força de criptografia na estrutura de SCH_CREDENTIALS usada quando uma credencial foi criada.

Observação Um aplicativo pode encontrar a força de criptografia padrão do sistema consultando esse atributo com uma credencial padrão. Uma credencial padrão é criada chamando acquireCredentialsHandle com um parâmetro NULLpAuthData.

Consultar o atributo SECPKG_ATTR_SUPPORTED_ALGS retorna uma estrutura SecPkgCred_SupportedAlgs. Os algoritmos nessa estrutura são compatíveis com os indicados na estrutura de SCH_CREDENTIALS usada quando uma credencial foi criada.

Consultar o atributo SECPKG_ATTR_SUPPORTED_PROTOCOLS retorna uma estrutura SecPkgCred_SupportedProtocols que contém uma matriz de bits compatível com o campo grbitEnabledProtocols da estrutura SCH_CREDENTIALS.

O chamador deve alocar a estrutura apontada pelo parâmetro pBuffer. O pacote de segurança aloca o buffer para qualquer ponteiro retornado na estrutura de pBuffer . O chamador pode chamar a função FreeContextBuffer para liberar os ponteiros alocados pelo pacote de segurança.

Nota

O cabeçalho sspi.h define QueryCredentialsAttributes como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	sspi.h (inclua Security.h)
biblioteca	Secur32.lib
de DLL	Secur32.dll