parameters: (self, username, sharedKey, settings=None,
                                   checker=None, async=False)
docstring: Perform a shared-key handshake in the role of client.
  
          This function performs a shared-key handshake.  Using shared
          symmetric keys of high entropy (128 bits or greater) mutually
          authenticates both parties to each other.
  
          TLS with shared-keys is non-standard.  Most TLS
          implementations don't support it.  See
          U{http://www.ietf.org/html.charters/tls-charter.html} for the
          latest information on TLS with shared-keys.  If the shared-keys
          Internet-Draft changes or is superceded, TLS Lite will track
          those changes, so the shared-key support in later versions of
          TLS Lite may become incompatible with this version.
  
          Like any handshake function, this can be called on a closed
          TLS connection, or on a TLS connection that is already open.
          If called on an open connection it performs a re-handshake.
  
          If the function completes without raising an exception, the
          TLS connection will be open and available for data transfer.
  
          If an exception is raised, the connection will have been
          automatically closed (if it was ever open).
  
          @type username: str
          @param username: The shared-key username.
  
          @type sharedKey: str
          @param sharedKey: The shared key.
  
          @type settings: L{tlslite.HandshakeSettings.HandshakeSettings}
          @param settings: Various settings which can be used to control
          the ciphersuites, certificate types, and SSL/TLS versions
          offered by the client.
  
          @type checker: L{tlslite.Checker.Checker}
          @param checker: A Checker instance.  This instance will be
          invoked to examine the other party's authentication
          credentials, if the handshake completes succesfully.
  
          @type async: bool
          @param async: If False, this function will block until the
          handshake is completed.  If True, this function will return a
          generator.  Successive invocations of the generator will
          return 0 if it is waiting to read from the socket, 1 if it is
          waiting to write to the socket, or will raise StopIteration if
          the handshake operation is completed.
  
          @rtype: None or an iterable
          @return: If 'async' is True, a generator object will be
          returned.
  
          @raise socket.error: If a socket error occurs.
          @raise tlslite.errors.TLSAbruptCloseError: If the socket is closed
          without a preceding alert.
          @raise tlslite.errors.TLSAlert: If a TLS alert is signalled.
          @raise tlslite.errors.TLSAuthenticationError: If the checker
          doesn't like the other party's authentication credentials.
docstring_summary: Perform a shared-key handshake in the role of client.
docstring_tokens: Perform a shared - key handshake in the role of client .
function: def handshakeClientSharedKey(self, username, sharedKey, settings=None,
                                   checker=None, async=False):
          """Perform a shared-key handshake in the role of client.
  
          This function performs a shared-key handshake.  Using shared
          symmetric keys of high entropy (128 bits or greater) mutually
          authenticates both parties to each other.
  
          TLS with shared-keys is non-standard.  Most TLS
          implementations don't support it.  See
          U{http://www.ietf.org/html.charters/tls-charter.html} for the
          latest information on TLS with shared-keys.  If the shared-keys
          Internet-Draft changes or is superceded, TLS Lite will track
          those changes, so the shared-key support in later versions of
          TLS Lite may become incompatible with this version.
  
          Like any handshake function, this can be called on a closed
          TLS connection, or on a TLS connection that is already open.
          If called on an open connection it performs a re-handshake.
  
          If the function completes without raising an exception, the
          TLS connection will be open and available for data transfer.
  
          If an exception is raised, the connection will have been
          automatically closed (if it was ever open).
  
          @type username: str
          @param username: The shared-key username.
  
          @type sharedKey: str
          @param sharedKey: The shared key.
  
          @type settings: L{tlslite.HandshakeSettings.HandshakeSettings}
          @param settings: Various settings which can be used to control
          the ciphersuites, certificate types, and SSL/TLS versions
          offered by the client.
  
          @type checker: L{tlslite.Checker.Checker}
          @param checker: A Checker instance.  This instance will be
          invoked to examine the other party's authentication
          credentials, if the handshake completes succesfully.
  
          @type async: bool
          @param async: If False, this function will block until the
          handshake is completed.  If True, this function will return a
          generator.  Successive invocations of the generator will
          return 0 if it is waiting to read from the socket, 1 if it is
          waiting to write to the socket, or will raise StopIteration if
          the handshake operation is completed.
  
          @rtype: None or an iterable
          @return: If 'async' is True, a generator object will be
          returned.
  
          @raise socket.error: If a socket error occurs.
          @raise tlslite.errors.TLSAbruptCloseError: If the socket is closed
          without a preceding alert.
          @raise tlslite.errors.TLSAlert: If a TLS alert is signalled.
          @raise tlslite.errors.TLSAuthenticationError: If the checker
          doesn't like the other party's authentication credentials.
          """
          handshaker = self._handshakeClientAsync(sharedKeyParams=(username,
                          sharedKey), settings=settings, checker=checker)
          if async:
              return handshaker
          for result in handshaker:
              pass
function_tokens: def handshakeClientSharedKey ( self , username , sharedKey , settings = None , checker = None , async = False ) : handshaker = self . _handshakeClientAsync ( sharedKeyParams = ( username , sharedKey ) , settings = settings , checker = checker ) if async : return handshaker for result in handshaker : pass