4. WBEM client library API

The WBEM client library API supports issuing WBEM operations to a WBEM server, using the CIM operations over HTTP (CIM-XML) protocol defined in the DMTF standards DSP0200 and DSP0201.

This chapter has the following sections:

  • WBEM operations - Class WBEMConnection is the main class of the WBEM client library API and is used to issue WBEM operations to a WBEM server.
    • WBEM Operation recording - Class WBEMConnection includes the capability to optionally record the WBEMConnection method calls that communicate with a WBEM server including creating yaml files for test generation and logging using the Python logging facility.
  • CIM objects - Python classes for representing CIM objects (instances, classes, properties, etc.) that are used by the WBEM operations as input or output.
  • CIM data types - Python classes for representing values of CIM data types.
  • Conversion functions - Conversion functions related to CIM objects and CIM data types.
  • CIM status codes - CIM status codes returned by failing WBEM operations.
  • Logging - Logging of WBEM operations.
  • Exceptions - Exceptions specific to pywbem that may be raised.
  • Statistics - Statistics classes to gather information on wbem operation performance.
  • WBEM Operation recorder - Python classes that implement the operation recorder functions that are used by WBEMConnection.
  • Value mappings - Utility class for mapping the values of CIM elements qualified with ValueMap and Values.
  • Security considerations - Information about authentication types and certificates.

A number of these topics apply also to the other APIs of the pywbem package.

4.1. WBEM operations

4.1.1. WBEMConnection

4.1.2. WBEM Operation recording

The WBEM client library API provides the possibility to record the WBEM operations that are executed on a connection. WBEM Operation recording uses the classes and subclasses defined in WBEM Operation recorder.

This is disabled by default and can be enabled by adding recorders to a WBEMConnection with the method add_operation_recorder().

Typical usage scenarios for various operation recorders are the tracing of WBEM operations, tracing of interactions with a WBEM server, or the generation of test cases.

Please not that the method of activating operation recorders changed starting with pywbem 0.11.0 and the addition of a second recorder. See add_operation_recorder() for more information.

This adds the recorder defined in the method call to a list of active recorders in WBEMConnection. All active recorders are called for each WBEMConnection method that sends information to the WBEM server.

A single recorder can be be disabled with disable() method and enabled with enable() method.

The logger names for the operations and http loggers must be defined using the :class:~pywbem.`PywbemLoggers` class to define usable loggers because the pywbem loggers include logging attributes in addition to the standard python logger attributes. This is done with the method create_logger() which defines one or more loggers from the input parameters. There is also a convience method create_loggers() which will define multiple pywbem logger definitions from a string definition that could be used with command line tools.

The following example shows defining loggers for both http and operations and adding activating the LogOperationRecorder in WBEMConnection.

# set the python logger facility to output at the DEBUG level
logger.setLevel(logging.DEBUG)

# Define the parameters of the LogOperationRecorder
# using one of the methods in the PywbemLoggers class
PywbemLoggers.create_logger('all',
                            log_dest='file',
                            log_detail_level='min'
                            log_filename='test.log')   # define both loggers

# Create the connection and enable the logger
conn = WBEMConnection(...)
conn.add_operation_recorder(LogOperationRecorder())
# The LogOperationRecorder is now active and writing logs to stderr.

The following example activates and enables both recorders:

# To add both recorders
logger.setLevel(logging.DEBUG)
PywbemLoggers.create_logger('log')   # define only the log logger
conn = WBEMConnection(...)
log_recorder = LogOperationRecorder()
conn.add_operation_recorder(log_recorder)
yamlfp = TestClientRecorder.open_file(self.yamlfile, 'a')
conn.add_operation_recorder(TestClientRecorder(yamlfp))

# Both TestClientRecorder and LogOperationRecorder are be
# active, enabled and recording
# To change the enabled state of either recorder, use the enabled/disabled
# methods of the Recorder
log_recorder.disable()   # disables recording to the log

Activated loggers can be computing-wise expensive so it is best not to activate either logger unless they are to be used for that specific WBEMConnection.

The enable() and disable() methods simply set flags to bypass creating the final recorder output so activating and disabling is still more compute-wise expensive than not activating a recorder at all.

