Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 4.35 KB

ns-mstcpip-socket_security_query_template.md

File metadata and controls

107 lines (71 loc) · 4.35 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:mstcpip._SOCKET_SECURITY_QUERY_TEMPLATE
SOCKET_SECURITY_QUERY_TEMPLATE (mstcpip.h)
Contains the security template used by the WSAQuerySocketSecurity function.
SOCKET_SECURITY_QUERY_TEMPLATE
SOCKET_SECURITY_QUERY_TEMPLATE structure [Winsock]
mstcpip/SOCKET_SECURITY_QUERY_TEMPLATE
winsock.socket_security_query_template
winsock\socket_security_query_template.htm
WinSock
cd222287-c4f2-4c4b-8b5f-81b6fcbe87d4
12/05/2018
SOCKET_SECURITY_QUERY_TEMPLATE, SOCKET_SECURITY_QUERY_TEMPLATE structure [Winsock], mstcpip/SOCKET_SECURITY_QUERY_TEMPLATE, winsock.socket_security_query_template
mstcpip.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Windows
SOCKET_SECURITY_QUERY_TEMPLATE
19H1
_SOCKET_SECURITY_QUERY_TEMPLATE
mstcpip/_SOCKET_SECURITY_QUERY_TEMPLATE
SOCKET_SECURITY_QUERY_TEMPLATE
mstcpip/SOCKET_SECURITY_QUERY_TEMPLATE
c++
APIRef
kbSyntax
HeaderDef
Mstcpip.h
SOCKET_SECURITY_QUERY_TEMPLATE

SOCKET_SECURITY_QUERY_TEMPLATE structure

-description

The SOCKET_SECURITY_QUERY_TEMPLATE structure contains the security template used by the WSAQuerySocketSecurity function.

-struct-fields

-field SecurityProtocol

A SOCKET_SECURITY_PROTOCOL value that identifies the protocol used to secure the traffic.

-field PeerAddress

The IP address of the peer for which security information is being queried. For connection-oriented sockets (protocol of IPPROTO_TCP), the connected socket uniquely identifies a peer. In this case, this parameter is ignored.

-field PeerTokenAccessMask

The access mask used for opening the peer user application and computer token handles that are returned as part of the query information.

-remarks

The SOCKET_SECURITY_QUERY_TEMPLATE structure is supported on Windows Vista and later.

The SOCKET_SECURITY_QUERY_TEMPLATE structure is used by the WSAQuerySocketSecurity function to specify the type of query information to return for a socket. The SOCKET_SECURITY_QUERY_TEMPLATE structure passed to the WSAQuerySocketSecurity function may contain zeros for all members to request default security information.

If the SOCKET_SECURITY_QUERY_TEMPLATE structure is specified with the PeerTokenAccessMask member not specified (set to zero), then the WSAQuerySocketSecurity function will not return the PeerApplicationAccessTokenHandle and PeerMachineAccessTokenHandle members in the SOCKET_SECURITY_QUERY_INFO structure.

Currently, the only type of security protocol that is supported is IPsec. So specifying an enumeration value of SOCKET_SECURITY_PROTOCOL_DEFAULT for the SecurityProtocol member has the same effect as specifying SOCKET_SECURITY_PROTOCOL_IPSEC.

-see-also

SOCKET_SECURITY_PROTOCOL

SOCKET_SECURITY_QUERY_INFO

Using Secure Socket Extensions

WSAQuerySocketSecurity

Windows Filtering Platform

Windows Filtering Platform API Functions

Winsock Secure Socket Extensions