Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / e5a99777b8710cdcc82bffb25a7a248e18705e2d
commite5a99777b8710cdcc82bffb25a7a248e18705e2d[log] [tgz]
authorAlbert Zhang <zhanghaodi@inspur.com>Tue Jun 15 17:53:56 2021 +0800
committerEd Tanous <ed@tanous.net>Fri Jun 18 18:19:19 2021 +0000
treea04425d3aebfc7dc778edfd76927c7703099d473
parent0256b69420e2b99eb0494334da71dd50f457a8e8 [diff]
Redfish: Allow disabling and enabling SSH

This patch adds support for disabling and enabling SSH using
Redfish API.

Tested:Validator passes

1.Disabled SSH from Redfish and verified cannot open a new SSH
connection to the machine, but the original SSH connection still
takes effect and verified ProtocolEnabled is false for SSH.

 curl -k -H "X-Auth-Token: $token" -X  GET
 https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol/
 {
  "@odata.id": "/redfish/v1/Managers/bmc/NetworkProtocol",
  ...
  "SSH": {
    "Port": 22,
    "ProtocolEnabled": true
  },
  ...
 }

 curl -k -H "X-Auth-Token: $token" -X PATCH '-d
 {"SSH": {"ProtocolEnabled": false}}'
 https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol/

 Open a new SSH connection:
 sudo ssh username@<IP>
 ssh: connect to host <IP> port 22: Connection refused

 curl -k -H "X-Auth-Token: $token" -X  GET
 https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol/
 {
  "@odata.id": "/redfish/v1/Managers/bmc/NetworkProtocol",
  ...
  "SSH": {
    "Port": 22,
    "ProtocolEnabled": false
  },
  ...
 }

 D-bus has changed to :

 busctl introspect xyz.openbmc_project.Control.Service.Manager
 /xyz/openbmc_project/control/service/dropbear
 NAME                   TYPE      SIGNATURE RESULT/VALUE FLAGS
 ...                    ...       ...
 xyz.openbmc_project.Control.Service.Attributes       interface
 .Enabled                property  b    false  emits-change writable
 .Masked                 property  b    false  emits-change writable
 .Running                property  b    false  emits-change writable
 ...

2.Abled SSH from Redfish, verified can open a new SSH
connection to the machine and ProtocolEnabled is true for SSH.

 curl -k -H "X-Auth-Token: $token" -X  GET
 https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol/
 {
  "@odata.id": "/redfish/v1/Managers/bmc/NetworkProtocol",
  ...
  "SSH": {
    "Port": 22,
    "ProtocolEnabled": false
  },
  ...
 }

 curl -k -H "X-Auth-Token: $token" -X PATCH '-d
 {"SSH": {"ProtocolEnabled": false}}'
 https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol/

 Open a new SSH connection:
 sudo ssh username@<IP>
 Successfully connected

 curl -k -H "X-Auth-Token: $token" -X  GET
 https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol/
 {
  "@odata.id": "/redfish/v1/Managers/bmc/NetworkProtocol",
  ...
  "SSH": {
    "Port": 22,
    "ProtocolEnabled": true
  },
  ...
 }

 D-bus has changed to :

 busctl introspect xyz.openbmc_project.Control.Service.Manager
 /xyz/openbmc_project/control/service/dropbear
 NAME                   TYPE      SIGNATURE RESULT/VALUE FLAGS
 ...                    ...       ...
 xyz.openbmc_project.Control.Service.Attributes       interface
 .Enabled                property  b    true  emits-change writable
 .Masked                 property  b    false  emits-change writable
 .Running                property  b    true  emits-change writable
 ...

Signed-off-by: Albert Zhang <zhanghaodi@inspur.com>
Change-Id: Ifd80db4d33934e83d4e5f337e5dfd02b4ba39018
1 file changed
tree: a04425d3aebfc7dc778edfd76927c7703099d473
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .shellcheck
  15. bmcweb.service.in
  16. bmcweb.socket
  17. bmcweb_config.h.in
  18. build_x86.sh
  19. build_x86_docker.sh
  20. COMMON_ERRORS.md
  21. DEVELOPING.md
  22. Dockerfile
  23. Dockerfile.base
  24. LICENCE
  25. MAINTAINERS
  26. meson.build
  27. meson_options.txt
  28. OEM_SCHEMAS.md
  29. OWNERS
  30. pam-webserver
  31. README.md
  32. Redfish.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

  • Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
  • An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
  • Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
  • An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
  • SSL key generation at runtime. See the configuration section for details.
  • Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
  • Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/meson_options.txt and then compiling. For example, meson <builddir> -Dkvm=disabled ... followed by ninja in build directory. The option names become C++ preprocessor symbols that control which code is compiled into the program.

Compile bmcweb with default options:

meson builddir
ninja -C builddir

Compile bmcweb with yocto defaults:

meson builddir -Dbuildtype=minsize -Db_lto=true -Dtests=disabled
ninja -C buildir

If any of the dependencies are not found on the host system during configuration, meson automatically gets them via its wrap dependencies mentioned in bmcweb/subprojects.

Enable/Disable meson wrap feature

meson builddir -Dwrap_mode=nofallback
ninja -C builddir

Enable debug traces

meson builddir -Dbuildtype=debug
ninja -C builddir

Generate test coverage report:

meson builddir -Db_coverage=true -Dtests=enabled
ninja coverage -C builddir test

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

  • is issued by C=US, O=OpenBMC, CN=testhost,
  • is valid for 10 years,
  • has a random serial number, and
  • is signed using the SHA-256 algorithm.