SSL Internal Members

Microchip TCP/IP Stack

Microchip TCP/IP Stack Help

The following functions and variables are designated as internal to the SSL module.

Enumerations

	Name	Description
	SM_SSL_RX_SERVER_HELLO	State machine for SSLRxServerHello
	SSL_ALERT_LEVEL	Describes the two types of Alert records
	SSL_MESSAGES	Describes the types of SSL messages (handshake and alerts)
	SSL_SESSION_TYPE	SSL Session Type Enumeration

Functions

	Name	Description
	CalculateFinishedHash	Calculates the handshake hash over the data. hashID can be either MD5 or SHA-1, and this function will calculate accordingly.
	GenerateHashRounds	Generates hash rounds to find either the Master Secret or the Key Block.
	GenerateSessionKeys	Generates the session write keys and MAC secrets
	HSEnd	Hashes the message contents into the Handshake hash structures and begins a new handshake hash.
	HSGet	Reads data from socket, transparently hashing it into the handshake hashes.
	HSGetArray	Function: static WORD HSGetArray(TCP_SOCKET skt, BYTE data, WORD len) PreCondition: None * Input: skt - socket to read data from data - array to read into, or NULL len - number of bytes to read * Output: Number of bytes read * Side Effects: None * Overview: Reads data from socket, transparently hashing it into the handshake hashes. * Note: None
	HSGetWord	Reads data from socket, transparently hashing it into the handshake hashes.
	HSPut	Writes data to socket, transparently hashing it into the handshake hashes.
	HSPutArray	Function: static WORD HSPutArray(TCP_SOCKET skt, BYTE data, BYTE len) PreCondition: None * Input: skt - socket to write data to data - data to write len - number of bytes to write * Output: Number of bytes written * Side Effects: None * Overview: Writes data to socket, transparently hashing it into the handshake hashes. * Note: None
	HSPutROMArray	This is function HSPutROMArray.
	HSPutWord	Writes data to socket, transparently hashing it into the handshake hashes.
	HSStart	Sets up the buffer to store data for handshake hash tracking
	LoadOffChip	Copies data from Ethernet RAM to local RAM
	SaveOffChip	Copies data in PIC RAM to the Ethernet RAM
	SSLBufferAlloc	Allocates a buffer for use.
	SSLBufferFree	Specified buffer is released
	SSLBufferSync	Specified buffer is loaded to RAM. Only loads if necessary, and saves any current buffer before switching.
	SSLHashAlloc	Allocates a hash for use.
	SSLHashFree	Specified hash is released
	SSLHashSync	Specified hash is loaded to RAM. Only loads if necessary, and saves any current hash before switching.
	SSLKeysSync	Specified key set is loaded to RAM. Only loads if necessary, and saves any current key set before switching.
	SSLMACAdd	This is function SSLMACAdd.
	SSLMACBegin	This is function SSLMACBegin.
	SSLMACCalc	This is function SSLMACCalc.
	SSLRSAOperation	Pauses connection processing until RSA calculation is complete.
	SSLRxAlert	Receives an alert message and decides what to do
	SSLRxAntiqueClientHello	Receives the SSLv2 ClientHello message, initiating a new SSL session with a client
	SSLRxCCS	Receives a ChangeCipherSpec from the remote server
	SSLRxClientHello	Receives the ClientHello message, initiating a new SSL session with a client
	SSLRxClientKeyExchange	Receives the ClientKeyExchange message and begins the decryption process.
	SSLRxFinished	Receives the Finished message from remote node
	SSLRxHandshake	Receives a handshake message.
	SSLRxRecord	Receives an SSL record.
	SSLRxServerCertificate	Receives ServerCertificate from the remote server, locates the public key information, and executes RSA operation.
	SSLRxServerHello	Receives the ServerHello from the remote server
	SSLSessionMatchID	Locates a cached SSL session for reuse. Syncs found session into RAM.
	SSLSessionMatchIP	Locates a cached SSL session for reuse
	SSLSessionNew	Finds space for a new SSL session
	SSLSessionSync	Specified session is loaded to RAM. Only loads if necessary, and saves any current session before switching if it has been updated.
	SSLStartPartialRecord	Begins a long SSL record.
	SSLStubAlloc	Allocates a stub for use.
	SSLStubFree	Specified stub is released
	SSLStubSync	Specified stub is loaded to RAM. Only loads if necessary, and saves any current stub before switching.
	SSLTerminate	Terminates an SSL connection and releases allocated resources.
	SSLTxCCSFin	Generates the session keys from the master secret, then allocates and generates the encryption context. Once processing is complete, transmits the Change Cipher Spec message and the Finished handshake message to the server.
	SSLTxClientHello	Transmits the ClientHello message to initiate a new SSL session with the server.
	SSLTxClientKeyExchange	Transmits the encrypted pre-master secret to the server and requests the Change Cipher Spec. Also generates the Master Secret from the pre-master secret that was used.
	SSLTxMessage	Transmits an SSL message.
	SSLTxRecord	Transmits an SSL record.
	SSLTxServerCertificate	Transmits the Certificate message with the server's specified public key certificate.
	SSLTxServerHello	Transmits the ServerHello message.
	SSLTxServerHelloDone	Transmits the ServerHelloDone message.

