mirror of https://github.com/acidanthera/audk.git
RedfishPkg/Library: RedfishLib
EDK2 port of DMTF libredfish project. We clone the necessary files from open source project libredfish (https://github.com/DMTF/ libredfish) tag v1.0.0 and revise it to incorporate with edk2 firmware code base. The reason of cloning the necessary files instead of using extern submodule of libredfish project: libredfish as a C library which is executed under Windows and Linux. It could be binded with other programming languages such as java and python. The library uses curl library as the communication service with Redfish, which is not easy to be abstracted and replaced with EFI specific protocols (e.g. EFI_REST_EX_PROTOCOL or payload encode/decode library) and EFI data types. We had the conversation with DMTF community and they think edk2 is a firmware solution but not the programming language, therefore they rejected to have edk2 as a binding to libredfish. According to above, we decide to clone the necessary files from libredfish modify it to incorporate with edk2. Signed-off-by: Jiaxin Wu <jiaxin.wu@intel.com> Signed-off-by: Ting Ye <ting.ye@intel.com> Signed-off-by: Siyuan Fu <siyuan.fu@intel.com> Signed-off-by: Fan Wang <fan.wang@intel.com> Signed-off-by: Abner Chang <abner.chang@hpe.com> Cc: Nickle Wang <nickle.wang@hpe.com> Reviewed-by: Nickle Wang <nickle.wang@hpe.com>
This commit is contained in:
Abner Chang
mergify[bot]
parent
54ba08c6b6
commit
4751a48aeb
|
|
@ -0,0 +1,611 @@
|
|||
/** @file
|
||||
This library provides a set of utility APIs that allow to create/read/update/delete
|
||||
(CRUD) Redfish resources and provide basic query abilities by using [URI/RedPath]
|
||||
(https://github.com/DMTF/libredfish).
|
||||
|
||||
The query language is based on XPath (https://www.w3.org/TR/1999/REC-xpath-19991116/).
|
||||
This library and query language essentially treat the entire Redfish Service like it
|
||||
was a single JSON document. In other words whenever it encounters an odata.id in JSON
|
||||
document, it will retrieve the new JSON document (if needed). We name the path as
|
||||
RedPath:
|
||||
|
||||
Expression Description
|
||||
|
||||
nodename Selects the JSON entity with the name "nodename".
|
||||
If the value of nodename is an object with "@odata.id",
|
||||
it will continue get the value from "@odata.id".
|
||||
|
||||
/ Selects from the root node
|
||||
|
||||
[index] Selects the index number JSON entity from an array or
|
||||
object. If the JSON entity is one collection (has
|
||||
Members & Members@odata.count), means to get the index
|
||||
member in "Members". Index number >=1, 1 means to return
|
||||
the first instance.
|
||||
|
||||
[XXX] Operation on JSON entity.
|
||||
If the JSON entity is one collection (has Members &
|
||||
Members@odata.count), means to get all elements in
|
||||
"Members". If the JSON entity is one array, means to
|
||||
get all elements in array. Others will match the nodename
|
||||
directly (e.g. JSON_OBJECT, JSON_STRING, JSON_TRUE,
|
||||
JSON_FALSE, JSON_INTEGER).
|
||||
|
||||
[nodename] Selects all the elements from an JSON entity that
|
||||
contain a property named "nodename"
|
||||
|
||||
[name=value] Selects all the elements from an JSON entity where
|
||||
the property "name" is equal to "value"
|
||||
|
||||
[name~value] Selects all the elements from an JSON entity where
|
||||
the string property "name" is equal to "value" using
|
||||
case insensitive comparison.
|
||||
|
||||
[name<value] Selects all the elements from an JSON entity where
|
||||
the property "name" is less than "value"
|
||||
|
||||
[name<=value] Selects all the elements from an JSON entity where
|
||||
the property "name" is less than or equal to "value"
|
||||
|
||||
[name>value] Selects all the elements from an JSON entity where
|
||||
the property "name" is greater than "value"
|
||||
|
||||
[name>=value] Selects all the elements from an JSON entity where
|
||||
the property "name" is greater than or equal to "value"
|
||||
|
||||
Some examples:
|
||||
|
||||
/v1/Chassis[1] - Will return the first Chassis instance.
|
||||
/v1/Chassis[SKU=1234] - Will return all Chassis instances with a SKU field equal to 1234.
|
||||
/v1/Systems[Storage] - Will return all the System instances that have Storage field populated.
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
|
||||
#ifndef REDFISH_LIB_H_
|
||||
#define REDFISH_LIB_H_
|
||||
|
||||
#include <Library/JsonLib.h>
|
||||
|
||||
#include <Protocol/Http.h>
|
||||
#include <Protocol/EdkIIRedfishConfigHandler.h>
|
||||
|
||||
#define ODATA_TYPE_NAME_MAX_SIZE 128
|
||||
#define ODATA_TYPE_MAX_SIZE 128
|
||||
|
||||
///
|
||||
/// Library class public defines
|
||||
///
|
||||
typedef VOID* REDFISH_SERVICE;
|
||||
typedef VOID* REDFISH_PAYLOAD;
|
||||
|
||||
///
|
||||
/// Library class public structures/unions
|
||||
///
|
||||
typedef struct {
|
||||
EFI_HTTP_STATUS_CODE *StatusCode;
|
||||
UINTN HeaderCount;
|
||||
EFI_HTTP_HEADER *Headers;
|
||||
REDFISH_PAYLOAD Payload;
|
||||
} REDFISH_RESPONSE;
|
||||
|
||||
///
|
||||
/// Odata type-name mapping structure.
|
||||
///
|
||||
typedef struct {
|
||||
CONST CHAR8 OdataTypeName [ODATA_TYPE_NAME_MAX_SIZE];
|
||||
CONST CHAR8 OdataType [ODATA_TYPE_MAX_SIZE];
|
||||
} REDFISH_ODATA_TYPE_MAPPING;
|
||||
|
||||
/**
|
||||
This function uses REST EX protocol provided in RedfishConfigServiceInfo.
|
||||
The service enumerator will also handle the authentication flow automatically
|
||||
if HTTP basic auth or Redfish session login is configured to use.
|
||||
|
||||
Callers are responsible for freeing the returned service by RedfishCleanupService().
|
||||
|
||||
@param[in] RedfishConfigServiceInfo Redfish service information the EFI Redfish
|
||||
feature driver communicates with.
|
||||
|
||||
@return New created Redfish Service, or NULL if error happens.
|
||||
|
||||
**/
|
||||
REDFISH_SERVICE
|
||||
EFIAPI
|
||||
RedfishCreateService (
|
||||
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo
|
||||
);
|
||||
|
||||
/**
|
||||
Free the Service and all its related resources.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
RedfishCleanupService (
|
||||
IN REDFISH_SERVICE RedfishService
|
||||
);
|
||||
|
||||
/**
|
||||
Create REDFISH_PAYLOAD instance in local with JSON represented resource value and
|
||||
the Redfish Service.
|
||||
|
||||
The returned REDFISH_PAYLOAD can be used to create or update Redfish resource in
|
||||
server side.
|
||||
|
||||
Callers are responsible for freeing the returned payload by RedfishCleanupPayload().
|
||||
|
||||
@param[in] Value JSON Value of the redfish resource.
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
|
||||
@return REDFISH_PAYLOAD instance of the resource, or NULL if error happens.
|
||||
|
||||
**/
|
||||
REDFISH_PAYLOAD
|
||||
EFIAPI
|
||||
RedfishCreatePayload (
|
||||
IN EDKII_JSON_VALUE Value,
|
||||
IN REDFISH_SERVICE RedfishService
|
||||
);
|
||||
|
||||
/**
|
||||
Free the RedfishPayload and all its related resources.
|
||||
|
||||
@param[in] Payload Payload to be freed.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
RedfishCleanupPayload (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
);
|
||||
|
||||
/**
|
||||
This function returns the decoded JSON value of a REDFISH_PAYLOAD.
|
||||
|
||||
Caller doesn't need to free the returned JSON value because it will be released
|
||||
in corresponding RedfishCleanupPayload() function.
|
||||
|
||||
@param[in] Payload A REDFISH_PAYLOAD instance.
|
||||
|
||||
@return Decoded JSON value of the payload.
|
||||
|
||||
**/
|
||||
EDKII_JSON_VALUE
|
||||
EFIAPI
|
||||
RedfishJsonInPayload (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
);
|
||||
|
||||
/**
|
||||
Fill the input RedPath string with system UUID from SMBIOS table or use the customized
|
||||
ID if FromSmbios == FALSE.
|
||||
|
||||
This is a helper function to build a RedPath string which can be used to address
|
||||
a Redfish resource for this computer system. The input PathString must have a Systems
|
||||
note in format of "Systems[UUID=%g]" or "Systems[UUID~%g]" to fill the UUID value.
|
||||
|
||||
Example:
|
||||
Use "/v1/Systems[UUID=%g]/Bios" to build a RedPath to address the "Bios" resource
|
||||
for this computer system.
|
||||
|
||||
@param[in] RedPath RedPath format to be build.
|
||||
@param[in] FromSmbios Get system UUID from SMBIOS as computer system instance ID.
|
||||
@param[in] IdString The computer system instance ID.
|
||||
|
||||
@return Full RedPath with system UUID inside, or NULL if error happens.
|
||||
|
||||
**/
|
||||
CHAR8 *
|
||||
EFIAPI
|
||||
RedfishBuildPathWithSystemUuid (
|
||||
IN CONST CHAR8 *RedPath,
|
||||
IN BOOLEAN FromSmbios,
|
||||
IN CHAR8 *IdString OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
Get a redfish response addressed by a RedPath string, including HTTP StatusCode, Headers
|
||||
and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
@param[in] RedPath RedPath string to address a resource, must start
|
||||
from the root node.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The corresponding redfish resource has
|
||||
been returned in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned Payload is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is NULL, indicates any error happen.
|
||||
3. If the returned StatusCode is not 2XX, indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishGetByService (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *RedPath,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
);
|
||||
|
||||
/**
|
||||
Get a redfish response addressed by URI, including HTTP StatusCode, Headers
|
||||
and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the URI resources.
|
||||
@param[in] URI String to address a resource.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The corresponding redfish resource has
|
||||
been returned in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned Payload is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is NULL, indicates any error happen.
|
||||
3. If the returned StatusCode is not 2XX, indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishGetByUri (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *Uri,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
);
|
||||
|
||||
/**
|
||||
Get a redfish response addressed by the input Payload and relative RedPath string,
|
||||
including HTTP StatusCode, Headers and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] Payload A existing REDFISH_PAYLOAD instance.
|
||||
@param[in] RedPath Relative RedPath string to address a resource inside Payload.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful:
|
||||
1. The HTTP StatusCode is NULL and the returned Payload in
|
||||
RedResponse is not NULL, indicates the Redfish resource has
|
||||
been parsed from the input payload directly.
|
||||
2. The HTTP StatusCode is not NULL and the value is 2XX,
|
||||
indicates the corresponding redfish resource has been returned
|
||||
in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER Payload, RedPath, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned Payload is NULL, indicates any error happen.
|
||||
2. If StatusCode is not NULL and the returned value of StatusCode
|
||||
is not 2XX, indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishGetByPayload (
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN CONST CHAR8 *RedPath,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
);
|
||||
|
||||
/**
|
||||
Use HTTP PATCH to perform updates on pre-existing Redfish resource.
|
||||
|
||||
This function uses the RedfishService to patch a Redfish resource addressed by
|
||||
Uri (only the relative path is required). Changes to one or more properties within
|
||||
the target resource are represented in the input Content, properties not specified
|
||||
in Content won't be changed by this request. The corresponding redfish response will
|
||||
returned, including HTTP StatusCode, Headers and Payload which record any HTTP response
|
||||
messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
@param[in] Uri Relative path to address the resource.
|
||||
@param[in] Content JSON represented properties to be update.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The Redfish resource will be returned
|
||||
in Payload within RedResponse if server send it back in the HTTP
|
||||
response message body.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, Uri, Content, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishPatchToUri (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *Uri,
|
||||
IN CONST CHAR8 *Content,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
);
|
||||
|
||||
/**
|
||||
Use HTTP PATCH to perform updates on target payload. Patch to odata.id in Payload directly.
|
||||
|
||||
This function uses the Payload to patch the Target. Changes to one or more properties
|
||||
within the target resource are represented in the input Payload, properties not specified
|
||||
in Payload won't be changed by this request. The corresponding redfish response will
|
||||
returned, including HTTP StatusCode, Headers and Payload which record any HTTP response
|
||||
messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] Target The target payload to be updated.
|
||||
@param[in] Payload Palyoad with properties to be changed.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The Redfish resource will be returned
|
||||
in Payload within RedResponse if server send it back in the HTTP
|
||||
response message body.
|
||||
@retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishPatchToPayload (
|
||||
IN REDFISH_PAYLOAD Target,
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
);
|
||||
|
||||
/**
|
||||
Use HTTP POST to create a new resource in target payload.
|
||||
|
||||
The POST request should be submitted to the Resource Collection in which the new resource
|
||||
is to belong. The Resource Collection is addressed by Target payload. The Redfish may
|
||||
ignore any service controlled properties. The corresponding redfish response will returned,
|
||||
including HTTP StatusCode, Headers and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] Target Target payload of the Resource Collection.
|
||||
@param[in] Payload The new resource to be created.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The Redfish resource will be returned
|
||||
in Payload within RedResponse if server send it back in the HTTP
|
||||
response message body.
|
||||
@retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishPostToPayload (
|
||||
IN REDFISH_PAYLOAD Target,
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
);
|
||||
|
||||
/**
|
||||
Use HTTP DELETE to remove a resource.
|
||||
|
||||
This function uses the RedfishService to remove a Redfish resource which is addressed
|
||||
by input Uri (only the relative path is required). The corresponding redfish response will
|
||||
returned, including HTTP StatusCode, Headers and Payload which record any HTTP response
|
||||
messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
@param[in] Uri Relative path to address the resource.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX, the Redfish resource has been removed.
|
||||
If there is any message returned from server, it will be returned
|
||||
in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, Uri, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishDeleteByUri (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *Uri,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
);
|
||||
|
||||
/**
|
||||
Dump text in fractions.
|
||||
|
||||
@param[in] String ASCII string to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishDumpJsonStringFractions (
|
||||
IN CHAR8 *String
|
||||
);
|
||||
|
||||
/**
|
||||
Extract the JSON text content from REDFISH_PAYLOAD and dump to debug console.
|
||||
|
||||
@param[in] Payload The Redfish payload to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishDumpPayload (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
);
|
||||
/**
|
||||
Dump text in JSON value.
|
||||
|
||||
@param[in] JsonValue The Redfish JSON value to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishDumpJson (
|
||||
IN EDKII_JSON_VALUE JsonValue
|
||||
);
|
||||
/**
|
||||
This function will cleanup the HTTP header and Redfish payload resources.
|
||||
|
||||
@param[in] StatusCode The status code in HTTP response message.
|
||||
@param[in] HeaderCount Number of HTTP header structures in Headers list.
|
||||
@param[in] Headers Array containing list of HTTP headers.
|
||||
@param[in] Payload The Redfish payload to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishFreeResponse (
|
||||
IN EFI_HTTP_STATUS_CODE *StatusCode,
|
||||
IN UINTN HeaderCount,
|
||||
IN EFI_HTTP_HEADER *Headers,
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
);
|
||||
|
||||
/**
|
||||
Check if the "@odata.type" in Payload is valid or not.
|
||||
|
||||
@param[in] Payload The Redfish payload to be checked.
|
||||
@param[in] OdataTypeName OdataType will be retrived from mapping list.
|
||||
@param[in] OdataTypeMappingList The list of OdataType.
|
||||
@param[in] OdataTypeMappingListSize The number of mapping list
|
||||
|
||||
@return TRUE if the "@odata.type" in Payload is valid, otherwise FALSE.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
RedfishIsValidOdataType (
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN CONST CHAR8 *OdataTypeName,
|
||||
IN REDFISH_ODATA_TYPE_MAPPING *OdataTypeMappingList,
|
||||
IN UINTN OdataTypeMappingListSize
|
||||
);
|
||||
|
||||
/**
|
||||
Check if the payload is collection
|
||||
|
||||
@param[in] Payload The Redfish payload to be checked.
|
||||
|
||||
@return TRUE if the payload is collection.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
RedfishIsPayloadCollection (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
);
|
||||
/**
|
||||
Get collection size.
|
||||
|
||||
@param[in] Payload The Redfish collection payload
|
||||
@param[in] CollectionSize Size of this collection
|
||||
|
||||
@return EFI_SUCCESS Coolection size is returned in CollectionSize
|
||||
@return EFI_INVALID_PARAMETER The payload is not a collection.
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishGetCollectionSize(
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN UINTN *CollectionSize
|
||||
);
|
||||
/**
|
||||
Get Redfish payload of collection member
|
||||
|
||||
@param[in] Payload The Redfish collection payload
|
||||
@param[in] Index Index of collection member
|
||||
|
||||
@return NULL Fail to get collection member.
|
||||
@return Non NULL Payload is returned.
|
||||
**/
|
||||
REDFISH_PAYLOAD
|
||||
RedfishGetPayloadByIndex (
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN UINTN Index
|
||||
);
|
||||
|
||||
/**
|
||||
Check and return Redfish resource of the given Redpath.
|
||||
|
||||
@param[in] RedfishService Pointer to REDFISH_SERVICE
|
||||
@param[in] Redpath Redpath of the resource.
|
||||
@param[in] Response Optional return the resource.
|
||||
|
||||
@return EFI_STATUS
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishCheckIfRedpathExist (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CHAR8 *Redpath,
|
||||
IN REDFISH_RESPONSE *Response OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
This function returns the string of Redfish service version.
|
||||
|
||||
@param[in] RedfishService Redfish service instance.
|
||||
@param[out] ServiceVersionStr Redfish service string.
|
||||
|
||||
@return EFI_STATUS
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishGetServiceVersion(
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
OUT CHAR8 **ServiceVersionStr
|
||||
);
|
||||
|
||||
/**
|
||||
This function returns the string of Redfish service version.
|
||||
|
||||
@param[in] ServiceVerisonStr The string of Redfish service version.
|
||||
@param[in] Url The URL to build Redpath with ID.
|
||||
Start with "/", for example "/Registries"
|
||||
@param[in] Id ID string
|
||||
@param[out] Redpath Pointer to retrive Redpath, caller has to free
|
||||
the memory allocated for this string.
|
||||
@return EFI_STATUS
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishBuildRedpathUseId (
|
||||
IN CHAR8 *ServiceVerisonStr,
|
||||
IN CHAR8 *Url,
|
||||
IN CHAR8 *Id,
|
||||
OUT CHAR8 **Redpath
|
||||
);
|
||||
#endif
|
||||
|
|
@ -0,0 +1,993 @@
|
|||
/** @file
|
||||
Provides a set of utility APIs that allow to create/read/update/delete
|
||||
(CRUD) Redfish resources and provide basic query.
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
|
||||
#include "RedfishMisc.h"
|
||||
|
||||
/**
|
||||
This function uses REST EX protocol provided in RedfishConfigServiceInfo.
|
||||
The service enumerator will also handle the authentication flow automatically
|
||||
if HTTP basic auth or Redfish session login is configured to use.
|
||||
|
||||
Callers are responsible for freeing the returned service by RedfishCleanupService().
|
||||
|
||||
@param[in] RedfishConfigServiceInfo Redfish service information the EFI Redfish
|
||||
feature driver communicates with.
|
||||
|
||||
@return New created Redfish Service, or NULL if error happens.
|
||||
|
||||
**/
|
||||
REDFISH_SERVICE
|
||||
EFIAPI
|
||||
RedfishCreateService (
|
||||
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo
|
||||
)
|
||||
{
|
||||
REDFISH_SERVICE RedfishService;
|
||||
EDKII_REDFISH_AUTH_METHOD AuthMethod;
|
||||
CHAR8 *UserId;
|
||||
CHAR8 *Password;
|
||||
EFI_STATUS Status;
|
||||
|
||||
RedfishService = NULL;
|
||||
UserId = NULL;
|
||||
Password = NULL;
|
||||
|
||||
//
|
||||
// Check Input Parameters.
|
||||
//
|
||||
if (RedfishConfigServiceInfo == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
//
|
||||
// Get Authentication Configuration.
|
||||
//
|
||||
Status = RedfishGetAuthInfo (&AuthMethod, &UserId, &Password);
|
||||
if (EFI_ERROR (Status)) {
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// Create a redfish service node based on Redfish network host interface.
|
||||
//
|
||||
RedfishService = RedfishCreateLibredfishService (
|
||||
RedfishConfigServiceInfo,
|
||||
AuthMethod,
|
||||
UserId,
|
||||
Password
|
||||
);
|
||||
|
||||
ON_EXIT:
|
||||
if (UserId != NULL) {
|
||||
FreePool (UserId);
|
||||
}
|
||||
if (Password!= NULL) {
|
||||
FreePool (Password);
|
||||
}
|
||||
|
||||
return RedfishService;
|
||||
}
|
||||
|
||||
/**
|
||||
Free the Service and all its related resources.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
RedfishCleanupService (
|
||||
IN REDFISH_SERVICE RedfishService
|
||||
)
|
||||
{
|
||||
if (RedfishService == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
cleanupServiceEnumerator (RedfishService);
|
||||
}
|
||||
/**
|
||||
Create REDFISH_PAYLOAD instance in local with JSON represented resource value and
|
||||
the Redfish Service.
|
||||
|
||||
The returned REDFISH_PAYLOAD can be used to create or update Redfish resource in
|
||||
server side.
|
||||
|
||||
Callers are responsible for freeing the returned payload by RedfishCleanupPayload().
|
||||
|
||||
@param[in] Value JSON Value of the redfish resource.
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
|
||||
@return REDFISH_PAYLOAD instance of the resource, or NULL if error happens.
|
||||
|
||||
**/
|
||||
REDFISH_PAYLOAD
|
||||
EFIAPI
|
||||
RedfishCreatePayload (
|
||||
IN EDKII_JSON_VALUE Value,
|
||||
IN REDFISH_SERVICE RedfishService
|
||||
)
|
||||
{
|
||||
EDKII_JSON_VALUE CopyValue;
|
||||
|
||||
CopyValue = JsonValueClone (Value);
|
||||
return createRedfishPayload (CopyValue, RedfishService);
|
||||
}
|
||||
|
||||
/**
|
||||
Free the RedfishPayload and all its related resources.
|
||||
|
||||
@param[in] Payload Payload to be freed.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
RedfishCleanupPayload (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
)
|
||||
{
|
||||
if (Payload == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
cleanupPayload ((redfishPayload *) Payload);
|
||||
}
|
||||
|
||||
/**
|
||||
This function returns the decoded JSON value of a REDFISH_PAYLOAD.
|
||||
|
||||
Caller doesn't need to free the returned JSON value because it will be released
|
||||
in corresponding RedfishCleanupPayload() function.
|
||||
|
||||
@param[in] Payload A REDFISH_PAYLOAD instance.
|
||||
|
||||
@return Decoded JSON value of the payload.
|
||||
|
||||
**/
|
||||
EDKII_JSON_VALUE
|
||||
EFIAPI
|
||||
RedfishJsonInPayload (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
)
|
||||
{
|
||||
if (Payload == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return ((redfishPayload*)Payload)->json;
|
||||
}
|
||||
|
||||
/**
|
||||
Fill the input RedPath string with system UUID from SMBIOS table or use the customized
|
||||
ID if FromSmbios == FALSE.
|
||||
|
||||
This is a helper function to build a RedPath string which can be used to address
|
||||
a Redfish resource for this computer system. The input PathString must have a Systems
|
||||
note in format of "Systems[UUID=%g]" or "Systems[UUID~%g]" to fill the UUID value.
|
||||
|
||||
Example:
|
||||
Use "/v1/Systems[UUID=%g]/Bios" to build a RedPath to address the "Bios" resource
|
||||
for this computer system.
|
||||
|
||||
@param[in] RedPath RedPath format to be build.
|
||||
@param[in] FromSmbios Get system UUID from SMBIOS as computer system instance ID.
|
||||
@param[in] IdString The computer system instance ID.
|
||||
|
||||
@return Full RedPath with system UUID inside, or NULL if error happens.
|
||||
|
||||
**/
|
||||
CHAR8 *
|
||||
EFIAPI
|
||||
RedfishBuildPathWithSystemUuid (
|
||||
IN CONST CHAR8 *RedPath,
|
||||
IN BOOLEAN FromSmbios,
|
||||
IN CHAR8 *IdString OPTIONAL
|
||||
)
|
||||
{
|
||||
UINTN BufSize;
|
||||
CHAR8* RetRedPath;
|
||||
EFI_GUID SystemUuid;
|
||||
EFI_STATUS Status;
|
||||
|
||||
if (RedPath == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
//
|
||||
// Find system UUID from SMBIOS table.
|
||||
//
|
||||
if (FromSmbios) {
|
||||
Status = NetLibGetSystemGuid(&SystemUuid);
|
||||
if (EFI_ERROR (Status)) {
|
||||
return NULL;
|
||||
}
|
||||
// AsciiStrLen ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") = 36
|
||||
BufSize = AsciiStrSize (RedPath) + AsciiStrLen ("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
|
||||
} else {
|
||||
BufSize = AsciiStrSize (RedPath) + AsciiStrLen (IdString);
|
||||
}
|
||||
|
||||
RetRedPath = AllocateZeroPool (BufSize);
|
||||
if (RetRedPath == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
if (FromSmbios) {
|
||||
AsciiSPrint (RetRedPath, BufSize, RedPath, &SystemUuid);
|
||||
} else {
|
||||
AsciiSPrint (RetRedPath, BufSize, RedPath, IdString);
|
||||
}
|
||||
return RetRedPath;
|
||||
}
|
||||
/**
|
||||
Get a redfish response addressed by a RedPath string, including HTTP StatusCode, Headers
|
||||
and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
@param[in] RedPath RedPath string to address a resource, must start
|
||||
from the root node.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The corresponding redfish resource has
|
||||
been returned in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned Payload is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is NULL, indicates any error happen.
|
||||
3. If the returned StatusCode is not 2XX, indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishGetByService (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *RedPath,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
)
|
||||
{
|
||||
if (RedfishService == NULL || RedPath == NULL || RedResponse == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));
|
||||
|
||||
RedResponse->Payload = (REDFISH_PAYLOAD) getPayloadByPath (RedfishService, RedPath, &(RedResponse->StatusCode));
|
||||
|
||||
//
|
||||
// 1. If the returned Payload is NULL, indicates any error happen.
|
||||
// 2. If the returned StatusCode is NULL, indicates any error happen.
|
||||
//
|
||||
if (RedResponse->Payload == NULL || RedResponse->StatusCode == NULL) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
//
|
||||
// 3. If the returned StatusCode is not 2XX, indicates any error happen.
|
||||
// NOTE: If there is any error message returned from server, it will be returned in
|
||||
// Payload within RedResponse.
|
||||
//
|
||||
if (*(RedResponse->StatusCode) < HTTP_STATUS_200_OK || \
|
||||
*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
/**
|
||||
Get a redfish response addressed by URI, including HTTP StatusCode, Headers
|
||||
and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the URI resources.
|
||||
@param[in] Uri String to address a resource.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The corresponding redfish resource has
|
||||
been returned in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned Payload is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is NULL, indicates any error happen.
|
||||
3. If the returned StatusCode is not 2XX, indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishGetByUri (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *Uri,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
)
|
||||
{
|
||||
EDKII_JSON_VALUE JsonValue;
|
||||
|
||||
if (RedfishService == NULL || Uri == NULL || RedResponse == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));
|
||||
|
||||
JsonValue = getUriFromService (RedfishService, Uri, &RedResponse->StatusCode);
|
||||
RedResponse->Payload = createRedfishPayload(JsonValue, RedfishService);
|
||||
|
||||
//
|
||||
// 1. If the returned Payload is NULL, indicates any error happen.
|
||||
// 2. If the returned StatusCode is NULL, indicates any error happen.
|
||||
//
|
||||
if (RedResponse->Payload == NULL || RedResponse->StatusCode == NULL) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
//
|
||||
// 3. If the returned StatusCode is not 2XX, indicates any error happen.
|
||||
// NOTE: If there is any error message returned from server, it will be returned in
|
||||
// Payload within RedResponse.
|
||||
//
|
||||
if (*(RedResponse->StatusCode) < HTTP_STATUS_200_OK || \
|
||||
*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
/**
|
||||
Get a redfish response addressed by the input Payload and relative RedPath string,
|
||||
including HTTP StatusCode, Headers and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] Payload A existing REDFISH_PAYLOAD instance.
|
||||
@param[in] RedPath Relative RedPath string to address a resource inside Payload.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful:
|
||||
1. The HTTP StatusCode is NULL and the returned Payload in
|
||||
RedResponse is not NULL, indicates the Redfish resource has
|
||||
been parsed from the input payload directly.
|
||||
2. The HTTP StatusCode is not NULL and the value is 2XX,
|
||||
indicates the corresponding redfish resource has been returned
|
||||
in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER Payload, RedPath, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned Payload is NULL, indicates any error happen.
|
||||
2. If StatusCode is not NULL and the returned value of StatusCode
|
||||
is not 2XX, indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishGetByPayload (
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN CONST CHAR8 *RedPath,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
)
|
||||
{
|
||||
if (Payload == NULL || RedPath == NULL || RedResponse == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));
|
||||
|
||||
RedResponse->Payload = (REDFISH_PAYLOAD) getPayloadForPathString (Payload, RedPath, &(RedResponse->StatusCode));
|
||||
|
||||
//
|
||||
// 1. If the returned Payload is NULL, indicates any error happen.
|
||||
//
|
||||
if (RedResponse->Payload == NULL) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
//
|
||||
// 2. If StatusCode is not NULL and the returned value of StatusCode is not 2XX, indicates any
|
||||
// error happen.
|
||||
// NOTE: If there is any error message returned from server, it will be returned in
|
||||
// Payload within RedResponse.
|
||||
//
|
||||
if (RedResponse->StatusCode != NULL && \
|
||||
(*(RedResponse->StatusCode) < HTTP_STATUS_200_OK || \
|
||||
*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT
|
||||
)) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
/**
|
||||
Use HTTP PATCH to perform updates on pre-existing Redfish resource.
|
||||
|
||||
This function uses the RedfishService to patch a Redfish resource addressed by
|
||||
Uri (only the relative path is required). Changes to one or more properties within
|
||||
the target resource are represented in the input Content, properties not specified
|
||||
in Content won't be changed by this request. The corresponding redfish response will
|
||||
returned, including HTTP StatusCode, Headers and Payload which record any HTTP response
|
||||
messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
@param[in] Uri Relative path to address the resource.
|
||||
@param[in] Content JSON represented properties to be update.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The Redfish resource will be returned
|
||||
in Payload within RedResponse if server send it back in the HTTP
|
||||
response message body.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, Uri, Content, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishPatchToUri (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *Uri,
|
||||
IN CONST CHAR8 *Content,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
EDKII_JSON_VALUE JsonValue;
|
||||
|
||||
Status = EFI_SUCCESS;
|
||||
JsonValue = NULL;
|
||||
|
||||
if (RedfishService == NULL || Uri == NULL || Content == NULL || RedResponse == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));
|
||||
|
||||
JsonValue = (EDKII_JSON_VALUE) patchUriFromService (
|
||||
RedfishService,
|
||||
Uri,
|
||||
Content,
|
||||
&(RedResponse->StatusCode)
|
||||
);
|
||||
|
||||
//
|
||||
// 1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
//
|
||||
if (RedResponse->StatusCode == NULL) {
|
||||
Status = EFI_DEVICE_ERROR;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.
|
||||
// NOTE: If there is any error message returned from server, it will be returned in
|
||||
// Payload within RedResponse.
|
||||
//
|
||||
if (*(RedResponse->StatusCode) < HTTP_STATUS_200_OK || \
|
||||
*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT) {
|
||||
Status = EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
ON_EXIT:
|
||||
if (JsonValue != NULL) {
|
||||
RedResponse->Payload = createRedfishPayload (JsonValue, RedfishService);
|
||||
if (RedResponse->Payload == NULL) {
|
||||
//
|
||||
// Ignore the error when create RedfishPayload, just free the JsonValue since it's not what
|
||||
// we care about if the returned StatusCode is 2XX.
|
||||
//
|
||||
JsonValueFree (JsonValue);
|
||||
}
|
||||
}
|
||||
|
||||
return Status;
|
||||
}
|
||||
/**
|
||||
Use HTTP PATCH to perform updates on target payload. Patch to odata.id in Payload directly.
|
||||
|
||||
This function uses the Payload to patch the Target. Changes to one or more properties
|
||||
within the target resource are represented in the input Payload, properties not specified
|
||||
in Payload won't be changed by this request. The corresponding redfish response will
|
||||
returned, including HTTP StatusCode, Headers and Payload which record any HTTP response
|
||||
messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] Target The target payload to be updated.
|
||||
@param[in] Payload Palyoad with properties to be changed.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The Redfish resource will be returned
|
||||
in Payload within RedResponse if server send it back in the HTTP
|
||||
response message body.
|
||||
@retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishPatchToPayload (
|
||||
IN REDFISH_PAYLOAD Target,
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
)
|
||||
{
|
||||
if (Target == NULL || Payload == NULL || RedResponse == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));
|
||||
|
||||
RedResponse->Payload = (REDFISH_PAYLOAD) patchPayload (
|
||||
Target,
|
||||
Payload,
|
||||
&(RedResponse->StatusCode)
|
||||
);
|
||||
|
||||
//
|
||||
// 1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
//
|
||||
if (RedResponse->StatusCode == NULL) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
//
|
||||
// 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.
|
||||
// NOTE: If there is any error message returned from server, it will be returned in
|
||||
// Payload within RedResponse.
|
||||
//
|
||||
if (*(RedResponse->StatusCode) < HTTP_STATUS_200_OK || \
|
||||
*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
/**
|
||||
Use HTTP POST to create a new resource in target payload.
|
||||
|
||||
The POST request should be submitted to the Resource Collection in which the new resource
|
||||
is to belong. The Resource Collection is addressed by Target payload. The Redfish may
|
||||
ignore any service controlled properties. The corresponding redfish response will returned,
|
||||
including HTTP StatusCode, Headers and Payload which record any HTTP response messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] Target Target payload of the Resource Collection.
|
||||
@param[in] Payload The new resource to be created.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX. The Redfish resource will be returned
|
||||
in Payload within RedResponse if server send it back in the HTTP
|
||||
response message body.
|
||||
@retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishPostToPayload (
|
||||
IN REDFISH_PAYLOAD Target,
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
)
|
||||
{
|
||||
if (Target == NULL || Payload == NULL || RedResponse == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));
|
||||
|
||||
RedResponse->Payload = (REDFISH_PAYLOAD) postPayload (
|
||||
Target,
|
||||
Payload,
|
||||
&(RedResponse->StatusCode)
|
||||
);
|
||||
|
||||
//
|
||||
// 1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
//
|
||||
if (RedResponse->StatusCode == NULL) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
//
|
||||
// 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.
|
||||
// NOTE: If there is any error message returned from server, it will be returned in
|
||||
// Payload within RedResponse.
|
||||
//
|
||||
if (*(RedResponse->StatusCode) < HTTP_STATUS_200_OK || \
|
||||
*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
/**
|
||||
Use HTTP DELETE to remove a resource.
|
||||
|
||||
This function uses the RedfishService to remove a Redfish resource which is addressed
|
||||
by input Uri (only the relative path is required). The corresponding redfish response will
|
||||
returned, including HTTP StatusCode, Headers and Payload which record any HTTP response
|
||||
messages.
|
||||
|
||||
Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in
|
||||
redfish response data.
|
||||
|
||||
@param[in] RedfishService The Service to access the Redfish resources.
|
||||
@param[in] Uri Relative path to address the resource.
|
||||
@param[out] RedResponse Pointer to the Redfish response data.
|
||||
|
||||
@retval EFI_SUCCESS The opeartion is successful, indicates the HTTP StatusCode is not
|
||||
NULL and the value is 2XX, the Redfish resource has been removed.
|
||||
If there is any message returned from server, it will be returned
|
||||
in Payload within RedResponse.
|
||||
@retval EFI_INVALID_PARAMETER RedfishService, Uri, or RedResponse is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. Callers can get
|
||||
more error info from returned HTTP StatusCode, Headers and Payload
|
||||
within RedResponse:
|
||||
1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
2. If the returned StatusCode is not NULL and the value is not 2XX,
|
||||
indicates any error happen.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RedfishDeleteByUri (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CONST CHAR8 *Uri,
|
||||
OUT REDFISH_RESPONSE *RedResponse
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
EDKII_JSON_VALUE JsonValue;
|
||||
|
||||
Status = EFI_SUCCESS;
|
||||
JsonValue = NULL;
|
||||
|
||||
if (RedfishService == NULL || Uri == NULL || RedResponse == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));
|
||||
|
||||
JsonValue = (EDKII_JSON_VALUE) deleteUriFromService (
|
||||
RedfishService,
|
||||
Uri,
|
||||
&(RedResponse->StatusCode)
|
||||
);
|
||||
|
||||
//
|
||||
// 1. If the returned StatusCode is NULL, indicates any error happen.
|
||||
//
|
||||
if (RedResponse->StatusCode == NULL) {
|
||||
Status = EFI_DEVICE_ERROR;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.
|
||||
// NOTE: If there is any error message returned from server, it will be returned in
|
||||
// Payload within RedResponse.
|
||||
//
|
||||
if (*(RedResponse->StatusCode) < HTTP_STATUS_200_OK || \
|
||||
*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT) {
|
||||
Status = EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
ON_EXIT:
|
||||
if (JsonValue != NULL) {
|
||||
RedResponse->Payload = createRedfishPayload (JsonValue, RedfishService);
|
||||
if (RedResponse->Payload == NULL) {
|
||||
//
|
||||
// Ignore the error when create RedfishPayload, just free the JsonValue since it's not what
|
||||
// we care about if the returned StatusCode is 2XX.
|
||||
//
|
||||
JsonValueFree (JsonValue);
|
||||
}
|
||||
}
|
||||
|
||||
return Status;
|
||||
}
|
||||
/**
|
||||
Dump text in fractions.
|
||||
|
||||
@param[in] String ASCII string to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishDumpJsonStringFractions (
|
||||
IN CHAR8 *String
|
||||
)
|
||||
{
|
||||
CHAR8 *NextFraction;
|
||||
UINTN StringFractionSize;
|
||||
UINTN StrLen;
|
||||
UINTN Count;
|
||||
CHAR8 BackupChar;
|
||||
|
||||
StringFractionSize = 200;
|
||||
if (String == NULL) {
|
||||
return ;
|
||||
}
|
||||
|
||||
DEBUG((DEBUG_INFO, "JSON text:\n"));
|
||||
NextFraction = String;
|
||||
StrLen = AsciiStrLen (String);
|
||||
if (StrLen == 0) {
|
||||
return;
|
||||
}
|
||||
for (Count = 0; Count < (StrLen / StringFractionSize); Count++) {
|
||||
BackupChar = *(NextFraction + StringFractionSize);
|
||||
*(NextFraction + StringFractionSize) = 0;
|
||||
DEBUG((DEBUG_INFO, "%a", NextFraction));
|
||||
*(NextFraction + StringFractionSize) = BackupChar;
|
||||
NextFraction += StringFractionSize;
|
||||
}
|
||||
if ((StrLen % StringFractionSize) != 0) {
|
||||
DEBUG((DEBUG_INFO, "%a\n\n", NextFraction));
|
||||
}
|
||||
}
|
||||
/**
|
||||
Dump text in JSON value.
|
||||
|
||||
@param[in] JsonValue The Redfish JSON value to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishDumpJson (
|
||||
IN EDKII_JSON_VALUE JsonValue
|
||||
)
|
||||
{
|
||||
CHAR8 *String;
|
||||
|
||||
String = JsonDumpString (JsonValue, 0);
|
||||
if (String == NULL) {
|
||||
return;
|
||||
}
|
||||
RedfishDumpJsonStringFractions (String);
|
||||
FreePool(String);
|
||||
}
|
||||
/**
|
||||
Extract the JSON text content from REDFISH_PAYLOAD and dump to debug console.
|
||||
|
||||
@param[in] Payload The Redfish payload to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishDumpPayload (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
)
|
||||
{
|
||||
EDKII_JSON_VALUE JsonValue;
|
||||
CHAR8 *String;
|
||||
|
||||
JsonValue = NULL;
|
||||
String = NULL;
|
||||
|
||||
if (Payload == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
JsonValue = RedfishJsonInPayload (Payload);
|
||||
if (JsonValue == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
String = JsonDumpString (JsonValue, 0);
|
||||
if (String == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
RedfishDumpJsonStringFractions (String);
|
||||
FreePool(String);
|
||||
}
|
||||
/**
|
||||
This function will cleanup the HTTP header and Redfish payload resources.
|
||||
|
||||
@param[in] StatusCode The status code in HTTP response message.
|
||||
@param[in] HeaderCount Number of HTTP header structures in Headers list.
|
||||
@param[in] Headers Array containing list of HTTP headers.
|
||||
@param[in] Payload The Redfish payload to dump.
|
||||
|
||||
**/
|
||||
VOID
|
||||
RedfishFreeResponse (
|
||||
IN EFI_HTTP_STATUS_CODE *StatusCode,
|
||||
IN UINTN HeaderCount,
|
||||
IN EFI_HTTP_HEADER *Headers,
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
)
|
||||
{
|
||||
if (StatusCode != NULL) {
|
||||
FreePool (StatusCode);
|
||||
StatusCode = NULL;
|
||||
}
|
||||
|
||||
if (HeaderCount != 0 && Headers != NULL) {
|
||||
HttpFreeHeaderFields(Headers, HeaderCount);
|
||||
Headers = NULL;
|
||||
}
|
||||
|
||||
if (Payload != NULL) {
|
||||
RedfishCleanupPayload (Payload);
|
||||
Payload = NULL;
|
||||
}
|
||||
}
|
||||
/**
|
||||
Check if the "@odata.type" in Payload is valid or not.
|
||||
|
||||
@param[in] Payload The Redfish payload to be checked.
|
||||
@param[in] OdataTypeName OdataType will be retrived from mapping list.
|
||||
@param[in] OdataTypeMappingList The list of OdataType.
|
||||
@param[in] OdataTypeMappingListSize The number of mapping list
|
||||
|
||||
@return TRUE if the "@odata.type" in Payload is valid, otherwise FALSE.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
RedfishIsValidOdataType (
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN CONST CHAR8 *OdataTypeName,
|
||||
IN REDFISH_ODATA_TYPE_MAPPING *OdataTypeMappingList,
|
||||
IN UINTN OdataTypeMappingListSize
|
||||
)
|
||||
{
|
||||
UINTN Index;
|
||||
EDKII_JSON_VALUE OdataType;
|
||||
EDKII_JSON_VALUE JsonValue;
|
||||
|
||||
if (Payload == NULL || OdataTypeName == NULL) {
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
JsonValue = RedfishJsonInPayload (Payload);
|
||||
if (!JsonValueIsObject (JsonValue)) {
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
OdataType = JsonObjectGetValue (JsonValueGetObject (JsonValue), "@odata.type");
|
||||
if (!JsonValueIsString (OdataType) || JsonValueGetAsciiString (OdataType) == NULL) {
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
for (Index = 0; Index < OdataTypeMappingListSize; Index ++) {
|
||||
if (AsciiStrCmp (OdataTypeMappingList[Index].OdataTypeName, OdataTypeName) == 0 &&
|
||||
AsciiStrCmp (OdataTypeMappingList[Index].OdataType, JsonValueGetAsciiString (OdataType)) == 0) {
|
||||
return TRUE;
|
||||
}
|
||||
}
|
||||
DEBUG ((DEBUG_INFO, "%a: This Odata type is not in the list.\n", __FUNCTION__));
|
||||
return FALSE;
|
||||
}
|
||||
/**
|
||||
Check if the payload is collection
|
||||
|
||||
@param[in] Payload The Redfish payload to be checked.
|
||||
|
||||
@return TRUE if the payload is collection.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
RedfishIsPayloadCollection (
|
||||
IN REDFISH_PAYLOAD Payload
|
||||
)
|
||||
{
|
||||
return isPayloadCollection (Payload);
|
||||
}
|
||||
/**
|
||||
Get collection size.
|
||||
|
||||
@param[in] Payload The Redfish collection payload
|
||||
@param[in] CollectionSize Size of this collection
|
||||
|
||||
@return EFI_SUCCESS Coolection size is returned in CollectionSize
|
||||
@return EFI_INVALID_PARAMETER The payload is not a collection.
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishGetCollectionSize(
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN UINTN *CollectionSize
|
||||
)
|
||||
{
|
||||
if (Payload == NULL || CollectionSize == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
if (!RedfishIsPayloadCollection(Payload)) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
*CollectionSize = (UINTN)getCollectionSize(Payload);
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
/**
|
||||
Get Redfish payload of collection member
|
||||
|
||||
@param[in] Payload The Redfish collection payload
|
||||
@param[in] Index Index of collection member
|
||||
|
||||
@return NULL Fail to get collection member.
|
||||
@return Non NULL Payload is returned.
|
||||
**/
|
||||
REDFISH_PAYLOAD
|
||||
RedfishGetPayloadByIndex (
|
||||
IN REDFISH_PAYLOAD Payload,
|
||||
IN UINTN Index
|
||||
)
|
||||
{
|
||||
REDFISH_RESPONSE RedfishResponse;
|
||||
REDFISH_PAYLOAD PayloadReturn;
|
||||
|
||||
PayloadReturn = (VOID *)getPayloadByIndex (Payload, Index, &RedfishResponse.StatusCode);
|
||||
if(PayloadReturn == NULL ||
|
||||
(*(RedfishResponse.StatusCode) < HTTP_STATUS_200_OK && *(RedfishResponse.StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT)){
|
||||
return NULL;
|
||||
}
|
||||
return PayloadReturn;
|
||||
}
|
||||
/**
|
||||
Check and return Redfish resource of the given Redpath.
|
||||
|
||||
@param[in] RedfishService Pointer to REDFISH_SERVICE
|
||||
@param[in] Redpath Redpath of the resource.
|
||||
@param[in] Response Optional return the resource.
|
||||
|
||||
@return EFI_STATUS
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishCheckIfRedpathExist (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
IN CHAR8 *Redpath,
|
||||
IN REDFISH_RESPONSE *Response OPTIONAL
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
REDFISH_RESPONSE TempResponse;
|
||||
|
||||
if (Redpath == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
Status = RedfishGetByService (RedfishService, Redpath, &TempResponse);
|
||||
if (EFI_ERROR (Status)) {
|
||||
return Status;
|
||||
}
|
||||
if (Response == NULL) {
|
||||
RedfishFreeResponse(
|
||||
TempResponse.StatusCode,
|
||||
TempResponse.HeaderCount,
|
||||
TempResponse.Headers,
|
||||
TempResponse.Payload
|
||||
);
|
||||
} else {
|
||||
CopyMem ((VOID *)Response, (VOID *)&TempResponse, sizeof (REDFISH_RESPONSE));
|
||||
}
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
## @file
|
||||
# RedfishLib Library implementation.
|
||||
#
|
||||
# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
#
|
||||
# SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
#
|
||||
##
|
||||
|
||||
[Defines]
|
||||
INF_VERSION = 0x0001001b
|
||||
BASE_NAME = DxeRedfishLib
|
||||
FILE_GUID = 9C2CA9CF-4F79-11E8-A7D1-8CDCD426C973
|
||||
MODULE_TYPE = DXE_DRIVER
|
||||
VERSION_STRING = 1.0
|
||||
LIBRARY_CLASS = RedfishLib| DXE_DRIVER UEFI_APPLICATION UEFI_DRIVER
|
||||
|
||||
#
|
||||
# VALID_ARCHITECTURES = IA32 X64 ARM AARCH64 RISCV64
|
||||
#
|
||||
|
||||
[Sources]
|
||||
edk2libredfish/src/redpath.c
|
||||
edk2libredfish/src/service.c
|
||||
edk2libredfish/src/payload.c
|
||||
edk2libredfish/include/redfish.h
|
||||
edk2libredfish/include/redfishPayload.h
|
||||
edk2libredfish/include/redfishService.h
|
||||
edk2libredfish/include/redpath.h
|
||||
RedfishLib.c
|
||||
RedfishMisc.h
|
||||
RedfishMisc.c
|
||||
|
||||
[Packages]
|
||||
MdePkg/MdePkg.dec
|
||||
MdeModulePkg/MdeModulePkg.dec
|
||||
NetworkPkg/NetworkPkg.dec
|
||||
RedfishPkg/RedfishPkg.dec
|
||||
|
||||
[LibraryClasses]
|
||||
BaseLib
|
||||
BaseMemoryLib
|
||||
DebugLib
|
||||
HttpLib
|
||||
MemoryAllocationLib
|
||||
NetLib
|
||||
RedfishContentCodingLib
|
||||
RedfishCrtLib
|
||||
UefiBootServicesTableLib
|
||||
UefiLib
|
||||
|
||||
[Protocols]
|
||||
gEfiRestExServiceBindingProtocolGuid ## Consumed
|
||||
gEfiRestExProtocolGuid ## Consumed
|
||||
gEdkIIRedfishCredentialProtocolGuid ## Consumed
|
||||
|
||||
[BuildOptions]
|
||||
MSFT:*_*_*_CC_FLAGS = /U_WIN32 /UWIN64 /U_MSC_VER
|
||||
GCC:*_*_*_CC_FLAGS = -Wno-unused-function -Wno-unused-but-set-variable
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
/** @file
|
||||
Internal Functions for RedfishLib.
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
|
||||
#include "RedfishMisc.h"
|
||||
|
||||
EDKII_REDFISH_CREDENTIAL_PROTOCOL *mCredentialProtocol = NULL;
|
||||
|
||||
/**
|
||||
This function returns the string of Redfish service version.
|
||||
|
||||
@param[in] RedfishService Redfish service instance.
|
||||
@param[out] ServiceVersionStr Redfish service string.
|
||||
|
||||
@return EFI_STATUS
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishGetServiceVersion (
|
||||
IN REDFISH_SERVICE RedfishService,
|
||||
OUT CHAR8 **ServiceVersionStr
|
||||
)
|
||||
{
|
||||
redfishService *Redfish;
|
||||
CHAR8 **KeysArray;
|
||||
UINTN KeysNum;
|
||||
|
||||
if (RedfishService == NULL || ServiceVersionStr == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
Redfish = (redfishService *)RedfishService;
|
||||
if (Redfish->versions == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
KeysArray = JsonObjectGetKeys (Redfish->versions, &KeysNum);
|
||||
if (KeysNum == 0 || KeysArray == NULL) {
|
||||
return EFI_NOT_FOUND;
|
||||
}
|
||||
*ServiceVersionStr = *KeysArray;
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
Creates a REDFISH_SERVICE which can be later used to access the Redfish resources.
|
||||
|
||||
This function will configure REST EX child according to parameters described in
|
||||
Redfish network host interface in SMBIOS type 42 record. The service enumerator will also
|
||||
handle the authentication flow automatically if HTTP basic auth or Redfish session
|
||||
login is configured to use.
|
||||
|
||||
@param[in] RedfishConfigServiceInfo Redfish service information the EFI Redfish
|
||||
feature driver communicates with.
|
||||
@param[in] AuthMethod None, HTTP basic auth, or Redfish session login.
|
||||
@param[in] UserId User Name used for authentication.
|
||||
@param[in] Password Password used for authentication.
|
||||
|
||||
@return New created Redfish service, or NULL if error happens.
|
||||
|
||||
**/
|
||||
REDFISH_SERVICE
|
||||
RedfishCreateLibredfishService (
|
||||
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo,
|
||||
IN EDKII_REDFISH_AUTH_METHOD AuthMethod,
|
||||
IN CHAR8 *UserId,
|
||||
IN CHAR8 *Password
|
||||
)
|
||||
{
|
||||
|
||||
UINTN Flags;
|
||||
enumeratorAuthentication Auth;
|
||||
redfishService* Redfish;
|
||||
|
||||
Redfish = NULL;
|
||||
|
||||
ZeroMem (&Auth, sizeof (Auth));
|
||||
if (AuthMethod == AuthMethodHttpBasic) {
|
||||
Auth.authType = REDFISH_AUTH_BASIC;
|
||||
} else if (AuthMethod == AuthMethodRedfishSession) {
|
||||
Auth.authType = REDFISH_AUTH_SESSION;
|
||||
}
|
||||
Auth.authCodes.userPass.username = UserId;
|
||||
Auth.authCodes.userPass.password = Password;
|
||||
|
||||
Flags = REDFISH_FLAG_SERVICE_NO_VERSION_DOC;
|
||||
|
||||
if (AuthMethod != AuthMethodNone) {
|
||||
Redfish = createServiceEnumerator(RedfishConfigServiceInfo, NULL, &Auth, (unsigned int ) Flags);
|
||||
} else {
|
||||
Redfish = createServiceEnumerator(RedfishConfigServiceInfo, NULL, NULL, (unsigned int) Flags);
|
||||
}
|
||||
|
||||
//
|
||||
// Zero the Password after use.
|
||||
//
|
||||
if (Password != NULL) {
|
||||
ZeroMem (Password, AsciiStrLen(Password));
|
||||
}
|
||||
|
||||
return (REDFISH_SERVICE) Redfish;
|
||||
}
|
||||
|
||||
/**
|
||||
Retrieve platform's Redfish authentication information.
|
||||
|
||||
This functions returns the Redfish authentication method together with the user
|
||||
Id and password.
|
||||
For AuthMethodNone, UserId and Password will point to NULL which means authentication
|
||||
is not required to access the Redfish service.
|
||||
For AuthMethodHttpBasic, the UserId and Password could be used for
|
||||
HTTP header authentication as defined by RFC7235. For AuthMethodRedfishSession,
|
||||
the UserId and Password could be used for Redfish session login as defined by
|
||||
Redfish API specification (DSP0266).
|
||||
|
||||
Callers are responsible for freeing the returned string storage pointed by UserId
|
||||
and Password.
|
||||
|
||||
@param[out] AuthMethod Type of Redfish authentication method.
|
||||
@param[out] UserId The pointer to store the returned UserId string.
|
||||
@param[out] Password The pointer to store the returned Password string.
|
||||
|
||||
@retval EFI_SUCCESS Get the authentication information successfully.
|
||||
@retval EFI_INVALID_PARAMETER AuthMethod or UserId or Password is NULL.
|
||||
@retval EFI_UNSUPPORTED Unsupported authentication method is found.
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishGetAuthInfo (
|
||||
OUT EDKII_REDFISH_AUTH_METHOD *AuthMethod,
|
||||
OUT CHAR8 **UserId,
|
||||
OUT CHAR8 **Password
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
||||
if (AuthMethod == NULL || UserId == NULL || Password == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
//
|
||||
// Locate Redfish Credential Protocol.
|
||||
//
|
||||
if (mCredentialProtocol == NULL) {
|
||||
Status = gBS->LocateProtocol (&gEdkIIRedfishCredentialProtocolGuid, NULL, (VOID **)&mCredentialProtocol);
|
||||
if (EFI_ERROR (Status)) {
|
||||
return EFI_UNSUPPORTED;
|
||||
}
|
||||
}
|
||||
|
||||
ASSERT (mCredentialProtocol != NULL);
|
||||
|
||||
Status = mCredentialProtocol->GetAuthInfo (mCredentialProtocol, AuthMethod, UserId, Password);
|
||||
if (EFI_ERROR (Status)) {
|
||||
DEBUG ((DEBUG_ERROR, "RedfishGetAuthInfo: failed to retrieve Redfish credential - %r\n", Status));
|
||||
return Status;
|
||||
}
|
||||
|
||||
return Status;
|
||||
}
|
||||
/**
|
||||
This function returns the string of Redfish service version.
|
||||
|
||||
@param[in] ServiceVerisonStr The string of Redfish service version.
|
||||
@param[in] Url The URL to build Redpath with ID.
|
||||
Start with "/", for example "/Registries"
|
||||
@param[in] Id ID string
|
||||
@param[out] Redpath Pointer to retrive Redpath, caller has to free
|
||||
the memory allocated for this string.
|
||||
@return EFI_STATUS
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishBuildRedpathUseId (
|
||||
IN CHAR8 *ServiceVerisonStr,
|
||||
IN CHAR8 *Url,
|
||||
IN CHAR8 *Id,
|
||||
OUT CHAR8 **Redpath
|
||||
)
|
||||
{
|
||||
UINTN RedpathSize;
|
||||
|
||||
if (Redpath == NULL || ServiceVerisonStr == NULL || Url == NULL || Id == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
RedpathSize = AsciiStrLen ("/") +
|
||||
AsciiStrLen (ServiceVerisonStr) +
|
||||
AsciiStrLen (Url) +
|
||||
AsciiStrLen ("[Id=]") +
|
||||
AsciiStrLen (Id) + 1;
|
||||
*Redpath = AllocatePool(RedpathSize);
|
||||
if (*Redpath == NULL) {
|
||||
return EFI_OUT_OF_RESOURCES;
|
||||
}
|
||||
AsciiSPrint (*Redpath, RedpathSize, "/%a%a[Id=%a]", ServiceVerisonStr, Url, Id);
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
/** @file
|
||||
Internal Functions for RedfishLib.
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
|
||||
#ifndef DXE_REDFISH_MISC_LIB_H_
|
||||
#define DXE_REDFISH_MISC_LIB_H_
|
||||
|
||||
#include <Library/BaseLib.h>
|
||||
#include <Library/BaseMemoryLib.h>
|
||||
#include <Library/DebugLib.h>
|
||||
#include <Library/JsonLib.h>
|
||||
#include <Library/MemoryAllocationLib.h>
|
||||
#include <Library/PrintLib.h>
|
||||
#include <Library/RedfishLib.h>
|
||||
#include <Library/UefiLib.h>
|
||||
#include <Protocol/EdkIIRedfishCredential.h>
|
||||
#include <redfish.h>
|
||||
|
||||
#define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))
|
||||
|
||||
/**
|
||||
Creates a REDFISH_SERVICE which can be later used to access the Redfish resources.
|
||||
|
||||
This function will configure REST EX child according to parameters described in
|
||||
Redfish network host interface in SMBIOS type 42 record. The service enumerator will also
|
||||
handle the authentication flow automatically if HTTP basic auth or Redfish session
|
||||
login is configured to use.
|
||||
|
||||
@param[in] RedfishConfigServiceInfo Redfish service information the EFI Redfish
|
||||
feature driver communicates with.
|
||||
@param[in] AuthMethod None, HTTP basic auth, or Redfish session login.
|
||||
@param[in] UserId User Name used for authentication.
|
||||
@param[in] Password Password used for authentication.
|
||||
|
||||
@return New created Redfish service, or NULL if error happens.
|
||||
|
||||
**/
|
||||
REDFISH_SERVICE
|
||||
RedfishCreateLibredfishService (
|
||||
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo,
|
||||
IN EDKII_REDFISH_AUTH_METHOD AuthMethod,
|
||||
IN CHAR8 *UserId,
|
||||
IN CHAR8 *Password
|
||||
);
|
||||
|
||||
/**
|
||||
Retrieve platform's Redfish authentication information.
|
||||
|
||||
This functions returns the Redfish authentication method together with the user
|
||||
Id and password.
|
||||
For AuthMethodNone, UserId and Password will point to NULL which means authentication
|
||||
is not required to access the Redfish service.
|
||||
For AuthMethodHttpBasic, the UserId and Password could be used for
|
||||
HTTP header authentication as defined by RFC7235. For AuthMethodRedfishSession,
|
||||
the UserId and Password could be used for Redfish session login as defined by
|
||||
Redfish API specification (DSP0266).
|
||||
|
||||
Callers are responsible for freeing the returned string storage pointed by UserId
|
||||
and Password.
|
||||
|
||||
@param[out] AuthMethod Type of Redfish authentication method.
|
||||
@param[out] UserId The pointer to store the returned UserId string.
|
||||
@param[out] Password The pointer to store the returned Password string.
|
||||
|
||||
@retval EFI_SUCCESS Get the authentication information successfully.
|
||||
@retval EFI_INVALID_PARAMETER AuthMethod or UserId or Password is NULL.
|
||||
@retval EFI_UNSUPPORTED Unsupported authentication method is found.
|
||||
**/
|
||||
EFI_STATUS
|
||||
RedfishGetAuthInfo (
|
||||
OUT EDKII_REDFISH_AUTH_METHOD *AuthMethod,
|
||||
OUT CHAR8 **UserId,
|
||||
OUT CHAR8 **Password
|
||||
);
|
||||
|
||||
#endif
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
/** @file
|
||||
This file is cloned from DMTF libredfish library tag v1.0.0 and maintained
|
||||
by EDKII.
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Copyright Notice:
|
||||
// Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
|
||||
// License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md
|
||||
//----------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
#ifndef LIBREDFISH_REDFISH_H_
|
||||
#define LIBREDFISH_REDFISH_H_
|
||||
|
||||
#include <redfishService.h>
|
||||
#include <redfishPayload.h>
|
||||
#include <redpath.h>
|
||||
|
||||
#endif
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
/** @file
|
||||
This file is cloned from DMTF libredfish library tag v1.0.0 and maintained
|
||||
by EDKII.
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Copyright Notice:
|
||||
// Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
|
||||
// License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md
|
||||
//----------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
#ifndef LIBREDFISH_REDFISH_PAYLOAD_H_
|
||||
#define LIBREDFISH_REDFISH_PAYLOAD_H_
|
||||
|
||||
#include <PrivateInclude/Library/RedfishCrtLib.h>
|
||||
|
||||
#include <jansson.h>
|
||||
#include <redfishService.h>
|
||||
#include <redpath.h>
|
||||
|
||||
redfishPayload* createRedfishPayload(json_t* value, redfishService* service);
|
||||
redfishPayload* getPayloadByNodeName(redfishPayload* payload, const char* nodeName, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* getPayloadByIndex(redfishPayload* payload, size_t index, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* getPayloadForPath(redfishPayload* payload, redPathNode* redpath, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* getPayloadForPathString(redfishPayload* payload, const char* string, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* patchPayload(redfishPayload* target, redfishPayload* payload, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* postContentToPayload(redfishPayload* target, const char* data, size_t dataSize, const char* contentType, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* postPayload(redfishPayload* target, redfishPayload* payload, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
void cleanupPayload(redfishPayload* payload);
|
||||
bool isPayloadCollection (redfishPayload *Payload);
|
||||
size_t getCollectionSize(redfishPayload* payload);
|
||||
redfishPayload* getPayloadByIndex (redfishPayload* payload, size_t index, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
|
||||
#endif
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
/** @file
|
||||
This file is cloned from DMTF libredfish library tag v1.0.0 and maintained
|
||||
by EDKII.
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Copyright Notice:
|
||||
// Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
|
||||
// License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md
|
||||
//----------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
|
||||
#ifndef LIBREDFISH_REDFISH_SERVICE_H_
|
||||
#define LIBREDFISH_REDFISH_SERVICE_H_
|
||||
|
||||
#include <IndustryStandard/Http11.h>
|
||||
|
||||
#include <Library/BaseLib.h>
|
||||
#include <Library/BaseMemoryLib.h>
|
||||
#include <Library/DebugLib.h>
|
||||
#include <Library/HttpLib.h>
|
||||
#include <Library/MemoryAllocationLib.h>
|
||||
#include <Library/NetLib.h>
|
||||
#include <Library/RedfishContentCodingLib.h>
|
||||
#include <Library/UefiRuntimeServicesTableLib.h>
|
||||
#include <Library/UefiBootServicesTableLib.h>
|
||||
|
||||
#include <PrivateInclude/Library/RedfishCrtLib.h>
|
||||
|
||||
#include <Protocol/EdkIIRedfishConfigHandler.h>
|
||||
#include <Protocol/RestEx.h>
|
||||
|
||||
#include <jansson.h>
|
||||
|
||||
typedef struct {
|
||||
char* host;
|
||||
json_t* versions;
|
||||
unsigned int flags;
|
||||
char* sessionToken;
|
||||
char* basicAuthStr;
|
||||
//
|
||||
// point to the <HOST> part in above "host" field, which will be put into
|
||||
// the "Host" header of HTTP request message.
|
||||
//
|
||||
char* HostHeaderValue;
|
||||
EFI_REST_EX_PROTOCOL *RestEx;
|
||||
} redfishService;
|
||||
|
||||
typedef struct {
|
||||
json_t* json;
|
||||
redfishService* service;
|
||||
} redfishPayload;
|
||||
|
||||
#define REDFISH_AUTH_BASIC 0
|
||||
#define REDFISH_AUTH_BEARER_TOKEN 1
|
||||
#define REDFISH_AUTH_SESSION 2
|
||||
|
||||
#define REDFISH_HTTP_RESPONSE_TIMEOUT 5000 /// 5 seconds in uints of millisecond.
|
||||
|
||||
///
|
||||
/// Library class public defines
|
||||
///
|
||||
#define HTTP_FLAG L"http://"
|
||||
#define HTTPS_FLAG L"https://"
|
||||
|
||||
///
|
||||
/// The redfish first URL should be "/redfish/v1/", while we use "/redfish/v1" here without "/"
|
||||
/// in the end is to avoid the 301 Perment redirect response from Redfish profile simulator.
|
||||
///
|
||||
#define REDFISH_FIRST_URL L"/redfish/v1"
|
||||
|
||||
typedef struct {
|
||||
unsigned int authType;
|
||||
union {
|
||||
struct {
|
||||
char* username;
|
||||
char* password;
|
||||
} userPass;
|
||||
struct {
|
||||
char* token;
|
||||
} authToken;
|
||||
} authCodes;
|
||||
} enumeratorAuthentication;
|
||||
|
||||
//Values for flags
|
||||
#define REDFISH_FLAG_SERVICE_NO_VERSION_DOC 0x00000001 //The Redfish Service lacks the version document (in violation of the Redfish spec)
|
||||
redfishService* createServiceEnumerator(REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo, const char* rootUri, enumeratorAuthentication* auth, unsigned int flags);
|
||||
json_t* getUriFromService(redfishService* service, const char* uri, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
json_t* patchUriFromService(redfishService* service, const char* uri, const char* content, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
json_t* postUriFromService(redfishService* service, const char* uri, const char* content, size_t contentLength, const char* contentType, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
json_t* deleteUriFromService(redfishService* service, const char* uri, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* getRedfishServiceRoot(redfishService* service, const char* version, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
redfishPayload* getPayloadByPath(redfishService* service, const char* path, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
void cleanupServiceEnumerator(redfishService* service);
|
||||
|
||||
#endif
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
/** @file
|
||||
This file is cloned from DMTF libredfish library tag v1.0.0 and maintained
|
||||
by EDKII.
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Copyright Notice:
|
||||
// Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
|
||||
// License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md
|
||||
//----------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
#ifndef LIBREDFISH_REDPATH_H_
|
||||
#define LIBREDFISH_REDPATH_H_
|
||||
|
||||
#include <PrivateInclude/Library/RedfishCrtLib.h>
|
||||
|
||||
#include <jansson.h>
|
||||
|
||||
typedef struct _redPathNode
|
||||
{
|
||||
bool isRoot;
|
||||
bool isIndex;
|
||||
|
||||
char* version;
|
||||
char* nodeName;
|
||||
size_t index;
|
||||
char* op;
|
||||
char* propName;
|
||||
char* value;
|
||||
|
||||
struct _redPathNode* next;
|
||||
} redPathNode;
|
||||
|
||||
redPathNode* parseRedPath(const char* path);
|
||||
void cleanupRedPath(redPathNode* node);
|
||||
|
||||
#endif
|
||||
|
|
@ -0,0 +1,732 @@
|
|||
/** @file
|
||||
This file is cloned from DMTF libredfish library tag v1.0.0 and maintained
|
||||
by EDKII.
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Copyright Notice:
|
||||
// Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
|
||||
// License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md
|
||||
//----------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
#include <redfishPayload.h>
|
||||
|
||||
static redfishPayload* getOpResult(redfishPayload* payload, const char* propName, const char* op, const char* value, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
static redfishPayload* collectionEvalOp(redfishPayload* payload, const char* propName, const char* op, const char* value, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
static redfishPayload* arrayEvalOp(redfishPayload* payload, const char* propName, const char* op, const char* value, EFI_HTTP_STATUS_CODE** StatusCode);
|
||||
static redfishPayload* createCollection(redfishService* service, size_t count, redfishPayload** payloads);
|
||||
static json_t* json_object_get_by_index(json_t* json, size_t index);
|
||||
|
||||
bool isPayloadCollection(redfishPayload* payload)
|
||||
{
|
||||
json_t* members;
|
||||
json_t* count;
|
||||
|
||||
if(!payload || !json_is_object(payload->json))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
members = json_object_get(payload->json, "Members");
|
||||
count = json_object_get(payload->json, "Members@odata.count");
|
||||
return ((members != NULL) && (count != NULL));
|
||||
}
|
||||
|
||||
size_t getCollectionSize(redfishPayload* payload)
|
||||
{
|
||||
json_t* members;
|
||||
json_t* count;
|
||||
|
||||
if(!payload || !json_is_object(payload->json))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
members = json_object_get(payload->json, "Members");
|
||||
count = json_object_get(payload->json, "Members@odata.count");
|
||||
if(!members || !count)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
return (size_t)json_integer_value(count);
|
||||
}
|
||||
|
||||
bool isPayloadArray(redfishPayload* payload)
|
||||
{
|
||||
if(!payload || !json_is_array(payload->json))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
char* payloadToString(redfishPayload* payload, bool prettyPrint)
|
||||
{
|
||||
size_t flags = 0;
|
||||
if(!payload)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
if(prettyPrint)
|
||||
{
|
||||
flags = JSON_INDENT(2);
|
||||
}
|
||||
return json_dumps(payload->json, flags);
|
||||
}
|
||||
|
||||
redfishPayload* createRedfishPayload(json_t* value, redfishService* service)
|
||||
{
|
||||
redfishPayload* payload;
|
||||
payload = (redfishPayload*)malloc(sizeof(redfishPayload));
|
||||
if(payload != NULL)
|
||||
{
|
||||
payload->json = value;
|
||||
payload->service = service;
|
||||
}
|
||||
return payload;
|
||||
}
|
||||
|
||||
redfishPayload* getPayloadByNodeName(redfishPayload* payload, const char* nodeName, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
json_t* value;
|
||||
json_t* odataId;
|
||||
const char* uri;
|
||||
|
||||
if(!payload || !nodeName || StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
*StatusCode = NULL;
|
||||
|
||||
value = json_object_get(payload->json, nodeName);
|
||||
if(value == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
json_incref(value);
|
||||
if(json_object_size(value) == 1)
|
||||
{
|
||||
odataId = json_object_get(value, "@odata.id");
|
||||
if(odataId != NULL)
|
||||
{
|
||||
json_incref(odataId);
|
||||
uri = json_string_value(odataId);
|
||||
json_decref(value);
|
||||
value = getUriFromService(payload->service, uri, StatusCode);
|
||||
json_decref(odataId);
|
||||
if(value == NULL || *StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (*StatusCode == NULL || (**StatusCode >= HTTP_STATUS_200_OK && **StatusCode <= HTTP_STATUS_206_PARTIAL_CONTENT)) {
|
||||
if(json_is_string(value))
|
||||
{
|
||||
odataId = json_object();
|
||||
json_object_set(odataId, nodeName, value);
|
||||
json_decref(value);
|
||||
value = odataId;
|
||||
}
|
||||
}
|
||||
|
||||
return createRedfishPayload(value, payload->service);
|
||||
}
|
||||
|
||||
redfishPayload* getPayloadByIndex(redfishPayload* payload, size_t index, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
json_t* value = NULL;
|
||||
json_t* odataId;
|
||||
const char* uri;
|
||||
BOOLEAN FromServerFlag = FALSE;
|
||||
|
||||
if(!payload || StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
*StatusCode = NULL;
|
||||
|
||||
if(isPayloadCollection(payload))
|
||||
{
|
||||
redfishPayload* members = getPayloadByNodeName(payload, "Members", StatusCode);
|
||||
if ((*StatusCode == NULL && members == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
return members;
|
||||
}
|
||||
|
||||
if (*StatusCode != NULL) {
|
||||
//
|
||||
// The Payload (members) are retrived from server.
|
||||
//
|
||||
FreePool (*StatusCode);
|
||||
*StatusCode = NULL;
|
||||
FromServerFlag = TRUE;
|
||||
}
|
||||
|
||||
redfishPayload* ret = getPayloadByIndex(members, index, StatusCode);
|
||||
if (*StatusCode == NULL && ret != NULL && FromServerFlag) {
|
||||
//
|
||||
// In such a case, the Redfish resource is parsed from the input payload (members) directly.
|
||||
// Since the members are retrived from server, we still return HTTP_STATUS_200_OK.
|
||||
//
|
||||
*StatusCode = AllocateZeroPool (sizeof (EFI_HTTP_STATUS_CODE));
|
||||
if (*StatusCode == NULL) {
|
||||
ret = NULL;
|
||||
} else {
|
||||
**StatusCode = HTTP_STATUS_200_OK;
|
||||
}
|
||||
}
|
||||
|
||||
cleanupPayload(members);
|
||||
return ret;
|
||||
}
|
||||
|
||||
if(json_is_array(payload->json))
|
||||
{
|
||||
//
|
||||
// The valid range for index is from 0 to the return value of json_array_size() minus 1
|
||||
//
|
||||
value = json_array_get(payload->json, index);
|
||||
}
|
||||
else if(json_is_object(payload->json))
|
||||
{
|
||||
value = json_object_get_by_index(payload->json, index);
|
||||
}
|
||||
|
||||
if(value == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
json_incref(value);
|
||||
if(json_object_size(value) == 1)
|
||||
{
|
||||
odataId = json_object_get(value, "@odata.id");
|
||||
if(odataId != NULL)
|
||||
{
|
||||
uri = json_string_value(odataId);
|
||||
json_decref(value);
|
||||
value = getUriFromService(payload->service, uri, StatusCode);
|
||||
if(value == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
return createRedfishPayload(value, payload->service);
|
||||
}
|
||||
|
||||
redfishPayload* getPayloadForPath(redfishPayload* payload, redPathNode* redpath, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
redfishPayload* ret = NULL;
|
||||
redfishPayload* tmp;
|
||||
|
||||
if(!payload || !redpath || StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
*StatusCode = NULL;
|
||||
BOOLEAN FromServerFlag = FALSE;
|
||||
|
||||
if(redpath->nodeName)
|
||||
{
|
||||
ret = getPayloadByNodeName(payload, redpath->nodeName, StatusCode);
|
||||
if ((*StatusCode == NULL && ret == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
//
|
||||
// Any error happen, return directly.
|
||||
//
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
else if(redpath->isIndex)
|
||||
{
|
||||
ASSERT (redpath->index >= 1);
|
||||
ret = getPayloadByIndex(payload, redpath->index - 1, StatusCode);
|
||||
if ((*StatusCode == NULL && ret == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
//
|
||||
// Any error happen, return directly.
|
||||
//
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
else if(redpath->op)
|
||||
{
|
||||
ret = getOpResult(payload, redpath->propName, redpath->op, redpath->value, StatusCode);
|
||||
if ((*StatusCode == NULL && ret == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
//
|
||||
// Any error happen, return directly.
|
||||
//
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if(redpath->next == NULL || ret == NULL)
|
||||
{
|
||||
return ret;
|
||||
}
|
||||
else
|
||||
{
|
||||
if (*StatusCode != NULL) {
|
||||
FreePool (*StatusCode);
|
||||
*StatusCode = NULL;
|
||||
FromServerFlag = TRUE;
|
||||
}
|
||||
|
||||
tmp = getPayloadForPath(ret, redpath->next, StatusCode);
|
||||
if (*StatusCode == NULL && tmp != NULL && FromServerFlag) {
|
||||
//
|
||||
// In such a case, the Redfish resource is parsed from the input payload (ret) directly.
|
||||
// Since the ret are retrived from server, we still return HTTP_STATUS_200_OK.
|
||||
//
|
||||
*StatusCode = AllocateZeroPool (sizeof (EFI_HTTP_STATUS_CODE));
|
||||
if (*StatusCode == NULL) {
|
||||
tmp = NULL;
|
||||
} else {
|
||||
**StatusCode = HTTP_STATUS_200_OK;
|
||||
}
|
||||
}
|
||||
|
||||
cleanupPayload(ret);
|
||||
return tmp;
|
||||
}
|
||||
}
|
||||
|
||||
redfishPayload* getPayloadForPathString(redfishPayload* payload, const char* string, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
redPathNode* redpath;
|
||||
redfishPayload* ret;
|
||||
|
||||
if(!string || StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
*StatusCode = NULL;
|
||||
|
||||
redpath = parseRedPath(string);
|
||||
if(redpath == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
ret = getPayloadForPath(payload, redpath, StatusCode);
|
||||
cleanupRedPath(redpath);
|
||||
return ret;
|
||||
}
|
||||
|
||||
redfishPayload* patchPayload(redfishPayload* target, redfishPayload* payload, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
json_t* json;
|
||||
char* content;
|
||||
char* uri;
|
||||
|
||||
if(!target || !payload || StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
*StatusCode = NULL;
|
||||
|
||||
json = json_object_get(target->json, "@odata.id");
|
||||
if(json == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
uri = strdup(json_string_value(json));
|
||||
|
||||
content = json_dumps(payload->json, 0);
|
||||
json_decref(json);
|
||||
|
||||
json = patchUriFromService(target->service, uri, content, StatusCode);
|
||||
free(uri);
|
||||
free(content);
|
||||
if(json == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return createRedfishPayload(json, target->service);
|
||||
}
|
||||
|
||||
redfishPayload* postContentToPayload(redfishPayload* target, const char* data, size_t dataSize, const char* contentType, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
json_t* json;
|
||||
char* uri;
|
||||
|
||||
if(!target || !data || StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
*StatusCode = NULL;
|
||||
|
||||
json = json_object_get(target->json, "@odata.id");
|
||||
if(json == NULL)
|
||||
{
|
||||
json = json_object_get(target->json, "target");
|
||||
if(json == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
uri = strdup(json_string_value(json));
|
||||
json = postUriFromService(target->service, uri, data, dataSize, contentType, StatusCode);
|
||||
free(uri);
|
||||
if(json == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return createRedfishPayload(json, target->service);
|
||||
}
|
||||
|
||||
redfishPayload* postPayload(redfishPayload* target, redfishPayload* payload, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
char* content;
|
||||
redfishPayload* ret;
|
||||
|
||||
if(!target || !payload || StatusCode == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
*StatusCode = NULL;
|
||||
|
||||
if(!json_is_object(payload->json))
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
content = payloadToString(payload, false);
|
||||
ret = postContentToPayload(target, content, strlen(content), NULL, StatusCode);
|
||||
free(content);
|
||||
return ret;
|
||||
}
|
||||
|
||||
void cleanupPayload(redfishPayload* payload)
|
||||
{
|
||||
if(!payload)
|
||||
{
|
||||
return;
|
||||
}
|
||||
json_decref(payload->json);
|
||||
//Don't free payload->service, let the caller handle cleaning up the service
|
||||
free(payload);
|
||||
}
|
||||
|
||||
static redfishPayload* getOpResult(redfishPayload* payload, const char* propName, const char* op, const char* value, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
const char* propStr;
|
||||
json_t* stringProp;
|
||||
bool ret = false;
|
||||
redfishPayload* prop;
|
||||
long long intVal, intPropVal;
|
||||
json_type jsonType;
|
||||
|
||||
if(isPayloadCollection(payload))
|
||||
{
|
||||
return collectionEvalOp(payload, propName, op, value, StatusCode);
|
||||
}
|
||||
if(isPayloadArray(payload))
|
||||
{
|
||||
return arrayEvalOp(payload, propName, op, value, StatusCode);
|
||||
}
|
||||
|
||||
prop = getPayloadByNodeName(payload, propName, StatusCode);
|
||||
if ((*StatusCode == NULL && prop == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
return prop;
|
||||
}
|
||||
stringProp = prop->json;
|
||||
jsonType = prop->json->type;
|
||||
switch(jsonType)
|
||||
{
|
||||
case JSON_OBJECT:
|
||||
stringProp = json_object_get(prop->json, propName);
|
||||
case JSON_STRING:
|
||||
if(strcmp(op, "=") == 0)
|
||||
{
|
||||
propStr = json_string_value(stringProp);
|
||||
if(propStr == NULL)
|
||||
{
|
||||
cleanupPayload(prop);
|
||||
return NULL;
|
||||
}
|
||||
ret = (strcmp(propStr, value) == 0);
|
||||
} else if(strcmp(op, "~") == 0)
|
||||
{
|
||||
propStr = json_string_value(stringProp);
|
||||
if(propStr == NULL)
|
||||
{
|
||||
cleanupPayload(prop);
|
||||
return NULL;
|
||||
}
|
||||
ret = (strcasecmp(propStr, value) == 0);
|
||||
}
|
||||
break;
|
||||
case JSON_TRUE:
|
||||
if(strcmp(op, "=") == 0)
|
||||
{
|
||||
ret = (strcmp(value, "true") == 0);
|
||||
}
|
||||
break;
|
||||
case JSON_FALSE:
|
||||
if(strcmp(op, "=") == 0)
|
||||
{
|
||||
ret = (strcmp(value, "false") == 0);
|
||||
}
|
||||
break;
|
||||
case JSON_INTEGER:
|
||||
intPropVal = json_integer_value(prop->json);
|
||||
intVal = strtoll(value, NULL, 0);
|
||||
if(strcmp(op, "=") == 0)
|
||||
{
|
||||
ret = (intPropVal == intVal);
|
||||
}
|
||||
else if(strcmp(op, "<") == 0)
|
||||
{
|
||||
ret = (intPropVal < intVal);
|
||||
}
|
||||
else if(strcmp(op, ">") == 0)
|
||||
{
|
||||
ret = (intPropVal > intVal);
|
||||
}
|
||||
else if(strcmp(op, "<=") == 0)
|
||||
{
|
||||
ret = (intPropVal <= intVal);
|
||||
}
|
||||
else if(strcmp(op, ">=") == 0)
|
||||
{
|
||||
ret = (intPropVal >= intVal);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
cleanupPayload(prop);
|
||||
if(ret)
|
||||
{
|
||||
return payload;
|
||||
}
|
||||
else
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
|
||||
static redfishPayload* collectionEvalOp(redfishPayload* payload, const char* propName, const char* op, const char* value, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
redfishPayload* ret;
|
||||
redfishPayload* tmp;
|
||||
redfishPayload* members;
|
||||
redfishPayload** valid;
|
||||
size_t validMax;
|
||||
size_t validCount = 0;
|
||||
size_t i;
|
||||
|
||||
validMax = getCollectionSize(payload);
|
||||
if(validMax == 0)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
valid = (redfishPayload**)calloc(validMax, sizeof(redfishPayload*));
|
||||
if(valid == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
/*Technically getPayloadByIndex would do this, but this optimizes things*/
|
||||
members = getPayloadByNodeName(payload, "Members", StatusCode);
|
||||
if ((*StatusCode == NULL && members == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
return members;
|
||||
}
|
||||
|
||||
for(i = 0; i < validMax; i++)
|
||||
{
|
||||
if (*StatusCode != NULL) {
|
||||
FreePool (*StatusCode);
|
||||
*StatusCode = NULL;
|
||||
}
|
||||
|
||||
tmp = getPayloadByIndex(members, i, StatusCode);
|
||||
if ((*StatusCode == NULL && tmp == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
return tmp;
|
||||
}
|
||||
|
||||
if (*StatusCode != NULL) {
|
||||
FreePool (*StatusCode);
|
||||
*StatusCode = NULL;
|
||||
}
|
||||
|
||||
valid[validCount] = getOpResult(tmp, propName, op, value, StatusCode);
|
||||
/*
|
||||
if ((*StatusCode == NULL && valid[validCount] == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
return valid[validCount];
|
||||
}
|
||||
*/
|
||||
if(valid[validCount] != NULL)
|
||||
{
|
||||
validCount++;
|
||||
}
|
||||
else
|
||||
{
|
||||
cleanupPayload(tmp);
|
||||
}
|
||||
}
|
||||
cleanupPayload(members);
|
||||
if(validCount == 0)
|
||||
{
|
||||
free(valid);
|
||||
return NULL;
|
||||
}
|
||||
if(validCount == 1)
|
||||
{
|
||||
ret = valid[0];
|
||||
free(valid);
|
||||
return ret;
|
||||
}
|
||||
else
|
||||
{
|
||||
ret = createCollection(payload->service, validCount, valid);
|
||||
free(valid);
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
|
||||
static redfishPayload* arrayEvalOp(redfishPayload* payload, const char* propName, const char* op, const char* value, EFI_HTTP_STATUS_CODE** StatusCode)
|
||||
{
|
||||
redfishPayload* ret;
|
||||
redfishPayload* tmp;
|
||||
redfishPayload** valid;
|
||||
size_t validMax;
|
||||
size_t validCount = 0;
|
||||
size_t i;
|
||||
|
||||
validMax = json_array_size(payload->json);
|
||||
if(validMax == 0)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
valid = (redfishPayload**)calloc(validMax, sizeof(redfishPayload*));
|
||||
if(valid == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
for(i = 0; i < validMax; i++)
|
||||
{
|
||||
if (*StatusCode != NULL) {
|
||||
FreePool (*StatusCode);
|
||||
*StatusCode = NULL;
|
||||
}
|
||||
|
||||
tmp = getPayloadByIndex(payload, i, StatusCode);
|
||||
if ((*StatusCode == NULL && tmp == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
return tmp;
|
||||
}
|
||||
|
||||
if (*StatusCode != NULL) {
|
||||
FreePool (*StatusCode);
|
||||
*StatusCode = NULL;
|
||||
}
|
||||
|
||||
valid[validCount] = getOpResult(tmp, propName, op, value, StatusCode);
|
||||
/*
|
||||
if ((*StatusCode == NULL && valid[validCount] == NULL) ||
|
||||
(*StatusCode != NULL && (**StatusCode < HTTP_STATUS_200_OK || **StatusCode > HTTP_STATUS_206_PARTIAL_CONTENT))) {
|
||||
return valid[validCount];
|
||||
}
|
||||
*/
|
||||
|
||||
if(valid[validCount] != NULL)
|
||||
{
|
||||
validCount++;
|
||||
}
|
||||
else
|
||||
{
|
||||
cleanupPayload(tmp);
|
||||
}
|
||||
}
|
||||
if(validCount == 0)
|
||||
{
|
||||
free(valid);
|
||||
return NULL;
|
||||
}
|
||||
if(validCount == 1)
|
||||
{
|
||||
ret = valid[0];
|
||||
free(valid);
|
||||
return ret;
|
||||
}
|
||||
else
|
||||
{
|
||||
ret = createCollection(payload->service, validCount, valid);
|
||||
free(valid);
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
|
||||
static redfishPayload* createCollection(redfishService* service, size_t count, redfishPayload** payloads)
|
||||
{
|
||||
redfishPayload* ret;
|
||||
json_t* collectionJson = json_object();
|
||||
json_t* jcount = json_integer((json_int_t)count);
|
||||
json_t* members = json_array();
|
||||
size_t i;
|
||||
|
||||
if(!collectionJson)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
if(!members)
|
||||
{
|
||||
json_decref(collectionJson);
|
||||
return NULL;
|
||||
}
|
||||
json_object_set(collectionJson, "Members@odata.count", jcount);
|
||||
json_decref(jcount);
|
||||
for(i = 0; i < count; i++)
|
||||
{
|
||||
json_array_append(members, payloads[i]->json);
|
||||
cleanupPayload(payloads[i]);
|
||||
}
|
||||
json_object_set(collectionJson, "Members", members);
|
||||
json_decref(members);
|
||||
|
||||
ret = createRedfishPayload(collectionJson, service);
|
||||
return ret;
|
||||
}
|
||||
|
||||
static json_t* json_object_get_by_index(json_t* json, size_t index)
|
||||
{
|
||||
void* iter;
|
||||
size_t i;
|
||||
|
||||
iter = json_object_iter(json);
|
||||
for(i = 0; i < index; i++)
|
||||
{
|
||||
iter = json_object_iter_next(json, iter);
|
||||
if(iter == NULL) break;
|
||||
}
|
||||
if(iter == NULL)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
return json_object_iter_value(iter);
|
||||
}
|
||||
/* vim: set tabstop=4 shiftwidth=4 expandtab: */
|
||||
|
|
@ -0,0 +1,192 @@
|
|||
/** @file
|
||||
This file is cloned from DMTF libredfish library tag v1.0.0 and maintained
|
||||
by EDKII.
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Copyright Notice:
|
||||
// Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
|
||||
// License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md
|
||||
//----------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
||||
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
|
||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
|
||||
**/
|
||||
#include <redpath.h>
|
||||
|
||||
static char* getVersion(const char* path, char** end);
|
||||
static void parseNode(const char* path, redPathNode* node, redPathNode** end);
|
||||
|
||||
static char* getStringTill(const char* string, const char* terminator, char** retEnd);
|
||||
|
||||
redPathNode* parseRedPath(const char* path)
|
||||
{
|
||||
redPathNode* node;
|
||||
redPathNode* endNode;
|
||||
char* curPath;
|
||||
char* end;
|
||||
|
||||
if(!path || strlen(path) == 0)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
node = (redPathNode*)calloc(1, sizeof(redPathNode));
|
||||
if(!node)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
if(path[0] == '/')
|
||||
{
|
||||
node->isRoot = true;
|
||||
if(path[1] == 'v')
|
||||
{
|
||||
node->version = getVersion(path+1, &curPath);
|
||||
if(curPath == NULL)
|
||||
{
|
||||
return node;
|
||||
}
|
||||
if(curPath[0] == '/')
|
||||
{
|
||||
curPath++;
|
||||
}
|
||||
node->next = parseRedPath(curPath);
|
||||
}
|
||||
else
|
||||
{
|
||||
node->next = parseRedPath(path+1);
|
||||
}
|
||||
return node;
|
||||
}
|
||||
node->isRoot = false;
|
||||
curPath = getStringTill(path, "/", &end);
|
||||
endNode = node;
|
||||
parseNode(curPath, node, &endNode);
|
||||
free(curPath);
|
||||
if(end != NULL)
|
||||
{
|
||||
endNode->next = parseRedPath(end+1);
|
||||
}
|
||||
return node;
|
||||
}
|
||||
|
||||
void cleanupRedPath(redPathNode* node)
|
||||
{
|
||||
if(!node)
|
||||
{
|
||||
return;
|
||||
}
|
||||
cleanupRedPath(node->next);
|
||||
node->next = NULL;
|
||||
if(node->version)
|
||||
{
|
||||
free(node->version);
|
||||
}
|
||||
if(node->nodeName)
|
||||
{
|
||||
free(node->nodeName);
|
||||
}
|
||||
if(node->op)
|
||||
{
|
||||
free(node->op);
|
||||
}
|
||||
if(node->propName)
|
||||
{
|
||||
free(node->propName);
|
||||
}
|
||||
if(node->value)
|
||||
{
|
||||
free(node->value);
|
||||
}
|
||||
free(node);
|
||||
}
|
||||
|
||||
static char* getVersion(const char* path, char** end)
|
||||
{
|
||||
return getStringTill(path, "/", end);
|
||||
}
|
||||
|
||||
static void parseNode(const char* path, redPathNode* node, redPathNode** end)
|
||||
{
|
||||
char* indexStart;
|
||||
char* index;
|
||||
char* indexEnd;
|
||||
char* nodeName = getStringTill(path, "[", &indexStart);
|
||||
size_t tmpIndex;
|
||||
char* opChars;
|
||||
|
||||
node->nodeName = nodeName;
|
||||
if(indexStart == NULL)
|
||||
{
|
||||
*end = node;
|
||||
return;
|
||||
}
|
||||
node->next = (redPathNode*)calloc(1, sizeof(redPathNode));
|
||||
if(!node->next)
|
||||
{
|
||||
return;
|
||||
}
|
||||
//Skip past [
|
||||
indexStart++;
|
||||
*end = node->next;
|
||||
index = getStringTill(indexStart, "]", NULL);
|
||||
tmpIndex = (size_t)strtoull(index, &indexEnd, 0);
|
||||
if(indexEnd != index)
|
||||
{
|
||||
free(index);
|
||||
node->next->index = tmpIndex;
|
||||
node->next->isIndex = true;
|
||||
return;
|
||||
}
|
||||
opChars = strpbrk(index, "<>=~");
|
||||
if(opChars == NULL)
|
||||
{
|
||||
//TODO handle last() and position()
|
||||
node->next->op = strdup("exists");
|
||||
node->next->propName = index;
|
||||
return;
|
||||
}
|
||||
node->next->propName = (char*)malloc((opChars - index)+1);
|
||||
memcpy(node->next->propName, index, (opChars - index));
|
||||
node->next->propName[(opChars - index)] = 0;
|
||||
|
||||
tmpIndex = 1;
|
||||
while(1)
|
||||
{
|
||||
if(opChars[tmpIndex] == '=' || opChars[tmpIndex] == '<' || opChars[tmpIndex] == '>' || opChars[tmpIndex] == '~')
|
||||
{
|
||||
tmpIndex++;
|
||||
continue;
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
node->next->op = (char*)malloc(tmpIndex+1);
|
||||
memcpy(node->next->op, opChars, tmpIndex);
|
||||
node->next->op[tmpIndex] = 0;
|
||||
|
||||
node->next->value = strdup(opChars+tmpIndex);
|
||||
free(index);
|
||||
}
|
||||
|
||||
static char* getStringTill(const char* string, const char* terminator, char** retEnd)
|
||||
{
|
||||
char* ret;
|
||||
char* end;
|
||||
end = strstr((char*)string, terminator);
|
||||
if(retEnd)
|
||||
{
|
||||
*retEnd = end;
|
||||
}
|
||||
if(end == NULL)
|
||||
{
|
||||
//No terminator
|
||||
return strdup(string);
|
||||
}
|
||||
ret = (char*)malloc((end-string)+1);
|
||||
memcpy(ret, string, (end-string));
|
||||
ret[(end-string)] = 0;
|
||||
return ret;
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -5,7 +5,7 @@
|
|||
# by using "!include RedfishPkg/RedfisLibs.dsc.inc" to specify the library instances
|
||||
# of EDKII network library classes.
|
||||
#
|
||||
# (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
|
||||
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
#
|
||||
# SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
#
|
||||
|
|
@ -16,5 +16,6 @@
|
|||
BaseSortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
|
||||
RedfishCrtLib|RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf
|
||||
JsonLib|RedfishPkg/Library/JsonLib/JsonLib.inf
|
||||
RedfishLib|RedfishPkg/PrivateLibrary/RedfishLib/RedfishLib.inf
|
||||
!endif
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
## @file
|
||||
# CI configuration for NetworkPkg
|
||||
#
|
||||
# (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
|
||||
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
||||
# SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
##
|
||||
{
|
||||
|
|
@ -41,7 +41,18 @@
|
|||
## load.c is overrided from open source.
|
||||
"Library/JsonLib/load.c",
|
||||
"Library/JsonLib/jansson_config.h",
|
||||
"Library/JsonLib/jansson_private_config.h"
|
||||
"Library/JsonLib/jansson_private_config.h",
|
||||
##
|
||||
## For libredfish open source
|
||||
## The files under edk2libredfish are cloned
|
||||
## from DMTF open source
|
||||
"PrivateLibrary/RedfishLib/edk2libredfish/include/redfish.h",
|
||||
"PrivateLibrary/RedfishLib/edk2libredfish/include/redfishPayload.h",
|
||||
"PrivateLibrary/RedfishLib/edk2libredfish/include/redfishService.h",
|
||||
"PrivateLibrary/RedfishLib/edk2libredfish/include/redpath.h",
|
||||
"PrivateLibrary/RedfishLib/edk2libredfish/src/payload.c",
|
||||
"PrivateLibrary/RedfishLib/edk2libredfish/src/redpath.c",
|
||||
"PrivateLibrary/RedfishLib/edk2libredfish/src/service.c"
|
||||
]
|
||||
},
|
||||
"CompilerPlugin": {
|
||||
|
|
|
|||
|
|
@ -62,6 +62,10 @@
|
|||
# project).
|
||||
RedfishCrtLib|PrivateInclude/Library/RedfishCrtLib.h
|
||||
|
||||
## @libraryclass Redfish Helper Library
|
||||
# Library provides Redfish helper functions.
|
||||
RedfishLib|PrivateInclude/Library/RedfishLib.h
|
||||
|
||||
[Protocols]
|
||||
## Include/Protocol/RedfishDiscover.h
|
||||
gEfiRedfishDiscoverProtocolGuid = { 0x5db12509, 0x4550, 0x4347, { 0x96, 0xb3, 0x73, 0xc0, 0xff, 0x6e, 0x86, 0x9f }}
|
||||
|
|
|
|||
|
|
@ -55,5 +55,6 @@
|
|||
RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf
|
||||
RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf
|
||||
RedfishPkg/Library/JsonLib/JsonLib.inf
|
||||
RedfishPkg/PrivateLibrary/RedfishLib/RedfishLib.inf
|
||||
|
||||
!include RedfishPkg/Redfish.dsc.inc
|
||||
|
|
|
|||
Loading…
Reference in New Issue