This section lists the APIs available for the L4 SSL DataScripts.
Datapath DS APIs
The following are the datapath APIs:
This data-script will collect “x” amount of bytes in the socket buffer. This API can yield and resume. Socket buffer is decided based on which DS event invokes this API (Client sockbuf for L4 request and server sockbuf for L4 response). The return value of the API is the amount of data present in the sockbuf.
Reads xBytes from socket buffer and presents it as hex-stream to the data-script. The direction decides which sockbuf data to be read from.
Discard xBytes from sockbuf using specified offset.
Inserts payload2 at offset of the sockbuf.
Stops invocation of current datascript for the connection.
Load Balancing API
avi.vs.persist will be a No-op if load balancing is already done.
All of the manipulation API are on the current snapshot of underlying socket buffer.
Every API is relative to the previous API, for instance,
avi.l4.discard will discard some part of payload. The succeeding API, for instance,
avi.l4.modify, will work on the new payload set obtained as result of
avi.fix.parse— Use FIX parser C library to parse the provided payload.
avi.fix.getTagValue— Get the TAG value in the current message context.
avi.ssl.clear_error - Clears the error bitmap set by OpenSSL in SSL context to ignore certain errors while SSL handshake (for instance, allow expired certificate, and so on).