Função InitializeSecurityContext (Geral)

A função InitializeSecurityContext (Geral) inicia o contexto de segurança de saída do lado do cliente de um identificador de credencial. Essa função é usada para criar um contexto de segurança entre o aplicativo cliente e um par remoto. InitializeSecurityContext (Geral) retornará um token que o cliente deverá passar para o par remoto, que enviará o token para a implementação de segurança local por meio da chamada AcceptSecurityContext (Geral). O token gerado deve ser considerado opaco por todos os chamadores.

Normalmente, a função InitializeSecurityContext (Geral) é chamada em um loop até que seja estabelecido um contexto de segurança suficiente.

Para obter informações sobre como usar essa função com um SSP (provedor de suporte de segurança) específico, consulte os tópicos a seguir.

Sintaxe

SECURITY_STATUS SEC_Entry InitializeSecurityContext(
  _In_opt_    PCredHandle    phCredential,
  _In_opt_    PCtxtHandle    phContext,
  _In_opt_    SEC_CHAR       *pszTargetName,
  _In_        ULONG          fContextReq,
  _In_        ULONG          Reserved1,
  _In_        ULONG          TargetDataRep,
  _In_opt_    PSecBufferDesc pInput,
  _In_        ULONG          Reserved2,
  _Inout_opt_ PCtxtHandle    phNewContext,
  _Inout_opt_ PSecBufferDesc pOutput,
  _Out_       PULONG         pfContextAttr,
  _Out_opt_   PTimeStamp     ptsExpiry
);

Parâmetros

phCredential[in, optional]

Um identificador para as credenciais retornadas por AcquireCredentialsHandle (Geral). Esse identificador é usado para criar o contexto de segurança. A função InitializeSecurityContext (Geral) exige credenciais de SAÍDA pelo menos.

phContext[in, optional]

Um ponteiro para uma estrutura CtxtHandle. Na primeira chamada para InitializeSecurityContext (Geral), esse ponteiro é NULL. Na segunda chamada, esse parâmetro é um ponteiro ao identificador para o contexto parcialmente formado retornado no parâmetro phNewContext pela primeira chamada.

Esse parâmetro é opcional com o SSP do Microsoft Digest e pode ser definido como NULL.

Ao usar esse SSP do Schannel, na primeira chamada para InitializeSecurityContext (Geral), especifique NULL. Em chamadas futuras, especifique o token recebido no parâmetro phNewContext após a primeira chamada para essa função.

pTargetName[in, optional]

Um ponteiro para uma cadeia de caracteres terminada em nulo que indica o destino do contexto. O conteúdo da cadeia de caracteres é específico do pacote de segurança, conforme descrito na tabela a seguir. Essa lista não é exaustiva. SSPs adicionais do sistema e de terceiros podem ser adicionados a um sistema.

fContextReq[in]

Sinalizadores de bits que indicam solicitações para o contexto. Nem todos os pacotes podem dar suporte a todos os requisitos. Os sinalizadores usados para esse parâmetro recebem o prefixo ISC_REQ_, por exemplo, ISC_REQ_DELEGATE. Esse parâmetro pode ser um ou mais dos sinalizadores de atributos a seguir.

Os atributos solicitados podem não ter suporte do cliente. Para obter mais informações, consulte o parâmetro pfContextAttr.

Para obter mais descrições dos vários atributos, consulte Requisitos de contexto.

Reserved1[in]

Esse parâmetro é reservado e precisa ser definido como zero.

TargetDataRep[in]

A representação de dados, como a ordenação de bytes, no destino. Esse parâmetro pode ser SECURITY_NATIVE_DREP ou SECURITY_NETWORK_DREP.

Esse parâmetro não é usado com Digest ou Schannel. Defina-o como zero.

pInput[in, optional]

Um ponteiro para uma estrutura SecBufferDesc que contém ponteiros para os buffers fornecidos como entrada ao pacote. A menos que o contexto do cliente tenha sido iniciado pelo servidor, o valor desse parâmetro deve estar NULL na primeira chamada para a função. Em chamadas subsequentes para a função ou quando o contexto do cliente foi iniciado pelo servidor, o valor desse parâmetro é um ponteiro para um buffer alocado com memória suficiente para manter o token retornado pelo computador remoto.

Reserved2[in]

Esse parâmetro é reservado e precisa ser definido como zero.

phNewContext[in, out, optional]

