MdePkg/Include: EFI Redfish Discover protocol

[mirror_edk2.git] / RedfishPkg / RedfishRestExDxe / RedfishRestExImpl.c

/** @file\r
  RestExDxe support functions implementation.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#include <Uefi.h>\r
#include "RedfishRestExInternal.h"\r
\r
/**\r
  Create a new TLS session becuase the previous on is closed.\r
  status.\r
\r
  @param[in]  Instance            Pointer to EFI_REST_EX_PROTOCOL instance for a particular\r
                                  REST service.\r
  @retval EFI_SUCCESS             operation succeeded.\r
  @retval EFI_ERROR               Other errors.\r
\r
**/\r
EFI_STATUS\r
ResetHttpTslSession (\r
  IN   RESTEX_INSTANCE  *Instance\r
)\r
{\r
  EFI_STATUS Status;\r
\r
  DEBUG ((DEBUG_INFO, "%a: TCP connection is finished. Could be TSL session closure, reset HTTP instance for the new TLS session.\n", __FUNCTION__));\r
\r
  Status = Instance->HttpIo.Http->Configure (Instance->HttpIo.Http, NULL);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "%a: Error to reset HTTP instance.\n", __FUNCTION__));\r
    return Status;\r
  }\r
  Status = Instance->HttpIo.Http->Configure(Instance->HttpIo.Http, &((EFI_REST_EX_HTTP_CONFIG_DATA *)Instance->ConfigData)->HttpConfigData);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "%a: Error to re-initiate HTTP instance.\n", __FUNCTION__));\r
  }\r
  return Status;\r
}\r
/**\r
  This function check\r
\r
  @param[in]  Instance             Pointer to EFI_REST_EX_PROTOCOL instance for a particular\r
                                   REST service.\r
  @param[in]  HttpIoReceiveStatus  This is the status return from HttpIoRecvResponse\r
\r
  @retval EFI_SUCCESS           The payload receive from Redfish service in sucessfully.\r
  @retval EFI_NOT_READY         May need to resend the HTTP request.\r
  @retval EFI_DEVICE_ERROR      Something wrong and can't be resolved.\r
  @retval Others                Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
RedfishCheckHttpReceiveStatus (\r
  IN RESTEX_INSTANCE *Instance,\r
  IN EFI_STATUS HttpIoReceiveStatus\r
  )\r
{\r
  EFI_STATUS Status;\r
  EFI_STATUS ReturnStatus;\r
\r
  if (!EFI_ERROR (HttpIoReceiveStatus)){\r
    ReturnStatus = EFI_SUCCESS;\r
  } else if (EFI_ERROR (HttpIoReceiveStatus) && HttpIoReceiveStatus != EFI_CONNECTION_FIN) {\r
    if ((Instance->Flags & RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY) == 0) {\r
      DEBUG ((DEBUG_ERROR, "%a: TCP error, reset HTTP session.\n", __FUNCTION__));\r
      Instance->Flags |= RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY;\r
      gBS->Stall (500);\r
      Status = ResetHttpTslSession (Instance);\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((DEBUG_ERROR, "%a: Reset HTTP instance fail.\n", __FUNCTION__));\r
        ReturnStatus = EFI_DEVICE_ERROR;\r
      } else {\r
        return EFI_NOT_READY;\r
      }\r
    } else {\r
      ReturnStatus = EFI_DEVICE_ERROR;\r
    }\r
  } else {\r
      if (HttpIoReceiveStatus == EFI_CONNECTION_FIN) {\r
        if ((Instance->Flags & RESTEX_INSTANCE_FLAGS_TLS_RETRY) != 0) {\r
          DEBUG ((DEBUG_ERROR, "%a: REST_EX Send and receive fail even with a new TLS session.\n", __FUNCTION__));\r
          ReturnStatus = EFI_DEVICE_ERROR;\r
        }\r
        Instance->Flags |= RESTEX_INSTANCE_FLAGS_TLS_RETRY;\r
        Status = ResetHttpTslSession (Instance);\r
        if (EFI_ERROR (Status)) {\r
          DEBUG ((DEBUG_ERROR, "%a: Reset HTTP instance fail.\n", __FUNCTION__));\r
          ReturnStatus = EFI_DEVICE_ERROR;\r
        }\r
        return EFI_NOT_READY;\r
      }\r
  }\r
  //\r
  // Clean TLS new session retry and error try flags.\r
  //\r
  Instance->Flags &= ~ (RESTEX_INSTANCE_FLAGS_TLS_RETRY | RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY);\r
  return ReturnStatus;\r
}\r
\r
/**\r
  This function send the HTTP request without body to see\r
  if the write to URL is permitted by Redfish service. This function\r
  checks if the HTTP request has Content-length in HTTP header. If yes,\r
  set HTTP body to NULL and then send to service. Check the HTTP status\r
  for the firther actions.\r
\r
  @param[in]  This                    Pointer to EFI_REST_EX_PROTOCOL instance for a particular\r
                                      REST service.\r
  @param[in]  RequestMessage          Pointer to the HTTP request data for this resource\r
  @param[in]  PreservedRequestHeaders The pointer to save the request headers\r
  @param[in]  ItsWrite                This is write method to URL.\r
\r
  @retval EFI_INVALID_PARAMETER  Improper given parameters.\r
  @retval EFI_SUCCESS            This HTTP request is free to send to Redfish service.\r
  @retval EFI_OUT_OF_RESOURCES   NOt enough memory to process.\r
  @retval EFI_ACCESS_DENIED      Not allowed to write to this URL.\r
\r
  @retval Others                 Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
RedfishHttpAddExpectation (\r
  IN EFI_REST_EX_PROTOCOL   *This,\r
  IN EFI_HTTP_MESSAGE       *RequestMessage,\r
  IN EFI_HTTP_HEADER        **PreservedRequestHeaders,\r
  IN BOOLEAN                *ItsWrite\r
  )\r
{\r
  EFI_HTTP_HEADER *NewHeaders;\r
\r
  if (This == NULL || RequestMessage == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *ItsWrite = FALSE;\r
  if (PreservedRequestHeaders != NULL) {\r
    *PreservedRequestHeaders = RequestMessage->Headers;\r
  }\r
\r
  if ((RequestMessage->Data.Request->Method != HttpMethodPut) && (RequestMessage->Data.Request->Method != HttpMethodPost) &&\r
      (RequestMessage->Data.Request->Method != HttpMethodPatch)) {\r
    return EFI_SUCCESS;\r
  }\r
  *ItsWrite = TRUE;\r
\r
  NewHeaders = AllocateZeroPool((RequestMessage->HeaderCount + 1) * sizeof(EFI_HTTP_HEADER));\r
  CopyMem ((VOID*)NewHeaders, (VOID *)RequestMessage->Headers, RequestMessage->HeaderCount * sizeof (EFI_HTTP_HEADER));\r
  HttpSetFieldNameAndValue (NewHeaders + RequestMessage->HeaderCount, HTTP_HEADER_EXPECT, HTTP_EXPECT_100_CONTINUE);\r
  RequestMessage->HeaderCount ++;\r
  RequestMessage->Headers = NewHeaders;\r
  return EFI_SUCCESS;\r
}\r
\r