Interface CtsSecurityInternal::SSLSocket

SSLSocket specifies an interface to deliver SSL capabilities to the client side ORB.

Operation Index

• close
• getProperty
• getSessionInfo
• open
• read
• readIntoBuffer
• setExcess
• setProperty
• write
• writeFromBuffer

Operations

• close

  Terminates the SSL session. This also closes the transport connection associated with this session. If "force" argument is set to false, it will try to internally re-use the SSL connection instead of closing it.

      void close
      (
          in boolean force
      )
      raises (CtsSecurity::TransportException, CtsSecurity::SSLException);
  

• getProperty

  Returns value of any of the SSL socket properties listed below (refer to Table. Jaguar Security - SSL Properties for detailed descriptions).
  

  Property
  certificateLabel
  qoss
  loginTimeout
  reuseSession
  pkcs11Token
  pkcs11Module
  pkcs11TokenPath
  callbackImpl
  userData
  entrustIniFile
  entrustUserProfile
  useEntrustID
  WebProxyHost
  WebProxyPort
  HttpExtraHeader

      string getProperty
      (
          in string property
      )
      raises (CtsSecurity::InvalidPropertyException);
  

• getSessionInfo

  Returns SSLSessionInfo object associated with this socket. Caller can extract session information using SSLSessionInfo interface.

      CtsSecurity::SSLSessionInfo getSessionInfo
      (
      )
      raises (CtsSecurity::TransportException, CtsSecurity::SSLException);
  

• open

  Opens a SSL connection to the specified hostname and port number.

      void open
      (
          in string hostname,
          in string port,
          in boolean reuse_existing
      )
      raises (CtsSecurity::TransportException, CtsSecurity::SSLException);
  

  This method first opens a transport (TCP/IP) connection to the specified host-port and then establishes a SSL session on that connection. It uses SSL properties set using SSLSocket interface (setProperty() method) and those set using SSLParams interface (setGlobalProperty() method). Parameters set at the SSLSocket level overrides those set using SSLParams interface. During the execution of this method, if certificate label, pin or certification trust verification is required (depending on whether callback parameters are set), this method will invoke the appropriate user-installed callback.

• read

  Reads data from the peer. This method performs SSL processing on the incoming SSL packets, decrypts, verifies the fragments and returns the raw plain-text data to the caller.

      CtsSecurity::OctetSeq read
      (
          in long minlength,
          in long maxLength
      )
      raises (CtsSecurity::TransportException, CtsSecurity::SSLException);
  

• readIntoBuffer

  Reads data from the peer into the supplied buffer. This method performs SSL processing on the incoming SSL packets, decrypts, verifies the fragments and returns the raw plain-text data to the caller.

      void readIntoBuffer
      (
          inout long length,
          in CtsSecurity::OctetSeq bufferRef
      )
      raises (CtsSecurity::TransportException, CtsSecurity::SSLException);
  

• setExcess

  Writes data back into the socket's internal buffers. The data can be retrieved on the next subsequent readreadIntoBuffer call. Useful if caller has read more than necessary, but would like the read methods to now return the excess buffer as part the next few calls to read.

      void setExcess
      (
          in long excess_length,
          in XDT::Binary bufferRef
      );
  

  excess_length is the length of the buffer. bufferRef is the address of the buffer. Memory for the buffer should be allocated using JagMemory_alloc. Responsibilty of freeing the buffer will now reside with the Socket implementation.

  This method is similar to int putc(int c, FILE *stream); in functionality.

  Should only be called by C++ client.

• setProperty

  Sets value of any of the SSL socket properties listed below (refer to Table. Jaguar Security - SSL Properties for detailed descriptions). It also returns the previous value of the property. Settings made here overrides the corresponding application wide settings made using SSLParams interface.
  

  Property
  certificateLabel
  qoss
  loginTimeout
  reuseSession
  pin
  pkcs11Token
  pkcs11Module
  pkcs11TokenPath
  callbackImpl
  userData
  entrustIniFile
  entrustUserProfile
  useEntrustID
  entrustPassword
  WebProxyHost
  WebProxyPort
  HttpExtraHeader

      string setProperty
      (
          in string property,
          in string value
      )
      raises (CtsSecurity::InvalidPropertyException, CtsSecurity::InvalidValueException);
  

• write

  Sends data to the peer. It applies negotiated SSL session encryption/MAC algorithms to the supplied plain-text data to generate SSL packets. SSL packets are then sent to the peer through the transport channel.

      void write
      (
          in CtsSecurity::OctetSeq data
      )
      raises (CtsSecurity::TransportException, CtsSecurity::SSLException);
  

• writeFromBuffer

  Sends data in the bufferRef to the peer. It applies negotiated SSL session encryption/MAC algorithms to the supplied plain-text data to generate SSL packets. SSL packets are then sent to the peer through the transport channel.

      void writeFromBuffer
      (
          in long length,
          in CtsSecurity::OctetSeq bufferRef
      )
      raises (CtsSecurity::TransportException, CtsSecurity::SSLException);