Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 402b5717ba59dbee0195d11ec9162ee88dc1baa6
commit402b5717ba59dbee0195d11ec9162ee88dc1baa6[log] [tgz]
authormanojkiraneda <manojkiran.eda@gmail.com>Fri Dec 13 17:07:09 2019 +0530
committerRatan Gupta <ratagupt@linux.vnet.ibm.com>Fri May 01 07:00:26 2020 +0000
tree3cbd6d207239326ec07906a2780acecd9f4eda5f
parent3fff6206a68bd50ea8750aa0d0321d43f9f06783 [diff]
Implement GetLockList function in Lock Service

- This commit implements the GetLockList rest API, by  which
  any external client(with admin privelege) can get a list of
  locks obtained by providing the list of sessionID's as input.

TestedBy:

1. Get the session ID from the Session Service

curl -k -H "X-Auth-Token: $bmc_tokens" -X GET https://<ip>/redfish/v1/SessionService/Sessions/
{
  "@odata.context": "/redfish/v1/$metadata#SessionCollection.SessionCollection",
  "@odata.id": "/redfish/v1/SessionService/Sessions/",
  "@odata.type": "#SessionCollection.SessionCollection",
  "Description": "Session Collection",
  "Members": [
    {
      "@odata.id": "/redfish/v1/SessionService/Sessions/qM4D0VfZt3"
    },
    {
      "@odata.id": "/redfish/v1/SessionService/Sessions/bjYCiBSCIh"
    },
    {
      "@odata.id": "/redfish/v1/SessionService/Sessions/LkfHvJFggY"
    },
    {
      "@odata.id": "/redfish/v1/SessionService/Sessions/6RKP0aN5Gi"
    }
  ],
  "Members@odata.count": 4,
  "Name": "Session Collection"
}

2. Use the GetLockList API to obtain the locks owned by a particular
session.

curl -k -H "X-Auth-Token:$bmc_tokens" -XPOST -H "Content-type: application/json" -d
'{"SessionIDs": ["qM4D0VfZt3","bjYCiBSCIh"]}' https://127.0.0.1:2443/ibm/v1/HMC/LockService/Actions/LockService.GetLockList
{
  "Records": [
    {
      "HMCID": "hmc-id",
      "LockType": "Read",
      "ResourceID": 256,
      "SegmentFlags": [
        {
          "LockFlag": "LockSame",
          "SegmentLength": 3
        },
        {
          "LockFlag": "DontLock",
          "SegmentLength": 4
        }
      ],
      "SessionID": "qM4D0VfZt3",
      "TransactionID": 1
    }
  ]
}

Signed-off-by: manojkiraneda <manojkiran.eda@gmail.com>
Change-Id: I9375e2927938ab682df06ef60c823b279a7efead
2 files changed
tree: 3cbd6d207239326ec07906a2780acecd9f4eda5f
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .gitignore
  10. bmcweb.service.in
  11. bmcweb.socket
  12. build_x86.sh
  13. cmake-format.json
  14. CMakeLists.txt
  15. CMakeLists.txt.in
  16. config.h.in
  17. DEVELOPING.md
  18. JenkinsFile
  19. LICENCE
  20. MAINTAINERS
  21. pam-webserver
  22. README.md
  23. 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/CMakeLists.txt and then compiling. For example, cmake -DBMCWEB_ENABLE_KVM=NO ... followed by make. The option names become C++ preprocessor symbols that control which code is compiled into the program.

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.