RedfishMisc.h File Reference

#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>

Go to the source code of this file.

Macros
#define	ARRAY_SIZE(Array)   (sizeof (Array) / sizeof ((Array)[0]))

Functions
REDFISH_SERVICE	RedfishCreateLibredfishService (IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo, IN EDKII_REDFISH_AUTH_METHOD AuthMethod, IN CHAR8 *UserId, IN CHAR8 *Password)
EFI_STATUS	RedfishGetAuthInfo (OUT EDKII_REDFISH_AUTH_METHOD *AuthMethod, OUT CHAR8 **UserId, OUT CHAR8 **Password)

Detailed Description

Internal Functions for RedfishLib.

Copyright (c) 2019, Intel Corporation. All rights reserved.
(C) Copyright 2021 Hewlett Packard Enterprise Development LP

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RedfishMisc.h.

Macro Definition Documentation

ARRAY_SIZE

#define ARRAY_SIZE

(

Array

)

(sizeof (Array) / sizeof ((Array)[0]))

Definition at line 25 of file RedfishMisc.h.

Function Documentation

RedfishCreateLibredfishService()

REDFISH_SERVICE RedfishCreateLibredfishService	(	IN REDFISH_CONFIG_SERVICE_INFORMATION *	RedfishConfigServiceInfo,
		IN EDKII_REDFISH_AUTH_METHOD	AuthMethod,
		IN CHAR8 *	UserId,
		IN CHAR8 *	Password
	)

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.

Parameters

[in]	RedfishConfigServiceInfo	Redfish service information the EFI Redfish feature driver communicates with.
[in]	AuthMethod	None, HTTP basic auth, or Redfish session login.
[in]	UserId	User Name used for authentication.
[in]	Password	Password used for authentication.

Returns

New created Redfish service, or NULL if error happens.

Definition at line 71 of file RedfishMisc.c.

RedfishGetAuthInfo()

EFI_STATUS RedfishGetAuthInfo	(	OUT EDKII_REDFISH_AUTH_METHOD *	AuthMethod,
		OUT CHAR8 **	UserId,
		OUT 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.

Parameters

[out]	AuthMethod	Type of Redfish authentication method.
[out]	UserId	The pointer to store the returned UserId string.
[out]	Password	The pointer to store the returned Password string.

Return values

EFI_SUCCESS	Get the authentication information successfully.
EFI_INVALID_PARAMETER	AuthMethod or UserId or Password is NULL.
EFI_UNSUPPORTED	Unsupported authentication method is found.

Definition at line 136 of file RedfishMisc.c.