Pegasus Enhancement Proposal (PEP)

PEP #: 277

Title: Recommended OpenPegasus 2.6.0 Build and Configuration Options for Selected Platforms

Version: 1.3

Created: 18 September 2006

Authors: Denise Eckstein

Status:  Approved


Abstract: This PEP defines a set of recommended options for building, testing and running OpenPegasus 2.6.0 on a selected set of platforms. In this version of the PEP, platform-specific configuration options have been documented for the following platforms: Linux, HP-UX and OpenVMS.

Note 1: The recommendations defined in this PEP are not intended to document the feature set included in any vendor's OpenPegasus-based product.  Rather, the purpose of this PEP is to provide input to vendors when making product decisions.


Definition of the Problem

OpenPegasus supports a large number of build and runtime options. Determining which options to use can be challenging. The purpose of this PEP is to simplify the build, testing and administration of OpenPegasus 2.6.0 by providing a recommended, tested set of options.

 

Proposed Solution

Security Considerations

  1. To avoid introducing security vulnerabilities, vendors must never ship providers incompatible with the security assumptions used in their deployment. For example, providers designed for a single-user deployment that don't perform authorization must not be shipped with a CIM Server that expects the providers to perform authorization. Note that this authorization burden is considerably lighter if the provider is registered as 'run as requestor' and if the CIM Server enables that feature. See PEP#223 - Security Coding Guidelines for additional details.
  2. Vendors should ensure they configure the CIM Server consistently with the security requirements of their deployment.

Terminology Notes

  1. In this document, the term "Not Set" is used to indicate that the a value for the environment variable has not been defined.  "Set" is used to indicate that the value must be defined, but the actual value of the variable is not checked.

Environment Variable Settings for Building OpenPegasus 2.6.0

Definitions

ICU_INSTALL
ICU_ROOT
OPENSSL_BIN
OPENSSL_HOME
PEGASUS_CIM_SCHEMA
PEGASUS_CLASS_CACHE_SIZE
PEGASUS_DEBUG
PEGASUS_DEFAULT_USERCTXT_REQUESTOR
PEGASUS_DEFAULT_ENABLE_OOP
PEGASUS_DISABLE_CQL
PEGASUS_DISABLE_DEPRECATED_INTERFACES
PEGASUS_DISABLE_INSTANCE_QUALIFIERS
PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET
PEGASUS_DISABLE_PERFINST
PEGASUS_DISABLE_PRIVILEGED_TESTS
PEGASUS_DISABLE_PROV_USERCTXT
PEGASUS_DISABLE_PROV_USERCTXT_CIMSERVER
PEGASUS_DISABLE_PROV_USERCTXT_DESIGNATED
PEGASUS_DISABLE_PROV_USERCTXT_PRIVILEGED
PEGASUS_DISABLE_PROV_USERCTXT_REQUESTOR
PEGASUS_EMANATE_INCLUDE_DIR
PEGASUS_EMANATE_LIB_DIR
PEGASUS_EMBEDDED_INSTANCE_SUPPORT
PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER
PEGASUS_ENABLE_COMPRESSED_REPOSITORY
PEGASUS_ENABLE_EXECQUERY
PEGASUS_ENABLE_EMAIL_HANDLER
PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER
PEGASUS_ENABLE_OBJECT_NORMALIZATION
PEGASUS_ENABLE_REMOTE_CMPI
PEGASUS_ENABLE_SLP
PEGASUS_ENABLE_SORTED_DIFF
PEGASUS_ENABLE_SYSTEM_LOG_HANDER
PEGASUS_ENABLE_SSLV2
PEGASUS_ENABLE_USERGROUP_AUTHORIZATION
PEGASUS_EXTRA_C_FLAGS
PEGASUS_EXTRA_CXX_FLAGS
PEGASUS_EXTRA_LINK_FLAGS
PEGASUS_HAS_MESSAGES
PEGASUS_HAS_SSL
PEGASUS_HOME
PEGASUS_INDICATIONS_Q_THRESHOLD
PEGASUS_MAX_THREADS_PER_SVC_QUEUE
PEGASUS_ROOT
PEGASUS_NET_SNMP_INCLUDE_DIR
PEGASUS_NET_SNMP_DIR
PEGASUS_NOASSERTS
PEGASUS_OPENSLP_HOME
PEGASUS_PAM_AUTHENTICATION
PEGASUS_PLATFORM
PEGASUS_REPOSITORY_MODE
PEGASUS_SLP_REG_TIMEOUT
PEGASUS_SNIA_EXTENSIONS
PEGASUS_TEST_ISGROUP_GROUP/PEGASUS_TEST_ISGROUP_USER_SUCCESS/PEGASUS_TEST_ISGROUP_USER_FAILURE
PEGASUS_TEST_USER_DEFINED
PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS
PEGASUS_USE_DEBUG_BUILD_OPTIONS
PEGASUS_USE_EMANATE
PEGASUS_USE_NET_SNMP
PEGASUS_USE_OPENSLP
PEGASUS_USE_PAM_STANDALONE_PROC
PEGASUS_USE_RELEASE_CONFIG_OPTIONS
PEGASUS_USE_RELEASE_DIRS
PEGASUS_USE_SYSLOGS
PEGASUS_WINDOWS_SDK_HOME