Um ponteiro para uma estrutura CtxtHandle. Na primeira chamada para InitializeSecurityContext (Geral), esse ponteiro recebe o novo identificador de contexto. Na segunda chamada, phNewContext pode ser o mesmo que o identificador especificado no parâmetro phContext. phNewContext nunca deverá ser NULL.

pOutput[in, out, optional]

Um ponteiro para uma estrutura SecBufferDesc contendo ponteiros para a estrutura SecBuffer que recebe os dados de saída. Se um buffer for digitado como SEC_READWRITE na entrada, ele estará lá na saída. Se solicitado, o sistema alocará um buffer para o token de segurança (por meio de ISC_REQ_ALLOCATE_MEMORY) e preencherá o endereço no descritor de buffer para o token de segurança.

Ao usar o SSP do Microsoft Digest, esse parâmetro recebe a resposta de desafio que deve ser enviada ao servidor.

Ao usar o SSP do Schannel, se o sinalizador ISC_REQ_ALLOCATE_MEMORY for especificado, o SSP do Schannel alocará memória para o buffer e colocará as informações apropriadas no SecBufferDesc. Além disso, o chamador deve passar um buffer de tipo SECBUFFER_ALERT. Na saída, se um alerta for gerado, esse buffer conterá informações sobre esse alerta e a função falhará.

pfContextAttr[out]

Um ponteiro para uma variável receber um conjunto de sinalizadores de bits que indicam os atributos do contexto estabelecido. Para obter uma descrição dos vários atributos, consulte Requisitos de contexto.

Sinalizadores usados para esse parâmetro recebem o prefixo ISC_RET, como ISC_RET_DELEGATE. Para obter uma lista de valores válidos, consulte o parâmetro fContextReq.

Não verifique se há atributos relacionados à segurança até que a chamada de função final retorne com êxito. Sinalizadores de atributo que não estão relacionados à segurança, como o sinalizador ASC_RET_ALLOCATED_MEMORY, podem ser verificados antes do retorno final.

ptsExpiry[out, optional]

Um ponteiro para uma estrutura TimeStamp que recebe o tempo de expiração do contexto. É recomendável que o pacote de segurança sempre retorne esse valor no horário local. Esse parâmetro é opcional e NULL deve ser passado para clientes de curta duração.

Credenciais ou contextos de segurança de SSP do Microsoft Digest não possuem tempo de validade.

Retornar valor

Se a função for bem-sucedida, ela retornará um dos seguintes códigos de êxito.

Se a função falhar, a função retornará um dos seguintes códigos de erro.

Comentários

O chamador é responsável por determinar se os atributos de contexto final são suficientes. Se, por exemplo, a confidencialidade foi solicitada, mas não pôde ser estabelecida, alguns aplicativos podem optar por desligar a conexão imediatamente.

Se os atributos do contexto de segurança não forem suficientes, o cliente deverá liberar o contexto parcialmente criado chamando a função DeleteSecurityContext.

A função InitializeSecurityContext (Geral) é usada por um cliente para inicializar um contexto de saída.

Para um contexto de segurança de duas etapas, esta é a sequência de chamadas:

1. O cliente chama a função com phContext definido como NULL e preenche o descritor de buffer com a mensagem de entrada.
2. O pacote de segurança examina os parâmetros e constrói um token opaco, colocando-o no elemento TOKEN na matriz de buffer. Se o parâmetro fContextReq incluir o sinalizador ISC_REQ_ALLOCATE_MEMORY, o pacote de segurança alocará a memória e retornará o ponteiro no elemento TOKEN.
3. O cliente envia o token retornado no buffer pOutput para o servidor de destino. Em seguida, o servidor passa o token como um argumento de entrada em uma chamada para a função AcceptSecurityContext (Geral).
4. AcceptSecurityContext (Geral) poderá retornar um token, que o servidor enviará ao cliente para uma segunda chamada para InitializeSecurityContext (Geral) se a primeira chamada retornar SEC_I_CONTINUE_NEEDED.

Para contextos de segurança de várias etapas, como a autenticação mútua, esta é a sequência de chamadas:

1. O cliente chama a função conforme descrito anteriormente, mas o pacote retorna o código de êxito SEC_I_CONTINUE_NEEDED.
2. O cliente envia o token de saída para o servidor e aguarda a resposta do servidor.
3. Após o recebimento da resposta do servidor, o cliente chama InitializeSecurityContext (Geral) novamente, com phContext definido como o identificador que foi retornado da última chamada. O token recebido do servidor é fornecido no parâmetro pInput.
4. Não use o valor phContext em chamadas simultâneas para InitializeSecurityContext (Geral). A implementação nos provedores de segurança não é segura para thread.

