SOCKET_SECURITY_PROTOCOL enumeration

The SOCKET_SECURITY_PROTOCOL enumeration indicates the type of security protocol to be used on a socket to secure network traffic.

Syntax


typedef enum _SOCKET_SECURITY_PROTOCOL { 
  SOCKET_SECURITY_PROTOCOL_DEFAULT,
  SOCKET_SECURITY_PROTOCOL_IPSEC,
  SOCKET_SECURITY_PROTOCOL_INVALID
} SOCKET_SECURITY_PROTOCOL;

Constants

SOCKET_SECURITY_PROTOCOL_DEFAULT

The default system security will be used.

SOCKET_SECURITY_PROTOCOL_IPSEC

IPsec will be used.

SOCKET_SECURITY_PROTOCOL_INVALID

The maximum possible value for the SOCKET_SECURITY_PROTOCOL enumeration type. This is not a legal value.

Remarks

This enumeration is supported on Windows Vista and later.

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

The SOCKET_SECURITY_PROTOCOL enumeration is used in the SOCKET_PEER_TARGET_NAME, SOCKET_SECURITY_QUERY_INFO, SOCKET_SECURITY_QUERY_TEMPLATE, SOCKET_SECURITY_SETTINGS, and SOCKET_SECURITY_SETTINGS_IPSEC structures to indicate the type of security protocol to be used on a socket in the SecurityProtocol member. These structures are used by the WSAQuerySocketSecurity, WSASetSocketPeerTargetName, and WSASetSocketSecurity functions.

In addition to identifying the security protocol, this type is also used to decide how to interpret a pointer passed to some of the secure socket functions. This is analogous to how the sa_family member of the sockaddr type is used to interpret a pointer as either sockaddr_in or sockaddr_in6.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Mstcpip.h

See also

sockaddr
SOCKET_PEER_TARGET_NAME
SOCKET_SECURITY_QUERY_INFO
SOCKET_SECURITY_QUERY_TEMPLATE
SOCKET_SECURITY_SETTINGS
SOCKET_SECURITY_SETTINGS_IPSEC
Using Secure Socket Extensions
Windows Filtering Platform
Windows Filtering Platform API Functions
Winsock Secure Socket Extensions
WSAQuerySocketSecurity
WSASetSocketPeerTargetName
WSASetSocketSecurity

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.