Macros

	Name	Description
	RESERVED_SSL_MEMORY	Total space needed by all SSL storage requirements
	SSL_ALERT	Protocol code for Alert records
	SSL_APPLICATION	Protocol code for Application data records
	SSL_BASE_BUFFER_ADDR	Base address for SSL buffers
	SSL_BASE_HASH_ADDR	Base address for SSL hashes
	SSL_BASE_KEYS_ADDR	Base address for SSL keys
	SSL_BASE_SESSION_ADDR	Base address for SSL sessions
	SSL_BASE_STUB_ADDR	Base address for SSL stubs
	SSL_BUFFER_SIZE	Amount of space needed by a single SSL buffer
	SSL_BUFFER_SPACE	Amount of space needed by all SSL buffer
	SSL_CHANGE_CIPHER_SPEC	Protocol code for Change Cipher Spec records
	SSL_HANDSHAKE	Protocol code for Handshake records
	SSL_HASH_SIZE	Amount of space needed by a single SSL hash
	SSL_HASH_SPACE	Amount of space needed by all SSL hash
	SSL_KEYS_SIZE	Amount of space needed by a single SSL key
	SSL_KEYS_SPACE	Amount of space needed by all SSL key
	SSL_RSA_EXPORT_WITH_ARCFOUR_40_MD5	This is macro SSL_RSA_EXPORT_WITH_ARCFOUR_40_MD5.
	SSL_RSA_WITH_ARCFOUR_128_MD5	This is macro SSL_RSA_WITH_ARCFOUR_128_MD5.
	SSL_SESSION_SIZE	Amount of space needed by a single SSL session
	SSL_SESSION_SPACE	Amount of space needed by all SSL session
	SSL_STUB_SIZE	Amount of space needed by a single SSL stub
	SSL_STUB_SPACE	Amount of space needed by all SSL stubs
	SSL_VERSION	SSL version number
	SSL_VERSION_HI	SSL version number (high byte)
	SSL_VERSION_LO	SSL version number (low byte)
	SSLFinishPartialRecord	This is macro SSLFinishPartialRecord.
	SSLFlushPartialRecord	This is macro SSLFlushPartialRecord.
	SSLSessionUpdated	This is macro SSLSessionUpdated.

Module

SSL

Structures

	Name	Description
	SSL_KEYS	Memory definition for SSL keys. This area is split into Local and Remote areas. During the handshake, Local.random and Remote.random hold the ServerRandom and ClientRandom values. Once the session keys are calculated, the Local.app and Remote.app contain the MAC secret, record sequence number, and encryption context for the ARCFOUR module.
	SSL_SESSION	Storage space for SSL Session identifiers. (The SessionID and MasterSecret)
	SSL_SESSION_STUB	Stub value for an SSL_SESSION. The tag associates this session with a remote node, either by matching to a remote IP address when we are the client or the first 3 bytes of the session ID when we are the host. When a session is free/expired, the tag is 0x00000000. The lastUsed value is the Tick count when the session was last used so that older sessions may be overwritten first.
	SSL_STUB	Memory holder for general information associated with an SSL connections.

Unions

	Name	Description
	SSL_BUFFER	Generic buffer space for SSL. The hashRounds element is used when this buffer is needed for handshake hash calculations, and the full element is used as the Sbox for ARCFOUR calculations.

Variables

	Name	Description
	isBufferUsed	Indicates which buffers are in use
	isHashUsed	Indicates which hashes are in use
	isStubUsed	Indicates which stubs are in use
	masks	Masks for each bit in the is*Used variables
	ptrHS	Used in buffering handshake results
	SSL_CERT	RSA public certificate data ?
	SSL_CERT_LEN	RSA public certificate length ?
	sslBufferID	Which buffer is loaded
	sslHash	Hash storage
	sslHashID	Which hash is loaded
	sslKeys	The current SSL session
	sslKeysID	Which SSL_KEYS are loaded
	sslRSAStubID	Which stub is using RSA, if any
	sslSession	Current session data
	sslSessionID	Which session is loaded
	sslSessionStubs	8 byte session stubs
	sslSessionUpdated	Whether or not it has been updated
	sslStub	The current SSL stub
	sslStubID	Which SSL_STUB is loaded

Stack API > SSL > Internal Members

Contents | Index | Home

previous page start next page