From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail05.groups.io (mail05.groups.io [45.79.224.7]) by spool.mail.gandi.net (Postfix) with ESMTPS id 630E378003C for ; Tue, 14 May 2024 12:40:26 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=tiXMv0lafzRZEEiFw7xibVt54bJI7Ob+qamiHbN5UcU=; c=relaxed/simple; d=groups.io; h=From:To:CC:Subject:Thread-Topic:Thread-Index:Date:Message-ID:References:In-Reply-To:Accept-Language:msip_labels:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Resent-Date:Resent-From:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Language:Content-Type:Content-Transfer-Encoding; s=20240206; t=1715690424; v=1; b=H+GoZEL6OG5+HCTGEZV3nA1dLk06zNa9xbPGSlDOhv7nn+9ktYYYS2naVNnuAsH1eTaofOI4 aGjL08HhFxAKuHNBWIRDX/07wv7o1e6bcagKk0hZCcLzM8VeqJ85r8Iy3cJi4ucxuJJGzz5lY4Y xxrKUJMkVnoXEtHS1/n0cApN0iM+bhAIL6hk0HeGK0Ur/FcwCChq7peu87hnRLZ0iSOMWSK3wEn AuqWmWcQFuCrrHRABTCDBshFchwkLdJLfqsKu9Xqb5OdKnVk+Zlf7Vz2i6iNWMFPIjVjYUDzzex yEKQ4lDWRHfJWVNp6188pzDdirZNLF1O92v6TsSJZMdKA== X-Received: by 127.0.0.2 with SMTP id yKhAYY7687511xKp43tSKeQr; Tue, 14 May 2024 05:40:24 -0700 X-Received: from NAM12-BN8-obe.outbound.protection.outlook.com (NAM12-BN8-obe.outbound.protection.outlook.com [40.107.237.80]) by mx.groups.io with SMTP id smtpd.web11.14299.1715690423630090670 for ; Tue, 14 May 2024 05:40:24 -0700 X-Received: from PH8PR12MB7025.namprd12.prod.outlook.com (2603:10b6:510:1bc::22) by CY8PR12MB7290.namprd12.prod.outlook.com (2603:10b6:930:55::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7544.55; Tue, 14 May 2024 12:40:18 +0000 X-Received: from PH8PR12MB7025.namprd12.prod.outlook.com ([fe80::cd43:b9f3:7c11:6a48]) by PH8PR12MB7025.namprd12.prod.outlook.com ([fe80::cd43:b9f3:7c11:6a48%5]) with mapi id 15.20.7544.052; Tue, 14 May 2024 12:40:17 +0000 From: "Nickle Wang via groups.io" To: "devel@edk2.groups.io" , "abner.chang@amd.com" , Igor Kulchytskyy CC: Nick Ramirez Subject: Re: [edk2-devel] [edk2-redfish-client][PATCH] RedfishClientPkg: introduce RedfishBootstrapAccountDxe Thread-Topic: [edk2-devel] [edk2-redfish-client][PATCH] RedfishClientPkg: introduce RedfishBootstrapAccountDxe Thread-Index: AQHalVHC+eOwnTG3tUCDH2WLi/Js3bGWzJvQ Date: Tue, 14 May 2024 12:40:17 +0000 Message-ID: References: <20240418122730.18204-1-nicklew@nvidia.com> In-Reply-To: Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: msip_labels: MSIP_Label_4342314e-0df4-4b58-84bf-38bed6170a0f_ActionId=02042108-8add-4e61-9fed-ea197e2b5c86;MSIP_Label_4342314e-0df4-4b58-84bf-38bed6170a0f_ContentBits=0;MSIP_Label_4342314e-0df4-4b58-84bf-38bed6170a0f_Enabled=true;MSIP_Label_4342314e-0df4-4b58-84bf-38bed6170a0f_Method=Standard;MSIP_Label_4342314e-0df4-4b58-84bf-38bed6170a0f_Name=General;MSIP_Label_4342314e-0df4-4b58-84bf-38bed6170a0f_SetDate=2024-04-22T02:10:33Z;MSIP_Label_4342314e-0df4-4b58-84bf-38bed6170a0f_SiteId=3dd8961f-e488-4e60-8e11-a82d994e183d; x-ms-publictraffictype: Email x-ms-traffictypediagnostic: PH8PR12MB7025:EE_|CY8PR12MB7290:EE_ x-ms-office365-filtering-correlation-id: c19cb2d9-3e15-4a20-d280-08dc741302a7 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam-message-info: =?us-ascii?Q?b6XPWqdczl4/cTw8VgDkdxON8Z9rbyRoYmSGGBIOVD1KuqHL+qfhGA8z4wcC?= =?us-ascii?Q?uLQCpcrmzwOPcEpmhm/zzF4FLEk63hw+oUP86wv4sUzVWmtT5BK5r3DfPLk4?= =?us-ascii?Q?LnekPo1r+tRUb3afJN4K2OcRx/3gBwUN+Q5dYVWHIJWZYnoQ+k3DUyKFnZ5t?= =?us-ascii?Q?SR59LwszntECZOSupq5G+5kpTVOa60jswVsD8gEaOze7tn+tFoLsvgBk/Rbz?= =?us-ascii?Q?iWbRdCpk1lGrrfiBKQdHAhZ0ZZHNGzZwGZxn6dzI6+EAs9w0ZvqiJ1upR0Qw?= =?us-ascii?Q?y56fMpLe2qcB+PwpB5UGUIKgPXD+y0HFyNDxYij4UwZJqd1CGIk2U6OMBOkK?= =?us-ascii?Q?tQF+TTGdUxP7zCBdCUfxv91DIc/JIH0/4Jy/45xi0hNMLK9tguWL8JnNRgZH?= =?us-ascii?Q?pSulcyh1/yMIL3VXH6FthExLD3AAnPNjZvMcfEH8GMp8DDTlA8NIcoKoJfEO?= =?us-ascii?Q?0EI4cJRgLZYq5IRXUinNlq2j/h2NEE+EEl9kNSvZ2uxk04UBGXGd+t6FpRh9?= =?us-ascii?Q?NQKys+zF4uPPYSDABoDSumVDisERArZaO/aBaFXMB9Nafs+Vez+CyZH8pgCx?= =?us-ascii?Q?ThGpzclarqP9U5JozKC7UYauuKowSz9IVp95bJtVjMVyu/Y3l8s7kBe0ojT+?= =?us-ascii?Q?BKLzfdWBGQ7tk2aup1IYiZBoODbqmGDZgCIX2yHzIrF0cRYAm8nDGVAYls09?= =?us-ascii?Q?gfowt7//MqE/36h0+d/aMUOu8o8Ug13mYM6HBeaTS+BOQFiu2I1EDU03s2ML?= =?us-ascii?Q?+Z2BDKDUkMwF2jnwDHihmdiYLL0RQbFp4x0aSh+5NOBWZe5ziVzMH/LH5PFM?= =?us-ascii?Q?McOsmX9NmrfOVGBrEX5DI/hOAcm8P9BrZyaktYfDr9DrKSso9D5RpYZyBUIA?= =?us-ascii?Q?6Hysx1Ajb6PpUgXua1aM5vWOVgAZh/obw04DIqJCR+Bw9N+YRDmI89S4pqvK?= =?us-ascii?Q?eaIgtBCPCVrlh7jXNb1H01e38hTNauCExfzhPtuq+WX/wLqta0QLN/f1Qni7?= =?us-ascii?Q?tx8HQxZrxF/6dHq2mGPMfqPaB0dnmg+fvKalesi3XHNCzJtpKevJxi5eHzYl?= =?us-ascii?Q?ffcz5jKqjrf1HdQfzcWO1+wlE8OFMDSqc/fNOp9JHIh3qef1DjJaaHVn+mn9?= =?us-ascii?Q?QQ0gZPmNkzC9OYRzSfMIQ3qbz+cmGJr5bLFcQ2IRbtT+0aHaex5hCwmDHBYp?= =?us-ascii?Q?z4DIEUZLBYa1831ij3Y7zWKgtLMEYI40kECYpBy3l/ZXdSNVutaQDE3HbW0k?= =?us-ascii?Q?i2tWJrrSLEjevyQg14Dk7bYcu152gkDMs8OPf0ZByQ=3D=3D?= x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?JZXstgMXZ8OH0xP2nsCTJBBfeGOk7uGLxXrTdmVQfLpCeqW8VKi3JQpPhmr7?= =?us-ascii?Q?t1NeApJhmI7ZoLBXgwQvFeGhfe7bInNMbhBv7Vj4Sn2NrP8wfc29g+6qjdQY?= =?us-ascii?Q?aDnBgjmTt/JS6zoy9soOVXi0KDf+6OL/ZbsE+tRxFeM9dWDTmsHCHTQEaiu/?= =?us-ascii?Q?RkrSiOpjTDMHvHv2lGcMJOOBcWAaG0RGC1uAG/zOXwmlYjXXhpyjEJJqIZlg?= =?us-ascii?Q?opRsYttkfZjYRTX4aDNWGXHFnlFDzMQJtDrI9UOQBGYOK7B91YR1Va/7K4lk?= =?us-ascii?Q?jfuiAFIC5Ik/dAk/UZCDrHuq8QvCQLC050sp9/mMzv1W3UiW29iS32cq6fRu?= =?us-ascii?Q?gWoCXP7z3pFh9jyo38J71WsAsposQF8ByVH9kjhtkmdpG/3w4SkzXD9bXwuK?= =?us-ascii?Q?BbNngHH7+sSBEoH6kiIdoxvW42s8lKjQcxH0MP+zgfd3KnSl7Mqh+ZBhX4sx?= =?us-ascii?Q?P/8Bg9COywhS5052gxqDAYHW6OGOjyOuNpVsbFSuVgbyAj+e0oKaOBE+qQVf?= =?us-ascii?Q?yV/rRQvWG+xuQohFQYTclUaTFrz9tvIOtUmwAm4g744Te++wcChRxQglMJQ4?= =?us-ascii?Q?FQIaCzia1SCg/GJpGUvNuwkypaSamjHwATRtqUI459pC45KV+8gyiSP5SbuT?= =?us-ascii?Q?sA2JGitbMwMfyeEv5KONemBndodcE/bRyzm34a9OTjk91awBTq95iOvKNO+C?= =?us-ascii?Q?a7SnWrNu0StTS6brNc8e8LXNh89TSm2g7nnDXku/ViC4XBtjb+TfLoIwoo7K?= =?us-ascii?Q?gwZkQFSk9te2NL4S5F3T3TJnjlFibDIGaPzolIEs4IMuaH2gyMXG7qAu9I5l?= =?us-ascii?Q?JH/bM4PW/xKVjzZ8z47C+KwRuX+aqPlsJOpCHWySsZAMGjDB+03sWMRrRrCa?= =?us-ascii?Q?PyLGKIfLpEPFkEwVNKKinWW8GHp/E50LZF3ryiSuQx/U5wyYO3g8vcb/v3By?= =?us-ascii?Q?tGXT5j4euoYZFqaIJKSFy4wG/Oysu6bg7pDCRy0ufTWA1C+tQ5YNnJEkUEjb?= =?us-ascii?Q?+UCZVkdYXmz3+KLeshc5iI3xu1tqnFyklerjiR4lX/Vq0S09UVB/QCN51iXB?= =?us-ascii?Q?8WCbSE4OSxmz3a3Lk/RR1xzozzR+xRMUVh1xIytAq8AVUxaRx97efMXce8Ct?= =?us-ascii?Q?ERD2UprusLXAbvStAhaRX3XDMdS2DDDXiNrHiGo7dYNjwnR7/Y23oRs6wkLl?= =?us-ascii?Q?IX3p14MaxZ9Uzi7tZeEDszlNq66jQtCcTuYsuyM7svq7M8yRNf1vVm6mSkPz?= =?us-ascii?Q?reyDiozG0/hN7S7kJ0M/7ty8hq30yPdHNYBpcM6xUyQeVD3aEH/sjcN4smTx?= =?us-ascii?Q?/dy9nH4Fj3Crm8r48HhPGVyvNjkz7n73tbicxcqzwOtBHzD/Y+rk51QsN4M3?= =?us-ascii?Q?jnwRVOi+MN1F1khYM6QIUkZaTj52z4g4DPyFIOwPIcizWpZnuBuvywPb82bj?= =?us-ascii?Q?xIjHeswhEYFhCK4/ErvUu6bfxQgOU0m9lFHFH2W5y5ocnWR1TtmatrerOKYj?= =?us-ascii?Q?ez9HrH6bciu6DSpyJsLQFkWkk5QYSumw2O+t/fEd6gNMsL8cWBkycWdVgtlx?= =?us-ascii?Q?bxtbyv989Z5yDkZlLqLcC4XKOImoj1b/rTBTYOBKq0Tjbl1nlokIcPTi7tWI?= =?us-ascii?Q?1qb+0+OTwCd9pRFsqCKKL46sln9NtDXc+JAA9ToEN/P6?= MIME-Version: 1.0 X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: PH8PR12MB7025.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: c19cb2d9-3e15-4a20-d280-08dc741302a7 X-MS-Exchange-CrossTenant-originalarrivaltime: 14 May 2024 12:40:17.7472 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: frOUl9biZDExUXfBrWk1urYo/Df6mC0mOlmg85El+3L8EQyy3Tq+yrl2GGRxdsqBUYVVZx+OQY4+jxAfd28VNw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY8PR12MB7290 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Resent-Date: Tue, 14 May 2024 05:40:24 -0700 Resent-From: nicklew@nvidia.com Reply-To: devel@edk2.groups.io,nicklew@nvidia.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: 4TluagAmW4nPc8appN5LWg1Mx7686176AA= Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20240206 header.b=H+GoZEL6; dmarc=pass (policy=none) header.from=groups.io; spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 45.79.224.7 as permitted sender) smtp.mailfrom=bounce@groups.io Hi Abner, > Ok, then I don't have the problem with invoking GetAuthInfo again. Howeve= r, I > will suggest to add more description in GetAuthInfo function header, ment= ion that > we will keep the auth info in EFI variable until exist boot service. > Also, give some more descriptions on the code you invoke to GetAuthInfo. Thanks for your comment. I add descriptions to explain above before calling= GetAuthInfo(). Version 2 path is here: https://edk2.groups.io/g/devel/mess= age/118889 Regards, Nickle > -----Original Message----- > From: devel@edk2.groups.io On Behalf Of Chang, Abn= er > via groups.io > Sent: Tuesday, April 23, 2024 3:42 PM > To: Nickle Wang ; Igor Kulchytskyy ; > devel@edk2.groups.io > Cc: Nick Ramirez > Subject: Re: [edk2-devel] [edk2-redfish-client][PATCH] RedfishClientPkg: > introduce RedfishBootstrapAccountDxe >=20 > External email: Use caution opening links or attachments >=20 >=20 > [AMD Official Use Only - General] >=20 > > -----Original Message----- > > From: Nickle Wang > > Sent: Tuesday, April 23, 2024 3:09 PM > > To: Igor Kulchytskyy ; Chang, Abner > > ; devel@edk2.groups.io > > Cc: Nick Ramirez > > Subject: RE: [EXTERNAL] RE: [edk2-redfish-client][PATCH] RedfishClientP= kg: > > introduce RedfishBootstrapAccountDxe > > > > [AMD Official Use Only - General] > > > > Caution: This message originated from an External Source. Use proper > > caution when opening attachments, clicking links, or responding. > > > > > > Hi Igor, Abner, > > > > Thanks for your review. Please allow me to answer your questions togeth= er. > > > > > 1. We suppose acquire the credential before we start to communicate > > > with > > Redfish. Will Redfish credential driver create another bootstrap > > account here after provisioning? > > No, according to the RedfishPlatformCredentialIpmiLib implementation, > > Redfish credential driver requests credential from BMC and will keep > > it for later use. So only one credential is requested for BIOS Redfish > > feature drivers during POST time. > Ok, then I don't have the problem with invoking GetAuthInfo again. Howeve= r, I > will suggest to add more description in GetAuthInfo function header, ment= ion that > we will keep the auth info in EFI variable until exist boot service. > Also, give some more descriptions on the code you invoke to GetAuthInfo. >=20 > > > > > 2. And why do we delete the credential after provisioning? How about > > > the > > later Redfish property updating process? > > In this driver, we listen to "AfterProvisioning" event. And this is > > the event triggered after Redfish feature driver finish all jobs. > > There is no feature driver which gets executed after this event. And > > since we finished all Redfish operations, we remove this account on BMC= . > Then this makes sense to me now. >=20 > > > > > Why do we need to delete those credentials? According to spec BMC > > > should > > delete the bootstrap credentials automatically on host or service reset= . > > Yes, bootstrap credentials get deleted on host reset. In practice, > > server in datacenter usually takes long time running under OS before it= gets > rebooted. > > The bootstrap credentials are exposed to end user at > > "/redfish/v1/AccountService/Accounts". I got report that there is > > concern for end user to see this unused account. > This sounds to me reasonable as we will give bootstrap credential a high = privilege > to update Redfish resource. Leave this information in Account service see= ms not a > good idea. >=20 > Thanks > Abner >=20 > > > > So, I create this driver to allows us to remove bootstrap account at > > BMC after we finish Redfish jobs. And this also release the BMC > > account resource since this account won't be used for a long period of = time. > > > > Regards, > > Nickle > > > > > -----Original Message----- > > > From: Igor Kulchytskyy > > > Sent: Monday, April 22, 2024 11:03 PM > > > To: Chang, Abner ; Nickle Wang > > > ; devel@edk2.groups.io > > > Cc: Nick Ramirez > > > Subject: RE: [EXTERNAL] RE: [edk2-redfish-client][PATCH] RedfishClien= tPkg: > > > introduce RedfishBootstrapAccountDxe > > > > > > External email: Use caution opening links or attachments > > > > > > > > > Hi Nickle and Abner, > > > I also have the same question as Abner. > > > Why do we need to delete those credentials? > > > According to spec BMC should delete the bootstrap credentials > > > automatically > > on > > > host or service reset. > > > Thank you, > > > Igor > > > > > > -----Original Message----- > > > From: Chang, Abner > > > Sent: Sunday, April 21, 2024 10:25 PM > > > To: Nickle Wang ; devel@edk2.groups.io > > > Cc: Igor Kulchytskyy ; Nick Ramirez > > > > > Subject: [EXTERNAL] RE: [edk2-redfish-client][PATCH] RedfishClientPkg= : > > > introduce RedfishBootstrapAccountDxe > > > > > > > > > **CAUTION: The e-mail below is from an external source. Please > > > exercise caution before opening attachments, clicking links, or > > > following guidance.** > > > > > > [AMD Official Use Only - General] > > > > > > Hi Nickle, > > > One comment and few questions, > > > > > > > -----Original Message----- > > > > From: Nickle Wang > > > > Sent: Thursday, April 18, 2024 8:28 PM > > > > To: devel@edk2.groups.io > > > > Cc: Chang, Abner ; Igor Kulchytskyy > > > > ; Nick Ramirez > > > > Subject: [edk2-redfish-client][PATCH] RedfishClientPkg: introduce > > > > RedfishBootstrapAccountDxe > > > > > > > > Caution: This message originated from an External Source. Use > > > > proper caution when opening attachments, clicking links, or respond= ing. > > > > > > > > > > > > -Introduce RedfishBootstrapAccountDxe to delete bootstrap account > > > > from /redfish/v1/AccountService/Accounts after BIOS finished all > > > > Redfish jobs. The bootstrap account won't be available to other app= lication. > > > > So deleting bootstrap account helps to release resource at BMC. > > > > - After bootstrap account is deleted at BMC, the Redfish service > > > > instance is no longer usable. Close Redfish service instance to > > > > release the HTTP connection between BIOS and BMC. > > > > > > > > Signed-off-by: Nickle Wang > > > > Cc: Abner Chang > > > > Cc: Igor Kulchytskyy > > > > Cc: Nick Ramirez > > > > --- > > > > .../RedfishClientComponents.dsc.inc | 1 + > > > > .../RedfishBootstrapAccountDxe.inf | 53 +++ > > > > .../RedfishBootstrapAccountDxe.h | 58 ++++ > > > > .../RedfishBootstrapAccountDxe.c | 328 ++++++++++++++= ++++ > > > > RedfishClientPkg/RedfishClient.fdf.inc | 1 + > > > > 5 files changed, 441 insertions(+) create mode 100644 > > > > > > RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountDxe > > > > .inf > > > > create mode 100644 > > > > > > RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountDxe > > > > .h > > > > create mode 100644 > > > > > > RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountDxe > > > > .c > > > > > > > > diff --git a/RedfishClientPkg/RedfishClientComponents.dsc.inc > > > > b/RedfishClientPkg/RedfishClientComponents.dsc.inc > > > > index 42fc0c299..fe5248b62 100644 > > > > --- a/RedfishClientPkg/RedfishClientComponents.dsc.inc > > > > +++ b/RedfishClientPkg/RedfishClientComponents.dsc.inc > > > > @@ -20,6 +20,7 @@ > > > > RedfishClientPkg/HiiToRedfishMemoryDxe/HiiToRedfishMemoryDxe.inf > > > > RedfishClientPkg/HiiToRedfishBootDxe/HiiToRedfishBootDxe.inf > > > > RedfishClientPkg/HiiToRedfishBiosDxe/HiiToRedfishBiosDxe.inf > > > > + > > > > > > RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountDxe > > > > .inf > > > > !endif > > > > # > > > > # Below two modules should be pulled in by build tool. > > > > diff --git > > > > > > a/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.in > > > > f > > > > > > b/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.in > > > > f > > > > new file mode 100644 > > > > index 000000000..4073e95f4 > > > > --- /dev/null > > > > +++ > > > > > > b/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.in > > > > f > > > > @@ -0,0 +1,53 @@ > > > > +## @file > > > > +# This driver deletes bootstrap account in BMC after BIOS > > > > +Redfish finished # all jobs # # (C) Copyright 2021 Hewlett > > > > +Packard Enterprise Development LP
# Copyright (c) 2023, > > > > +NVIDIA CORPORATION & AFFILIATES. All rights reserved. > > > > > > > > > Not sure if you want to update the copyright to 2024. > > > > > > > > > > +# > > > > +# SPDX-License-Identifier: BSD-2-Clause-Patent # ## > > > > + > > > > +[Defines] > > > > + INF_VERSION =3D 0x0001000b > > > > + BASE_NAME =3D RedfishBootstrapAccountDxe > > > > + FILE_GUID =3D 87555253-2F7E-45FC-B469-FD35B2E512= 10 > > > > + MODULE_TYPE =3D DXE_DRIVER > > > > + VERSION_STRING =3D 1.0 > > > > + ENTRY_POINT =3D RedfishBootstrapAccountEntryPoint > > > > + UNLOAD_IMAGE =3D RedfishBootstrapAccountUnload > > > > + > > > > +[Packages] > > > > + MdePkg/MdePkg.dec > > > > + MdeModulePkg/MdeModulePkg.dec > > > > + RedfishPkg/RedfishPkg.dec > > > > + RedfishClientPkg/RedfishClientPkg.dec > > > > + > > > > +[Sources] > > > > + RedfishBootstrapAccountDxe.h > > > > + RedfishBootstrapAccountDxe.c > > > > + > > > > +[LibraryClasses] > > > > + BaseLib > > > > + BaseMemoryLib > > > > + DebugLib > > > > + MemoryAllocationLib > > > > + PrintLib > > > > + RedfishEventLib > > > > + RedfishFeatureUtilityLib > > > > + RedfishDebugLib > > > > + RedfishVersionLib > > > > + RedfishHttpLib > > > > + UefiLib > > > > + UefiBootServicesTableLib > > > > + UefiRuntimeServicesTableLib > > > > + UefiDriverEntryPoint > > > > + > > > > +[Protocols] > > > > + gEdkIIRedfishConfigHandlerProtocolGuid ## CONSUMES ## > > > > + gEdkIIRedfishCredentialProtocolGuid ## CONSUMES ## > > > > + gEfiRestExProtocolGuid ## CONSUMES ## > > > > + > > > > +[Depex] > > > > + gEdkIIRedfishCredentialProtocolGuid > > > > diff --git > > > > > > a/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.h > > > > > > b/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.h > > > > new file mode 100644 > > > > index 000000000..5262f1e6b > > > > --- /dev/null > > > > +++ > > > > > > b/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.h > > > > @@ -0,0 +1,58 @@ > > > > +/** @file > > > > + Common header file for RedfishBootstrapAccountDxe driver. > > > > + > > > > + (C) Copyright 2021-2022 Hewlett Packard Enterprise Development > > > > + LP
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All > > rights > > > reserved. > > > > + > > > > + SPDX-License-Identifier: BSD-2-Clause-Patent > > > > + > > > > +**/ > > > > + > > > > +#ifndef REDFISH_BOOTSTRAP_ACCOUNT_DXE_H_ #define > > > > +REDFISH_BOOTSTRAP_ACCOUNT_DXE_H_ > > > > + > > > > +#include > > > > +#include > > > > + > > > > +// > > > > +// Libraries > > > > +// > > > > +#include > > > > +#include #include > > > > + > > > > +#include #include > > > > + #include > > > > +#include > > > > +#include #include > > > > + #include > > > > +#include > > > > +#include #include > > > > + #include > > > > + > > > > + > > > > +#include > > > > +#include > > > > +#include > > > > + > > > > +#define REDFISH_BOOTSTRAP_ACCOUNT_DEBUG DEBUG_VERBOSE > > > > +#define REDFISH_MANAGER_ACCOUNT_COLLECTION_URI > > > > L"AccountService/Accounts" > > > > +#define REDFISH_URI_LENGTH 128 > > > > + > > > > +// > > > > +// Definitions of REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE // typedef > > struct > > > > +{ > > > > + EFI_HANDLE ImageHandle; > > > > + EFI_HANDLE RestExHandle; > > > > + REDFISH_SERVICE RedfishService; > > > > + EFI_EVENT RedfishEvent; > > > > + EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL Protocol; > > > > +} REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE; > > > > + > > > > +#define > > REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE_FROM_PROTOCOL(This) \ > > > > + BASE_CR ((This), REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE, > > > > +Protocol) > > > > + > > > > +#endif > > > > diff --git > > > > > > a/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.c > > > > > > b/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.c > > > > new file mode 100644 > > > > index 000000000..6fe4856f8 > > > > --- /dev/null > > > > +++ > > > > > > b/RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountD > > > > xe.c > > > > @@ -0,0 +1,328 @@ > > > > +/** @file > > > > + This driver deletes bootstrap account in BMC after BIOS Redfish > > > > +finished > > > > + all jobs. > > > > + > > > > + (C) Copyright 2021-2022 Hewlett Packard Enterprise Development > > > > + LP
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All > > rights > > > reserved. > > > > + > > > > + SPDX-License-Identifier: BSD-2-Clause-Patent > > > > + > > > > +**/ > > > > + > > > > +#include "RedfishBootstrapAccountDxe.h" > > > > + > > > > +REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE *mBootstrapPrivate =3D NULL; > > > > + > > > > +/** > > > > + Close Redfish service instance by calling RestEx protocol to > > > > +release > > instance. > > > > + > > > > + @param[in] RestExHandle Handle of RestEx protocol. > > > > + > > > > + @retval EFI_SUCCESS The Redfish service is closed succ= essfully. > > > > + @retval EFI_INVALID_PARAMETER RestExHandle is NULL. > > > > + @retval Others Error occurs. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +CloseRedfishService ( > > > > + IN EFI_HANDLE RestExHandle > > > > + ) > > > > +{ > > > > + EFI_REST_EX_PROTOCOL *RestEx; > > > > + EFI_STATUS Status; > > > > + > > > > + if (RestExHandle =3D=3D NULL) { > > > > + return EFI_INVALID_PARAMETER; } > > > > + > > > > + Status =3D gBS->HandleProtocol ( > > > > + RestExHandle, > > > > + &gEfiRestExProtocolGuid, > > > > + (VOID **)&RestEx > > > > + ); > > > > + if (!EFI_ERROR (Status)) { > > > > + Status =3D RestEx->Configure (RestEx, NULL); > > > > + DEBUG ((REDFISH_BOOTSTRAP_ACCOUNT_DEBUG, "%a: release RestEx > > > > instance: %r\n", __func__, Status)); > > > > + } > > > > + > > > > + return Status; > > > > +} > > > > + > > > > +/** > > > > + Callback function executed when the AfterProvisioning event > > > > +group is > > > > signaled. > > > > + > > > > + @param[in] Event Event whose notification function is being= invoked. > > > > + @param[out] Context Pointer to the Context buffer > > > > + > > > > +**/ > > > > +VOID > > > > +EFIAPI > > > > +RedfishBootstrapAccountOnRedfishAfterProvisioning ( > > > > + IN EFI_EVENT Event, > > > > + OUT VOID *Context > > > > + ) > > > > +{ > > > > + EFI_STATUS Status; > > > > + REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE *Private; > > > > + EDKII_REDFISH_CREDENTIAL_PROTOCOL *credentialProtocol; > > > > + EDKII_REDFISH_AUTH_METHOD AuthMethod; > > > > + CHAR8 *AccountName; > > > > + CHAR8 *AccountCredential; > > > > + CHAR16 TargetUri[REDFISH_URI_LENGTH]= ; > > > > + CHAR16 *RedfishVersion; > > > > + REDFISH_RESPONSE RedfishResponse; > > > > + > > > > + RedfishVersion =3D NULL; > > > > + > > > > + Private =3D (REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE *)Context; if > > > > + ((Private =3D=3D NULL) || (Private->RedfishService =3D=3D NULL)) = { > > > > + DEBUG ((DEBUG_ERROR, "%a: Redfish service is not > > > > + available\n", > > > > __func__)); > > > > + return; > > > > + } > > > > + > > > > + // > > > > + // Locate Redfish Credential Protocol to get credential for // > > > > + accessing to Redfish service. > > > > + // > > > > + Status =3D gBS->LocateProtocol ( > > > > + &gEdkIIRedfishCredentialProtocolGuid, > > > > + NULL, > > > > + (VOID **)&credentialProtocol > > > > + ); > > > > + if (EFI_ERROR (Status)) { > > > > + DEBUG ((REDFISH_BOOTSTRAP_ACCOUNT_DEBUG, "%a: No Redfish > > > > Credential Protocol is installed on system.", __func__)); > > > > + return; > > > > + } > > > > + > > > > + Status =3D credentialProtocol->GetAuthInfo ( > > > > + credentialProtocol, > > > > + &AuthMethod, > > > > + &AccountName, > > > > + &AccountCredential > > > > + ); > > > > > > HI Nickle, I am not quite understand why do we acquire a credential > > > here but delete it from the Redfish account service here after provis= ion. > > > 1. We suppose acquire the credential before we start to communicate > > > with Redfish. Will Redfish credential driver create another > > > bootstrap account here after provisioning? > > > 2. And why do we delete the credential after provisioning? How about > > > the > > later > > > Redfish property updating process? > > > Or do I misunderstand the code logic? > > > > > > Regards, > > > Abner > > > > > > > + if (EFI_ERROR (Status)) { > > > > + DEBUG ((DEBUG_ERROR, "%a: can not get bootstrap account > > information: > > > > %r\n", __func__, Status)); > > > > + return; > > > > + } > > > > + > > > > + // > > > > + // Carving the URI > > > > + // > > > > + RedfishVersion =3D RedfishGetVersion (Private->RedfishService); > > > > + if (RedfishVersion =3D=3D NULL) { > > > > + DEBUG ((DEBUG_ERROR, "%a: can not get Redfish version\n", > > __func__)); > > > > + return; > > > > + } > > > > + > > > > + UnicodeSPrint (TargetUri, (sizeof (CHAR16) * > > > > + REDFISH_URI_LENGTH), > > > > L"%s%s/%a", RedfishVersion, > > > REDFISH_MANAGER_ACCOUNT_COLLECTION_URI, > > > > AccountName); > > > > + > > > > + DEBUG ((REDFISH_BOOTSTRAP_ACCOUNT_DEBUG, "%a: bootstrap > > account: > > > > %a\n", __func__, AccountName)); > > > > + DEBUG ((REDFISH_BOOTSTRAP_ACCOUNT_DEBUG, "%a: bootstrap > > > > credential: %a\n", __func__, AccountCredential)); > > > > + DEBUG ((REDFISH_BOOTSTRAP_ACCOUNT_DEBUG, "%a: bootstrap URI: > > > > %s\n", __func__, TargetUri)); > > > > + > > > > + // > > > > + // Remove bootstrap account at > > > > + /redfish/v1/AccountService/Account > > > > + // > > > > + ZeroMem (&RedfishResponse, sizeof (REDFISH_RESPONSE)); Status > > > > + =3D RedfishHttpDeleteResource ( > > > > + Private->RedfishService, > > > > + TargetUri, > > > > + &RedfishResponse > > > > + ); > > > > + if (EFI_ERROR (Status)) { > > > > + DEBUG ((DEBUG_ERROR, "%a: can not remove bootstrap account at > > BMC: > > > > %r", __func__, Status)); > > > > + DumpRedfishResponse (__func__, DEBUG_ERROR, > > &RedfishResponse); } > > > > + else { > > > > + DEBUG ((REDFISH_BOOTSTRAP_ACCOUNT_DEBUG, "%a: bootstrap > > > account: > > > > %a is removed from: %s\n", __func__, AccountName, > > > > REDFISH_MANAGER_ACCOUNT_COLLECTION_URI)); > > > > + } > > > > + > > > > + // > > > > + // Clean credential > > > > + // > > > > + ZeroMem (AccountName, AsciiStrSize (AccountName)); ZeroMem > > > > + (AccountCredential, AsciiStrSize (AccountCredential)); > > > > + > > > > + // > > > > + // Since the bootstrap account is deleted at BMC, the Redfish > > > > + service instance > > > > is no longer usable. > > > > + // Close Redfish service instance to release the HTTP > > > > + connection between > > > > BIOS and BMC. > > > > + // > > > > + Status =3D CloseRedfishService (Private->RestExHandle); if > > > > + (EFI_ERROR (Status)) { > > > > + DEBUG ((DEBUG_ERROR, "%a: cannot close Redfish service instanc= e: > > > > + %r\n", > > > > __func__, Status)); > > > > + } > > > > + > > > > + RedfishHttpFreeResponse (&RedfishResponse); > > > > + > > > > + return; > > > > +} > > > > + > > > > +/** > > > > + Initialize a Redfish configure handler. > > > > + > > > > + This function will be called by the Redfish config driver to > > > > + initialize each > > > > Redfish configure > > > > + handler. > > > > + > > > > + @param[in] This Pointer to > > > > EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL instance. > > > > + @param[in] RedfishConfigServiceInfo Redfish service informaito= n. > > > > + > > > > + @retval EFI_SUCCESS The handler has been initia= lized > > successfully. > > > > + @retval EFI_DEVICE_ERROR Failed to create or configu= re the REST > > EX > > > > protocol instance. > > > > + @retval EFI_ALREADY_STARTED This handler has already be= en > > > > initialized. > > > > + @retval Other Error happens during the in= itialization. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +EFIAPI > > > > +RedfishBootstrapAccountInit ( > > > > + IN EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL *This, > > > > + IN REDFISH_CONFIG_SERVICE_INFORMATION > > *RedfishConfigServiceInfo > > > > + ) > > > > +{ > > > > + REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE *Private; > > > > + > > > > + Private =3D REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE_FROM_PROTOCOL > > > > (This); > > > > + > > > > + Private->RedfishService =3D RedfishCreateService > > > > + (RedfishConfigServiceInfo); if (Private->RedfishService =3D=3D N= ULL) { > > > > + return EFI_DEVICE_ERROR; > > > > + } > > > > + > > > > + Private->RestExHandle =3D RedfishConfigServiceInfo- > > > > >RedfishServiceRestExHandle; > > > > + > > > > + return EFI_SUCCESS; > > > > +} > > > > + > > > > +/** > > > > + Stop a Redfish configure handler. > > > > + > > > > + @param[in] This Pointer to > > > > EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL instance. > > > > + > > > > + @retval EFI_SUCCESS This handler has been stoped su= ccessfully. > > > > + @retval Others Some error happened. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +EFIAPI > > > > +RedfishBootstrapAccountStop ( > > > > + IN EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL *This > > > > + ) > > > > +{ > > > > + REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE *Private; > > > > + > > > > + Private =3D REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE_FROM_PROTOCOL > > > > (This); > > > > + > > > > + if (Private->RedfishService !=3D NULL) { > > > > + RedfishCleanupService (Private->RedfishService); > > > > + Private->RedfishService =3D NULL; } > > > > + > > > > + return EFI_SUCCESS; > > > > +} > > > > + > > > > +EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL mRedfishConfigHandler =3D > > { > > > > + RedfishBootstrapAccountInit, > > > > + RedfishBootstrapAccountStop > > > > +}; > > > > + > > > > +/** > > > > + Unloads an image. > > > > + > > > > + @param[in] ImageHandle Handle that identifies the ima= ge to be > > > > unloaded. > > > > + > > > > + @retval EFI_SUCCESS The image has been unloaded. > > > > + @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image > > handle. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +EFIAPI > > > > +RedfishBootstrapAccountUnload ( > > > > + IN EFI_HANDLE ImageHandle > > > > + ) > > > > +{ > > > > + EFI_STATUS Status; > > > > + > > > > + if (mBootstrapPrivate =3D=3D NULL) { > > > > + return EFI_SUCCESS; > > > > + } > > > > + > > > > + if (mBootstrapPrivate->RedfishEvent !=3D NULL) { > > > > + gBS->CloseEvent (mBootstrapPrivate->RedfishEvent); > > > > + } > > > > + > > > > + Status =3D gBS->UninstallProtocolInterface ( > > > > + mBootstrapPrivate->ImageHandle, > > > > + &gEdkIIRedfishConfigHandlerProtocolGuid, > > > > + (VOID *)&mBootstrapPrivate->Protocol > > > > + ); > > > > + if (EFI_ERROR (Status)) { > > > > + DEBUG ((DEBUG_ERROR, "%a: can not uninstall Redfish config > > > > + handler > > > > protocol: %r\n", __func__, Status)); > > > > + } > > > > + > > > > + FreePool (mBootstrapPrivate); > > > > + mBootstrapPrivate =3D NULL; > > > > + > > > > + return EFI_SUCCESS; > > > > +} > > > > + > > > > +/** > > > > + This is the declaration of an EFI image entry point. This entry > > > > +point is > > > > + the same for UEFI Applications, UEFI OS Loaders, and UEFI > > > > +Drivers including > > > > + both device drivers and bus drivers. > > > > + > > > > + @param[in] ImageHandle The firmware allocated handle for = the UEFI > > > > image. > > > > + @param[in] SystemTable A pointer to the EFI System Table. > > > > + > > > > + @retval EFI_SUCCESS The operation completed successful= ly. > > > > + @retval Others An unexpected error occurred. > > > > +**/ > > > > +EFI_STATUS > > > > +EFIAPI > > > > +RedfishBootstrapAccountEntryPoint ( > > > > + IN EFI_HANDLE ImageHandle, > > > > + IN EFI_SYSTEM_TABLE *SystemTable > > > > + ) > > > > +{ > > > > + EFI_STATUS Status; > > > > + > > > > + if (mBootstrapPrivate !=3D NULL) { > > > > + return EFI_ALREADY_STARTED; > > > > + } > > > > + > > > > + mBootstrapPrivate =3D AllocateZeroPool (sizeof > > > > (REDFISH_BOOTSTRAP_ACCOUNT_PRIVATE)); > > > > + if (mBootstrapPrivate =3D=3D NULL) { > > > > + return EFI_OUT_OF_RESOURCES; > > > > + } > > > > + > > > > + CopyMem (&mBootstrapPrivate->Protocol, &mRedfishConfigHandler, > > > > + sizeof > > > > (EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL)); > > > > + Status =3D gBS->InstallProtocolInterface ( > > > > + &ImageHandle, > > > > + &gEdkIIRedfishConfigHandlerProtocolGuid, > > > > + EFI_NATIVE_INTERFACE, > > > > + &mBootstrapPrivate->Protocol > > > > + ); > > > > + if (EFI_ERROR (Status)) { > > > > + DEBUG ((DEBUG_ERROR, "%a: can not install Redfish config > > > > + handler > > > > protocol: %r\n", __func__, Status)); > > > > + goto ON_ERROR; > > > > + } > > > > + > > > > + // > > > > + // Register after provisioning event to remove bootstrap account= . > > > > + // > > > > + Status =3D CreateAfterProvisioningEvent ( > > > > + RedfishBootstrapAccountOnRedfishAfterProvisioning, > > > > + (VOID *)mBootstrapPrivate, > > > > + &mBootstrapPrivate->RedfishEvent > > > > + ); > > > > + if (EFI_ERROR (Status)) { > > > > + DEBUG ((DEBUG_ERROR, "%a: failed to register > > > > + after-provisioning > > event: > > > > %r\n", __func__, Status)); > > > > + goto ON_ERROR; > > > > + } > > > > + > > > > + return EFI_SUCCESS; > > > > + > > > > +ON_ERROR: > > > > + > > > > + RedfishBootstrapAccountUnload (ImageHandle); > > > > + > > > > + return Status; > > > > +} > > > > diff --git a/RedfishClientPkg/RedfishClient.fdf.inc > > > > b/RedfishClientPkg/RedfishClient.fdf.inc > > > > index 154f641b2..47e5093f2 100644 > > > > --- a/RedfishClientPkg/RedfishClient.fdf.inc > > > > +++ b/RedfishClientPkg/RedfishClient.fdf.inc > > > > @@ -15,6 +15,7 @@ > > > > INF RedfishClientPkg/RedfishFeatureCoreDxe/RedfishFeatureCoreDxe= .inf > > > > INF RedfishClientPkg/RedfishETagDxe/RedfishETagDxe.inf > > > > INF > > > > > > RedfishClientPkg/RedfishConfigLangMapDxe/RedfishConfigLangMapDxe.inf > > > > + INF > > > > > > > > > RedfishClientPkg/RedfishBootstrapAccountDxe/RedfishBootstrapAccountDxe > > .inf > > > > INF RedfishClientPkg/Features/Memory/V1_7_1/Dxe/MemoryDxe.inf > > > > INF > > > > > > RedfishClientPkg/Features/MemoryCollectionDxe/MemoryCollectionDxe.inf > > > > INF > > > > > > > > > RedfishClientPkg/Features/ComputerSystem/v1_5_0/Dxe/ComputerSystemD > > xe. > > > > i > > > > nf > > > > -- > > > > 2.34.1 > > > > > > -The information contained in this message may be confidential and > > proprietary > > > to American Megatrends (AMI). This communication is intended to be > > > read > > only by > > > the individual or entity to whom it is addressed or by their > > > designee. If the > > reader > > > of this message is not the intended recipient, you are on notice > > > that any distribution of this message, in any form, is strictly > > > prohibited. Please > > promptly > > > notify the sender by reply e-mail or by telephone at 770-246-8600, > > > and > > then > > > delete or destroy all copies of the transmission. >=20 >=20 >=20 >=20 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#118890): https://edk2.groups.io/g/devel/message/118890 Mute This Topic: https://groups.io/mt/105596648/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-