From ad2de237bc6e668c528c3ae76483fdfc0266b4f2 Mon Sep 17 00:00:00 2001 From: Jarrod Johnson Date: Thu, 12 Nov 2026 10:17:48 -0500 Subject: [PATCH] Implement management of UEFI HTTPS certificates On supported platforms, manage the UEFI HTTPS certificate store. This can make it easier to manage HTTPS boot. --- confluent_client/bin/nodecertutil | 39 +++++++++++----- confluent_client/confluent.fish | 4 +- confluent_client/confluent_env.sh | 4 +- confluent_client/doc/man/nodecertutil.ronn | 25 +++++++++-- confluent_server/aiohmi/redfish/command.py | 13 ++++++ .../aiohmi/redfish/oem/generic.py | 44 +++++++++++++++++++ confluent_server/confluent/core.py | 4 ++ confluent_server/confluent/messages.py | 2 + .../plugins/hardwaremanagement/redfish.py | 20 +++++++-- 9 files changed, 133 insertions(+), 22 deletions(-) diff --git a/confluent_client/bin/nodecertutil b/confluent_client/bin/nodecertutil index f2e20896..a230a229 100644 --- a/confluent_client/bin/nodecertutil +++ b/confluent_client/bin/nodecertutil @@ -11,16 +11,18 @@ if path.startswith('/opt'): sys.path.append(path) import confluent.client as client -def removebmccacert(noderange, certid, cmd): - for res in cmd.delete(f'/noderange/{noderange}/configuration/management_controller/certificate_authorities/{certid}'): +def removecacert(noderange, certid, cmd, uefi=False): + component = 'system' if uefi else 'management_controller' + for res in cmd.delete(f'/noderange/{noderange}/configuration/{component}/certificate_authorities/{certid}'): print(repr(res)) -def listbmccacerts(noderange, cmd): +def listcacerts(noderange, cmd, uefi=False): + component = 'system' if uefi else 'management_controller' certids = [] - for res in cmd.read(f'/noderange/{noderange}/configuration/management_controller/certificate_authorities'): + for res in cmd.read(f'/noderange/{noderange}/configuration/{component}/certificate_authorities'): certids.append(res.get('item', {}).get('href', '')) for certid in certids: - for res in cmd.read(f'/noderange/{noderange}/configuration/management_controller/certificate_authorities/{certid}'): + for res in cmd.read(f'/noderange/{noderange}/configuration/{component}/certificate_authorities/{certid}'): for node in res.get('databynode', {}): certdata = res['databynode'][node].get('pem', {}).get('value', '') summary = '' @@ -41,7 +43,7 @@ def listbmccacerts(noderange, cmd): summary += f" (SHA256={sha256})" print(f"{node}: {certid}: {summary}") -def installbmccacert(noderange, certfile, cmd): +def installcacert(noderange, certfile, cmd, uefi=False): if certfile: try: with open(certfile, 'r') as f: @@ -55,7 +57,10 @@ def installbmccacert(noderange, certfile, cmd): print("Invalid certificate format. Must be a PEM encoded certificate.", file=sys.stderr) sys.exit(1) payload = {'pem': certdata} - for res in cmd.update(f'/noderange/{noderange}/configuration/management_controller/certificate_authorities', payload): + url = f'/noderange/{noderange}/configuration/management_controller/certificate_authorities' + if uefi: + url = f'/noderange/{noderange}/configuration/system/certificate_authorities' + for res in cmd.update(url, payload): print(repr(res)) @@ -71,10 +76,18 @@ if __name__ == '__main__': install_parser = subparsers.add_parser('installbmccacert', help='Install BMC CA certificate') install_parser.add_argument('filename', help='Certificate file to install') + install_uefi_parser = subparsers.add_parser('installueficacert', help='Install UEFI CA certificate') + install_uefi_parser.add_argument('filename', help='Certificate file to install') + + remove_parser = subparsers.add_parser('removebmccacert', help='Remove BMC CA certificate') remove_parser.add_argument('id', help='Certificate id to remove') + remove_uefi_parser = subparsers.add_parser('removeueficacert', help='Remove UEFI CA certificate') + remove_uefi_parser.add_argument('id', help='Certificate id to remove') + list_parser = subparsers.add_parser('listbmccacerts', help='List BMC CA certificates') + list_uefi_parser = subparsers.add_parser('listueficacerts', help='List UEFI CA certificates') sign_bmc_parser = subparsers.add_parser('signbmccert', help='Sign BMC certificate') sign_bmc_parser.add_argument('--days', type=int, help='Number of days the certificate is valid for') @@ -83,11 +96,17 @@ if __name__ == '__main__': args = parser.parse_args() c = client.Command() if args.command == 'installbmccacert': - installbmccacert(args.noderange, args.filename, c) + installcacert(args.noderange, args.filename, c) + elif args.command == 'installueficacert': + installcacert(args.noderange, args.filename, c, uefi=True) elif args.command == 'removebmccacert': - removebmccacert(args.noderange, args.id, c) + removecacert(args.noderange, args.id, c) + elif args.command == 'removeueficacert': + removecacert(args.noderange, args.id, c, uefi=True) elif args.command == 'listbmccacerts': - listbmccacerts(args.noderange, c) + listcacerts(args.noderange, c) + elif args.command == 'listueficacerts': + listcacerts(args.noderange, c, uefi=True) elif args.command == 'signbmccert': payload = {} if args.days is not None: diff --git a/confluent_client/confluent.fish b/confluent_client/confluent.fish index 24e3566f..a4664c32 100644 --- a/confluent_client/confluent.fish +++ b/confluent_client/confluent.fish @@ -267,10 +267,10 @@ function _confluent_nodecertutil_complete if test $count -lt 3 _confluent_nr_complete else if test $count -eq 3 - printf '%s\n' installbmccacert removebmccacert listbmccacerts signbmccert + printf '%s\n' installbmccacert removebmccacert listbmccacerts installueficacert removeueficacert listueficacerts signbmccert else if test (count $args) -ge 3; and test "$args[3]" = signbmccert _confluent_unseen '--days --added-names' - else if test (count $args) -ge 3; and test "$args[3]" = installbmccacert + else if test (count $args) -ge 3; and contains -- "$args[3]" installbmccacert installueficacert _confluent_path_complete end end diff --git a/confluent_client/confluent_env.sh b/confluent_client/confluent_env.sh index 41a4ba2d..92bec38c 100644 --- a/confluent_client/confluent_env.sh +++ b/confluent_client/confluent_env.sh @@ -322,10 +322,10 @@ _confluent_nodecertutil_completion() return fi if [ $NUMARGS == 3 ]; then - COMPREPLY=($(compgen -W "installbmccacert removebmccacert listbmccacerts signbmccert" -- ${COMP_WORDS[COMP_CWORD]})) + COMPREPLY=($(compgen -W "installbmccacert removebmccacert listbmccacerts installueficacert removeueficacert listueficacerts signbmccert" -- ${COMP_WORDS[COMP_CWORD]})) return fi - if [ ${CMPARGS[2]} == 'installbmccacert' ]; then + if [ ${CMPARGS[2]} == 'installbmccacert' ] || [ ${CMPARGS[2]} == 'installueficacert' ]; then compopt -o default COMPREPLY=() return diff --git a/confluent_client/doc/man/nodecertutil.ronn b/confluent_client/doc/man/nodecertutil.ronn index ffa49c2a..0cc9c5e0 100644 --- a/confluent_client/doc/man/nodecertutil.ronn +++ b/confluent_client/doc/man/nodecertutil.ronn @@ -1,4 +1,4 @@ -nodecertutil(8) -- Manage BMC CA certificates and sign BMC certificates +nodecertutil(8) -- Manage BMC and UEFI CA certificates and sign BMC certificates ======================================================================= ## SYNOPSIS @@ -8,9 +8,9 @@ nodecertutil(8) -- Manage BMC CA certificates and sign BMC certificates ## DESCRIPTION `nodecertutil` manages the certificate authority (CA) certificates trusted by -the baseboard management controllers (BMCs) of the nodes matched by -``, and can sign a BMC certificate. One of the subcommands below -must be supplied. +the baseboard management controllers (BMCs) and UEFI firmware of the nodes +matched by ``, and can sign a BMC certificate. One of the +subcommands below must be supplied. ## COMMANDS @@ -24,6 +24,17 @@ must be supplied. * `listbmccacerts`: List the CA certificates currently installed on the BMCs. +* `installueficacert `: + Install the CA certificate contained in `` onto the nodes' UEFI + firmware. + +* `removeueficacert `: + Remove the CA certificate identified by `` from the nodes' UEFI + firmware. Use `listueficacerts` to discover the identifiers. + +* `listueficacerts`: + List the CA certificates currently installed in the nodes' UEFI firmware. + * `signbmccert` [`--days `] [`--added-names `]: Sign a BMC certificate. `--days` is required and sets the number of days the certificate is valid for; `--added-names` adds additional subject @@ -42,6 +53,12 @@ must be supplied. * Install a CA certificate on a range of nodes: `# nodecertutil n1-n4 installbmccacert /etc/confluent/myca.pem` +* List the CA certificates installed in a node's UEFI firmware: + `# nodecertutil n1 listueficacerts` + +* Install a CA certificate in a range of nodes' UEFI firmware: + `# nodecertutil n1-n4 installueficacert /etc/confluent/myca.pem` + * Sign a BMC certificate valid for one year: `# nodecertutil n1 signbmccert --days 365` diff --git a/confluent_server/aiohmi/redfish/command.py b/confluent_server/aiohmi/redfish/command.py index 3decf05e..f03d7d28 100644 --- a/confluent_server/aiohmi/redfish/command.py +++ b/confluent_server/aiohmi/redfish/command.py @@ -227,6 +227,19 @@ class Command(object): return await oem.get_bmc_csr( keytype=keytype, keylength=keylength, cn=cn) + async def get_trusted_uefi_cas(self): + oem = await self.oem() + async for ca in oem.get_trusted_uefi_cas(): + yield ca + + async def add_trusted_uefi_ca(self, pemdata): + oem = await self.oem() + return await oem.add_trusted_uefi_ca(pemdata) + + async def del_trusted_uefi_ca(self, certid): + oem = await self.oem() + return await oem.del_trusted_uefi_ca(certid) + async def install_bmc_certificate(self, certdata): oem = await self.oem() return await oem.install_bmc_certificate(certdata) diff --git a/confluent_server/aiohmi/redfish/oem/generic.py b/confluent_server/aiohmi/redfish/oem/generic.py index 81dff77f..fbc1b161 100644 --- a/confluent_server/aiohmi/redfish/oem/generic.py +++ b/confluent_server/aiohmi/redfish/oem/generic.py @@ -591,6 +591,50 @@ class OEMHandler(object): return True raise exc.PyghmiException(f'No such certificate found: {certid}') + async def get_trusted_uefi_cas(self): + sysinfo = await self.sysinfo() + caurl = sysinfo.get('Boot', {}).get('Certificates', {}).get('@odata.id', None) + if not caurl: + return + cas = await self._get_expanded_data(caurl) + cas = cas.get('Members', []) + for ca in cas: + cadesc = { + 'id': ca.get('Id', ''), + 'name': ca.get('Name', ''), + 'pem': ca.get('CertificateString', None), + 'subject': ca.get('Subject', {}).get('CommonName', ''), + 'sans': ca.get('Subject', {}).get('AlternativeNames', []), + 'issuer': ca.get('Issuer', {}).get('CommonName', ''), + 'validfrom': ca.get('ValidNotBefore', ''), + 'validto': ca.get('ValidNotAfter', ''), + } + yield cadesc + + async def add_trusted_uefi_ca(self, pemdata): + sysinfo = await self.sysinfo() + caurl = sysinfo.get('Boot', {}).get('Certificates', {}).get('@odata.id', None) + if not caurl: + raise exc.PyghmiException('Platform does not support UEFI CAs') + certpayload = _pem_to_dict(pemdata, uefi=True) + await self._do_web_request(caurl, certpayload) + self._invalidate_url_cache(caurl) + return True + + async def del_trusted_uefi_ca(self, certid): + sysinfo = await self.sysinfo() + caurl = sysinfo.get('Boot', {}).get('Certificates', {}).get('@odata.id', None) + if not caurl: + raise exc.PyghmiException('Platform does not support UEFI CAs') + cas = await self._get_expanded_data(caurl) + cas = cas.get('Members', []) + for ca in cas: + if ca.get('Id', '') == certid: + await self._do_web_request(ca['@odata.id'], method='DELETE') + self._invalidate_url_cache(caurl) + return True + raise exc.PyghmiException(f'No such certificate found: {certid}') + async def get_trusted_cas(self): mgrinfo = await self._bmcinfo() secpolicy = mgrinfo.get('SecurityPolicy', {}).get('@odata.id', None) diff --git a/confluent_server/confluent/core.py b/confluent_server/confluent/core.py index 73842251..3f47b97e 100644 --- a/confluent_server/confluent/core.py +++ b/confluent_server/confluent/core.py @@ -429,6 +429,10 @@ def _init_core(): 'pluginattrs': ['hardwaremanagement.method'], 'default': 'null', }), + 'certificate_authorities': PluginCollection({ + 'pluginattrs': ['hardwaremanagement.method'], + 'default': 'null', + }), 'clear': PluginRoute({ 'pluginattrs': ['hardwaremanagement.method'], 'default': 'null', diff --git a/confluent_server/confluent/messages.py b/confluent_server/confluent/messages.py index f8e2a4a1..c86df63a 100644 --- a/confluent_server/confluent/messages.py +++ b/confluent_server/confluent/messages.py @@ -521,6 +521,8 @@ def get_input_message(path, operation, inputdata, nodes=None, multinode=False, return InputAlertDestination(path, nodes, inputdata, multinode) elif len(path) == 3 and path[:3] == ['configuration', 'management_controller', 'certificate_authorities'] and operation not in ('retrieve', 'delete'): return InputCertificateAuthority(path, nodes, inputdata) + elif len(path) == 3 and path[:3] == ['configuration', 'system', 'certificate_authorities'] and operation not in ('retrieve', 'delete'): + return InputCertificateAuthority(path, nodes, inputdata) elif len(path) == 4 and path[:4] == ['configuration', 'management_controller', 'certificate', 'sign'] and operation not in ('retrieve', 'delete'): return InputSigningParameters(path, inputdata, nodes, configmanager) elif path == ['identify'] and operation != 'retrieve': diff --git a/confluent_server/confluent/plugins/hardwaremanagement/redfish.py b/confluent_server/confluent/plugins/hardwaremanagement/redfish.py index 62bc2b26..c3214e5a 100644 --- a/confluent_server/confluent/plugins/hardwaremanagement/redfish.py +++ b/confluent_server/confluent/plugins/hardwaremanagement/redfish.py @@ -601,6 +601,8 @@ class IpmiHandler: return await self.handle_sysconfig() elif self.element[1:3] == ['system', 'advanced']: return await self.handle_sysconfig(True) + elif self.element[1:3] == ['system', 'certificate_authorities']: + return await self.handle_cert_authorities() elif self.element[1:3] == ['system', 'clear']: return await self.handle_sysconfigclear() elif self.element[1:3] == ['management_controller', 'clear']: @@ -616,17 +618,26 @@ class IpmiHandler: 'Decoding an alert is not implemented for redfish') async def handle_cert_authorities(self): + uefi = False + if self.element[1] == 'system': + uefi = True if len(self.element) == 3: if self.op == 'read': - async for cert in self.ipmicmd.get_trusted_cas(): + if uefi: + trusted = self.ipmicmd.get_trusted_uefi_cas + else: + trusted = self.ipmicmd.get_trusted_cas + async for cert in trusted(): await self.output.put(msg.ChildCollection(cert['id'])) elif self.op == 'update': cert = self.inputdata.get_pem(self.node) - await self.ipmicmd.add_trusted_ca(cert) + atc = self.ipmicmd.add_trusted_uefi_ca if uefi else self.ipmicmd.add_trusted_ca + await atc(cert) elif len(self.element) == 4: certid = self.element[-1] if self.op == 'read': - async for certdata in self.ipmicmd.get_trusted_cas(): + trusted = self.ipmicmd.get_trusted_uefi_cas if uefi else self.ipmicmd.get_trusted_cas + async for certdata in trusted(): if certdata['id'] == certid: await self.output.put(msg.CertificateAuthority( pem=certdata['pem'], @@ -634,7 +645,8 @@ class IpmiHandler: subject=certdata['subject'], san=certdata.get('san', None))) elif self.op == 'delete': - await self.ipmicmd.del_trusted_ca(certid) + deltc = self.ipmicmd.del_trusted_uefi_ca if uefi else self.ipmicmd.del_trusted_ca + await deltc(certid) return async def handle_certificate(self):