/** The Response() function queues an HTTP response to this HTTP instance, similar to Receive() function in the EFI TCP driver. When the HTTP request is sent successfully, or if there is an error, Status in token will be updated and Event will be signaled. The HTTP driver will queue a receive token to the underlying TCP instance. When data is received in the underlying TCP instance, the data will be parsed and Token will be populated with the response data. If the data received from the remote host contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting (asynchronously) for more data to be sent from the remote host before signaling Event in Token. It is the responsibility of the caller to allocate a buffer for Body and specify the size in BodyLength. If the remote host provides a response that contains a content body, up to BodyLength bytes will be copied from the receive buffer into Body and BodyLength will be updated with the amount of bytes received and copied to Body. This allows the client to download a large file in chunks instead of into one contiguous block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive token to underlying TCP instance. If data arrives in the receive buffer, up to BodyLength bytes of data will be copied to Body. The HTTP driver will then update BodyLength with the amount of bytes received and copied to Body. If the HTTP driver does not have an open underlying TCP connection with the host specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain an open TCP connection between client and host. @param[in] This Pointer to EFI_HTTP_PROTOCOL instance. @param[in] Token Pointer to storage containing HTTP response token. @retval EFI_SUCCESS Allocation succeeded. @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been initialized. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: This is NULL. Token is NULL. Token->Message->Headers is NULL. Token->Message is NULL. Token->Message->Body is not NULL, Token->Message->BodyLength is non-zero, and Token->Message->Data is NULL, but a previous call to Response() has not been completed successfully. @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources. @retval EFI_ACCESS_DENIED An open TCP connection is not present with the host specified by response URL. **/ EFI_STATUS EFIAPI EfiHttpResponse ( IN EFI_HTTP_PROTOCOL *This, IN EFI_HTTP_TOKEN *Token ) { EFI_STATUS Status; EFI_HTTP_MESSAGE *HttpMsg; HTTP_PROTOCOL *HttpInstance; HTTP_TOKEN_WRAP *Wrap; if ((This == NULL) || (Token == NULL)) { return EFI_INVALID_PARAMETER; } HttpMsg = Token->Message; if (HttpMsg == NULL) { return EFI_INVALID_PARAMETER; } HttpInstance = HTTP_INSTANCE_FROM_PROTOCOL (This); ASSERT (HttpInstance != NULL); if (HttpInstance->State != HTTP_STATE_TCP_CONNECTED) { return EFI_NOT_STARTED; } if (HttpInstance->LocalAddressIsIPv6) { return EFI_UNSUPPORTED; } // // Check whether the token already existed. // if (EFI_ERROR (NetMapIterate (&HttpInstance->RxTokens, HttpTokenExist, Token))) { return EFI_ACCESS_DENIED; } Wrap = AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP)); if (Wrap == NULL) { return EFI_OUT_OF_RESOURCES; } Wrap->HttpInstance = HttpInstance; Wrap->HttpToken = Token; Status = HttpCreateTcp4RxEvent (Wrap); if (EFI_ERROR (Status)) { goto Error; } Status = NetMapInsertTail (&HttpInstance->RxTokens, Token, Wrap); if (EFI_ERROR (Status)) { goto Error; } // // If already have pending RxTokens, return directly. // if (NetMapGetCount (&HttpInstance->RxTokens) > 1) { return EFI_SUCCESS; } return HttpResponseWorker (Wrap); Error: if (Wrap != NULL) { if (Wrap->TcpWrap.RxToken.CompletionToken.Event != NULL) { gBS->CloseEvent (Wrap->TcpWrap.RxToken.CompletionToken.Event); } FreePool (Wrap); } return Status; }
/** The Request() function queues an HTTP request to this HTTP instance. Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent successfully, or if there is an error, Status in token will be updated and Event will be signaled. @param[in] This Pointer to EFI_HTTP_PROTOCOL instance. @param[in] Token Pointer to storage containing HTTP request token. @retval EFI_SUCCESS Outgoing data was processed. @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started. @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. @retval EFI_TIMEOUT Data was dropped out of the transmit or receive queue. @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources. @retval EFI_UNSUPPORTED The HTTP method is not supported in current implementation. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: This is NULL. Token->Message is NULL. Token->Message->Body is not NULL, Token->Message->BodyLength is non-zero, and Token->Message->Data is NULL, but a previous call to Request()has not been completed successfully. **/ EFI_STATUS EFIAPI EfiHttpRequest ( IN EFI_HTTP_PROTOCOL *This, IN EFI_HTTP_TOKEN *Token ) { EFI_HTTP_MESSAGE *HttpMsg; EFI_HTTP_REQUEST_DATA *Request; VOID *UrlParser; EFI_STATUS Status; CHAR8 *HostName; UINT16 RemotePort; HTTP_PROTOCOL *HttpInstance; BOOLEAN Configure; BOOLEAN ReConfigure; CHAR8 *RequestStr; CHAR8 *Url; CHAR16 *HostNameStr; HTTP_TOKEN_WRAP *Wrap; HTTP_TCP_TOKEN_WRAP *TcpWrap; if ((This == NULL) || (Token == NULL)) { return EFI_INVALID_PARAMETER; } HttpMsg = Token->Message; if ((HttpMsg == NULL) || (HttpMsg->Headers == NULL)) { return EFI_INVALID_PARAMETER; } // // Current implementation does not support POST/PUT method. // If future version supports these two methods, Request could be NULL for a special case that to send large amounts // of data. For this case, the implementation need check whether previous call to Request() has been completed or not. // // Request = HttpMsg->Data.Request; if ((Request == NULL) || (Request->Url == NULL)) { return EFI_INVALID_PARAMETER; } // // Only support GET and HEAD method in current implementation. // if ((Request->Method != HttpMethodGet) && (Request->Method != HttpMethodHead)) { return EFI_UNSUPPORTED; } HttpInstance = HTTP_INSTANCE_FROM_PROTOCOL (This); ASSERT (HttpInstance != NULL); if (HttpInstance->State < HTTP_STATE_HTTP_CONFIGED) { return EFI_NOT_STARTED; } if (HttpInstance->LocalAddressIsIPv6) { return EFI_UNSUPPORTED; } // // Check whether the token already existed. // if (EFI_ERROR (NetMapIterate (&HttpInstance->TxTokens, HttpTokenExist, Token))) { return EFI_ACCESS_DENIED; } Url = NULL; HostName = NULL; Wrap = NULL; HostNameStr = NULL; TcpWrap = NULL; // // Parse the URI of the remote host. // Url = AllocatePool (StrLen (Request->Url) + 1); if (Url == NULL) { return EFI_OUT_OF_RESOURCES; } UnicodeStrToAsciiStr (Request->Url, Url); UrlParser = NULL; Status = HttpParseUrl (Url, (UINT32) AsciiStrLen (Url), FALSE, &UrlParser); if (EFI_ERROR (Status)) { goto Error1; } RequestStr = NULL; HostName = NULL; Status = HttpUrlGetHostName (Url, UrlParser, &HostName); if (EFI_ERROR (Status)) { goto Error1; } Status = HttpUrlGetPort (Url, UrlParser, &RemotePort); if (EFI_ERROR (Status)) { RemotePort = HTTP_DEFAULT_PORT; } Configure = TRUE; ReConfigure = TRUE; if (HttpInstance->RemoteHost == NULL && HttpInstance->RemotePort == 0) { // // Request() is called the first time. // ReConfigure = FALSE; } else { if ((HttpInstance->RemotePort == RemotePort) && (AsciiStrCmp (HttpInstance->RemoteHost, HostName) == 0)) { // // Host Name and port number of the request URL are the same with previous call to Request(). // Check whether previous TCP packet sent out. // if (EFI_ERROR (NetMapIterate (&HttpInstance->TxTokens, HttpTcpNotReady, NULL))) { // // Wrap the HTTP token in HTTP_TOKEN_WRAP // Wrap = AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP)); if (Wrap == NULL) { Status = EFI_OUT_OF_RESOURCES; goto Error1; } Wrap->HttpToken = Token; Wrap->HttpInstance = HttpInstance; Status = HttpCreateTcp4TxEvent (Wrap); if (EFI_ERROR (Status)) { goto Error1; } Status = NetMapInsertTail (&HttpInstance->TxTokens, Token, Wrap); if (EFI_ERROR (Status)) { goto Error1; } Wrap->TcpWrap.Method = Request->Method; FreePool (Url); FreePool (HostName); // // Queue the HTTP token and return. // return EFI_SUCCESS; } else { // // Use existing TCP instance to transmit the packet. // Configure = FALSE; ReConfigure = FALSE; } } else { // // Need close existing TCP instance and create a new TCP instance for data transmit. // if (HttpInstance->RemoteHost != NULL) { FreePool (HttpInstance->RemoteHost); HttpInstance->RemoteHost = NULL; } } } if (Configure) { // // Parse Url for IPv4 address, if failed, perform DNS resolution. // Status = NetLibAsciiStrToIp4 (HostName, &HttpInstance->RemoteAddr); if (EFI_ERROR (Status)) { HostNameStr = AllocateZeroPool ((AsciiStrLen (HostName) + 1) * sizeof (UINT16)); if (HostNameStr == NULL) { Status = EFI_OUT_OF_RESOURCES; goto Error1; } AsciiStrToUnicodeStr (HostName, HostNameStr); Status = HttpDns4 (HttpInstance, HostNameStr, &HttpInstance->RemoteAddr); FreePool (HostNameStr); if (EFI_ERROR (Status)) { goto Error1; } } // // Save the RemotePort and RemoteHost. // ASSERT (HttpInstance->RemoteHost == NULL); HttpInstance->RemotePort = RemotePort; HttpInstance->RemoteHost = HostName; HostName = NULL; } if (ReConfigure) { // // The request URL is different from previous calls to Request(), close existing TCP instance. // ASSERT (HttpInstance->Tcp4 != NULL); HttpCloseConnection (HttpInstance); EfiHttpCancel (This, NULL); } // // Wrap the HTTP token in HTTP_TOKEN_WRAP // Wrap = AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP)); if (Wrap == NULL) { Status = EFI_OUT_OF_RESOURCES; goto Error1; } Wrap->HttpToken = Token; Wrap->HttpInstance = HttpInstance; Wrap->TcpWrap.Method = Request->Method; if (Configure) { // // Configure TCP instance. // Status = HttpConfigureTcp4 (HttpInstance, Wrap); if (EFI_ERROR (Status)) { goto Error1; } // // Connect TCP. // Status = HttpConnectTcp4 (HttpInstance); if (EFI_ERROR (Status)) { goto Error2; } } else { // // For the new HTTP token, create TX TCP token events. // Status = HttpCreateTcp4TxEvent (Wrap); if (EFI_ERROR (Status)) { goto Error1; } } // // Create request message. // RequestStr = HttpGenRequestString (HttpInstance, HttpMsg, Url); if (RequestStr == NULL) { Status = EFI_OUT_OF_RESOURCES; goto Error3; } Status = NetMapInsertTail (&HttpInstance->TxTokens, Token, Wrap); if (EFI_ERROR (Status)) { goto Error4; } FreePool (Url); if (HostName != NULL) { FreePool (HostName); } // // Transmit the request message. // Status = HttpTransmitTcp4 ( HttpInstance, Wrap, (UINT8*) RequestStr, AsciiStrLen (RequestStr) ); if (EFI_ERROR (Status)) { goto Error5; } return EFI_SUCCESS; Error5: NetMapRemoveTail (&HttpInstance->TxTokens, NULL); Error4: if (RequestStr != NULL) { FreePool (RequestStr); } Error3: HttpCloseConnection (HttpInstance); Error2: HttpCloseTcp4ConnCloseEvent (HttpInstance); if (NULL != Wrap->TcpWrap.TxToken.CompletionToken.Event) { gBS->CloseEvent (Wrap->TcpWrap.TxToken.CompletionToken.Event); } Error1: if (Url != NULL) { FreePool (Url); } if (HostName != NULL) { FreePool (HostName); } if (Wrap != NULL) { FreePool (Wrap); } if (UrlParser!= NULL) { HttpUrlFreeParser (UrlParser); } return Status; }
/** The Request() function queues an HTTP request to this HTTP instance. Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent successfully, or if there is an error, Status in token will be updated and Event will be signaled. @param[in] This Pointer to EFI_HTTP_PROTOCOL instance. @param[in] Token Pointer to storage containing HTTP request token. @retval EFI_SUCCESS Outgoing data was processed. @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started. @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. @retval EFI_TIMEOUT Data was dropped out of the transmit or receive queue. @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources. @retval EFI_UNSUPPORTED The HTTP method is not supported in current implementation. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: This is NULL. Token is NULL. Token->Message is NULL. Token->Message->Body is not NULL, Token->Message->BodyLength is non-zero, and Token->Message->Data is NULL, but a previous call to Request()has not been completed successfully. **/ EFI_STATUS EFIAPI EfiHttpRequest ( IN EFI_HTTP_PROTOCOL *This, IN EFI_HTTP_TOKEN *Token ) { EFI_HTTP_MESSAGE *HttpMsg; EFI_HTTP_REQUEST_DATA *Request; VOID *UrlParser; EFI_STATUS Status; CHAR8 *HostName; UINT16 RemotePort; HTTP_PROTOCOL *HttpInstance; BOOLEAN Configure; BOOLEAN ReConfigure; CHAR8 *RequestMsg; CHAR8 *Url; UINTN UrlLen; CHAR16 *HostNameStr; HTTP_TOKEN_WRAP *Wrap; CHAR8 *FileUrl; UINTN RequestMsgSize; // // Initializations // Url = NULL; HostName = NULL; RequestMsg = NULL; HostNameStr = NULL; Wrap = NULL; FileUrl = NULL; if ((This == NULL) || (Token == NULL)) { return EFI_INVALID_PARAMETER; } HttpMsg = Token->Message; if (HttpMsg == NULL) { return EFI_INVALID_PARAMETER; } Request = HttpMsg->Data.Request; // // Only support GET, HEAD, PUT and POST method in current implementation. // if ((Request != NULL) && (Request->Method != HttpMethodGet) && (Request->Method != HttpMethodHead) && (Request->Method != HttpMethodPut) && (Request->Method != HttpMethodPost)) { return EFI_UNSUPPORTED; } HttpInstance = HTTP_INSTANCE_FROM_PROTOCOL (This); ASSERT (HttpInstance != NULL); // // Capture the method into HttpInstance. // if (Request != NULL) { HttpInstance->Method = Request->Method; } if (HttpInstance->State < HTTP_STATE_HTTP_CONFIGED) { return EFI_NOT_STARTED; } if (Request == NULL) { // // Request would be NULL only for PUT/POST operation (in the current implementation) // if ((HttpInstance->Method != HttpMethodPut) && (HttpInstance->Method != HttpMethodPost)) { return EFI_INVALID_PARAMETER; } // // For PUT/POST, we need to have the TCP already configured. Bail out if it is not! // if (HttpInstance->State < HTTP_STATE_TCP_CONFIGED) { return EFI_INVALID_PARAMETER; } // // We need to have the Message Body for sending the HTTP message across in these cases. // if (HttpMsg->Body == NULL || HttpMsg->BodyLength == 0) { return EFI_INVALID_PARAMETER; } // // Use existing TCP instance to transmit the packet. // Configure = FALSE; ReConfigure = FALSE; } else { // // Check whether the token already existed. // if (EFI_ERROR (NetMapIterate (&HttpInstance->TxTokens, HttpTokenExist, Token))) { return EFI_ACCESS_DENIED; } // // Parse the URI of the remote host. // Url = HttpInstance->Url; UrlLen = StrLen (Request->Url) + 1; if (UrlLen > HTTP_URL_BUFFER_LEN) { Url = AllocateZeroPool (UrlLen); if (Url == NULL) { return EFI_OUT_OF_RESOURCES; } FreePool (HttpInstance->Url); HttpInstance->Url = Url; } UnicodeStrToAsciiStr (Request->Url, Url); UrlParser = NULL; Status = HttpParseUrl (Url, (UINT32) AsciiStrLen (Url), FALSE, &UrlParser); if (EFI_ERROR (Status)) { goto Error1; } HostName = NULL; Status = HttpUrlGetHostName (Url, UrlParser, &HostName); if (EFI_ERROR (Status)) { goto Error1; } Status = HttpUrlGetPort (Url, UrlParser, &RemotePort); if (EFI_ERROR (Status)) { RemotePort = HTTP_DEFAULT_PORT; } // // If Configure is TRUE, it indicates the first time to call Request(); // If ReConfigure is TRUE, it indicates the request URL is not same // with the previous call to Request(); // Configure = TRUE; ReConfigure = TRUE; if (HttpInstance->RemoteHost == NULL) { // // Request() is called the first time. // ReConfigure = FALSE; } else { if ((HttpInstance->RemotePort == RemotePort) && (AsciiStrCmp (HttpInstance->RemoteHost, HostName) == 0)) { // // Host Name and port number of the request URL are the same with previous call to Request(). // Check whether previous TCP packet sent out. // if (EFI_ERROR (NetMapIterate (&HttpInstance->TxTokens, HttpTcpNotReady, NULL))) { // // Wrap the HTTP token in HTTP_TOKEN_WRAP // Wrap = AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP)); if (Wrap == NULL) { Status = EFI_OUT_OF_RESOURCES; goto Error1; } Wrap->HttpToken = Token; Wrap->HttpInstance = HttpInstance; Status = HttpCreateTcpTxEvent (Wrap); if (EFI_ERROR (Status)) { goto Error1; } Status = NetMapInsertTail (&HttpInstance->TxTokens, Token, Wrap); if (EFI_ERROR (Status)) { goto Error1; } Wrap->TcpWrap.Method = Request->Method; FreePool (HostName); // // Queue the HTTP token and return. // return EFI_SUCCESS; } else { // // Use existing TCP instance to transmit the packet. // Configure = FALSE; ReConfigure = FALSE; } } else { // // Need close existing TCP instance and create a new TCP instance for data transmit. // if (HttpInstance->RemoteHost != NULL) { FreePool (HttpInstance->RemoteHost); HttpInstance->RemoteHost = NULL; HttpInstance->RemotePort = 0; } } } } if (Configure) { // // Parse Url for IPv4 or IPv6 address, if failed, perform DNS resolution. // if (!HttpInstance->LocalAddressIsIPv6) { Status = NetLibAsciiStrToIp4 (HostName, &HttpInstance->RemoteAddr); } else { Status = HttpUrlGetIp6 (Url, UrlParser, &HttpInstance->RemoteIpv6Addr); } if (EFI_ERROR (Status)) { HostNameStr = AllocateZeroPool ((AsciiStrLen (HostName) + 1) * sizeof (CHAR16)); if (HostNameStr == NULL) { Status = EFI_OUT_OF_RESOURCES; goto Error1; } AsciiStrToUnicodeStr (HostName, HostNameStr); if (!HttpInstance->LocalAddressIsIPv6) { Status = HttpDns4 (HttpInstance, HostNameStr, &HttpInstance->RemoteAddr); } else { Status = HttpDns6 (HttpInstance, HostNameStr, &HttpInstance->RemoteIpv6Addr); } FreePool (HostNameStr); if (EFI_ERROR (Status)) { goto Error1; } } // // Save the RemotePort and RemoteHost. // ASSERT (HttpInstance->RemoteHost == NULL); HttpInstance->RemotePort = RemotePort; HttpInstance->RemoteHost = HostName; HostName = NULL; } if (ReConfigure) { // // The request URL is different from previous calls to Request(), close existing TCP instance. // if (!HttpInstance->LocalAddressIsIPv6) { ASSERT (HttpInstance->Tcp4 != NULL); } else { ASSERT (HttpInstance->Tcp6 != NULL); } HttpCloseConnection (HttpInstance); EfiHttpCancel (This, NULL); } // // Wrap the HTTP token in HTTP_TOKEN_WRAP // Wrap = AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP)); if (Wrap == NULL) { Status = EFI_OUT_OF_RESOURCES; goto Error1; } Wrap->HttpToken = Token; Wrap->HttpInstance = HttpInstance; if (Request != NULL) { Wrap->TcpWrap.Method = Request->Method; } Status = HttpInitTcp (HttpInstance, Wrap, Configure); if (EFI_ERROR (Status)) { goto Error2; } if (!Configure) { // // For the new HTTP token, create TX TCP token events. // Status = HttpCreateTcpTxEvent (Wrap); if (EFI_ERROR (Status)) { goto Error1; } } // // Create request message. // FileUrl = Url; if (Url != NULL && *FileUrl != '/') { // // Convert the absolute-URI to the absolute-path // while (*FileUrl != ':') { FileUrl++; } if ((*(FileUrl+1) == '/') && (*(FileUrl+2) == '/')) { FileUrl += 3; while (*FileUrl != '/') { FileUrl++; } } else { Status = EFI_INVALID_PARAMETER; goto Error3; } } Status = HttpGenRequestMessage (HttpMsg, FileUrl, &RequestMsg, &RequestMsgSize); if (EFI_ERROR (Status)) { goto Error3; } // // Every request we insert a TxToken and a response call would remove the TxToken. // In cases of PUT/POST, after an initial request-response pair, we would do a // continuous request without a response call. So, in such cases, where Request // structure is NULL, we would not insert a TxToken. // if (Request != NULL) { Status = NetMapInsertTail (&HttpInstance->TxTokens, Token, Wrap); if (EFI_ERROR (Status)) { goto Error4; } } // // Transmit the request message. // Status = HttpTransmitTcp ( HttpInstance, Wrap, (UINT8*) RequestMsg, RequestMsgSize ); if (EFI_ERROR (Status)) { goto Error5; } DispatchDpc (); if (HostName != NULL) { FreePool (HostName); } return EFI_SUCCESS; Error5: // // We would have inserted a TxToken only if Request structure is not NULL. // Hence check before we do a remove in this error case. // if (Request != NULL) { NetMapRemoveTail (&HttpInstance->TxTokens, NULL); } Error4: if (RequestMsg != NULL) { FreePool (RequestMsg); } Error3: HttpCloseConnection (HttpInstance); Error2: HttpCloseTcpConnCloseEvent (HttpInstance); if (NULL != Wrap->TcpWrap.Tx4Token.CompletionToken.Event) { gBS->CloseEvent (Wrap->TcpWrap.Tx4Token.CompletionToken.Event); Wrap->TcpWrap.Tx4Token.CompletionToken.Event = NULL; } if (NULL != Wrap->TcpWrap.Tx6Token.CompletionToken.Event) { gBS->CloseEvent (Wrap->TcpWrap.Tx6Token.CompletionToken.Event); Wrap->TcpWrap.Tx6Token.CompletionToken.Event = NULL; } Error1: if (HostName != NULL) { FreePool (HostName); } if (Wrap != NULL) { FreePool (Wrap); } if (UrlParser!= NULL) { HttpUrlFreeParser (UrlParser); } return Status; }