Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-certificate-manager / e129be3b566a187f42e4ab45bccfb10d35dc3d71
commite129be3b566a187f42e4ab45bccfb10d35dc3d71[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Fri Apr 30 20:35:19 2021 -0500
committerPatrick Williams <patrick@stwcx.xyz>Fri Apr 30 20:38:27 2021 -0500
treefc357951460b3c50a277430ad98297d81af00d52
parent86a31ba5942bdd69d22446f756e32d949276e613 [diff]
use new sdbus++ camelcase for CSR.

Change I17a8d7479556596a3cf252b3f4eae9c8df547189 will change
how sdbus++ generates names which start with an acronym.
Prepare for this by keying off the SDBUSPP_NEW_CAMELCASE
define to use the new format.

Changes:
    cSR() -> csr()

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I9adb628d7d064af9f65d37aebe99e06532690163
4 files changed
tree: fc357951460b3c50a277430ad98297d81af00d52
  1. bmc-vmi-ca/
  2. test/
  3. .clang-format
  4. .gitignore
  5. .lcovrc
  6. argument.cpp
  7. argument.hpp
  8. bootstrap.sh
  9. certificate.cpp
  10. certificate.hpp
  11. certs_manager.cpp
  12. certs_manager.hpp
  13. configure.ac
  14. csr.cpp
  15. csr.hpp
  16. LICENSE
  17. mainapp.cpp
  18. MAINTAINERS
  19. Makefile.am
  20. Makefile.am.include
  21. README.md
  22. watch.cpp
  23. watch.hpp
README.md

phosphor-certificate-manager

Certificate management allows to replace the existing certificate and private key file with another (possibly CA signed) Certificate key file. Certificate management allows the user to install both the server and client certificates.

To Build

To build this package, do the following steps:

    1. ./bootstrap.sh
    2. ./configure ${CONFIGURE_FLAGS}
    3. make

To clean the repository run `./bootstrap.sh clean`.

To Run

Multiple instances of phosphor-certificate-manager are usually run on the bmc to support management of different types of certificates.

Usage: ./phosphor-certificate-manager [options]
Options:
    --help            Print this menu
    --type            certificate type
                      Valid types: client,server,authority
    --endpoint        d-bus endpoint
    --path            certificate file path
    --unit=<name>     Optional systemd unit need to reload

Https certificate management

Purpose: Server https certificate

./phosphor-certificate-manager --type=server --endpoint=https \
    --path=/etc/ssl/certs/https/server.pem --unit=bmcweb.service

CA certificate management

Purpose: Client certificate validation

./phosphor-certificate-manager --type=authority --endpoint=ldap \
    --path=/etc/ssl/certs/authority --unit=bmcweb.service

LDAP client certificate management

Purpose: LDAP client certificate validation

./phosphor-certificate-manager --type=client --endpoint=ldap \
    --path=/etc/nslcd/certs/cert.pem

D-Bus Interface

phosphor-certificate-manager is an implementation of the D-Bus interface defined in this document.

D-Bus service name is constructed by "xyz.openbmc_project.Certs.Manager.{Type}.{Endpoint}" and D-Bus object path is constructed by "/xyz/openbmc_project/certs/{type}/{endpoint}".

Take https certificate management as an example.

./phosphor-certificate-manager --type=server --endpoint=https \
    --path=/etc/ssl/certs/https/server.pem --unit=bmcweb.service

D-Bus service name is "xyz.openbmc_project.Certs.Manager.Server.Https" and D-Bus object path is "/xyz/openbmc_project/certs/server/https".

Usage in openbmc/bmcweb

OpenBMC bmcweb exposes various REST APIs for certificate management on the BMC, which leverages functionalities of phosphor-certificate-manager via D-Bus.