]>
Commit | Line | Data |
---|---|---|
10dc8c56 AC |
1 | /** @file\r |
2 | RestExDxe support functions implementation.\r | |
3 | \r | |
4 | Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r | |
5 | (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>\r | |
6 | \r | |
7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
8 | \r | |
9 | **/\r | |
10 | #include <Uefi.h>\r | |
11 | #include "RedfishRestExInternal.h"\r | |
12 | \r | |
13 | /**\r | |
14 | Create a new TLS session becuase the previous on is closed.\r | |
15 | status.\r | |
16 | \r | |
17 | @param[in] Instance Pointer to EFI_REST_EX_PROTOCOL instance for a particular\r | |
18 | REST service.\r | |
19 | @retval EFI_SUCCESS operation succeeded.\r | |
20 | @retval EFI_ERROR Other errors.\r | |
21 | \r | |
22 | **/\r | |
23 | EFI_STATUS\r | |
24 | ResetHttpTslSession (\r | |
25 | IN RESTEX_INSTANCE *Instance\r | |
26 | )\r | |
27 | {\r | |
28 | EFI_STATUS Status;\r | |
29 | \r | |
30 | DEBUG ((DEBUG_INFO, "%a: TCP connection is finished. Could be TSL session closure, reset HTTP instance for the new TLS session.\n", __FUNCTION__));\r | |
31 | \r | |
32 | Status = Instance->HttpIo.Http->Configure (Instance->HttpIo.Http, NULL);\r | |
33 | if (EFI_ERROR (Status)) {\r | |
34 | DEBUG ((DEBUG_ERROR, "%a: Error to reset HTTP instance.\n", __FUNCTION__));\r | |
35 | return Status;\r | |
36 | }\r | |
37 | Status = Instance->HttpIo.Http->Configure(Instance->HttpIo.Http, &((EFI_REST_EX_HTTP_CONFIG_DATA *)Instance->ConfigData)->HttpConfigData);\r | |
38 | if (EFI_ERROR (Status)) {\r | |
39 | DEBUG ((DEBUG_ERROR, "%a: Error to re-initiate HTTP instance.\n", __FUNCTION__));\r | |
40 | }\r | |
41 | return Status;\r | |
42 | }\r | |
43 | /**\r | |
44 | This function check\r | |
45 | \r | |
46 | @param[in] Instance Pointer to EFI_REST_EX_PROTOCOL instance for a particular\r | |
47 | REST service.\r | |
48 | @param[in] HttpIoReceiveStatus This is the status return from HttpIoRecvResponse\r | |
49 | \r | |
50 | @retval EFI_SUCCESS The payload receive from Redfish service in sucessfully.\r | |
51 | @retval EFI_NOT_READY May need to resend the HTTP request.\r | |
52 | @retval EFI_DEVICE_ERROR Something wrong and can't be resolved.\r | |
53 | @retval Others Other errors as indicated.\r | |
54 | \r | |
55 | **/\r | |
56 | EFI_STATUS\r | |
57 | RedfishCheckHttpReceiveStatus (\r | |
58 | IN RESTEX_INSTANCE *Instance,\r | |
59 | IN EFI_STATUS HttpIoReceiveStatus\r | |
60 | )\r | |
61 | {\r | |
62 | EFI_STATUS Status;\r | |
63 | EFI_STATUS ReturnStatus;\r | |
64 | \r | |
65 | if (!EFI_ERROR (HttpIoReceiveStatus)){\r | |
66 | ReturnStatus = EFI_SUCCESS;\r | |
67 | } else if (EFI_ERROR (HttpIoReceiveStatus) && HttpIoReceiveStatus != EFI_CONNECTION_FIN) {\r | |
68 | if ((Instance->Flags & RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY) == 0) {\r | |
69 | DEBUG ((DEBUG_ERROR, "%a: TCP error, reset HTTP session.\n", __FUNCTION__));\r | |
70 | Instance->Flags |= RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY;\r | |
71 | gBS->Stall (500);\r | |
72 | Status = ResetHttpTslSession (Instance);\r | |
73 | if (EFI_ERROR (Status)) {\r | |
74 | DEBUG ((DEBUG_ERROR, "%a: Reset HTTP instance fail.\n", __FUNCTION__));\r | |
75 | ReturnStatus = EFI_DEVICE_ERROR;\r | |
76 | } else {\r | |
77 | return EFI_NOT_READY;\r | |
78 | }\r | |
79 | } else {\r | |
80 | ReturnStatus = EFI_DEVICE_ERROR;\r | |
81 | }\r | |
82 | } else {\r | |
83 | if (HttpIoReceiveStatus == EFI_CONNECTION_FIN) {\r | |
84 | if ((Instance->Flags & RESTEX_INSTANCE_FLAGS_TLS_RETRY) != 0) {\r | |
85 | DEBUG ((DEBUG_ERROR, "%a: REST_EX Send and receive fail even with a new TLS session.\n", __FUNCTION__));\r | |
86 | ReturnStatus = EFI_DEVICE_ERROR;\r | |
87 | }\r | |
88 | Instance->Flags |= RESTEX_INSTANCE_FLAGS_TLS_RETRY;\r | |
89 | Status = ResetHttpTslSession (Instance);\r | |
90 | if (EFI_ERROR (Status)) {\r | |
91 | DEBUG ((DEBUG_ERROR, "%a: Reset HTTP instance fail.\n", __FUNCTION__));\r | |
92 | ReturnStatus = EFI_DEVICE_ERROR;\r | |
93 | }\r | |
94 | return EFI_NOT_READY;\r | |
95 | }\r | |
96 | }\r | |
97 | //\r | |
98 | // Clean TLS new session retry and error try flags.\r | |
99 | //\r | |
100 | Instance->Flags &= ~ (RESTEX_INSTANCE_FLAGS_TLS_RETRY | RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY);\r | |
101 | return ReturnStatus;\r | |
102 | }\r | |
103 | \r | |
104 | /**\r | |
105 | This function send the HTTP request without body to see\r | |
106 | if the write to URL is permitted by Redfish service. This function\r | |
107 | checks if the HTTP request has Content-length in HTTP header. If yes,\r | |
108 | set HTTP body to NULL and then send to service. Check the HTTP status\r | |
109 | for the firther actions.\r | |
110 | \r | |
111 | @param[in] This Pointer to EFI_REST_EX_PROTOCOL instance for a particular\r | |
112 | REST service.\r | |
113 | @param[in] RequestMessage Pointer to the HTTP request data for this resource\r | |
114 | @param[in] PreservedRequestHeaders The pointer to save the request headers\r | |
115 | @param[in] ItsWrite This is write method to URL.\r | |
116 | \r | |
117 | @retval EFI_INVALID_PARAMETER Improper given parameters.\r | |
118 | @retval EFI_SUCCESS This HTTP request is free to send to Redfish service.\r | |
119 | @retval EFI_OUT_OF_RESOURCES NOt enough memory to process.\r | |
120 | @retval EFI_ACCESS_DENIED Not allowed to write to this URL.\r | |
121 | \r | |
122 | @retval Others Other errors as indicated.\r | |
123 | \r | |
124 | **/\r | |
125 | EFI_STATUS\r | |
126 | RedfishHttpAddExpectation (\r | |
127 | IN EFI_REST_EX_PROTOCOL *This,\r | |
128 | IN EFI_HTTP_MESSAGE *RequestMessage,\r | |
129 | IN EFI_HTTP_HEADER **PreservedRequestHeaders,\r | |
130 | IN BOOLEAN *ItsWrite\r | |
131 | )\r | |
132 | {\r | |
133 | EFI_HTTP_HEADER *NewHeaders;\r | |
134 | \r | |
135 | if (This == NULL || RequestMessage == NULL) {\r | |
136 | return EFI_INVALID_PARAMETER;\r | |
137 | }\r | |
138 | \r | |
139 | *ItsWrite = FALSE;\r | |
140 | if (PreservedRequestHeaders != NULL) {\r | |
141 | *PreservedRequestHeaders = RequestMessage->Headers;\r | |
142 | }\r | |
143 | \r | |
144 | if ((RequestMessage->Data.Request->Method != HttpMethodPut) && (RequestMessage->Data.Request->Method != HttpMethodPost) &&\r | |
145 | (RequestMessage->Data.Request->Method != HttpMethodPatch)) {\r | |
146 | return EFI_SUCCESS;\r | |
147 | }\r | |
148 | *ItsWrite = TRUE;\r | |
149 | \r | |
150 | NewHeaders = AllocateZeroPool((RequestMessage->HeaderCount + 1) * sizeof(EFI_HTTP_HEADER));\r | |
151 | CopyMem ((VOID*)NewHeaders, (VOID *)RequestMessage->Headers, RequestMessage->HeaderCount * sizeof (EFI_HTTP_HEADER));\r | |
152 | HttpSetFieldNameAndValue (NewHeaders + RequestMessage->HeaderCount, HTTP_HEADER_EXPECT, HTTP_EXPECT_100_CONTINUE);\r | |
153 | RequestMessage->HeaderCount ++;\r | |
154 | RequestMessage->Headers = NewHeaders;\r | |
155 | return EFI_SUCCESS;\r | |
156 | }\r | |
157 | \r |