2 The header files of miscellaneous routines for HttpDxe driver.
4 Copyright (c) 2015 - 2017, 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
;
94 typedef struct _HTTP_PROTOCOL
{
96 EFI_HTTP_PROTOCOL Http
;
98 HTTP_SERVICE
*Service
;
99 LIST_ENTRY Link
; // Link to all HTTP instance from the service.
102 EFI_HTTP_METHOD Method
;
106 EFI_EVENT TimeoutEvent
;
108 EFI_HANDLE Tcp4ChildHandle
;
109 EFI_TCP4_PROTOCOL
*Tcp4
;
110 EFI_TCP4_CONFIG_DATA Tcp4CfgData
;
111 EFI_TCP4_OPTION Tcp4Option
;
113 EFI_TCP4_CONNECTION_TOKEN Tcp4ConnToken
;
114 BOOLEAN IsTcp4ConnDone
;
115 EFI_TCP4_CLOSE_TOKEN Tcp4CloseToken
;
116 BOOLEAN IsTcp4CloseDone
;
119 EFI_IPv4_ADDRESS RemoteAddr
;
121 EFI_HANDLE Tcp6ChildHandle
;
122 EFI_TCP6_PROTOCOL
*Tcp6
;
123 EFI_TCP6_CONFIG_DATA Tcp6CfgData
;
124 EFI_TCP6_OPTION Tcp6Option
;
126 EFI_TCP6_CONNECTION_TOKEN Tcp6ConnToken
;
127 BOOLEAN IsTcp6ConnDone
;
128 EFI_TCP6_CLOSE_TOKEN Tcp6CloseToken
;
129 BOOLEAN IsTcp6CloseDone
;
130 EFI_IPv6_ADDRESS RemoteIpv6Addr
;
133 // Rx4Token or Rx6Token used for receiving HTTP header.
135 EFI_TCP4_IO_TOKEN Rx4Token
;
136 EFI_TCP4_RECEIVE_DATA Rx4Data
;
137 EFI_TCP6_IO_TOKEN Rx6Token
;
138 EFI_TCP6_RECEIVE_DATA Rx6Data
;
149 // HTTP message-body parser.
153 EFI_HTTP_VERSION HttpVersion
;
154 UINT32 TimeOutMillisec
;
155 BOOLEAN LocalAddressIsIPv6
;
157 EFI_HTTPv4_ACCESS_POINT IPv4Node
;
158 EFI_HTTPv6_ACCESS_POINT Ipv6Node
;
170 EFI_HANDLE TlsChildHandle
; /// Tls ChildHandle
171 TLS_CONFIG_DATA TlsConfigData
;
172 EFI_TLS_PROTOCOL
*Tls
;
173 EFI_TLS_CONFIGURATION_PROTOCOL
*TlsConfiguration
;
174 EFI_TLS_SESSION_STATE TlsSessionState
;
177 // TlsTxData used for transmitting TLS related messages.
179 EFI_TCP4_IO_TOKEN Tcp4TlsTxToken
;
180 EFI_TCP4_TRANSMIT_DATA Tcp4TlsTxData
;
181 EFI_TCP6_IO_TOKEN Tcp6TlsTxToken
;
182 EFI_TCP6_TRANSMIT_DATA Tcp6TlsTxData
;
186 // TlsRxData used for receiving TLS related messages.
188 EFI_TCP4_IO_TOKEN Tcp4TlsRxToken
;
189 EFI_TCP4_RECEIVE_DATA Tcp4TlsRxData
;
190 EFI_TCP6_IO_TOKEN Tcp6TlsRxToken
;
191 EFI_TCP6_RECEIVE_DATA Tcp6TlsRxData
;
196 EFI_HTTP_TOKEN
*HttpToken
;
197 HTTP_PROTOCOL
*HttpInstance
;
198 HTTP_TCP_TOKEN_WRAP TcpWrap
;
202 #define HTTP_PROTOCOL_SIGNATURE SIGNATURE_32('H', 't', 't', 'P')
204 #define HTTP_INSTANCE_FROM_PROTOCOL(a) \
209 HTTP_PROTOCOL_SIGNATURE \
213 The common notify function used in HTTP driver.
215 @param[in] Event The event signaled.
216 @param[in] Context The context.
227 Create events for the TCP connection token and TCP close token.
229 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
231 @retval EFI_SUCCESS The events are created successfully.
232 @retval others Other error as indicated.
236 HttpCreateTcpConnCloseEvent (
237 IN HTTP_PROTOCOL
*HttpInstance
241 Close events in the TCP connection token and TCP close token.
243 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
247 HttpCloseTcpConnCloseEvent (
248 IN HTTP_PROTOCOL
*HttpInstance
252 Create event for the TCP transmit token.
254 @param[in] Wrap Point to HTTP token's wrap data.
256 @retval EFI_SUCCESS The events is created successfully.
257 @retval others Other error as indicated.
261 HttpCreateTcpTxEvent (
262 IN HTTP_TOKEN_WRAP
*Wrap
266 Create event for the TCP receive token which is used to receive HTTP header.
268 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
270 @retval EFI_SUCCESS The events is created successfully.
271 @retval others Other error as indicated.
275 HttpCreateTcpRxEventForHeader (
276 IN HTTP_PROTOCOL
*HttpInstance
280 Create event for the TCP receive token which is used to receive HTTP body.
282 @param[in] Wrap Point to HTTP token's wrap data.
284 @retval EFI_SUCCESS The events is created successfully.
285 @retval others Other error as indicated.
289 HttpCreateTcpRxEvent (
290 IN HTTP_TOKEN_WRAP
*Wrap
294 Close Events for Tcp Receive Tokens for HTTP body and HTTP header.
296 @param[in] Wrap Pointer to HTTP token's wrap data.
300 HttpCloseTcpRxEvent (
301 IN HTTP_TOKEN_WRAP
*Wrap
305 Intiialize the HTTP_PROTOCOL structure to the unconfigured state.
307 @param[in, out] HttpInstance Pointer to HTTP_PROTOCOL structure.
308 @param[in] IpVersion Indicate us TCP4 protocol or TCP6 protocol.
310 @retval EFI_SUCCESS HTTP_PROTOCOL structure is initialized successfully.
311 @retval Others Other error as indicated.
316 IN OUT HTTP_PROTOCOL
*HttpInstance
,
321 Clean up the HTTP child, release all the resources used by it.
323 @param[in] HttpInstance The HTTP child to clean up.
328 IN HTTP_PROTOCOL
*HttpInstance
332 Establish TCP connection with HTTP server.
334 @param[in] HttpInstance The HTTP instance private data.
336 @retval EFI_SUCCESS The TCP connection is established.
337 @retval Others Other error as indicated.
341 HttpCreateConnection (
342 IN HTTP_PROTOCOL
*HttpInstance
346 Close existing TCP connection.
348 @param[in] HttpInstance The HTTP instance private data.
350 @retval EFI_SUCCESS The TCP connection is closed.
351 @retval Others Other error as indicated.
355 HttpCloseConnection (
356 IN HTTP_PROTOCOL
*HttpInstance
360 Configure TCP4 protocol child.
362 @param[in] HttpInstance The HTTP instance private data.
363 @param[in] Wrap The HTTP token's wrap data.
365 @retval EFI_SUCCESS The TCP4 protocol child is configured.
366 @retval Others Other error as indicated.
371 IN HTTP_PROTOCOL
*HttpInstance
,
372 IN HTTP_TOKEN_WRAP
*Wrap
376 Configure TCP6 protocol child.
378 @param[in] HttpInstance The HTTP instance private data.
379 @param[in] Wrap The HTTP token's wrap data.
381 @retval EFI_SUCCESS The TCP6 protocol child is configured.
382 @retval Others Other error as indicated.
387 IN HTTP_PROTOCOL
*HttpInstance
,
388 IN HTTP_TOKEN_WRAP
*Wrap
392 Check existing TCP connection, if in error state, recover TCP4 connection. Then,
393 connect one TLS session if required.
395 @param[in] HttpInstance The HTTP instance private data.
397 @retval EFI_SUCCESS The TCP connection is established.
398 @retval EFI_NOT_READY TCP4 protocol child is not created or configured.
399 @retval Others Other error as indicated.
404 IN HTTP_PROTOCOL
*HttpInstance
408 Check existing TCP connection, if in error state, recover TCP6 connection. Then,
409 connect one TLS session if required.
411 @param[in] HttpInstance The HTTP instance private data.
413 @retval EFI_SUCCESS The TCP connection is established.
414 @retval EFI_NOT_READY TCP6 protocol child is not created or configured.
415 @retval Others Other error as indicated.
420 IN HTTP_PROTOCOL
*HttpInstance
424 Send the HTTP or HTTPS message through TCP4 or TCP6.
426 @param[in] HttpInstance The HTTP instance private data.
427 @param[in] Wrap The HTTP token's wrap data.
428 @param[in] TxString Buffer containing the HTTP message string.
429 @param[in] TxStringLen Length of the HTTP message string in bytes.
431 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit queue.
432 @retval Others Other error as indicated.
437 IN HTTP_PROTOCOL
*HttpInstance
,
438 IN HTTP_TOKEN_WRAP
*Wrap
,
444 Check whether the user's token or event has already
445 been enqueue on HTTP Tx or Rx Token list.
447 @param[in] Map The container of either user's transmit or receive
449 @param[in] Item Current item to check against.
450 @param[in] Context The Token to check againist.
452 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP
453 @retval EFI_SUCCESS The current item isn't the same token/event as the
461 IN NET_MAP_ITEM
*Item
,
466 Check whether the HTTP message associated with TxToken or Tx6Token is already sent out.
468 @param[in] Map The container of TxToken.
469 @param[in] Item Current item to check against.
470 @param[in] Context The Token to check againist.
472 @retval EFI_NOT_READY The HTTP message is still queued in the list.
473 @retval EFI_SUCCESS The HTTP message has been sent out.
480 IN NET_MAP_ITEM
*Item
,
485 Initialize Http session.
487 @param[in] HttpInstance The HTTP instance private data.
488 @param[in] Wrap The HTTP token's wrap data.
489 @param[in] Configure The Flag indicates whether need to initialize session.
490 @param[in] TlsConfigure The Flag indicates whether it's the new Tls session.
492 @retval EFI_SUCCESS The initialization of session is done.
493 @retval Others Other error as indicated.
498 IN HTTP_PROTOCOL
*HttpInstance
,
499 IN HTTP_TOKEN_WRAP
*Wrap
,
500 IN BOOLEAN Configure
,
501 IN BOOLEAN TlsConfigure
505 Transmit the HTTP or HTTPS mssage by processing the associated HTTP token.
507 @param[in] Map The container of TxToken or Tx6Token.
508 @param[in] Item Current item to check against.
509 @param[in] Context The Token to check againist.
511 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
512 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit
520 IN NET_MAP_ITEM
*Item
,
525 Receive the HTTP response by processing the associated HTTP token.
527 @param[in] Map The container of Rx4Token or Rx6Token.
528 @param[in] Item Current item to check against.
529 @param[in] Context The Token to check againist.
531 @retval EFI_SUCCESS The HTTP response is queued into TCP receive
533 @retval Others Other error as indicated.
540 IN NET_MAP_ITEM
*Item
,
545 Receive the HTTP header by processing the associated HTTP token.
547 @param[in] HttpInstance The HTTP instance private data.
548 @param[in, out] SizeofHeaders The HTTP header length.
549 @param[in, out] BufferSize The size of buffer to cacahe the header message.
550 @param[in] Timeout The time to wait for receiving the header packet.
552 @retval EFI_SUCCESS The HTTP header is received.
553 @retval Others Other errors as indicated.
557 HttpTcpReceiveHeader (
558 IN HTTP_PROTOCOL
*HttpInstance
,
559 IN OUT UINTN
*SizeofHeaders
,
560 IN OUT UINTN
*BufferSize
,
565 Receive the HTTP body by processing the associated HTTP token.
567 @param[in] Wrap The HTTP token's wrap data.
568 @param[in] HttpMsg The HTTP message data.
570 @retval EFI_SUCCESS The HTTP body is received.
571 @retval Others Other error as indicated.
576 IN HTTP_TOKEN_WRAP
*Wrap
,
577 IN EFI_HTTP_MESSAGE
*HttpMsg
581 Clean up Tcp Tokens while the Tcp transmission error occurs.
583 @param[in] Wrap Pointer to HTTP token's wrap data.
587 HttpTcpTokenCleanup (
588 IN HTTP_TOKEN_WRAP
*Wrap
592 The work function of EfiHttpResponse().
594 @param[in] Wrap Pointer to HTTP token's wrap data.
596 @retval EFI_SUCCESS Allocation succeeded.
597 @retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.
598 @retval EFI_NOT_READY Can't find a corresponding TxToken.
603 IN HTTP_TOKEN_WRAP
*Wrap