1362181Sdim/* ==================================================================== 2362181Sdim * Licensed to the Apache Software Foundation (ASF) under one 3362181Sdim * or more contributor license agreements. See the NOTICE file 4362181Sdim * distributed with this work for additional information 5362181Sdim * regarding copyright ownership. The ASF licenses this file 6362181Sdim * to you under the Apache License, Version 2.0 (the 7362181Sdim * "License"); you may not use this file except in compliance 8362181Sdim * with the License. You may obtain a copy of the License at 9251877Speter * 10362181Sdim * http://www.apache.org/licenses/LICENSE-2.0 11251877Speter * 12362181Sdim * Unless required by applicable law or agreed to in writing, 13362181Sdim * software distributed under the License is distributed on an 14362181Sdim * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15362181Sdim * KIND, either express or implied. See the License for the 16362181Sdim * specific language governing permissions and limitations 17362181Sdim * under the License. 18362181Sdim * ==================================================================== 19251877Speter */ 20251877Speter 21251877Speter#ifndef _SERF_PRIVATE_H_ 22251877Speter#define _SERF_PRIVATE_H_ 23251877Speter 24251877Speter/* ### what the hell? why does the APR interface have a "size" ?? 25251877Speter ### the implication is that, if we bust this limit, we'd need to 26251877Speter ### stop, rebuild a pollset, and repopulate it. what suckage. */ 27251877Speter#define MAX_CONN 16 28251877Speter 29251877Speter/* Windows does not define IOV_MAX, so we need to ensure it is defined. */ 30251877Speter#ifndef IOV_MAX 31262324Speter/* There is no limit for iovec count on Windows, but apr_socket_sendv 32262324Speter allocates WSABUF structures on stack if vecs_count <= 50. */ 33262324Speter#define IOV_MAX 50 34251877Speter#endif 35251877Speter 36253895Speter/* Older versions of APR do not have this macro. */ 37253895Speter#ifdef APR_SIZE_MAX 38253895Speter#define REQUESTED_MAX APR_SIZE_MAX 39253895Speter#else 40253895Speter#define REQUESTED_MAX (~((apr_size_t)0)) 41253895Speter#endif 42253895Speter 43251877Speter#define SERF_IO_CLIENT (1) 44251877Speter#define SERF_IO_CONN (2) 45251877Speter#define SERF_IO_LISTENER (3) 46251877Speter 47251877Speter/* Internal logging facilities, set flag to 1 to enable console logging for 48251877Speter the selected component. */ 49251877Speter#define SSL_VERBOSE 0 50251877Speter#define SSL_MSG_VERBOSE 0 /* logs decrypted requests and responses. */ 51251877Speter#define SOCK_VERBOSE 0 52251877Speter#define SOCK_MSG_VERBOSE 0 /* logs bytes received from or written to a socket. */ 53251877Speter#define CONN_VERBOSE 0 54251877Speter#define AUTH_VERBOSE 0 55251877Speter 56253895Speter/* Older versions of APR do not have the APR_VERSION_AT_LEAST macro. Those 57253895Speter implementations are safe. 58251877Speter 59253895Speter If the macro *is* defined, and we're on WIN32, and APR is version 1.4.0+, 60253895Speter then we have a broken WSAPoll() implementation. 61253895Speter 62253895Speter See serf_context_create_ex() below. */ 63253895Speter#if defined(APR_VERSION_AT_LEAST) && defined(WIN32) 64253895Speter#if APR_VERSION_AT_LEAST(1,4,0) 65253895Speter#define BROKEN_WSAPOLL 66253895Speter#endif 67253895Speter#endif 68253895Speter 69251877Spetertypedef struct serf__authn_scheme_t serf__authn_scheme_t; 70251877Speter 71251877Spetertypedef struct serf_io_baton_t { 72251877Speter int type; 73251877Speter union { 74251877Speter serf_incoming_t *client; 75251877Speter serf_connection_t *conn; 76251877Speter serf_listener_t *listener; 77251877Speter } u; 78251877Speter} serf_io_baton_t; 79251877Speter 80251877Speter/* Holds all the information corresponding to a request/response pair. */ 81251877Speterstruct serf_request_t { 82251877Speter serf_connection_t *conn; 83251877Speter 84251877Speter apr_pool_t *respool; 85251877Speter serf_bucket_alloc_t *allocator; 86251877Speter 87251877Speter /* The bucket corresponding to the request. Will be NULL once the 88251877Speter * bucket has been emptied (for delivery into the socket). 89251877Speter */ 90251877Speter serf_bucket_t *req_bkt; 91251877Speter 92251877Speter serf_request_setup_t setup; 93251877Speter void *setup_baton; 94251877Speter 95251877Speter serf_response_acceptor_t acceptor; 96251877Speter void *acceptor_baton; 97251877Speter 98251877Speter serf_response_handler_t handler; 99251877Speter void *handler_baton; 100251877Speter 101251877Speter serf_bucket_t *resp_bkt; 102251877Speter 103262324Speter int writing_started; 104251877Speter int priority; 105253895Speter /* 1 if this is a request to setup a SSL tunnel, 0 for normal requests. */ 106253895Speter int ssltunnel; 107251877Speter 108251877Speter /* This baton is currently only used for digest authentication, which 109251877Speter needs access to the uri of the request in the response handler. 110251877Speter If serf_request_t is replaced by a serf_http_request_t in the future, 111251877Speter which knows about uri and method and such, this baton won't be needed 112251877Speter anymore. */ 113251877Speter void *auth_baton; 114251877Speter 115251877Speter struct serf_request_t *next; 116251877Speter}; 117251877Speter 118251877Spetertypedef struct serf_pollset_t { 119251877Speter /* the set of connections to poll */ 120251877Speter apr_pollset_t *pollset; 121251877Speter} serf_pollset_t; 122251877Speter 123251877Spetertypedef struct serf__authn_info_t { 124251877Speter const serf__authn_scheme_t *scheme; 125251877Speter 126251877Speter void *baton; 127262324Speter 128262324Speter int failed_authn_types; 129251877Speter} serf__authn_info_t; 130251877Speter 131251877Speterstruct serf_context_t { 132251877Speter /* the pool used for self and for other allocations */ 133251877Speter apr_pool_t *pool; 134251877Speter 135251877Speter void *pollset_baton; 136251877Speter serf_socket_add_t pollset_add; 137251877Speter serf_socket_remove_t pollset_rm; 138251877Speter 139251877Speter /* one of our connections has a dirty pollset state. */ 140251877Speter int dirty_pollset; 141251877Speter 142251877Speter /* the list of active connections */ 143251877Speter apr_array_header_t *conns; 144251877Speter#define GET_CONN(ctx, i) (((serf_connection_t **)(ctx)->conns->elts)[i]) 145251877Speter 146251877Speter /* Proxy server address */ 147251877Speter apr_sockaddr_t *proxy_address; 148251877Speter 149251877Speter /* Progress callback */ 150251877Speter serf_progress_t progress_func; 151251877Speter void *progress_baton; 152251877Speter apr_off_t progress_read; 153251877Speter apr_off_t progress_written; 154251877Speter 155253895Speter /* authentication info for the servers used in this context. Shared by all 156253895Speter connections to the same server. 157253895Speter Structure of the hashtable: key: host url, e.g. https://localhost:80 158253895Speter value: serf__authn_info_t * 159253895Speter */ 160253895Speter apr_hash_t *server_authn_info; 161253895Speter 162253895Speter /* authentication info for the proxy configured in this context, shared by 163253895Speter all connections. */ 164251877Speter serf__authn_info_t proxy_authn_info; 165251877Speter 166251877Speter /* List of authn types supported by the client.*/ 167251877Speter int authn_types; 168251877Speter /* Callback function used to get credentials for a realm. */ 169251877Speter serf_credentials_callback_t cred_cb; 170251877Speter}; 171251877Speter 172251877Speterstruct serf_listener_t { 173251877Speter serf_context_t *ctx; 174251877Speter serf_io_baton_t baton; 175251877Speter apr_socket_t *skt; 176251877Speter apr_pool_t *pool; 177251877Speter apr_pollfd_t desc; 178251877Speter void *accept_baton; 179251877Speter serf_accept_client_t accept_func; 180251877Speter}; 181251877Speter 182251877Speterstruct serf_incoming_t { 183251877Speter serf_context_t *ctx; 184251877Speter serf_io_baton_t baton; 185251877Speter void *request_baton; 186251877Speter serf_incoming_request_cb_t request; 187251877Speter apr_socket_t *skt; 188251877Speter apr_pollfd_t desc; 189251877Speter}; 190251877Speter 191251877Speter/* States for the different stages in the lifecyle of a connection. */ 192251877Spetertypedef enum { 193251877Speter SERF_CONN_INIT, /* no socket created yet */ 194251877Speter SERF_CONN_SETUP_SSLTUNNEL, /* ssl tunnel being setup, no requests sent */ 195251877Speter SERF_CONN_CONNECTED, /* conn is ready to send requests */ 196253895Speter SERF_CONN_CLOSING /* conn is closing, no more requests, 197251877Speter start a new socket */ 198251877Speter} serf__connection_state_t; 199251877Speter 200251877Speterstruct serf_connection_t { 201251877Speter serf_context_t *ctx; 202251877Speter 203251877Speter apr_status_t status; 204251877Speter serf_io_baton_t baton; 205251877Speter 206251877Speter apr_pool_t *pool; 207251877Speter serf_bucket_alloc_t *allocator; 208251877Speter 209251877Speter apr_sockaddr_t *address; 210251877Speter 211251877Speter apr_socket_t *skt; 212251877Speter apr_pool_t *skt_pool; 213251877Speter 214251877Speter /* the last reqevents we gave to pollset_add */ 215251877Speter apr_int16_t reqevents; 216251877Speter 217251877Speter /* the events we've seen for this connection in our returned pollset */ 218251877Speter apr_int16_t seen_in_pollset; 219251877Speter 220251877Speter /* are we a dirty connection that needs its poll status updated? */ 221251877Speter int dirty_conn; 222251877Speter 223251877Speter /* number of completed requests we've sent */ 224251877Speter unsigned int completed_requests; 225251877Speter 226251877Speter /* number of completed responses we've got */ 227251877Speter unsigned int completed_responses; 228251877Speter 229251877Speter /* keepalive */ 230251877Speter unsigned int probable_keepalive_limit; 231251877Speter 232251877Speter /* Current state of the connection (whether or not it is connected). */ 233251877Speter serf__connection_state_t state; 234251877Speter 235251877Speter /* This connection may have responses without a request! */ 236251877Speter int async_responses; 237251877Speter serf_bucket_t *current_async_response; 238251877Speter serf_response_acceptor_t async_acceptor; 239251877Speter void *async_acceptor_baton; 240251877Speter serf_response_handler_t async_handler; 241251877Speter void *async_handler_baton; 242251877Speter 243251877Speter /* A bucket wrapped around our socket (for reading responses). */ 244251877Speter serf_bucket_t *stream; 245251877Speter /* A reference to the aggregate bucket that provides the boundary between 246251877Speter * request level buckets and connection level buckets. 247251877Speter */ 248251877Speter serf_bucket_t *ostream_head; 249251877Speter serf_bucket_t *ostream_tail; 250251877Speter 251251877Speter /* Aggregate bucket used to send the CONNECT request. */ 252251877Speter serf_bucket_t *ssltunnel_ostream; 253251877Speter 254251877Speter /* The list of active requests. */ 255251877Speter serf_request_t *requests; 256251877Speter serf_request_t *requests_tail; 257251877Speter 258251877Speter struct iovec vec[IOV_MAX]; 259251877Speter int vec_len; 260251877Speter 261251877Speter serf_connection_setup_t setup; 262251877Speter void *setup_baton; 263251877Speter serf_connection_closed_t closed; 264251877Speter void *closed_baton; 265251877Speter 266251877Speter /* Max. number of outstanding requests. */ 267251877Speter unsigned int max_outstanding_requests; 268251877Speter 269251877Speter int hit_eof; 270253895Speter 271253895Speter /* Host url, path ommitted, syntax: https://svn.apache.org . */ 272251877Speter const char *host_url; 273253895Speter 274253895Speter /* Exploded host url, path ommitted. Only scheme, hostinfo, hostname & 275253895Speter port values are filled in. */ 276251877Speter apr_uri_t host_info; 277251877Speter 278262324Speter /* authentication info for this connection. */ 279262324Speter serf__authn_info_t authn_info; 280251877Speter 281251877Speter /* Time marker when connection begins. */ 282251877Speter apr_time_t connect_time; 283251877Speter 284251877Speter /* Calculated connection latency. Negative value if latency is unknown. */ 285251877Speter apr_interval_time_t latency; 286253895Speter 287253895Speter /* Needs to read first before we can write again. */ 288253895Speter int stop_writing; 289251877Speter}; 290251877Speter 291251877Speter/*** Internal bucket functions ***/ 292251877Speter 293251877Speter/** Transform a response_bucket in-place into an aggregate bucket. Restore the 294251877Speter status line and all headers, not just the body. 295251877Speter 296251877Speter This can only be used when we haven't started reading the body of the 297251877Speter response yet. 298251877Speter 299251877Speter Keep internal for now, probably only useful within serf. 300251877Speter */ 301251877Speterapr_status_t serf_response_full_become_aggregate(serf_bucket_t *bucket); 302251877Speter 303262324Speter/** 304262324Speter * Remove the header from the list, do nothing if the header wasn't added. 305262324Speter */ 306262324Spetervoid serf__bucket_headers_remove(serf_bucket_t *headers_bucket, 307262324Speter const char *header); 308262324Speter 309251877Speter/*** Authentication handler declarations ***/ 310251877Speter 311251877Spetertypedef enum { PROXY, HOST } peer_t; 312251877Speter 313251877Speter/** 314251877Speter * For each authentication scheme we need a handler function of type 315251877Speter * serf__auth_handler_func_t. This function will be called when an 316251877Speter * authentication challenge is received in a session. 317251877Speter */ 318251877Spetertypedef apr_status_t 319251877Speter(*serf__auth_handler_func_t)(int code, 320251877Speter serf_request_t *request, 321251877Speter serf_bucket_t *response, 322251877Speter const char *auth_hdr, 323251877Speter const char *auth_attr, 324251877Speter void *baton, 325251877Speter apr_pool_t *pool); 326251877Speter 327251877Speter/** 328251877Speter * For each authentication scheme we need an initialization function of type 329251877Speter * serf__init_context_func_t. This function will be called the first time 330251877Speter * serf tries a specific authentication scheme handler. 331251877Speter */ 332251877Spetertypedef apr_status_t 333251877Speter(*serf__init_context_func_t)(int code, 334251877Speter serf_context_t *conn, 335251877Speter apr_pool_t *pool); 336251877Speter 337251877Speter/** 338251877Speter * For each authentication scheme we need an initialization function of type 339251877Speter * serf__init_conn_func_t. This function will be called when a new 340251877Speter * connection is opened. 341251877Speter */ 342251877Spetertypedef apr_status_t 343253895Speter(*serf__init_conn_func_t)(const serf__authn_scheme_t *scheme, 344253895Speter int code, 345251877Speter serf_connection_t *conn, 346251877Speter apr_pool_t *pool); 347251877Speter 348251877Speter/** 349251877Speter * For each authentication scheme we need a setup_request function of type 350251877Speter * serf__setup_request_func_t. This function will be called when a 351251877Speter * new serf_request_t object is created and should fill in the correct 352251877Speter * authentication headers (if needed). 353251877Speter */ 354251877Spetertypedef apr_status_t 355251877Speter(*serf__setup_request_func_t)(peer_t peer, 356251877Speter int code, 357251877Speter serf_connection_t *conn, 358251877Speter serf_request_t *request, 359251877Speter const char *method, 360251877Speter const char *uri, 361251877Speter serf_bucket_t *hdrs_bkt); 362251877Speter 363251877Speter/** 364251877Speter * This function will be called when a response is received, so that the 365251877Speter * scheme handler can validate the Authentication related response headers 366251877Speter * (if needed). 367251877Speter */ 368251877Spetertypedef apr_status_t 369262324Speter(*serf__validate_response_func_t)(const serf__authn_scheme_t *scheme, 370262324Speter peer_t peer, 371251877Speter int code, 372251877Speter serf_connection_t *conn, 373251877Speter serf_request_t *request, 374251877Speter serf_bucket_t *response, 375251877Speter apr_pool_t *pool); 376251877Speter 377251877Speter/** 378251877Speter * serf__authn_scheme_t: vtable for an authn scheme provider. 379251877Speter */ 380251877Speterstruct serf__authn_scheme_t { 381253895Speter /* The name of this authentication scheme. Used in headers of requests and 382253895Speter for logging. */ 383251877Speter const char *name; 384251877Speter 385253895Speter /* Key is the name of the authentication scheme in lower case, to 386253895Speter facilitate case insensitive matching of the response headers. */ 387253895Speter const char *key; 388253895Speter 389251877Speter /* Internal code used for this authn type. */ 390251877Speter int type; 391251877Speter 392251877Speter /* The context initialization function if any; otherwise, NULL */ 393251877Speter serf__init_context_func_t init_ctx_func; 394251877Speter 395251877Speter /* The connection initialization function if any; otherwise, NULL */ 396251877Speter serf__init_conn_func_t init_conn_func; 397251877Speter 398251877Speter /* The authentication handler function */ 399251877Speter serf__auth_handler_func_t handle_func; 400251877Speter 401251877Speter /* Function to set up the authentication header of a request */ 402251877Speter serf__setup_request_func_t setup_request_func; 403251877Speter 404251877Speter /* Function to validate the authentication header of a response */ 405251877Speter serf__validate_response_func_t validate_response_func; 406251877Speter}; 407251877Speter 408251877Speter/** 409251877Speter * Handles a 401 or 407 response, tries the different available authentication 410251877Speter * handlers. 411251877Speter */ 412251877Speterapr_status_t serf__handle_auth_response(int *consumed_response, 413251877Speter serf_request_t *request, 414251877Speter serf_bucket_t *response, 415251877Speter void *baton, 416251877Speter apr_pool_t *pool); 417251877Speter 418253895Speter/* Get the cached serf__authn_info_t object for the target server, or create one 419253895Speter when this is the first connection to the server. 420253895Speter TODO: The serf__authn_info_t objects are allocated in the context pool, so 421253895Speter a context that's used to connect to many different servers using Basic or 422253895Speter Digest authencation will hold on to many objects indefinitely. We should be 423253895Speter able to cleanup stale objects from time to time. */ 424253895Speterserf__authn_info_t *serf__get_authn_info_for_server(serf_connection_t *conn); 425253895Speter 426251877Speter/* fromt context.c */ 427251877Spetervoid serf__context_progress_delta(void *progress_baton, apr_off_t read, 428251877Speter apr_off_t written); 429251877Speter 430251877Speter/* from incoming.c */ 431251877Speterapr_status_t serf__process_client(serf_incoming_t *l, apr_int16_t events); 432251877Speterapr_status_t serf__process_listener(serf_listener_t *l); 433251877Speter 434251877Speter/* from outgoing.c */ 435251877Speterapr_status_t serf__open_connections(serf_context_t *ctx); 436251877Speterapr_status_t serf__process_connection(serf_connection_t *conn, 437251877Speter apr_int16_t events); 438251877Speterapr_status_t serf__conn_update_pollset(serf_connection_t *conn); 439253895Speterserf_request_t *serf__ssltunnel_request_create(serf_connection_t *conn, 440253895Speter serf_request_setup_t setup, 441253895Speter void *setup_baton); 442253895Speterapr_status_t serf__provide_credentials(serf_context_t *ctx, 443253895Speter char **username, 444253895Speter char **password, 445253895Speter serf_request_t *request, 446253895Speter void *baton, 447253895Speter int code, const char *authn_type, 448253895Speter const char *realm, 449253895Speter apr_pool_t *pool); 450251877Speter 451251877Speter/* from ssltunnel.c */ 452251877Speterapr_status_t serf__ssltunnel_connect(serf_connection_t *conn); 453251877Speter 454251877Speter 455251877Speter/** Logging functions. Use one of the [COMP]_VERBOSE flags to enable specific 456251877Speter logging. 457251877Speter **/ 458251877Speter 459251877Speter/* Logs a standard event, with filename & timestamp header */ 460251877Spetervoid serf__log(int verbose_flag, const char *filename, const char *fmt, ...); 461251877Speter 462251877Speter/* Logs a standard event, but without prefix. This is useful to build up 463251877Speter log lines in parts. */ 464251877Spetervoid serf__log_nopref(int verbose_flag, const char *fmt, ...); 465251877Speter 466251877Speter/* Logs a socket event, add local and remote ip address:port */ 467251877Spetervoid serf__log_skt(int verbose_flag, const char *filename, apr_socket_t *skt, 468251877Speter const char *fmt, ...); 469251877Speter 470251877Speter#endif 471