mirror of
https://github.com/moparisthebest/spdylay
synced 2024-11-14 05:25:07 -05:00
560 lines
19 KiB
C
560 lines
19 KiB
C
/*
|
|
* Spdylay - SPDY Library
|
|
*
|
|
* Copyright (c) 2012 Tatsuhiro Tsujikawa
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
#ifndef SPDYLAY_SESSION_H
|
|
#define SPDYLAY_SESSION_H
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
# include <config.h>
|
|
#endif /* HAVE_CONFIG_H */
|
|
|
|
#include <spdylay/spdylay.h>
|
|
#include "spdylay_pq.h"
|
|
#include "spdylay_map.h"
|
|
#include "spdylay_frame.h"
|
|
#include "spdylay_zlib.h"
|
|
#include "spdylay_stream.h"
|
|
#include "spdylay_buffer.h"
|
|
#include "spdylay_outbound_item.h"
|
|
#include "spdylay_client_cert_vector.h"
|
|
|
|
/**
|
|
* @macro
|
|
* Lowest priority value in SPDY/2, which is 3.
|
|
*/
|
|
#define SPDYLAY_PRI_LOWEST_SPDY2 3
|
|
/**
|
|
* @macro
|
|
* Lowest priority value in SPDY/3, which is 7.
|
|
*/
|
|
#define SPDYLAY_PRI_LOWEST_SPDY3 7
|
|
|
|
/*
|
|
* Option flags.
|
|
*/
|
|
typedef enum {
|
|
SPDYLAY_OPTMASK_NO_AUTO_WINDOW_UPDATE = 1 << 0
|
|
} spdylay_optmask;
|
|
|
|
typedef struct {
|
|
spdylay_outbound_item *item;
|
|
/* Buffer for outbound frames. Used to pack one frame. The memory
|
|
pointed by framebuf is initially allocated by
|
|
spdylay_session_{client,server}_new() and deallocated by
|
|
spdylay_session_del() */
|
|
uint8_t *framebuf;
|
|
/* The capacity of framebuf in bytes */
|
|
size_t framebufmax;
|
|
/* The length of the frame stored in framebuf */
|
|
size_t framebuflen;
|
|
/* The number of bytes has been sent */
|
|
size_t framebufoff;
|
|
} spdylay_active_outbound_item;
|
|
|
|
/* Buffer length for inbound raw byte stream. */
|
|
#define SPDYLAY_INBOUND_BUFFER_LENGTH 16384
|
|
|
|
#define SPDYLAY_INITIAL_OUTBOUND_FRAMEBUF_LENGTH (SPDYLAY_DATA_PAYLOAD_LENGTH+8)
|
|
#define SPDYLAY_INITIAL_INBOUND_FRAMEBUF_LENGTH \
|
|
SPDYLAY_INITIAL_OUTBOUND_FRAMEBUF_LENGTH
|
|
#define SPDYLAY_INITIAL_NV_BUFFER_LENGTH 4096
|
|
|
|
#define SPDYLAY_INITIAL_WINDOW_SIZE 65536
|
|
|
|
/* Initial size of client certificate vector */
|
|
#define SPDYLAY_INITIAL_CLIENT_CERT_VECTOR_LENGTH 8
|
|
/* Maxmum size of client certificate vector */
|
|
#define SPDYLAY_MAX_CLIENT_CERT_VECTOR_LENGTH 255
|
|
|
|
typedef enum {
|
|
SPDYLAY_RECV_HEAD,
|
|
SPDYLAY_RECV_PAYLOAD
|
|
} spdylay_inbound_state;
|
|
|
|
#define SPDYLAY_HEAD_LEN 8
|
|
|
|
/* Maximum unique ID in use for PING. If unique ID exeeds this number,
|
|
it wraps to 1 (client) or 2 (server) */
|
|
#define SPDYLAY_MAX_UNIQUE_ID ((1u << 31)-1)
|
|
|
|
typedef struct {
|
|
spdylay_inbound_state state;
|
|
uint8_t headbuf[SPDYLAY_HEAD_LEN];
|
|
/* How many bytes are filled in headbuf */
|
|
size_t headbufoff;
|
|
/* Payload for control frames. It is not used for DATA frames */
|
|
uint8_t *buf;
|
|
/* Capacity of buf */
|
|
size_t bufmax;
|
|
/* length in Length field */
|
|
size_t len;
|
|
/* How many bytes are filled in buf */
|
|
size_t off;
|
|
} spdylay_inbound_frame;
|
|
|
|
typedef enum {
|
|
SPDYLAY_GOAWAY_NONE = 0,
|
|
/* Flag means GOAWAY frame is sent to the remote peer. */
|
|
SPDYLAY_GOAWAY_SEND = 0x1,
|
|
/* Flag means GOAWAY frame is received from the remote peer. */
|
|
SPDYLAY_GOAWAY_RECV = 0x2,
|
|
/* Flag means connection should be dropped after sending GOAWAY. */
|
|
SPDYLAY_GOAWAY_FAIL_ON_SEND = 0x4
|
|
} spdylay_goaway_flag;
|
|
|
|
struct spdylay_session {
|
|
/* The protocol version: either SPDYLAY_PROTO_SPDY2 or
|
|
SPDYLAY_PROTO_SPDY3 */
|
|
uint16_t version;
|
|
uint8_t server;
|
|
/* Next Stream ID. Made unsigned int to detect >= (1 << 31). */
|
|
uint32_t next_stream_id;
|
|
int32_t last_recv_stream_id;
|
|
/* Counter of unique ID of PING. Wraps when it exceeds
|
|
SPDYLAY_MAX_UNIQUE_ID */
|
|
uint32_t next_unique_id;
|
|
|
|
/* Sequence number of outbound frame to maintain the order of
|
|
enqueue if priority is equal. */
|
|
int64_t next_seq;
|
|
|
|
spdylay_map /* <spdylay_stream*> */ streams;
|
|
/* The number of outgoing streams. This will be capped by
|
|
remote_settings[SPDYLAY_SETTINGS_MAX_CONCURRENT_STREAMS]. */
|
|
size_t num_outgoing_streams;
|
|
/* The number of incoming streams. This will be capped by
|
|
local_settings[SPDYLAY_SETTINGS_MAX_CONCURRENT_STREAMS]. */
|
|
size_t num_incoming_streams;
|
|
|
|
/* Queue for outbound frames other than SYN_STREAM */
|
|
spdylay_pq /* <spdylay_outbound_item*> */ ob_pq;
|
|
/* Queue for outbound SYN_STREAM frame */
|
|
spdylay_pq /* <spdylay_outbound_item*> */ ob_ss_pq;
|
|
|
|
spdylay_active_outbound_item aob;
|
|
|
|
spdylay_inbound_frame iframe;
|
|
|
|
/* Buffer used to store inflated name/value pairs in wire format
|
|
temporarily on pack/unpack. */
|
|
uint8_t *nvbuf;
|
|
/* The number of bytes allocated for nvbuf */
|
|
size_t nvbuflen;
|
|
/* Buffer used to store name/value pairs while inflating them using
|
|
zlib on unpack */
|
|
spdylay_buffer inflatebuf;
|
|
|
|
spdylay_zlib hd_deflater;
|
|
spdylay_zlib hd_inflater;
|
|
|
|
/* The last unique ID sent to the peer. */
|
|
uint32_t last_ping_unique_id;
|
|
|
|
/* Flags indicating GOAWAY is sent and/or recieved. The flags are
|
|
composed by bitwise OR-ing spdylay_goaway_flag. */
|
|
uint8_t goaway_flags;
|
|
/* This is the value in GOAWAY frame sent by remote endpoint. */
|
|
int32_t last_good_stream_id;
|
|
|
|
/* Flag to indicate whether this session enforces flow
|
|
control. Nonzero for flow control enabled. */
|
|
uint8_t flow_control;
|
|
|
|
/* Settings value received from the remote endpoint. We just use ID
|
|
as index. The index = 0 is unused. */
|
|
uint32_t remote_settings[SPDYLAY_SETTINGS_MAX+1];
|
|
/* Settings value of the local endpoint. */
|
|
uint32_t local_settings[SPDYLAY_SETTINGS_MAX+1];
|
|
|
|
/* Option flags. This is bitwise-OR of 0 or more of spdylay_optmask. */
|
|
uint32_t opt_flags;
|
|
|
|
/* Client certificate vector */
|
|
spdylay_client_cert_vector cli_certvec;
|
|
|
|
spdylay_session_callbacks callbacks;
|
|
void *user_data;
|
|
};
|
|
|
|
/* Struct used when updating initial window size of each active
|
|
stream. */
|
|
typedef struct {
|
|
spdylay_session *session;
|
|
int32_t new_window_size, old_window_size;
|
|
} spdylay_update_window_size_arg;
|
|
|
|
/* TODO stream timeout etc */
|
|
|
|
/*
|
|
* Returns nonzero value if |stream_id| is initiated by local
|
|
* endpoint.
|
|
*/
|
|
int spdylay_session_is_my_stream_id(spdylay_session *session,
|
|
int32_t stream_id);
|
|
|
|
/*
|
|
* Adds frame |frame| to the outbound queue in |session|. The
|
|
* |frame_cat| must be either SPDYLAY_CTRL or SPDYLAY_DATA. If the
|
|
* |frame_cat| is SPDYLAY_CTRL, the |frame| must be a pointer to
|
|
* spdylay_frame. If the |frame_cat| is SPDYLAY_DATA, it must be a
|
|
* pointer to spdylay_data. |aux_data| is a pointer to the arbitrary
|
|
* data. Its interpretation is defined per the type of the frame. When
|
|
* this function succeeds, it takes ownership of |frame| and
|
|
* |aux_data|, so caller must not free them on success.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_add_frame(spdylay_session *session,
|
|
spdylay_frame_category frame_cat,
|
|
void *abs_frame, void *aux_data);
|
|
|
|
/*
|
|
* Adds RST_STREAM frame for the stream |stream_id| with status code
|
|
* |status_code|. This is a convenient function built on top of
|
|
* spdylay_session_add_frame() to add RST_STREAM easily.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_add_rst_stream(spdylay_session *session,
|
|
int32_t stream_id, uint32_t status_code);
|
|
|
|
/*
|
|
* Adds PING frame with unique ID |unique_id|. This is a convenient
|
|
* functin built on top of spdylay_session_add_frame() to add PING
|
|
* easily.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_add_ping(spdylay_session *session, uint32_t unique_id);
|
|
|
|
/*
|
|
* Adds GOAWAY frame with last-good-stream-ID |last_good_stream_id|
|
|
* and the status code |status_code|. The |status_code| is ignored if
|
|
* the protocol version is SPDYLAY_PROTO_SPDY2. This is a convenient
|
|
* function built on top of spdylay_session_add_frame() to add GOAWAY
|
|
* easily.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_add_goaway(spdylay_session *session,
|
|
int32_t last_good_stream_id,
|
|
uint32_t status_code);
|
|
|
|
/*
|
|
* Adds WINDOW_UPDATE frame with stream ID |stream_id| and
|
|
* delta-window-size |delta_window_size|. This is a convenient
|
|
* function built on top of spdylay_session_add_frame() to add
|
|
* WINDOW_UPDATE easily.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_add_window_update(spdylay_session *session,
|
|
int32_t stream_id,
|
|
int32_t delta_window_size);
|
|
|
|
/*
|
|
* Creates new stream in |session| with stream ID |stream_id|,
|
|
* priority |pri| and flags |flags|. SPDYLAY_CTRL_FLAG_UNIDIRECTIONAL
|
|
* flag is set in |flags|, this stream is
|
|
* unidirectional. SPDYLAY_CTRL_FLAG_FIN flag is set in |flags|, the
|
|
* sender of SYN_STREAM will not send any further data in this
|
|
* stream. Since this function is called when SYN_STREAM is sent or
|
|
* received, these flags are taken from SYN_STREAM. The state of
|
|
* stream is set to |initial_state|. |stream_user_data| is a pointer
|
|
* to the arbitrary user supplied data to be associated to this
|
|
* stream.
|
|
*
|
|
* This function returns a pointer to created new stream object, or
|
|
* NULL.
|
|
*/
|
|
spdylay_stream* spdylay_session_open_stream(spdylay_session *session,
|
|
int32_t stream_id,
|
|
uint8_t flags, uint8_t pri,
|
|
spdylay_stream_state initial_state,
|
|
void *stream_user_data);
|
|
|
|
/*
|
|
* Closes stream whose stream ID is |stream_id|. The reason of closure
|
|
* is indicated by |status_code|. When closing the stream,
|
|
* on_stream_close_callback will be called.
|
|
*
|
|
* This function returns 0 if it succeeds, or one the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_INVALID_ARGUMENT
|
|
* The specified stream does not exist.
|
|
*/
|
|
int spdylay_session_close_stream(spdylay_session *session, int32_t stream_id,
|
|
spdylay_status_code status_code);
|
|
|
|
/*
|
|
* Closes all pushed streams which associate them to stream
|
|
* |stream_id| with the status code |status_code|.
|
|
*/
|
|
void spdylay_session_close_pushed_streams(spdylay_session *session,
|
|
int32_t stream_id,
|
|
spdylay_status_code status_code);
|
|
|
|
/*
|
|
* If further receptions and transmissions over the stream |stream_id|
|
|
* are disallowed, close the stream with status code |status_code|.
|
|
*
|
|
* This function returns 0 if it
|
|
* succeeds, or one of the following negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_INVALID_ARGUMENT
|
|
* The specified stream does not exist.
|
|
*/
|
|
int spdylay_session_close_stream_if_shut_rdwr(spdylay_session *session,
|
|
spdylay_stream *stream);
|
|
|
|
/*
|
|
* Called when SYN_STREAM is received, assuming |frame.syn_stream| is
|
|
* properly initialized. This function does first validate received
|
|
* frame and then open stream and call callback functions. This
|
|
* function does not return error if frame is not valid.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_on_syn_stream_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when SYN_REPLY is received, assuming |frame.syn_reply| is
|
|
* properly initialized.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_on_syn_reply_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
|
|
/*
|
|
* Called when RST_STREAM is received, assuming |frame.rst_stream| is
|
|
* properly initialized.
|
|
*
|
|
* This function returns 0 and never fail.
|
|
*/
|
|
int spdylay_session_on_rst_stream_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when SETTINGS is received, assuming |frame.settings| is
|
|
* properly initialized.
|
|
*
|
|
* This function returns 0 and never fail.
|
|
*/
|
|
int spdylay_session_on_settings_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when PING is received, assuming |frame.ping| is properly
|
|
* initialized.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_on_ping_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when GOAWAY is received, assuming |frame.goaway| is properly
|
|
* initialized.
|
|
*
|
|
* This function returns 0 and never fail.
|
|
*/
|
|
int spdylay_session_on_goaway_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when HEADERS is recieved, assuming |frame.headers| is
|
|
* properly initialized.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_on_headers_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when WINDOW_UPDATE is recieved, assuming
|
|
* |frame.window_update| is properly initialized.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_on_window_update_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when CREDENTIAL is received, assuming |frame.credential| is
|
|
* properly initialized.
|
|
*
|
|
* Currently, this function always succeeds and returns 0.
|
|
*/
|
|
int spdylay_session_on_credential_received(spdylay_session *session,
|
|
spdylay_frame *frame);
|
|
|
|
/*
|
|
* Called when DATA is received.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_session_on_data_received(spdylay_session *session,
|
|
uint8_t flags, int32_t length,
|
|
int32_t stream_id);
|
|
|
|
/*
|
|
* Returns spdylay_stream* object whose stream ID is |stream_id|. It
|
|
* could be NULL if such stream does not exist.
|
|
*/
|
|
spdylay_stream* spdylay_session_get_stream(spdylay_session *session,
|
|
int32_t stream_id);
|
|
|
|
/*
|
|
* Packs DATA frame |frame| in wire frame format and stores it in
|
|
* |*buf_ptr|. The capacity of |*buf_ptr| is |*buflen_ptr|
|
|
* length. This function expands |*buf_ptr| as necessary to store
|
|
* given |frame|. It packs header in first 8 bytes. Remaining bytes
|
|
* are the DATA apyload and are filled using |frame->data_prd|. The
|
|
* length of payload is at most |datamax| bytes.
|
|
*
|
|
* This function returns the size of packed frame if it succeeds, or
|
|
* one of the following negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_DEFERRED
|
|
* The DATA frame is postponed.
|
|
* SPDYLAY_ERR_TEMPORAL_CALLBACK_FAILURE
|
|
* The read_callback failed (stream error).
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
* SPDYLAY_ERR_CALLBACK_FAILURE
|
|
* The read_callback failed (session error).
|
|
*/
|
|
ssize_t spdylay_session_pack_data(spdylay_session *session,
|
|
uint8_t **buf_ptr, size_t *buflen_ptr,
|
|
size_t datamax,
|
|
spdylay_data *frame);
|
|
|
|
/*
|
|
* Returns next unique ID which can be used with PING.
|
|
*/
|
|
uint32_t spdylay_session_get_next_unique_id(spdylay_session *session);
|
|
|
|
/*
|
|
* Returns top of outbound frame queue. This function returns NULL if
|
|
* queue is empty.
|
|
*/
|
|
spdylay_outbound_item* spdylay_session_get_ob_pq_top(spdylay_session *session);
|
|
|
|
/*
|
|
* Pops and returns next item to send. If there is no such item,
|
|
* returns NULL. This function takes into account max concurrent
|
|
* streams. That means if session->ob_pq is empty but
|
|
* session->ob_ss_pq has item and max concurrent streams is reached,
|
|
* then this function returns NULL.
|
|
*/
|
|
spdylay_outbound_item* spdylay_session_pop_next_ob_item
|
|
(spdylay_session *session);
|
|
|
|
/*
|
|
* Returns next item to send. If there is no such item, this function
|
|
* returns NULL. This function takes into account max concurrent
|
|
* streams. That means if session->ob_pq is empty but
|
|
* session->ob_ss_pq has item and max concurrent streams is reached,
|
|
* then this function returns NULL.
|
|
*/
|
|
spdylay_outbound_item* spdylay_session_get_next_ob_item
|
|
(spdylay_session *session);
|
|
|
|
/*
|
|
* Updates local settings with the |iv|. The number of elements in the
|
|
* array pointed by the |iv| is given by the |niv|. This function
|
|
* assumes that the all settings_id member in |iv| are in range 1 to
|
|
* SPDYLAY_SETTINGS_MAX, inclusive.
|
|
*/
|
|
void spdylay_session_update_local_settings(spdylay_session *session,
|
|
spdylay_settings_entry *iv,
|
|
size_t niv);
|
|
|
|
/*
|
|
* Returns the index in the client certificate vector for the
|
|
* |syn_stream|. The origin is computed from |syn_stream->nv|. If no
|
|
* client certificate is required, return 0. If CREDENTIAL frame needs
|
|
* to be sent before the |syn_stream|, this function returns
|
|
* :macro:`SPDYLAY_ERR_CREDENTIAL_PENDING`. In this case, CREDENTIAL
|
|
* frame has been already queued. This function returns one of the
|
|
* following negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
* SPDYLAY_ERR_CREDENTIAL_PENDING
|
|
* The CREDENTIAL frame must be sent before the |syn_stream|.
|
|
*/
|
|
int spdylay_session_prep_credential(spdylay_session *session,
|
|
spdylay_syn_stream *syn_stream);
|
|
|
|
#endif /* SPDYLAY_SESSION_H */
|