RedfishPkg/RefishCrtLib: Public RefishCrtLib

[mirror_edk2.git] / RedfishPkg / PrivateLibrary / RedfishLib / edk2libredfish / include / redfishService.h

/** @file\r
  This file is cloned from DMTF libredfish library tag v1.0.0 and maintained\r
  by EDKII.\r
\r
//----------------------------------------------------------------------------\r
// Copyright Notice:\r
// Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.\r
// License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md\r
//----------------------------------------------------------------------------\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef LIBREDFISH_REDFISH_SERVICE_H_\r
#define LIBREDFISH_REDFISH_SERVICE_H_\r
\r
#include <IndustryStandard/Http11.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/HttpLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/NetLib.h>\r
#include <Library/RedfishContentCodingLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include <Include/Library/RedfishCrtLib.h>\r
\r
#include <Protocol/EdkIIRedfishConfigHandler.h>\r
#include <Protocol/RestEx.h>\r
\r
#include <jansson.h>\r
\r
typedef struct {\r
    char* host;\r
    json_t* versions;\r
    unsigned int flags;\r
    char* sessionToken;\r
    char* basicAuthStr;\r
    //\r
    // point to the <HOST> part in above "host" field, which will be put into\r
    // the "Host" header of HTTP request message.\r
    //\r
    char* HostHeaderValue;\r
    EFI_REST_EX_PROTOCOL *RestEx;\r
} redfishService;\r
\r
typedef struct {\r
    json_t* json;\r
    redfishService* service;\r
} redfishPayload;\r
\r
#define REDFISH_AUTH_BASIC        0\r
#define REDFISH_AUTH_BEARER_TOKEN 1\r
#define REDFISH_AUTH_SESSION      2\r
\r
#define REDFISH_HTTP_RESPONSE_TIMEOUT   5000      /// 5 seconds in uints of millisecond.\r
\r
///\r
/// Library class public defines\r
///\r
#define HTTP_FLAG                  L"http://"\r
#define HTTPS_FLAG                 L"https://"\r
\r
///\r
/// The redfish first URL should be "/redfish/v1/", while we use "/redfish/v1" here without "/"\r
/// in the end is to avoid the 301 Perment redirect response from Redfish profile simulator.\r
///\r
#define REDFISH_FIRST_URL          L"/redfish/v1"\r
\r
typedef struct {\r
        unsigned int authType;\r
        union {\r
            struct {\r
                char* username;\r
                char* password;\r
            } userPass;\r
            struct {\r
                char* token;\r
            } authToken;\r
        } authCodes;\r
} enumeratorAuthentication;\r
\r
//Values for flags\r
#define REDFISH_FLAG_SERVICE_NO_VERSION_DOC 0x00000001 //The Redfish Service lacks the version document (in violation of the Redfish spec)\r
redfishService* createServiceEnumerator(REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo, const char* rootUri, enumeratorAuthentication* auth, unsigned int flags);\r
json_t* getUriFromService(redfishService* service, const char* uri, EFI_HTTP_STATUS_CODE** StatusCode);\r
json_t* patchUriFromService(redfishService* service, const char* uri, const char* content, EFI_HTTP_STATUS_CODE** StatusCode);\r
json_t* postUriFromService(redfishService* service, const char* uri, const char* content, size_t contentLength, const char* contentType, EFI_HTTP_STATUS_CODE** StatusCode);\r
json_t* deleteUriFromService(redfishService* service, const char* uri, EFI_HTTP_STATUS_CODE** StatusCode);\r
redfishPayload* getRedfishServiceRoot(redfishService* service, const char* version, EFI_HTTP_STATUS_CODE** StatusCode);\r
redfishPayload* getPayloadByPath(redfishService* service, const char* path, EFI_HTTP_STATUS_CODE** StatusCode);\r
void cleanupServiceEnumerator(redfishService* service);\r
\r
#endif\r