a mzfj0@sdZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlmZddlmZmZmZddlmZddlmZddlmZdd lmZmZd Z e !d kZ"e#d d $dZ%e" oe% Z&e&r:zddl'Z'ddl(Z(Wn e)y0dZ&d\Z'Z(Yn0ddl*Z*e"rpe+edrpe+eds^de_,e+edspde_-e+edserdnde_.dZ/dZ0dZ1dZ2dZ3dZ4dZ5d Z6d!Z7d"Z8e9d:d#e8fZ;e<Z=gd$Z>e+e d%sie _?Gd&d'd'Z@Gd(d)d)e@ZAGd*d+d+ZBGd,d-d-ZCGd.d/d/ZDGd0d1d1ZEGd2d3d3ZFGd4d5d5ZGGd6d7d7ZHd8d9d:ZId>d serve() while ready: _connections.run() while not stop_requested: child = socket.accept() # blocks until a request comes in conn = HTTPConnection(child, ...) server.process_conn(conn) # adds conn to threadpool Worker threads are kept in a pool and poll the Queue, popping off and then handling each connection in turn. Each connection can consist of an arbitrary number of requests and their responses, so we run a nested loop:: while True: conn = server.requests.get() conn.communicate() -> while True: req = HTTPRequest(...) req.parse_request() -> # Read the Request-Line, e.g. "GET /page HTTP/1.1" req.rfile.readline() read_headers(req.rfile, req.inheaders) req.respond() -> response = app(...) try: for chunk in response: if chunk: req.write(chunk) finally: if hasattr(response, "close"): response.close() if req.close_connection: return For running a server you can invoke :func:`start() ` (it will run the server forever) or use invoking :func:`prepare() ` and :func:`serve() ` like this:: server = HTTPServer(...) server.prepare() try: threading.Thread(target=server.serve).start() # waiting/detecting some appropriate stop condition here ... finally: server.stop() And now for a trivial doctest to exercise the test suite .. testsetup:: from cheroot.server import HTTPServer >>> 'HTTPServer' in globals() True N) lru_cache) connectionserrors __version__)bton)IS_PPC) threadpool)MakeFile StreamWriter) HTTPRequestHTTPConnection HTTPServer HeaderReaderDropUnderscoreHeaderReaderSizeCheckWrapperKnownLengthRFile ChunkedRFileGatewayget_ssl_adapter_classWindowsSERVER_SOFTWAREzGoogle App Engine/F)NNAF_INET6 IPPROTO_IPV6) IPV6_V6ONLY SO_PEERCRED s   :;*/s%2Fs(?i))sAcceptsAccept-CharsetsAccept-EncodingsAccept-Languages Accept-RangessAllows Cache-Control ConnectionsContent-EncodingsContent-LanguageExpectsIf-Matchs If-None-MatchsPragmasProxy-AuthenticatesTEsTrailerTransfer-EncodingsUpgradesVarysViasWarningsWWW-Authenticate statisticsc@s*eZdZdZd ddZddZddZdS) rz`Object for reading headers from an HTTP request. Interface and default implementation. NcCs|dur i}|}|s td|tkr*q|tsmaxlen bytes_read)r=r>rUrDrDrE__init__szSizeCheckWrapper.__init__cCs|jr|j|jkrtdSrI)rUrVrMaxSizeExceededr=rDrDrE _check_length szSizeCheckWrapper._check_lengthNcCs*|j|}|jt|7_||S)Read a chunk from ``rfile`` buffer and return it. :param size: amount of data to read :type size: int :returns: chunk from ``rfile``, limited by size if specified :rtype: bytes )r>readrVlenrZr=sizedatarDrDrEr\s zSizeCheckWrapper.readcCs|dur2|j|}|jt|7_||Sg}|jd}|jt|7_|||t|dks|ddtkr6t|Sq6dS)Read a single line from ``rfile`` buffer and return it. :param size: minimum amount of data to read :type size: int :returns: one line from ``rfile`` :rtype: bytes N) r>r/rVr]rZappendLFEMPTYr<)r=r_r`resrDrDrEr/s    zSizeCheckWrapper.readlinercCsVd}g}||}|rR|||t|7}d|kr@|krFqRnqR||}q|SzRead all lines from ``rfile`` buffer and return them. :param sizehint: hint of minimum amount of data to read :type sizehint: int :returns: lines of bytes read from ``rfile`` :rtype: list[bytes] rr/rdr]r=sizehinttotallinesr?rDrDrE readlines9s     zSizeCheckWrapper.readlinescCs|jdSz*Release resources allocated for ``rfile``.Nr>closerYrDrDrErqNszSizeCheckWrapper.closecCs|SzReturn file iterator.rDrYrDrDrE__iter__RszSizeCheckWrapper.__iter__cCs(t|j}|jt|7_||SzGenerate next file chunk.)nextr>rVr]rZr=r`rDrDrE__next__Vs zSizeCheckWrapper.__next__)N)N)r) rKrLrMrNrWrZr\r/rnrqrsrwrurDrDrDrErs   rc@sReZdZdZddZdddZdddZdd d Zd d ZddZ ddZ e Z dS)rzWraps a file-like object, returning an empty string when exhausted. :param rfile: ``file`` of a known size :param int content_length: length of the file being read cCs||_||_dS)z%Initialize KnownLengthRFile instance.N)r> remaining)r=r>content_lengthrDrDrErWgszKnownLengthRFile.__init__NcCsL|jdkrdS|dur|j}n t||j}|j|}|jt|8_|S)zRead a chunk from ``rfile`` buffer and return it. :param size: amount of data to read :type size: int :rtype: bytes :returns: chunk from ``rfile``, limited by size if specified rr&N)rxminr>r\r]r^rDrDrEr\ls   zKnownLengthRFile.readcCsL|jdkrdS|dur|j}n t||j}|j|}|jt|8_|S)rarr&N)rxrzr>r/r]r^rDrDrEr/s   zKnownLengthRFile.readlinercCsVd}g}||}|rR|||t|7}d|kr@|krFqRnqR||}q|SrhrirjrDrDrErns     zKnownLengthRFile.readlinescCs|jdSrorprYrDrDrErqszKnownLengthRFile.closecCs|SrrrDrYrDrDrErsszKnownLengthRFile.__iter__cCs t|j}|jt|8_|Srt)rur>rxr]rvrDrDrErws zKnownLengthRFile.__next__)N)N)r) rKrLrMrNrWr\r/rnrqrsrwrurDrDrDrEr`s   rc@sPeZdZdZdddZddZddd Zdd d Zdd dZddZ ddZ dS)raWraps a file-like object, returning an empty string when exhausted. This class is intended to provide a conforming wsgi.input value for request entities that have been encoded with the 'chunked' transfer encoding. :param rfile: file encoded with the 'chunked' transfer encoding :param int maxlen: maximum length of the file being read :param int bufsize: size of the buffer used to read the file cCs(||_||_d|_t|_||_d|_dS)z!Initialize ChunkedRFile instance.rFN)r>rUrVrfbufferbufsizeclosed)r=r>rUr}rDrDrErWs zChunkedRFile.__init__cCs|jr dS|j}|jt|7_|jrF|j|jkrFtd|j| t d}z| d}t |d}Wn"t yt dj|dYn0|dkrd|_dS|jr|j||jkrtd|j|}|jt|7_|j|7_|jd}|tkrt d t|d dS) NRequest Entity Too Largerrz)Bad chunked transfer size: {chunk_size!r}) chunk_sizeTz2Bad chunked transfer coding (expected '\r\n', got ))r~r>r/rVr]rUrrXr5r6 SEMICOLONpopintr0formatIOErrorr\r|r1repr)r=r?rchunkZcrlfrDrDrE_fetchsF       zChunkedRFile._fetchNcCst}|dkr|S|r$t||kr$|S|js<||js<|S|rp|t|}||jd|7}|j|d|_q||j7}t|_qdS)r[rN)rfr]r|r)r=r_r`rxrDrDrEr\s   zChunkedRFile.readcCst}|dkr|S|r$t||kr$|S|js<||js<|S|jt}|r|dkr|t|}||jd|7}|j|d|_qt|t||}||jd|7}|j|d|_q|dkr||j7}t|_q||jd|7}|j|d|_qdS)rarrcN)rfr]r|rfindrerz)r=r_r`Z newline_posrxrDrDrEr/s.    zChunkedRFile.readlinercCsVd}g}||}|rR|||t|7}d|kr@|krFqRnqR||}q|SrhrirjrDrDrErnDs     zChunkedRFile.readlinesccsx|jstd|j}|s$td|jt|7_|jrP|j|jkrPtd|tkrZqt| tsltd|VqdS)zhRead HTTP headers and yield them. :yields: CRLF separated lines :ytype: bytes z:Cannot read trailers until the request body has been read.r-rr.N) r~r0r>r/rVr]rUrr1r2)r=r?rDrDrEread_trailer_linesYs  zChunkedRFile.read_trailer_linescCs|jdSrorprYrDrDrErqwszChunkedRFile.close)r{)N)N)r) rKrLrMrNrWrr\r/rnrrqrDrDrDrErs + * rc@s~eZdZdZdZdZiZgZdZdZ dZ e Z dddZ ddZd d Zd d Zd dZdddZddZddZddZdS)r zrAn HTTP Request (and response). A single HTTP connection may consist of multiple request/response pairs. NFTcCsx||_||_d|_d|_d|_|jjdur0d|_d|_i|_d|_g|_ d|_ |j j |_ d|_ |j j|_||_||_dS)aInitialize HTTP request container instance. Args: server (HTTPServer): web server object receiving this request conn (HTTPConnection): HTTP connection object for this request proxy_mode (bool): whether this HTTPServer should behave as a PROXY server for certain requests strict_mode (bool): whether we should return a 400 Bad Request when we encounter a request that a HTTP compliant client should not be making FshttpNshttpszHTTP/1.0r)serverconnreadystarted_requestscheme ssl_adapterresponse_protocol inheadersstatus outheaders sent_headersrSclose_connection chunked_read chunked_write proxy_mode strict_mode)r=rrrrrDrDrErWs"    zHTTPRequest.__init__cCst|jj|jj|_z |}Wn"tjyB|ddYdS0|sLdSz | }Wn"tjyz|ddYdS0|sdSd|_ dS)z;Parse the next HTTP request start-line and message-headers.z414 Request-URI Too LongzHThe Request-URI sent with the request exceeds the maximum allowed bytes.N413 Request Entity Too LargezCThe headers sent with the request exceed the maximum allowed bytes.T) rrr>rmax_request_header_sizeread_request_linerrXsimple_responseread_request_headersr)r=successrDrDrE parse_requests2  zHTTPRequest.parse_requestc Cs|j}d|_|sdS|tkr2|j}|s2dS|tsL|dddSz|td\}}}| ds|ddWdS|dd d d }t |dkr|dd WdSt t t |}|d kr|ddWdSWn&ttfy|ddYdS0||_||_|jr<||jkrsz1HTTPRequest.read_request_line..rz HTTP/%s.%s)*r>r/rr1r2rr5r6r3 startswithr]tuplemaprr0 IndexErroruriuppermethodrrrurlsplit UnicodeErrorrr<rfportany FORWARD_SLASHQUOTED_SLASH_REGEXargs QUOTED_SLASHr authoritypathqsrprotocolZrequest_protocolrzr)r=Z request_linerrZ req_protocolrpresprrrrfragmentZuri_is_absolute_formZ uri_splitZ_schemeZ _authority_pathZ_qsZ _fragmentZ_portZ invalid_pathZdisallowed_absoluteZatomsexsprDrDrErs                           zHTTPRequest.read_request_linec Csz||j|jWn8tyL}z |d|jdWYd}~dSd}~00|jj}zt|j dd}Wn ty|ddYdS0|r||kr|dddS|j d kr|j d d d krd |_ n|j d d dkrd |_ d}|j d kr|j d}|rdd| dD}d|_ |r\|D].}|dkrBd |_ n|dd |_ dSq,|j dd dkrd |jjdtdttf}z|jj|Wn<tjy}z |jdtjvrȂWYd}~n d}~00d S)zRead ``self.rfile`` into ``self.inheaders``. Ref: :py:attr:`self.inheaders `. :returns: success status :rtype: bool rrNFContent-Lengthz Malformed Content-Length Header.rCThe entity sent with the request exceeds the maximum allowed bytes.HTTP/1.1r)r&closeT Keep-Aliver+cSs g|]}|r|qSrD)r5lowerrrDrDrErr&z4HTTPRequest.read_request_headers..,chunkedz501 Unimplementedr*s 100-continueasciis 100 Continue) header_readerr>rr0rrrmax_request_body_sizerr;rrr6rr<rencoder3r1rwfilewritesocketerrorrsocket_errors_to_ignore)r=rmrbsclteencmsgrDrDrErsb         z HTTPRequest.read_request_headerscCs|jj}|jr t|jj||_nDt|jdd}|rT||krT|j sP| dddSt |jj||_|j | |jo||jr|jjddS)z/Call the gateway and write its iterable output.rrrrNs0 )rrrrrr>rrr;rrrgatewayrespondrensure_headers_sentrrr)r=rrrDrDrEr(s  zHTTPRequest.respondrc Cst|}d|jj|f}dt|}d}|d|d|dg}|dddvrtd|_|jd krp|d nd }|t|rt |tr|d}||z|j j t |Wn8tjy}z|jd tjvr܂WYd}~n d}~00dS) z+Write a simple response back to the client.z%s %s zContent-Length: %s zContent-Type: text/plain ISO-8859-1N)Z413Z414TrsConnection: close rr)strrrr]rrrrdr1 isinstancerrrrfr<rrrrr)r=rrZ proto_statusry content_typebufrrDrDrEr?s.       zHTTPRequest.simple_responsecCs|jsd|_|dS)z:Ensure headers are sent to the client if not already sent.TN)r send_headersrYrDrDrErdszHTTPRequest.ensure_headers_sentcCsX|jrF|rFtt|ddd}|t|tg}|jjt |n|jj|dS)z$Write unbuffered data to the client.rNr) rhexr]rr1rrrrfr<)r=rZchunk_size_hexrrDrDrErjs   zHTTPRequest.writec Csdd|jD}t|jdd}|dkr2d|_nLd|vr~|dks~|d vrLn2|jd ko^|jd k}|rxd|_|jd nd|_|js|jj }| |_d |vr|jd kr|jr|jdn|js|jdd|jvr|jddj |jj d df|js,|j s,t|jdd}|dkr,|j|d|vrV|jdtjjdd dfd|vrz|jd|jj df|jj d}|t|jtg}|jD]$\}} ||tt| tq|t|jjt|dS)zAssert, process, and send the HTTP response message-headers. You must set ``self.status``, and :py:attr:`self.outheaders ` before calling this. cSsg|]\}}|qSrD)r)rkeyvaluerDrDrEryr&z,HTTPRequest.send_headers..NriTscontent-length)i0rsHEAD)r+rs connection)r)r)r)rrztimeout={connection_timeout})Zconnection_timeoutrrxrsdatesDate)usegmtsserversServerr)rrrrrrrrdrcan_add_keepalive_connectionrtimeoutrrgetattrr>r\emailutils formatdate server_namerr3r1r7rrrrfr<) r=ZhkeysrZ needs_chunkedZcan_keeprxprotorrAr@rDrDrErssh           zHTTPRequest.send_headers)FT)r)rKrLrMrNrrrrrrrrrrWrrrrrrrrrDrDrDrEr |s& !"d` % r c@seZdZdZdZdZdZejZ ejZ e Z dZ dZdZefddZddZdZdd Zd d Zd d ZddZeddZeddZeddZddZeddZeddZddZdS)r z#An HTTP connection (active socket).NFcCsn||_||_||d|j|_||d|j|_d|_|jj|_|jj|_t dd|j |_ t dd|j |_ dS)aBInitialize HTTPConnection instance. Args: server (HTTPServer): web server object receiving this request sock (socket._socketobject): the raw socket object (usually TCP) for this connection makefile (file): a fileobject class for reading from the socket rbwbrr)maxsizeN) rrrbufsizer>wbufsizer requests_seenpeercreds_enabledpeercreds_resolve_enabledrresolve_peer_credsget_peer_creds)r=rsockmakefilerDrDrErWs   zHTTPConnection.__init__c Cs~d}zZ||j|}||jjdr6|jd7_|jsBWdSd}||jsZWdSWntj y}zp|j d}d}||vr|r|r|j r| |dn2|t jvr|jjdt|tjdd | |d WYd }~nd }~0ttfyYn|t jyYnht jy0||YnJtyx}z0|jjt|tjdd | |d WYd }~n d }~00dS) zrRead each request and respond appropriately. Returns true if the connection should be kept open. FEnabledrTr)z timed outzThe read operation timed outz408 Request Timeoutzsocket.error %slevel tracebackz500 Internal Server ErrorN)RequestHandlerClassrrstatsrrrrrrrr_conditional_errorrr error_logrloggingWARNINGKeyboardInterrupt SystemExit FatalSSLAlert NoSSLError_handle_no_ssl ExceptionERROR)r=Z request_seenreqrZerrnumZ timeout_errsrDrDrE communicatesH       "zHTTPConnection.communicatecCs`|r |jrdSz |jj}Wnty4|jj}Yn0t|d|j|_d}|d|d|_ dS)NrzUThe client sent a plain HTTP request, but this server only speaks HTTPS on this port.rT) rr_sockAttributeError_socketr rrrlinger)r=rZ resp_sockrrDrDrEr.s    zHTTPConnection._handle_no_sslcCsR|r |jrdSz||Wn0tjy0YntjyL||Yn0dS)zvRespond with an error. Don't bother writing if a response has already started being written. N)rrrrrr)r=rresponserDrDrEr ?s z!HTTPConnection._conditional_errorcCs(|j|js$||jndS)z,Close the socket underlying this connection.N)r>rqr_close_kernel_socketrrYrDrDrErqOs   zHTTPConnection.closec Csd}ts|jjtjkr tdn|js.tdz|jtjtj t |}Wn,tj yx}zt|WYd}~n&d}~00t ||\}}}|||fSdS)aReturn the PID/UID/GID tuple of the peer socket for UNIX sockets. This function uses SO_PEERCRED to query the UNIX PID, UID, GID of the peer, which is only available if the bind address is a UNIX domain socket. Raises: NotImplementedError: in case of unsupported socket type RuntimeError: in case of SO_PEERCRED lookup unsupported or disabled Z3iz5SO_PEERCRED is only supported in Linux kernel and WSLz0Peer creds lookup is disabled within this serverN) IS_WINDOWSrfamilyAF_UNIXNotImplementedErrorr RuntimeError getsockopt SOL_SOCKETrstructcalcsizerunpack)r=ZPEERCRED_STRUCT_DEFZ peer_credsZ socket_errpiduidgidrDrDrErbs$ zHTTPConnection.get_peer_credscCs|\}}}|S)z,Return the id of the connected peer process.r)r=r'rOrDrDrEpeer_pidszHTTPConnection.peer_pidcCs|\}}}|S)z1Return the user id of the connected peer process.r*)r=rOr(rDrDrEpeer_uidszHTTPConnection.peer_uidcCs|\}}}|S)z2Return the group id of the connected peer process.r*)r=rOr)rDrDrEpeer_gidszHTTPConnection.peer_gidcCs@tstdn|jstdt|jj}t |j j }||fS)aLook up the username and group tuple of the ``PEERCREDS``. :returns: the username and group tuple of the ``PEERCREDS`` :raises NotImplementedError: if the OS is unsupported :raises RuntimeError: if UID/GID lookup is unsupported or disabled zUID/GID lookup is unavailable under current platform. It can only be done under UNIX-like OS but not under the Google App Enginez-UID/GID lookup is disabled within this server) IS_UID_GID_RESOLVABLEr rr!pwdgetpwuidr,pw_namegrpgetgrgidr-gr_name)r=usergrouprDrDrErsz!HTTPConnection.resolve_peer_credscCs|\}}|S)z2Return the username of the connected peer process.r)r=r5rOrDrDrE peer_users zHTTPConnection.peer_usercCs|\}}|S)z/Return the group of the connected peer process.r7)r=rOr6rDrDrE peer_groups zHTTPConnection.peer_groupc Cslt|jd|jj}z|tjWnFtjy4Yn4tjyf}z|jtjvrRWYd}~n d}~00dS)z0Terminate the connection at the transport level.Z sock_shutdownN) rrshutdown SHUT_RDWRrZ#acceptable_sock_shutdown_exceptionsrerrnoZ$acceptable_sock_shutdown_error_codes)r=r:erDrDrErs z#HTTPConnection._close_kernel_socket) rKrLrMrNZ remote_addrZ remote_portZssl_envioDEFAULT_BUFFER_SIZErrr rrrZ last_usedr rWrrrr rqrpropertyr+r,r-rr8r9rrDrDrDrEr s: 3+     r c@sveZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dZdjed ZdZd Zd Zd Zd ZeZdZd Zd Zd ZdZd@ddZddZddZ ddZ!e"ddZ#e#j$ddZ#ddZ%ddZ&ddZ'dd Z(e)j*d!d"Z+e"d#d$Z,d%d&Z-dAd)d*Z.dBd+d,Z/d-d.Z0e1d/d0Z2e3dCd1d2Z4e1d3d4Z5e1d5d6Z6d7d8Z7e"d9d:Z8e"d;d<Z9e8j$d=d:Z8d>d?Z:dS)DrzAn HTTP server.z 127.0.0.1Nrr g?zCheroot/{version!s})versionFrTrcc CsT||_||_tj||pd|d|_|s,|j}||_||_|o>||_||_ | dS)aInitialize HTTPServer instance. Args: bind_addr (tuple): network interface to listen to gateway (Gateway): gateway for processing HTTP requests minthreads (int): minimum number of threads for HTTP thread pool maxthreads (int): maximum number of threads for HTTP thread pool server_name (str): web server name to be advertised via Server HTTP header reuse_port (bool): if True SO_REUSEPORT option would be set to socket r)rzmaxN) bind_addrrr Z ThreadPoolrequestsrBrrr reuse_port clear_stats) r=rDr minthreads maxthreadsrrrrFrDrDrErW3s zHTTPServer.__init__csd_d_dfddfdddfddfddfd dfd ddd dd dd dddddddid_jtjdt<dS)zReset server stat counters..NrFcs tjSrI)rrDsrYrDrE\r&z(HTTPServer.clear_stats..cs|d rdpS)NrrcruntimerJrYrDrErL]r&cs|dS)NAcceptsrMrJrYrDrErL_r&cstjddS)NqsizerrErJrYrDrErL`r&csttjdgS)N_threads)r]rrErJrYrDrErLar&cstjddS)NZidlerQrJrYrDrErLbr&cSs*|d rdp(tdd|dDdS)Nrrccss|]}|d|VqdS)RequestsNrDrwrDrDrE er&;HTTPServer.clear_stats....Worker ThreadsrsumvaluesrJrDrDrErLdscSs*|d rdp(tdd|dDdS)Nrrccss|]}|d|VqdS) Bytes ReadNrDrTrDrDrErVhr&rWrXrrYrJrDrDrErLgscSs*|d rdp(tdd|dDdS)Nrrccss|]}|d|VqdS) Bytes WrittenNrDrTrDrDrErVkr&rWrXrrYrJrDrDrErLjscSs*|d rdp(tdd|dDdS)Nrrccss|]}|d|VqdS) Work TimeNrDrTrDrDrErVor&rWrXrrYrJrDrDrErLnscSs*|d rdp(tdd|dDdS)Nrrccss*|]"}|d||d|pdVqdS)r\r^ư>NrDrTrDrDrErVrsrWrXrrYrJrDrDrErLqs  cSs*|d rdp(tdd|dDdS)Nrrccss*|]"}|d||d|pdVqdS)r]r^r_NrDrTrDrDrErVxsrWrXrrYrJrDrDrErLws  )rz Bind AddresszRun timerOz Accepts/secQueueZThreadsz Threads Idlez Socket ErrorsrSr\r]r^zRead ThroughputzWrite ThroughputrXzCheroot HTTPServer %d) _start_time _run_timer r r,idrYrDrYrErGVs(      %zHTTPServer.clear_statscCs(|jdur|jS|jt|jSdS)zReturn server uptime.N)rarbtimerYrDrDrErNs zHTTPServer.runtimecCsd|j|jj|jfS)z1Render Server instance representing bind address.z %s.%s(%r))rLrSrKrDrYrDrDrE__str__s zHTTPServer.__str__cCs|jS)aReturn the interface on which to listen for connections. For TCP sockets, a (host, port) tuple. Host values may be any :term:`IPv4` or :term:`IPv6` address, or any valid hostname. The string 'localhost' is a synonym for '127.0.0.1' (or '::1', if your hosts file prefers :term:`IPv6`). The string '0.0.0.0' is a special :term:`IPv4` entry meaning "any active interface" (INADDR_ANY), and '::' is the similar IN6ADDR_ANY for :term:`IPv6`. The empty string or :py:data:`None` are not allowed. For UNIX sockets, supply the file name as a string. Systemd socket activation is automatic and doesn't require tempering with this variable. .. glossary:: :abbr:`IPv4 (Internet Protocol version 4)` Internet Protocol version 4 :abbr:`IPv6 (Internet Protocol version 6)` Internet Protocol version 6 ) _bind_addrrYrDrDrErDszHTTPServer.bind_addrcCs(t|tr|ddvrtd||_dS)z5Set the interface on which to listen for connections.r)rNzzHost values of '' or None are not allowed. Use '0.0.0.0' (IPv4) or '::' (IPv6) instead to listen on all active interfaces.N)rrr0rf)r=rrDrDrErDs  c Csz |WnrtyF}z"|j}|s,||_||WYd}~nBd}~0ty~}z"|j}|sd||_||WYd}~n d}~00dS)z4Run the server forever, and stop it cleanly on exit.N)startr interruptr)r=Z kb_intr_excZunderlying_interruptZ sys_exit_excrDrDrE safe_starts zHTTPServer.safe_startc Csd|_|jdurd|j|_d|_d}tddrJtdtjtj|_n`t |j t t frz| |j WnBtjy}z(d||j |f}t||WYd}~n d}~00n|j \}}zt||tjtjdtj}WnLtjy$tj}|j }d|vrtj}|d }|tjdd |fg}Yn0|D]~}|\} } } } } z|| | | WqWnNtjy}z2d|| |f}|jr|jd|_WYd}~n d}~00q*|jst||jd |j|jt||_|jd |_t|_ dS) zPrepare server to serving requests. It binds a socket's port, setups the socket to ``listen()`` and does other preparing things. Nz %s ServerzNo socket could be createdZ LISTEN_PIDrz%s -- (%s: %s)r:)rrrrT)! _interruptsoftwarerBrosgetenvfromfdAF_INET SOCK_STREAMrrDrbytesbind_unix_socketr getaddrinfo AF_UNSPEC AI_PASSIVEgaierrorrbindrq settimeoutlistenrequest_queue_sizerZConnectionManager _connectionsrErgrrdra)r=rZserrhostrinfoZ sock_typerDrgafsocktyper _canonnamesarDrDrEpreparesX   $          zHTTPServer.preparec Cs|jr\|js\z|j|jWqttfy6YqtyX|jdt j ddYq0q|jr|j rtt dqb|jr|jdS)z1Serve requests, after invoking :func:`prepare()`.zError in HTTPServer.serveTrg?N)rrhr|runexpiration_intervalrrrr r r_stopping_for_interruptrdsleeprYrDrDrEserves   zHTTPServer.servecCs||dS)zmRun the server forever. It is shortcut for invoking :func:`prepare()` then :func:`serve()`. N)rrrYrDrDrErg+s zHTTPServer.startccsF|tj|jd}d|_|z|VW|n |0dS)z4Context manager for running this server in a thread.)targetTN)r threadingThreadrdaemonrgstop)r=threadrDrDrE_run_in_thread7szHTTPServer._run_in_threadcCs|jo |jjS)z>Flag whether it is allowed to add a new keep-alive connection.)rr|rrYrDrDrErCsz'HTTPServer.can_add_keepalive_connectioncCs |jr|j|n|dS)z7Put an idle connection back into the ConnectionManager.N)rr|putrqr=rrDrDrEput_connHszHTTPServer.put_connrcCsDtjdj|dtj|r@t}tj|tjdS)zWrite error message to log. Args: msg (str): error message level (int): logging level traceback (bool): add traceback to output or not z{msg!s} )rN)sysstderrrrflush traceback_ format_exc)r=rrrZtblinesrDrDrEr Ps   zHTTPServer.error_logc CsB||j||||j|j|j}|||j}|_|||_|S)z.Create (or recreate) the actual socket object.)prepare_socketrDnodelayrrF bind_socketrresolve_real_bind_addr)r=rtyperrrDrDrErx`s zHTTPServer.bindc Cstr tdd}zt|jWnty2Ynztyf}zt|}d|vrRWYd}~nNd}~0ty}z.t|}d|vrd|vrd|vrWYd}~n d}~00|j|t j t j d|j |j |jd }zt||d }Wntyd }Yn0z|||}Wn t jy.|Yn0||}zD|s|zt||Wn$tyvtj||d d Yn0d }WntyYn0|s|jd tjd||_||_ |S)z*Create (or recreate) a UNIX socket object.z0AF_UNIX sockets are not supported under Windows.izJremove() argument 1 must be encoded string without null bytes, not unicodeNz'unlink: embedded null character in pathzembedded null bytez0argument must be a string without NUL charactersr)rDrrrrrrFTF)follow_symlinksz(Failed to set socket fs mode permissions)r)rr0rmunlinkrDOSError TypeErrorrrrrrqrrrFfchmodfilenorrrqrlchmodrchmodr r r )r=rDZfs_permissionsZtyp_errerr_msgZval_errrZ FS_PERMS_SETrDrDrErsls~     zHTTPServer.bind_unix_socketcCs|dd\}}|dk}|jtjtjfvr2td|r>tdttdr\|tjtjdn>ttdrz|tjtj dn t r|tjtj dnt ddS) NrrzCannot reuse a non-IP socketz"Cannot reuse an ephemeral port (0)SO_REUSEPORT_LBr SO_REUSEPORTz,Current platform does not support port reuse) rrrprr0hasattr setsockoptr#rrr SO_REUSEADDRr )socket_rDr}rIS_EPHEMERAL_PORTrDrDrE_make_socket_reusables  z HTTPServer._make_socket_reusablec Cst|||}t||dd\} } | dk} |rB|j||dts\| s\|tjtjd|rt|t t fs|tj tj d|dur| |}ttdo|tjko| dv} | rz|tjtjdWnttjfyYn0|S)z%Create and prepare the socket object.NrrrrDrr)z::z::0z ::0.0.0.0)rrZprevent_socket_inheritancerrrr#rrrrr IPPROTO_TCP TCP_NODELAYrxrrrrrr) clsrDrrrrrrFrr}rrZlistening_ipv6rDrDrErs2     zHTTPServer.prepare_socketcCs|||S)z#Bind the socket to given interface.)rxrrDrDrErs zHTTPServer.bind_socketcCs<|}|jtjtjfvr&|ddSt|tr8t|}|S)z/Retrieve actual bind address from bound socket.Nr) getsocknamerrrprrrrrrrDrDrErs  z!HTTPServer.resolve_real_bind_addrcCs2z|j|Wntjy,|Yn0dS)z#Process an incoming HTTPConnection.N)rErqueueFullrqrrDrDrE process_conn*szHTTPServer.process_conncCs|jS)zFlag interrupt of the server.)rkrYrDrDrErh2szHTTPServer.interruptcCs |jtuS)z8Return whether the server is responding to an interrupt.)rk_STOPPING_FOR_INTERRUPTrYrDrDrEr7sz"HTTPServer._stopping_for_interruptcCs@t|_t|tr|dt|tr.|d|||_dS)aPerform the shutdown of this server and save the exception. Typically invoked by a worker thread in :py:mod:`~cheroot.workers.threadpool`, the exception is raised from the thread running :py:meth:`serve` once :py:meth:`stop` has completed. z!Keyboard Interrupt: shutting downz SystemExit raised: shutting downN)rrkrrr rr)r=rhrDrDrErh<s     c Csr|js dSd|_|jdur2|jt|j7_d|_|jt|dd}|rVt|jt t fsProcess the current request. Must be overridden in a subclass.N)r rYrDrDrErszGateway.respondN)rKrLrMrNrWrrDrDrDrErsrz%cheroot.ssl.builtin.BuiltinSSLAdapterz&cheroot.ssl.pyopenssl.pyOpenSSLAdapter)builtinZ pyopensslrcCst|}t|tr|d}||dd}|d|}ztj|}|durVtWn&ty~t|t t dg}Yn0zt ||}Wn"t yt d||fYn0|S)z/Return an SSL adapter class for the given name..rNrz!'%s' object has no attribute '%s') ssl_adaptersrrrrfindrmodulesKeyError __import__globalslocalsrr)nameadapterZlast_dot attr_nameZmod_pathmodrDrDrErs(         r)r)KrNrmr>re email.utilsrrrrdrrr platformrrr urllib.parser functoolsrrrrr_compatrrworkersr rr r __all__systemrrnrZIS_GAEr.r2r/ ImportErrorr$rrrrrer1r4r3r7rrfZASTERISKrrcompiler<rrrr:r,rrrrrr r rrrrrDrDrDrEsC           FaZCW7