The LogOperationRecorder is a more complete mechanism than the debug in that it records information on operations and HTTP interactions with a WBEM server to a log destination defined through PywbemLoggers using the python logging facility. This information includes the following:

  1. If operations logging is set (the log component == ‘ops’):
    1. Records the method input parameters
    2. Records either all or a fixed length of the response values with an optional maximum length attribute because this log entry can become enormous if it records complete responses.
    3. Records all exceptions
  2. If http logging is set (the log component == ‘http’):
    1. Records the HTTP attributes and data of the request
    2. Records the HTTP attributes and data of the response with an optional max length
  1. If the log component = ‘all’ both operations and http are logged.

In addition to the method and HTTP information, the parameters of each WBEM connection are also logged including an id so that method logs can be linked back to the WBEM connection.

The PywbemLoggers allows defining loggers to output the logs to either stderr or a file based on the create_logger() log_dest parameter.

4.2. CIM objects

4.2.1. CIMInstanceName

4.2.2. CIMInstance

4.2.3. CIMClassName

4.2.4. CIMClass

4.2.5. CIMProperty

4.2.6. CIMMethod

4.2.7. CIMParameter

4.2.8. CIMQualifier

4.2.9. CIMQualifierDeclaration

4.3. CIM data types

4.4. Conversion functions

This section describes conversion functions related to CIM objects and CIM data types.

4.5. CIM status codes

4.6. Exceptions

4.7. Statistics

4.8. Logging

4.9. WBEM Operation recorder

The WBEM client library API includes the abstract base class BaseOperationRecorder from which operation recorders can be written that perform specific recording tasks.

Users can write their own operation recorder classes based upon the abstract base class BaseOperationRecorder.

The WBEM client library API provides the following operation recorder classes:

Class Purpose
TestClientRecorder Generate test cases for the test_client unit test module.
LogOperationRecorder Generate logs using the python logging facitlity for WBEMConnection methods that communicate with a WBEM server.

4.10. Value mappings

4.11. Security considerations

4.11.1. Authentication types

Authentication is the act of establishing the identity of a user on the client side to the server, and possibly also of establishing the identity of a server to the client.

There are two levels of authentication in CIM-XML:

  • TLS/SSL level authentication (only when HTTPS is used):

    This kind of authentication is also known as transport level authentication. It is used during the TLS/SSL handshake protocol, before any HTTP requests flow.

    In almost all cases (unless an anonymous cipher is used), this involves an X.509 certificate that is presented by the server (therefore called server certificate) and that allows the client to establish the identity of the server.

    It optionally involves an X.509 certificate that is presented by the client (therefore called client certificate) and that allows the server to establish the identity of the client or even of the client user, and thus can avoid the use of credentials in the HTTP level authentication.

    If a client certificate is used, the authentication scheme at the TLS/SSL level is called 2-way authentication (also known as client authentication or mutual SSL authentication). If a client certificate is not used, the authentication scheme is called 1-way authentication (also known as SSL authentication).

    Userid/password credentials do not play any role in TLS/SSL level authentication.

  • HTTP level authentication:

    This kind of authentication is used in HTTP/HTTPS requests and responses (in case of HTTPS, after the TLS/SSL handshake protocol has completed).

    In case of Basic Authentication and Digest Authentication (see RFC2617), it involves passing credentials (userid and password) via the Authenticate and WWW-Authenticate HTTP headers. In case of no authentication, credentials are not passed.

    A client can either provide the Authenticate header along with a request, hoping that the server supports the authentication scheme that was used.

    A client can also omit that header in the request, causing the server to send an error response with a WWW-Authenticate header that tells the client which authentication types are supported by the server (also known as a challenge). The client then repeats the first request with one of the supported authentication types.

    HTTP is extensible w.r.t. authentication schemes, and so is CIM-XML. However, pywbem only supports Basic Authentication and no authentication.

    X.509 certificates do not play any role in HTTP level authentication.

HTTP/HTTPS knows a third level of authentication by the use of session cookies. CIM-XML does not define how cookies would be used, and pywbem does not deal with cookies in any way (i.e. it does not pass cookies provided in a response into the next request).

The following table shows the possible combinations of protocol, TLS/SSL level and HTTP level authentication schemes, which information items need to be provided to the WBEM client API, and whether the combination is supported by pywbem:

