1251877Speter/* Copyright 2002-2004 Justin Erenkrantz and Greg Stein 2251877Speter * 3251877Speter * Licensed under the Apache License, Version 2.0 (the "License"); 4251877Speter * you may not use this file except in compliance with the License. 5251877Speter * You may obtain a copy of the License at 6251877Speter * 7251877Speter * http://www.apache.org/licenses/LICENSE-2.0 8251877Speter * 9251877Speter * Unless required by applicable law or agreed to in writing, software 10251877Speter * distributed under the License is distributed on an "AS IS" BASIS, 11251877Speter * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12251877Speter * See the License for the specific language governing permissions and 13251877Speter * limitations under the License. 14251877Speter */ 15251877Speter 16251877Speter#ifndef _SERF_PRIVATE_H_ 17251877Speter#define _SERF_PRIVATE_H_ 18251877Speter 19251877Speter/* ### what the hell? why does the APR interface have a "size" ?? 20251877Speter ### the implication is that, if we bust this limit, we'd need to 21251877Speter ### stop, rebuild a pollset, and repopulate it. what suckage. */ 22251877Speter#define MAX_CONN 16 23251877Speter 24251877Speter/* Windows does not define IOV_MAX, so we need to ensure it is defined. */ 25251877Speter#ifndef IOV_MAX 26262339Speter/* There is no limit for iovec count on Windows, but apr_socket_sendv 27262339Speter allocates WSABUF structures on stack if vecs_count <= 50. */ 28262339Speter#define IOV_MAX 50 29251877Speter#endif 30251877Speter 31253895Speter/* Older versions of APR do not have this macro. */ 32253895Speter#ifdef APR_SIZE_MAX 33253895Speter#define REQUESTED_MAX APR_SIZE_MAX 34253895Speter#else 35253895Speter#define REQUESTED_MAX (~((apr_size_t)0)) 36253895Speter#endif 37253895Speter 38251877Speter#define SERF_IO_CLIENT (1) 39251877Speter#define SERF_IO_CONN (2) 40251877Speter#define SERF_IO_LISTENER (3) 41251877Speter 42251877Speter/* Internal logging facilities, set flag to 1 to enable console logging for 43251877Speter the selected component. */ 44251877Speter#define SSL_VERBOSE 0 45251877Speter#define SSL_MSG_VERBOSE 0 /* logs decrypted requests and responses. */ 46251877Speter#define SOCK_VERBOSE 0 47251877Speter#define SOCK_MSG_VERBOSE 0 /* logs bytes received from or written to a socket. */ 48251877Speter#define CONN_VERBOSE 0 49251877Speter#define AUTH_VERBOSE 0 50251877Speter 51253895Speter/* Older versions of APR do not have the APR_VERSION_AT_LEAST macro. Those 52253895Speter implementations are safe. 53251877Speter 54253895Speter If the macro *is* defined, and we're on WIN32, and APR is version 1.4.0+, 55253895Speter then we have a broken WSAPoll() implementation. 56253895Speter 57253895Speter See serf_context_create_ex() below. */ 58253895Speter#if defined(APR_VERSION_AT_LEAST) && defined(WIN32) 59253895Speter#if APR_VERSION_AT_LEAST(1,4,0) 60253895Speter#define BROKEN_WSAPOLL 61253895Speter#endif 62253895Speter#endif 63253895Speter 64251877Spetertypedef struct serf__authn_scheme_t serf__authn_scheme_t; 65251877Speter 66251877Spetertypedef struct serf_io_baton_t { 67251877Speter int type; 68251877Speter union { 69251877Speter serf_incoming_t *client; 70251877Speter serf_connection_t *conn; 71251877Speter serf_listener_t *listener; 72251877Speter } u; 73251877Speter} serf_io_baton_t; 74251877Speter 75251877Speter/* Holds all the information corresponding to a request/response pair. */ 76251877Speterstruct serf_request_t { 77251877Speter serf_connection_t *conn; 78251877Speter 79251877Speter apr_pool_t *respool; 80251877Speter serf_bucket_alloc_t *allocator; 81251877Speter 82251877Speter /* The bucket corresponding to the request. Will be NULL once the 83251877Speter * bucket has been emptied (for delivery into the socket). 84251877Speter */ 85251877Speter serf_bucket_t *req_bkt; 86251877Speter 87251877Speter serf_request_setup_t setup; 88251877Speter void *setup_baton; 89251877Speter 90251877Speter serf_response_acceptor_t acceptor; 91251877Speter void *acceptor_baton; 92251877Speter 93251877Speter serf_response_handler_t handler; 94251877Speter void *handler_baton; 95251877Speter 96251877Speter serf_bucket_t *resp_bkt; 97251877Speter 98262339Speter int writing_started; 99251877Speter int priority; 100253895Speter /* 1 if this is a request to setup a SSL tunnel, 0 for normal requests. */ 101253895Speter int ssltunnel; 102251877Speter 103251877Speter /* This baton is currently only used for digest authentication, which 104251877Speter needs access to the uri of the request in the response handler. 105251877Speter If serf_request_t is replaced by a serf_http_request_t in the future, 106251877Speter which knows about uri and method and such, this baton won't be needed 107251877Speter anymore. */ 108251877Speter void *auth_baton; 109251877Speter 110251877Speter struct serf_request_t *next; 111251877Speter}; 112251877Speter 113251877Spetertypedef struct serf_pollset_t { 114251877Speter /* the set of connections to poll */ 115251877Speter apr_pollset_t *pollset; 116251877Speter} serf_pollset_t; 117251877Speter 118251877Spetertypedef struct serf__authn_info_t { 119251877Speter const serf__authn_scheme_t *scheme; 120251877Speter 121251877Speter void *baton; 122262339Speter 123262339Speter int failed_authn_types; 124251877Speter} serf__authn_info_t; 125251877Speter 126251877Speterstruct serf_context_t { 127251877Speter /* the pool used for self and for other allocations */ 128251877Speter apr_pool_t *pool; 129251877Speter 130251877Speter void *pollset_baton; 131251877Speter serf_socket_add_t pollset_add; 132251877Speter serf_socket_remove_t pollset_rm; 133251877Speter 134251877Speter /* one of our connections has a dirty pollset state. */ 135251877Speter int dirty_pollset; 136251877Speter 137251877Speter /* the list of active connections */ 138251877Speter apr_array_header_t *conns; 139251877Speter#define GET_CONN(ctx, i) (((serf_connection_t **)(ctx)->conns->elts)[i]) 140251877Speter 141251877Speter /* Proxy server address */ 142251877Speter apr_sockaddr_t *proxy_address; 143251877Speter 144251877Speter /* Progress callback */ 145251877Speter serf_progress_t progress_func; 146251877Speter void *progress_baton; 147251877Speter apr_off_t progress_read; 148251877Speter apr_off_t progress_written; 149251877Speter 150253895Speter /* authentication info for the servers used in this context. Shared by all 151253895Speter connections to the same server. 152253895Speter Structure of the hashtable: key: host url, e.g. https://localhost:80 153253895Speter value: serf__authn_info_t * 154253895Speter */ 155253895Speter apr_hash_t *server_authn_info; 156253895Speter 157253895Speter /* authentication info for the proxy configured in this context, shared by 158253895Speter all connections. */ 159251877Speter serf__authn_info_t proxy_authn_info; 160251877Speter 161251877Speter /* List of authn types supported by the client.*/ 162251877Speter int authn_types; 163251877Speter /* Callback function used to get credentials for a realm. */ 164251877Speter serf_credentials_callback_t cred_cb; 165251877Speter}; 166251877Speter 167251877Speterstruct serf_listener_t { 168251877Speter serf_context_t *ctx; 169251877Speter serf_io_baton_t baton; 170251877Speter apr_socket_t *skt; 171251877Speter apr_pool_t *pool; 172251877Speter apr_pollfd_t desc; 173251877Speter void *accept_baton; 174251877Speter serf_accept_client_t accept_func; 175251877Speter}; 176251877Speter 177251877Speterstruct serf_incoming_t { 178251877Speter serf_context_t *ctx; 179251877Speter serf_io_baton_t baton; 180251877Speter void *request_baton; 181251877Speter serf_incoming_request_cb_t request; 182251877Speter apr_socket_t *skt; 183251877Speter apr_pollfd_t desc; 184251877Speter}; 185251877Speter 186251877Speter/* States for the different stages in the lifecyle of a connection. */ 187251877Spetertypedef enum { 188251877Speter SERF_CONN_INIT, /* no socket created yet */ 189251877Speter SERF_CONN_SETUP_SSLTUNNEL, /* ssl tunnel being setup, no requests sent */ 190251877Speter SERF_CONN_CONNECTED, /* conn is ready to send requests */ 191253895Speter SERF_CONN_CLOSING /* conn is closing, no more requests, 192251877Speter start a new socket */ 193251877Speter} serf__connection_state_t; 194251877Speter 195251877Speterstruct serf_connection_t { 196251877Speter serf_context_t *ctx; 197251877Speter 198251877Speter apr_status_t status; 199251877Speter serf_io_baton_t baton; 200251877Speter 201251877Speter apr_pool_t *pool; 202251877Speter serf_bucket_alloc_t *allocator; 203251877Speter 204251877Speter apr_sockaddr_t *address; 205251877Speter 206251877Speter apr_socket_t *skt; 207251877Speter apr_pool_t *skt_pool; 208251877Speter 209251877Speter /* the last reqevents we gave to pollset_add */ 210251877Speter apr_int16_t reqevents; 211251877Speter 212251877Speter /* the events we've seen for this connection in our returned pollset */ 213251877Speter apr_int16_t seen_in_pollset; 214251877Speter 215251877Speter /* are we a dirty connection that needs its poll status updated? */ 216251877Speter int dirty_conn; 217251877Speter 218251877Speter /* number of completed requests we've sent */ 219251877Speter unsigned int completed_requests; 220251877Speter 221251877Speter /* number of completed responses we've got */ 222251877Speter unsigned int completed_responses; 223251877Speter 224251877Speter /* keepalive */ 225251877Speter unsigned int probable_keepalive_limit; 226251877Speter 227251877Speter /* Current state of the connection (whether or not it is connected). */ 228251877Speter serf__connection_state_t state; 229251877Speter 230251877Speter /* This connection may have responses without a request! */ 231251877Speter int async_responses; 232251877Speter serf_bucket_t *current_async_response; 233251877Speter serf_response_acceptor_t async_acceptor; 234251877Speter void *async_acceptor_baton; 235251877Speter serf_response_handler_t async_handler; 236251877Speter void *async_handler_baton; 237251877Speter 238251877Speter /* A bucket wrapped around our socket (for reading responses). */ 239251877Speter serf_bucket_t *stream; 240251877Speter /* A reference to the aggregate bucket that provides the boundary between 241251877Speter * request level buckets and connection level buckets. 242251877Speter */ 243251877Speter serf_bucket_t *ostream_head; 244251877Speter serf_bucket_t *ostream_tail; 245251877Speter 246251877Speter /* Aggregate bucket used to send the CONNECT request. */ 247251877Speter serf_bucket_t *ssltunnel_ostream; 248251877Speter 249251877Speter /* The list of active requests. */ 250251877Speter serf_request_t *requests; 251251877Speter serf_request_t *requests_tail; 252251877Speter 253251877Speter struct iovec vec[IOV_MAX]; 254251877Speter int vec_len; 255251877Speter 256251877Speter serf_connection_setup_t setup; 257251877Speter void *setup_baton; 258251877Speter serf_connection_closed_t closed; 259251877Speter void *closed_baton; 260251877Speter 261251877Speter /* Max. number of outstanding requests. */ 262251877Speter unsigned int max_outstanding_requests; 263251877Speter 264251877Speter int hit_eof; 265253895Speter 266253895Speter /* Host url, path ommitted, syntax: https://svn.apache.org . */ 267251877Speter const char *host_url; 268253895Speter 269253895Speter /* Exploded host url, path ommitted. Only scheme, hostinfo, hostname & 270253895Speter port values are filled in. */ 271251877Speter apr_uri_t host_info; 272251877Speter 273262339Speter /* authentication info for this connection. */ 274262339Speter serf__authn_info_t authn_info; 275251877Speter 276251877Speter /* Time marker when connection begins. */ 277251877Speter apr_time_t connect_time; 278251877Speter 279251877Speter /* Calculated connection latency. Negative value if latency is unknown. */ 280251877Speter apr_interval_time_t latency; 281253895Speter 282253895Speter /* Needs to read first before we can write again. */ 283253895Speter int stop_writing; 284251877Speter}; 285251877Speter 286251877Speter/*** Internal bucket functions ***/ 287251877Speter 288251877Speter/** Transform a response_bucket in-place into an aggregate bucket. Restore the 289251877Speter status line and all headers, not just the body. 290251877Speter 291251877Speter This can only be used when we haven't started reading the body of the 292251877Speter response yet. 293251877Speter 294251877Speter Keep internal for now, probably only useful within serf. 295251877Speter */ 296251877Speterapr_status_t serf_response_full_become_aggregate(serf_bucket_t *bucket); 297251877Speter 298262339Speter/** 299262339Speter * Remove the header from the list, do nothing if the header wasn't added. 300262339Speter */ 301262339Spetervoid serf__bucket_headers_remove(serf_bucket_t *headers_bucket, 302262339Speter const char *header); 303262339Speter 304251877Speter/*** Authentication handler declarations ***/ 305251877Speter 306251877Spetertypedef enum { PROXY, HOST } peer_t; 307251877Speter 308251877Speter/** 309251877Speter * For each authentication scheme we need a handler function of type 310251877Speter * serf__auth_handler_func_t. This function will be called when an 311251877Speter * authentication challenge is received in a session. 312251877Speter */ 313251877Spetertypedef apr_status_t 314251877Speter(*serf__auth_handler_func_t)(int code, 315251877Speter serf_request_t *request, 316251877Speter serf_bucket_t *response, 317251877Speter const char *auth_hdr, 318251877Speter const char *auth_attr, 319251877Speter void *baton, 320251877Speter apr_pool_t *pool); 321251877Speter 322251877Speter/** 323251877Speter * For each authentication scheme we need an initialization function of type 324251877Speter * serf__init_context_func_t. This function will be called the first time 325251877Speter * serf tries a specific authentication scheme handler. 326251877Speter */ 327251877Spetertypedef apr_status_t 328251877Speter(*serf__init_context_func_t)(int code, 329251877Speter serf_context_t *conn, 330251877Speter apr_pool_t *pool); 331251877Speter 332251877Speter/** 333251877Speter * For each authentication scheme we need an initialization function of type 334251877Speter * serf__init_conn_func_t. This function will be called when a new 335251877Speter * connection is opened. 336251877Speter */ 337251877Spetertypedef apr_status_t 338253895Speter(*serf__init_conn_func_t)(const serf__authn_scheme_t *scheme, 339253895Speter int code, 340251877Speter serf_connection_t *conn, 341251877Speter apr_pool_t *pool); 342251877Speter 343251877Speter/** 344251877Speter * For each authentication scheme we need a setup_request function of type 345251877Speter * serf__setup_request_func_t. This function will be called when a 346251877Speter * new serf_request_t object is created and should fill in the correct 347251877Speter * authentication headers (if needed). 348251877Speter */ 349251877Spetertypedef apr_status_t 350251877Speter(*serf__setup_request_func_t)(peer_t peer, 351251877Speter int code, 352251877Speter serf_connection_t *conn, 353251877Speter serf_request_t *request, 354251877Speter const char *method, 355251877Speter const char *uri, 356251877Speter serf_bucket_t *hdrs_bkt); 357251877Speter 358251877Speter/** 359251877Speter * This function will be called when a response is received, so that the 360251877Speter * scheme handler can validate the Authentication related response headers 361251877Speter * (if needed). 362251877Speter */ 363251877Spetertypedef apr_status_t 364262339Speter(*serf__validate_response_func_t)(const serf__authn_scheme_t *scheme, 365262339Speter peer_t peer, 366251877Speter int code, 367251877Speter serf_connection_t *conn, 368251877Speter serf_request_t *request, 369251877Speter serf_bucket_t *response, 370251877Speter apr_pool_t *pool); 371251877Speter 372251877Speter/** 373251877Speter * serf__authn_scheme_t: vtable for an authn scheme provider. 374251877Speter */ 375251877Speterstruct serf__authn_scheme_t { 376253895Speter /* The name of this authentication scheme. Used in headers of requests and 377253895Speter for logging. */ 378251877Speter const char *name; 379251877Speter 380253895Speter /* Key is the name of the authentication scheme in lower case, to 381253895Speter facilitate case insensitive matching of the response headers. */ 382253895Speter const char *key; 383253895Speter 384251877Speter /* Internal code used for this authn type. */ 385251877Speter int type; 386251877Speter 387251877Speter /* The context initialization function if any; otherwise, NULL */ 388251877Speter serf__init_context_func_t init_ctx_func; 389251877Speter 390251877Speter /* The connection initialization function if any; otherwise, NULL */ 391251877Speter serf__init_conn_func_t init_conn_func; 392251877Speter 393251877Speter /* The authentication handler function */ 394251877Speter serf__auth_handler_func_t handle_func; 395251877Speter 396251877Speter /* Function to set up the authentication header of a request */ 397251877Speter serf__setup_request_func_t setup_request_func; 398251877Speter 399251877Speter /* Function to validate the authentication header of a response */ 400251877Speter serf__validate_response_func_t validate_response_func; 401251877Speter}; 402251877Speter 403251877Speter/** 404251877Speter * Handles a 401 or 407 response, tries the different available authentication 405251877Speter * handlers. 406251877Speter */ 407251877Speterapr_status_t serf__handle_auth_response(int *consumed_response, 408251877Speter serf_request_t *request, 409251877Speter serf_bucket_t *response, 410251877Speter void *baton, 411251877Speter apr_pool_t *pool); 412251877Speter 413253895Speter/* Get the cached serf__authn_info_t object for the target server, or create one 414253895Speter when this is the first connection to the server. 415253895Speter TODO: The serf__authn_info_t objects are allocated in the context pool, so 416253895Speter a context that's used to connect to many different servers using Basic or 417253895Speter Digest authencation will hold on to many objects indefinitely. We should be 418253895Speter able to cleanup stale objects from time to time. */ 419253895Speterserf__authn_info_t *serf__get_authn_info_for_server(serf_connection_t *conn); 420253895Speter 421251877Speter/* fromt context.c */ 422251877Spetervoid serf__context_progress_delta(void *progress_baton, apr_off_t read, 423251877Speter apr_off_t written); 424251877Speter 425251877Speter/* from incoming.c */ 426251877Speterapr_status_t serf__process_client(serf_incoming_t *l, apr_int16_t events); 427251877Speterapr_status_t serf__process_listener(serf_listener_t *l); 428251877Speter 429251877Speter/* from outgoing.c */ 430251877Speterapr_status_t serf__open_connections(serf_context_t *ctx); 431251877Speterapr_status_t serf__process_connection(serf_connection_t *conn, 432251877Speter apr_int16_t events); 433251877Speterapr_status_t serf__conn_update_pollset(serf_connection_t *conn); 434253895Speterserf_request_t *serf__ssltunnel_request_create(serf_connection_t *conn, 435253895Speter serf_request_setup_t setup, 436253895Speter void *setup_baton); 437253895Speterapr_status_t serf__provide_credentials(serf_context_t *ctx, 438253895Speter char **username, 439253895Speter char **password, 440253895Speter serf_request_t *request, 441253895Speter void *baton, 442253895Speter int code, const char *authn_type, 443253895Speter const char *realm, 444253895Speter apr_pool_t *pool); 445251877Speter 446251877Speter/* from ssltunnel.c */ 447251877Speterapr_status_t serf__ssltunnel_connect(serf_connection_t *conn); 448251877Speter 449251877Speter 450251877Speter/** Logging functions. Use one of the [COMP]_VERBOSE flags to enable specific 451251877Speter logging. 452251877Speter **/ 453251877Speter 454251877Speter/* Logs a standard event, with filename & timestamp header */ 455251877Spetervoid serf__log(int verbose_flag, const char *filename, const char *fmt, ...); 456251877Speter 457251877Speter/* Logs a standard event, but without prefix. This is useful to build up 458251877Speter log lines in parts. */ 459251877Spetervoid serf__log_nopref(int verbose_flag, const char *fmt, ...); 460251877Speter 461251877Speter/* Logs a socket event, add local and remote ip address:port */ 462251877Spetervoid serf__log_skt(int verbose_flag, const char *filename, apr_socket_t *skt, 463251877Speter const char *fmt, ...); 464251877Speter 465251877Speter#endif 466