Se o servidor responder com êxito, o pacote de segurança retornará SEC_E_OK e será estabelecida uma sessão segura.

Se a função retornar uma das respostas de erro, a resposta do servidor não será aceita e a sessão não será estabelecida.

Se a função retornar SEC_I_CONTINUE_NEEDED, SEC_I_COMPLETE_NEEDED ou SEC_I_COMPLETE_AND_CONTINUE, as etapas 2 e 3 serão repetidas.

Para inicializar um contexto de segurança, pode ser necessária mais de uma chamada para essa função, dependendo do mecanismo de autenticação subjacente, bem como das opções especificadas no parâmetro fContextReq.

Os parâmetros fContextReq e pfContextAttributes são bitmasks que representam vários atributos de contexto. Para obter uma descrição dos vários atributos, consulte Requisitos de contexto. O parâmetro pfContextAttributes é válido em todo retorno com êxito, mas somente no retorno final com êxito você deve examinar os sinalizadores que pertencem a aspectos de segurança do contexto. Os retornos intermediários podem definir, por exemplo, o sinalizador ISC_RET_ALLOCATED_MEMORY.

Se o sinalizador ISC_REQ_USE_SUPPLIED_CREDS estiver definido, o pacote de segurança deverá procurar um tipo de buffer SECBUFFER_PKG_PARAMS no buffer de entrada pInput. Essa não é uma solução genérica, mas permite um emparelhamento sólido de pacote de segurança e aplicativo, quando adequado.

Se ISC_REQ_ALLOCATE_MEMORY tiver sido especificado, o chamador deverá liberar a memória chamando a função FreeContextBuffer.

Por exemplo, o token de entrada pode ser o desafio de um Gerenciador de LAN. Nesse caso, o token de saída seria a resposta criptografada em NTLM para o desafio.

A ação que o cliente executa depende do código de retorno dessa função. Se o código de retorno for SEC_E_OK, não haverá segunda chamada de InitializeSecurityContext (Geral) e não será esperada resposta do servidor. Se o código de retorno for SEC_I_CONTINUE_NEEDED, o cliente esperará um token em resposta do servidor e o passará em uma segunda chamada para InitializeSecurityContext (Geral). O código de retorno SEC_I_COMPLETE_NEEDED indica que o cliente deve concluir a compilação da mensagem e chamar a função CompleteAuthToken. O código SEC_I_COMPLETE_AND_CONTINUE incorpora estas duas ações.

Se InitializeSecurityContext (Geral) retornar com êxito na primeira (ou única) chamada, o chamador deverá chamar a função DeleteSecurityContext no identificador retornado, mesmo que a chamada falhe em uma etapa posterior da troca de autenticação.

O cliente poderá chamar InitializeSecurityContext (Geral) novamente depois de concluir isso com êxito. Isso indica ao pacote de segurança que uma nova autenticação é desejada.

Os chamadores do modo kernel têm as seguintes diferenças: o nome de destino é uma cadeia de caracteres Unicode que deve ser alocada na memória virtual usando VirtualAlloc e ela não deve ser alocada a partir do pool. Os buffers passados e fornecidos em pInput e pOutput devem estar na memória virtual, não no pool.

Ao usar o SSP do Schannel, se a função retornar SEC_I_INCOMPLETE_CREDENTIALS, verifique se foi especificado um certificado válido e confiável em suas credenciais. O certificado é especificado ao chamar a função AcquireCredentialsHandle (Geral). O certificado deve ser um certificado de autenticação de cliente emitido por uma AC (autoridade de certificação) confiável para o servidor. Para obter uma lista dos ACs confiáveis para o servidor, chame a função QueryContextAttributes (Geral) e especifique o atributo SECPKG_ATTR_ISSUER_LIST_EX.

Ao usar o SSP do Schannel, depois que um aplicativo cliente recebe um certificado de autenticação de uma AC confiável para o servidor, o aplicativo cria uma nova credencial chamando a função AcquireCredentialsHandle (Geral) e chamando InitializeSecurityContext (Geral) novamente, especificando a credencial nova no parâmetro phCredential.

Requisitos

Confira também

Funções SSPI

Suporte à Proteção Estendida para Autenticação (EPA) em um serviço

AcceptSecurityContext (Geral)

AcquireCredentialsHandle (Geral)

CompleteAuthToken

DeleteSecurityContext

FreeContextBuffer

SecBuffer

SecBufferDesc