Protocol SSL auth. HTTP auth. Credentials Client cert. CA cert. Supported
HTTP N/A None No No No Yes (1)
HTTP N/A Basic Yes No No Yes (2)
HTTP N/A Digest Yes No No No
HTTPS 1-way None No No Yes (3) Yes (1)
HTTPS 1-way Basic Yes No Yes (3) Yes
HTTPS 1-way Digest Yes No Yes (3) No
HTTPS 2-way None No Yes Yes (3) Yes (4)
HTTPS 2-way Basic Yes Yes Yes (3) Yes
HTTPS 2-way Digest Yes Yes Yes (3) No

Notes:

  1. This option does not allow a server to establish the identity of the user. Its use should be limited to environments where network access is secured.
  2. The use of HTTP Basic Authentication is strongly discouraged, because the password is sent unencrypted over the network.
  3. A CA certificate is needed, unless server certificate verification is disabled via the no_verification parameter (not recommended), or unless an anonymous cipher is used for the server certificate (not recommended).
  4. This is the most desirable option from a security perspective, if the WBEM server is able to establish the user identity based on the client certificate.

The protocol and authentication types that can be used on a connection to a WBEM server are set by the user when creating the WBEMConnection object:

  • The scheme of the URL in the url parameter controls whether the HTTP or HTTPS protocol is used.
  • The cred parameter may specify credentials (userid/password). If specified, pywbem uses them for Basic Authentication at the HTTP level. Pywbem provides an Authenticate HTTP header on each request, and also handles server challenges transparently to the user of the WBEM client API, by retrying the original request.
  • The x509 parameter may specify an X.509 client certificate and key. If specified, pywbem uses 2-way authentication; otherwise it uses 1-way authentication at the TLS/SSL level.
  • The ca_certs parameter may specify the location of X.509 CA certificates that are used to validate the X.509 server certificate returned by the WBEM server. If not specified, pywbem assumes default locations for these certificates.

It is important to understand which side actually makes decisions about security-related parameters: The client only decides whether HTTP or HTTPS is used, and whether the server certificate is verified. The server decides everything else: Which HTTP authentication scheme is used (None, Basic, Digest), whether an X.509 client certificate is requested from the client and if so, whether it tolerates a client not providing one. In addition, when HTTPS is used, the client proposes cipher suites it supports, and the server picks one of them.

Therefore, the cred and x509 parameters do not control the authentication scheme that is actually used, but merely prepare pywbem to deal with whatever authentication scheme the WBEM server elects to use.

WBEM servers typically support corresponding configuration parameters.

4.11.2. Verification of the X.509 server certificate

When using HTTPS, the TLS/SSL handshake protocol requires that the server always returns an X.509 server certificate to the client (unless anonymous ciphers are used, which is not recommended).

Pywbem performs the following verifications on the server certificate returned by the WBEM server:

  • Validation of the server certificate against the CA certificates specified in the ca_certs parameter. This is done by the TLS/SSL components used by pywbem.
  • Validation of the server certificate’s expiration date, based on the system clock. This is done by the TLS/SSL components used by pywbem.
  • Validation of the hostname, by comparing the Subject attribute of the server certificate with the hostname specified in the url parameter. This is done by pywbem itself.
  • Calling the validation function specified in the verify_callback parameter, if any, and looking at its validation result.

If any of these validations fails, the WBEM operation methods of the WBEMConnection object raise a pywbem.AuthError.

If verification was disabled via the no_verification parameter, none of these validations of the server certificate happens.

4.11.3. Use of X.509 client certificates

When using HTTPS, the TLS/SSL handshake protocol provides the option for the client to present an X.509 certificate to the server (therefore called client certificate).

This procedure is initiated by the server, by requesting that the client present a client certificate. If the client does not have one (for example, because the x509 parameter was not specified in pywbem), it must send an empty list of certificates to the server. Depending on the server configuration, the server may or may not accept an empty list. If a client certificate is presented, the server must validate it.

The server can support to accept the user identity specified in the client certificate as the user’s identity, and refrain from sending HTTP challenges that request credentials.

4.11.4. Authentication errors

The operation methods of WBEMConnection raise pywbem.AuthError in any of these situations:

  • When client side verification of the X.509 server certificate fails.
  • When the WBEM server returns HTTP status 401 “Unauthorized” and the retries in the client are exhausted. The server typically returns that status in any of these situations:
    • no authorization information provided by client
    • wrong HTTP authentication scheme used by client
    • authentication failed
    • user is not authorized to access resource

4.11.5. Default CA certificate paths