IFWXFirewall2::CreateSSLNetworkSocket method

  • Article

Applies to: desktop apps only

The CreateSSLNetworkSocket method creates an SSL socket object that works with the dynamic packet filtering scheme.

Syntax

HRESULT CreateSSLNetworkSocket(
  [in]   BOOL fAskForClientCert,
  [in]   LPSTR pszHostName,
  [in]   DWORD dwHostNameLen,
  [in]   LONG *pCreds,
  [in]   LONG *pDefaultCreds,
  [in]   FwxSSLSocketSide eSide,
  [in]   DWORD dwDefaultSendTimeout,
  [in]   DWORD dwDefaultRecvTimeout,
  [in]   BOOL fAllowHTTPSTunnelingMode,
  [out]  IFWXNetworkSocket **ppiSslSocket
);

Parameters

  • fAskForClientCert [in]
    Boolean value that specifies whether a client certificate is requested.

  • pszHostName [in]
    Pointer to a null-terminated string containing the name of the server you are trying to connect to. The pszHostName parameter is needed for authentication.

  • dwHostNameLen [in]
    The length of the host name.

  • pCreds [in]
    Pointer to a 32-bit integer that specifies the credentials of the socket creator.

  • pDefaultCreds [in]
    Pointer to a 32-bit integer that specifies the default credentials, which do not include a user name.

  • eSide [in]
    Value from the FwxSSLSocketSide enumerated type that specifies whether the socket is on the server side or client side of Forefront TMG.

    Value Meaning
    eServerSide

    The socket is on the server side.
    eClientSide

    The socket is on the client side.

     

  • dwDefaultSendTimeout [in]
    The default send time-out period.

  • dwDefaultRecvTimeout [in]
    The default receive time-out period.

  • fAllowHTTPSTunnelingMode [in]
    Boolean value that specifies whether HTTPS (SSL) tunneling mode is allowed.

  • ppiSslSocket [out]
    Address of an interface pointer that on return points to the IFWXNetworkSocket interface created.

Return value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

Requirements

Minimum supported client

 None supported

Minimum supported server

 Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

 Forefront Threat Management Gateway (TMG) 2010

Header

 Wspfwext.idl

DLL

 Wspsrv.exe

See also

IFWXFirewall2

 

 

Build date: 7/12/2010