connect method - RawSecureSocket class - dart:io library (original) (raw)

connect static method

Future<RawSecureSocket> connect(

1. dynamic host,
2. int port, {
3. SecurityContext? context,
4. bool onBadCertificate(
   1. X509Certificate certificate
      )?,
5. void keyLog(
   1. String line
      )?,
6. List<String>? supportedProtocols,
7. Duration? timeout, })

override

Constructs a new secure client socket and connect it to the given host on the given port.

The returned Future is completed with theRawSecureSocket when it is connected and ready for subscription.

The certificate provided by the server is checked using the trusted certificates set in the SecurityContext object If a certificate and key are set on the client, using SecurityContext.useCertificateChain andSecurityContext.usePrivateKey, and the server asks for a client certificate, then that client certificate is sent to the server.

onBadCertificate is an optional handler for unverifiable certificates. The handler receives the X509Certificate, and can inspect it and decide (or let the user decide) whether to accept the connection or not. The handler should return true to continue the RawSecureSocket connection.

onBadCertificate is an optional handler for unverifiable certificates. The handler receives the X509Certificate, and can inspect it and decide (or let the user decide) whether to accept the connection or not. The handler should return true to continue the SecureSocket connection.

keyLog is an optional callback that will be called when new TLS keys are exchanged with the server. keyLog will receive one line of text inNSS Key Log Formatfor each call. Writing these lines to a file will allow tools (such asWireshark) to decrypt content sent through this socket. This is meant to allow network-level debugging of secure sockets and should not be used in production code. For example:

final log = File('keylog.txt');
final socket = await SecureSocket.connect('www.example.com', 443,
    keyLog: (line) => log.writeAsStringSync(line, mode: FileMode.append));

supportedProtocols is an optional list of protocols (in decreasing order of preference) to use during the ALPN protocol negotiation with the server. Example values are "http/1.1" or "h2". The selected protocol can be obtained via RawSecureSocket.selectedProtocol.

Implementation

static Future<RawSecureSocket> connect(
  host,
  int port, {
  SecurityContext? context,
  bool onBadCertificate(X509Certificate certificate)?,
  void keyLog(String line)?,
  List<String>? supportedProtocols,
  Duration? timeout,
}) {
  _RawSecureSocket._verifyFields(host, port, false, false);
  return RawSocket.connect(host, port, timeout: timeout).then((socket) {
    return secure(
      socket,
      context: context,
      onBadCertificate: onBadCertificate,
      keyLog: keyLog,
      supportedProtocols: supportedProtocols,
    );
  });
}