ltm rule command SSL payload

iRule(1)		      BIG-IP TMSH Manual		      iRule(1)



SSL::payload
       Returns and manipulates plaintext data collected via SSL::collect.

SYNOPSIS
       SSL::payload (length |
			     (replace OFFSET LENGTH DATA) |
			     ((OFFSET)? (LENGTH)?))

DESCRIPTION
       The SSL::payload commands allow you to return and manipulate the data
       collected via the SSL::collect command. This data is in plaintext
       format.

RETURN VALUE
       SSL::payload length
	   Returns the amount of plaintext data collected by the SSL::collect
       command.

       SSL::payload [[] ]
	   Returns the actual plaintext data (optionally at the specified
       offset and/or for the specified length).

       SSL::payload replace   
	   Replaces the specified amount of plaintext data at the specified
       offset with the provided data.

VALID DURING
       ANY_EVENT

EXAMPLES
	when CLIENTSSL_HANDSHAKE {
	    log local0. "[IP::client_addr]:[TCP::client_port]: SSL handshake completed, collecting SSL payload"
	    SSL::collect
	}
	when CLIENTSSL_DATA {
	    log local0. "[IP::client_addr]:[TCP::client_port]: Collected bytes [SSL::payload length]"
	    log local0. "[IP::client_addr]:[TCP::client_port]: Decrypted payload (\[SSL::payload\]): [SSL::payload]"
	    log local0. "[IP::client_addr]:[TCP::client_port]: Parsed first line: [SSL::payload 0 [string first \r\n [SSL::payload]]]"
	    log local0. "[IP::client_addr]:[TCP::client_port]: Releasing payload"
	    SSL::release
	}

	# Sample log output:
	# : 1.1.1.1 : 1.1.1.1 : 1.1.1.1 : 1.1.1.1 : 1.1.1.1

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-10.0.0 --First introduced the command.



BIG-IP				  2017-01-31			      iRule(1)