2 The header files of miscellaneous routines for HttpDxe driver.
4 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __EFI_HTTP_PROTO_H__
17 #define __EFI_HTTP_PROTO_H__
19 #define DEF_BUF_LEN 2048
21 #define HTTP_SERVICE_SIGNATURE SIGNATURE_32('H', 't', 't', 'S')
23 #define HTTP_SERVICE_FROM_PROTOCOL(a) \
28 HTTP_SERVICE_SIGNATURE \
33 // The state of HTTP protocol. It starts from UNCONFIGED.
35 #define HTTP_STATE_UNCONFIGED 0
36 #define HTTP_STATE_HTTP_CONFIGED 1
37 #define HTTP_STATE_TCP_CONFIGED 2
38 #define HTTP_STATE_TCP_UNCONFIGED 3
39 #define HTTP_STATE_TCP_CONNECTED 4
40 #define HTTP_STATE_TCP_CLOSED 5
43 // TCP configured data.
45 #define HTTP_TOS_DEAULT 8
46 #define HTTP_TTL_DEAULT 255
47 #define HTTP_BUFFER_SIZE_DEAULT 65535
48 #define HTTP_MAX_SYN_BACK_LOG 5
49 #define HTTP_CONNECTION_TIMEOUT 60
50 #define HTTP_RESPONSE_TIMEOUT 5
51 #define HTTP_DATA_RETRIES 12
52 #define HTTP_FIN_TIMEOUT 2
53 #define HTTP_KEEP_ALIVE_PROBES 6
54 #define HTTP_KEEP_ALIVE_TIME 7200
55 #define HTTP_KEEP_ALIVE_INTERVAL 30
57 #define HTTP_URL_BUFFER_LEN 4096
59 typedef struct _HTTP_SERVICE
{
61 EFI_SERVICE_BINDING_PROTOCOL ServiceBinding
;
62 EFI_HANDLE Ip4DriverBindingHandle
;
63 EFI_HANDLE Ip6DriverBindingHandle
;
64 EFI_HANDLE ControllerHandle
;
65 EFI_HANDLE Tcp4ChildHandle
;
66 EFI_HANDLE Tcp6ChildHandle
;
67 LIST_ENTRY ChildrenList
;
73 EFI_TCP4_IO_TOKEN Tx4Token
;
74 EFI_TCP4_TRANSMIT_DATA Tx4Data
;
75 EFI_TCP6_IO_TOKEN Tx6Token
;
76 EFI_TCP6_TRANSMIT_DATA Tx6Data
;
77 EFI_TCP4_IO_TOKEN Rx4Token
;
78 EFI_TCP4_RECEIVE_DATA Rx4Data
;
79 EFI_TCP6_IO_TOKEN Rx6Token
;
80 EFI_TCP6_RECEIVE_DATA Rx6Data
;
84 EFI_HTTP_METHOD Method
;
85 } HTTP_TCP_TOKEN_WRAP
;
88 EFI_TLS_VERSION Version
;
89 EFI_TLS_CONNECTION_END ConnectionEnd
;
90 EFI_TLS_VERIFY VerifyMethod
;
91 EFI_TLS_SESSION_STATE SessionState
;
95 // Callback data for HTTP_PARSER_CALLBACK()
98 UINTN ParseDataLength
;
101 } HTTP_CALLBACK_DATA
;
103 typedef struct _HTTP_PROTOCOL
{
105 EFI_HTTP_PROTOCOL Http
;
107 HTTP_SERVICE
*Service
;
108 LIST_ENTRY Link
; // Link to all HTTP instance from the service.
111 EFI_HTTP_METHOD Method
;
115 EFI_EVENT TimeoutEvent
;
117 EFI_HANDLE Tcp4ChildHandle
;
118 EFI_TCP4_PROTOCOL
*Tcp4
;
119 EFI_TCP4_CONFIG_DATA Tcp4CfgData
;
120 EFI_TCP4_OPTION Tcp4Option
;
122 EFI_TCP4_CONNECTION_TOKEN Tcp4ConnToken
;
123 BOOLEAN IsTcp4ConnDone
;
124 EFI_TCP4_CLOSE_TOKEN Tcp4CloseToken
;
125 BOOLEAN IsTcp4CloseDone
;
128 EFI_IPv4_ADDRESS RemoteAddr
;
130 EFI_HANDLE Tcp6ChildHandle
;
131 EFI_TCP6_PROTOCOL
*Tcp6
;
132 EFI_TCP6_CONFIG_DATA Tcp6CfgData
;
133 EFI_TCP6_OPTION Tcp6Option
;
135 EFI_TCP6_CONNECTION_TOKEN Tcp6ConnToken
;
136 BOOLEAN IsTcp6ConnDone
;
137 EFI_TCP6_CLOSE_TOKEN Tcp6CloseToken
;
138 BOOLEAN IsTcp6CloseDone
;
139 EFI_IPv6_ADDRESS RemoteIpv6Addr
;
142 // Rx4Token or Rx6Token used for receiving HTTP header.
144 EFI_TCP4_IO_TOKEN Rx4Token
;
145 EFI_TCP4_RECEIVE_DATA Rx4Data
;
146 EFI_TCP6_IO_TOKEN Rx6Token
;
147 EFI_TCP6_RECEIVE_DATA Rx6Data
;
158 // HTTP message-body parser.
161 HTTP_CALLBACK_DATA CallbackData
;
163 EFI_HTTP_VERSION HttpVersion
;
164 UINT32 TimeOutMillisec
;
165 BOOLEAN LocalAddressIsIPv6
;
167 EFI_HTTPv4_ACCESS_POINT IPv4Node
;
168 EFI_HTTPv6_ACCESS_POINT Ipv6Node
;
180 EFI_SERVICE_BINDING_PROTOCOL
*TlsSb
;
181 EFI_HANDLE TlsChildHandle
; /// Tls ChildHandle
182 TLS_CONFIG_DATA TlsConfigData
;
183 EFI_TLS_PROTOCOL
*Tls
;
184 EFI_TLS_CONFIGURATION_PROTOCOL
*TlsConfiguration
;
185 EFI_TLS_SESSION_STATE TlsSessionState
;
188 // TlsTxData used for transmitting TLS related messages.
190 EFI_TCP4_IO_TOKEN Tcp4TlsTxToken
;
191 EFI_TCP4_TRANSMIT_DATA Tcp4TlsTxData
;
192 EFI_TCP6_IO_TOKEN Tcp6TlsTxToken
;
193 EFI_TCP6_TRANSMIT_DATA Tcp6TlsTxData
;
197 // TlsRxData used for receiving TLS related messages.
199 EFI_TCP4_IO_TOKEN Tcp4TlsRxToken
;
200 EFI_TCP4_RECEIVE_DATA Tcp4TlsRxData
;
201 EFI_TCP6_IO_TOKEN Tcp6TlsRxToken
;
202 EFI_TCP6_RECEIVE_DATA Tcp6TlsRxData
;
207 EFI_HTTP_TOKEN
*HttpToken
;
208 HTTP_PROTOCOL
*HttpInstance
;
209 HTTP_TCP_TOKEN_WRAP TcpWrap
;
213 #define HTTP_PROTOCOL_SIGNATURE SIGNATURE_32('H', 't', 't', 'P')
215 #define HTTP_INSTANCE_FROM_PROTOCOL(a) \
220 HTTP_PROTOCOL_SIGNATURE \
224 The common notify function used in HTTP driver.
226 @param[in] Event The event signaled.
227 @param[in] Context The context.
238 Create events for the TCP connection token and TCP close token.
240 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
242 @retval EFI_SUCCESS The events are created successfully.
243 @retval others Other error as indicated.
247 HttpCreateTcpConnCloseEvent (
248 IN HTTP_PROTOCOL
*HttpInstance
252 Close events in the TCP connection token and TCP close token.
254 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
258 HttpCloseTcpConnCloseEvent (
259 IN HTTP_PROTOCOL
*HttpInstance
263 Create event for the TCP transmit token.
265 @param[in] Wrap Point to HTTP token's wrap data.
267 @retval EFI_SUCCESS The events is created successfully.
268 @retval others Other error as indicated.
272 HttpCreateTcpTxEvent (
273 IN HTTP_TOKEN_WRAP
*Wrap
277 Create event for the TCP receive token which is used to receive HTTP header.
279 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
281 @retval EFI_SUCCESS The events is created successfully.
282 @retval others Other error as indicated.
286 HttpCreateTcpRxEventForHeader (
287 IN HTTP_PROTOCOL
*HttpInstance
291 Create event for the TCP receive token which is used to receive HTTP body.
293 @param[in] Wrap Point to HTTP token's wrap data.
295 @retval EFI_SUCCESS The events is created successfully.
296 @retval others Other error as indicated.
300 HttpCreateTcpRxEvent (
301 IN HTTP_TOKEN_WRAP
*Wrap
305 Close Events for Tcp Receive Tokens for HTTP body and HTTP header.
307 @param[in] Wrap Pointer to HTTP token's wrap data.
311 HttpCloseTcpRxEvent (
312 IN HTTP_TOKEN_WRAP
*Wrap
316 Intiialize the HTTP_PROTOCOL structure to the unconfigured state.
318 @param[in, out] HttpInstance Pointer to HTTP_PROTOCOL structure.
319 @param[in] IpVersion Indicate us TCP4 protocol or TCP6 protocol.
321 @retval EFI_SUCCESS HTTP_PROTOCOL structure is initialized successfully.
322 @retval Others Other error as indicated.
327 IN OUT HTTP_PROTOCOL
*HttpInstance
,
332 Clean up the HTTP child, release all the resources used by it.
334 @param[in] HttpInstance The HTTP child to clean up.
339 IN HTTP_PROTOCOL
*HttpInstance
343 Establish TCP connection with HTTP server.
345 @param[in] HttpInstance The HTTP instance private data.
347 @retval EFI_SUCCESS The TCP connection is established.
348 @retval Others Other error as indicated.
352 HttpCreateConnection (
353 IN HTTP_PROTOCOL
*HttpInstance
357 Close existing TCP connection.
359 @param[in] HttpInstance The HTTP instance private data.
361 @retval EFI_SUCCESS The TCP connection is closed.
362 @retval Others Other error as indicated.
366 HttpCloseConnection (
367 IN HTTP_PROTOCOL
*HttpInstance
371 Configure TCP4 protocol child.
373 @param[in] HttpInstance The HTTP instance private data.
374 @param[in] Wrap The HTTP token's wrap data.
376 @retval EFI_SUCCESS The TCP4 protocol child is configured.
377 @retval Others Other error as indicated.
382 IN HTTP_PROTOCOL
*HttpInstance
,
383 IN HTTP_TOKEN_WRAP
*Wrap
387 Configure TCP6 protocol child.
389 @param[in] HttpInstance The HTTP instance private data.
390 @param[in] Wrap The HTTP token's wrap data.
392 @retval EFI_SUCCESS The TCP6 protocol child is configured.
393 @retval Others Other error as indicated.
398 IN HTTP_PROTOCOL
*HttpInstance
,
399 IN HTTP_TOKEN_WRAP
*Wrap
403 Check existing TCP connection, if in error state, recover TCP4 connection. Then,
404 connect one TLS session if required.
406 @param[in] HttpInstance The HTTP instance private data.
408 @retval EFI_SUCCESS The TCP connection is established.
409 @retval EFI_NOT_READY TCP4 protocol child is not created or configured.
410 @retval Others Other error as indicated.
415 IN HTTP_PROTOCOL
*HttpInstance
419 Check existing TCP connection, if in error state, recover TCP6 connection. Then,
420 connect one TLS session if required.
422 @param[in] HttpInstance The HTTP instance private data.
424 @retval EFI_SUCCESS The TCP connection is established.
425 @retval EFI_NOT_READY TCP6 protocol child is not created or configured.
426 @retval Others Other error as indicated.
431 IN HTTP_PROTOCOL
*HttpInstance
435 Send the HTTP or HTTPS message through TCP4 or TCP6.
437 @param[in] HttpInstance The HTTP instance private data.
438 @param[in] Wrap The HTTP token's wrap data.
439 @param[in] TxString Buffer containing the HTTP message string.
440 @param[in] TxStringLen Length of the HTTP message string in bytes.
442 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit queue.
443 @retval Others Other error as indicated.
448 IN HTTP_PROTOCOL
*HttpInstance
,
449 IN HTTP_TOKEN_WRAP
*Wrap
,
455 Check whether the user's token or event has already
456 been enqueue on HTTP Tx or Rx Token list.
458 @param[in] Map The container of either user's transmit or receive
460 @param[in] Item Current item to check against.
461 @param[in] Context The Token to check againist.
463 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP
464 @retval EFI_SUCCESS The current item isn't the same token/event as the
472 IN NET_MAP_ITEM
*Item
,
477 Check whether the HTTP message associated with TxToken or Tx6Token is already sent out.
479 @param[in] Map The container of TxToken.
480 @param[in] Item Current item to check against.
481 @param[in] Context The Token to check againist.
483 @retval EFI_NOT_READY The HTTP message is still queued in the list.
484 @retval EFI_SUCCESS The HTTP message has been sent out.
491 IN NET_MAP_ITEM
*Item
,
496 Initialize Http session.
498 @param[in] HttpInstance The HTTP instance private data.
499 @param[in] Wrap The HTTP token's wrap data.
500 @param[in] Configure The Flag indicates whether need to initialize session.
501 @param[in] TlsConfigure The Flag indicates whether it's the new Tls session.
503 @retval EFI_SUCCESS The initialization of session is done.
504 @retval Others Other error as indicated.
509 IN HTTP_PROTOCOL
*HttpInstance
,
510 IN HTTP_TOKEN_WRAP
*Wrap
,
511 IN BOOLEAN Configure
,
512 IN BOOLEAN TlsConfigure
516 Transmit the HTTP or HTTPS mssage by processing the associated HTTP token.
518 @param[in] Map The container of TxToken or Tx6Token.
519 @param[in] Item Current item to check against.
520 @param[in] Context The Token to check againist.
522 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
523 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit
531 IN NET_MAP_ITEM
*Item
,
536 Receive the HTTP response by processing the associated HTTP token.
538 @param[in] Map The container of Rx4Token or Rx6Token.
539 @param[in] Item Current item to check against.
540 @param[in] Context The Token to check againist.
542 @retval EFI_SUCCESS The HTTP response is queued into TCP receive
544 @retval Others Other error as indicated.
551 IN NET_MAP_ITEM
*Item
,
556 Receive the HTTP header by processing the associated HTTP token.
558 @param[in] HttpInstance The HTTP instance private data.
559 @param[in, out] SizeofHeaders The HTTP header length.
560 @param[in, out] BufferSize The size of buffer to cacahe the header message.
561 @param[in] Timeout The time to wait for receiving the header packet.
563 @retval EFI_SUCCESS The HTTP header is received.
564 @retval Others Other errors as indicated.
568 HttpTcpReceiveHeader (
569 IN HTTP_PROTOCOL
*HttpInstance
,
570 IN OUT UINTN
*SizeofHeaders
,
571 IN OUT UINTN
*BufferSize
,
576 Receive the HTTP body by processing the associated HTTP token.
578 @param[in] Wrap The HTTP token's wrap data.
579 @param[in] HttpMsg The HTTP message data.
581 @retval EFI_SUCCESS The HTTP body is received.
582 @retval Others Other error as indicated.
587 IN HTTP_TOKEN_WRAP
*Wrap
,
588 IN EFI_HTTP_MESSAGE
*HttpMsg
592 Clean up Tcp Tokens while the Tcp transmission error occurs.
594 @param[in] Wrap Pointer to HTTP token's wrap data.
598 HttpTcpTokenCleanup (
599 IN HTTP_TOKEN_WRAP
*Wrap
603 The work function of EfiHttpResponse().
605 @param[in] Wrap Pointer to HTTP token's wrap data.
607 @retval EFI_SUCCESS Allocation succeeded.
608 @retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.
609 @retval EFI_NOT_READY Can't find a corresponding TxToken.
614 IN HTTP_TOKEN_WRAP
*Wrap