Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-certificate-manager / 7e2797ee0a595cb0f3d044c1b58b8ed4f3f56f99
commit7e2797ee0a595cb0f3d044c1b58b8ed4f3f56f99[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Fri Dec 03 13:37:07 2021 -0600
committerPatrick Williams <patrick@stwcx.xyz>Fri Dec 03 14:49:46 2021 -0600
tree2f9303fcc0f9f04a428074a03b2a99a53c1b9dfa
parent5f0f6d405faa7e165a9ad2b8c98541a5242e7140 [diff]
fix unused parameter warnings

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