Examples Building a Linux IA32 (#IA64) Development/Debug Version

Building a Linux IA32 (#IA64) Production Release Version

Environment Variable Settings for Running OpenPegasus 2.6.0

Definitions

PEGASUS_HOME
PEGASUS_MSG_HOME

Configuration Properties

Notation

This section describes the notation used to define the configuration properties.

Definitions

authorizedUserGroups
daemon
enableAssociationTraversal
enableAuthentication
enableBinaryRepository
enableHttpConnection
enableHttpsConnection
enableIndicationService
enableNamespaceAuthorization
enableNormalization
enableRemotePrivilegedUserAccess
enableSSLExportClientVerification
enableSubscriptionsForNonprivilegedUsers
excludeModulesFromNormalization
exportSSLTrustStore
forceProviderProcesses
home
httpPort
httpsPort
logdir
logLevel
maxProviderProcesses
messageDir
providerDir
repositoryDir
repositoryIsDefaultInstanceProvider
    Description: If true, the Repository functions as the Instance Provider for all classes for which there is not an explicitly registered Provider. This flag is also used to control the behavior of the repository when processing association operators.
    Recommended Default Value (Development Build):  true
    Recommended Default Value (Release Build):  false
    Recommend To Be Fixed/Hidden (Development Build):  No/No
    Recommend To Be Fixed/Hidden (Release Build):  No/Yes
    Dynamic?:  No
    Considerations:  This flag can be used to configure the CIM Server to allow the Repository to be used by CIM Clients and CIM Providers as a dynamic data store. The setting of this flag will significantly affect CIM Server behavior as viewed by the CIM Client.
    The following issues should be considered when setting repositoryIsDefaultInstanceProvider=true:
    The following issues should be considered when setting repositoryIsDefaultInstanceProvider=false: Source Configuration File:  Pegasus/Config/RepositoryPropertyOwner.cpp
shutdownTimeout
slp
sslCertificateFilePath
sslClientVerificationMode
sslKeyFilePath
sslTrustStore
sslTrustStoreUserName
traceComponents
traceFilePath
traceLevel

Configuration Constants

Definitions

static char CURRENT_CONFIG_FILE [] =
static char PLANNED_CONFIG_FILE [] =
static char CIMSERVER_START_FILE [] =

Configuration Macros

Definitions

PEGASUS_SSLCLIENT_CERTIFICATEFILE
PEGASUS_SSLCLIENT_RANDOMFILE
PEGASUS_SSLSERVER_RANDOMFILE
PEGASUS_LOCAL_AUTH_DIR
PEGASUS_LOCAL_DOMAIN_SOCKET_PATH

Version History

Version Date Author Change Description
1.0 18 Sep 2006 Denise Eckstein Initial Submission based on PEP 237.
1.1 14 Dec 2006 Denise Eckstein
  • Added PEGASUS_DEFAULT_USERCTXT_REQUESTOR.
  • Noted that the PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER variable must be set to "true" or "false".
  • Since MessageLoader is not part of the SDK, removed the following from the Consideration text of PEGASUS_MSG_HOME: "Use of the PEGASUS_MSG_HOME environment is not recommended in a production environment, CIM Client application developers are encouraged to use MessageLoader::setPegasusMsgHome(String home) to explicitly set the directory where the ICU resource bundles are located."
  • 1.2 01 Jan 2007 Denise Eckstein
  • Added PEGASUS_EMBEDDED_INSTANCE_SUPPORT.
  • Added PEGASUS_SLP_REG_TIMEOUT.
  • Removed definition of PEGASUS_DISABLE_SLP.  This variable was removed in 2.5.1.
  • Fixed formatting of PEGASUS_USE_OPENSLP entry.
  • Added PEGASUS_TEST_ISGROUP_GROUP/ PEGASUS_TEST_ISGROUP_USER_SUCCESS/ PEGASUS_TEST_ISGROUP_USER_FAILURE
  • 1.2.1 01 Jan 2007 Denise Eckstein
  • Fixed formatting problem introduced in version 1.2.
  • 1.3 05 Jan 2007 Denise Eckstein
  • Changes per Ballot 129 Comments
    • Changed references to "Pegasus" to "OpenPegasus".
    • Changed "Default" and "Recommended" settings for PEGASUS_ENABLE_SORTED_DIFF from "Not Set" to "true".
    • Changed "Default" and "Recommended (Development Build)" for PEGASUS_ENABLE_USERGROUP_AUTHORIZATION from "Set" to "Not Set".
    • Modified description of PEGASUS_PLATFORM.
    • Modified description of PEGASUS_SLP_REG_TIMEOUT.
    • Added Considerations (2) & (3) to PEGASUS_SLP_REG_TIMEOUT.
    • Fixed font in PEGASUS_SNIA_EXTENSIONS and "bold" in PEGASUS_TEST_ISGROUP_GROUP
    • Changed "Recommended Default Value (Release Build)" for httpPort from "blank" to "5988".
    • Changed "Recommended Default Value (Release Build)" for httpsPort from "blank" to "5989".
    • Approved - Ballot 129 - Jan 10, 2007

     


    Copyright (c) 2004 EMC Corporation; Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation
    Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; EMC Corporation; Symantec Corporation; The Open Group.

    Permission is hereby granted, free of charge, to any person obtaining a copy  of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED  "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


    Template last modified: January 20th 2004 by Martin Kirk
    Template version: 1.6