Pegasus Enhancement Proposal (PEP)

PEP #: 103

Title: OpenPegasus Version 2.3 Release Readme file

Version: 1.2

Created: 12 November 2003

Authors: Karl Schopmeyer, Konrad Rzeszutek

Status: draft

Version History:

Version | Date | Author | Change Description
--- | --- | --- | ---
1.0 | 12 November 2003 | Karl Schopmeyer | Update from 2.2 Release notes. Converted to HTML
1.1 | March 10 2004 | Konrad Rzeszutek | Added sections describing SSL and PAM configuration
1.2 | April 2004 | Karl Schopmeyer | Update for Pegasus 2.3.2

Abstract: Installation, build, operation information on the Pegasus Platform Version 2.3 Release. Note that if this readme conflicts with the documentation in the release notes or interface definition documents for a particular release, those documents should be considered authorative. This is a simplified overview to act as an introduction to Pegasus.

OpenPegasus - A Manageability Services Broker for the DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for DMTF CIM objects written in C++ and supported by The Open Group

STATUS: Revised April 2004 for Pegasus release version 2.3.2

Table of Contents

Overview

Availability of Pegasus

Pegasus Major Components

Pegasus Supported Platforms

Pegasus Dependencies

The Pegasus Directory Structure

Installation

Building Pegasus

Populate the Repository

Registering Providers

The MU Utility

Notes about Building Pegasus on Linux

Notes on building Pegasus with SSL

Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++

Installing the Pegasus HTML Test Client

Development with Pegasus and Pegasus Tools

Client Development

Provider Development

Commands

Creating SSL certifications

Configuring Pegasus to use SSL

Configuring Pegasus to use PAM

Testing with ICU enabled

Documentation

Participate

# Overview

OpenPegasus (also referred to as Pegasus): Pegasus is an open-source CIM Server for based on the DMTF CIM/WBEM specifications. It is written in C++ and includes the Object manager (CIMOM), a set of defined interfaces, an implemenation of the CIMOperations over HTTP operations and their cimxml HTTP encodings, and Interface libraries for both client and providers. It is maintained consistent with the DMTF CIM and WBEM specifications except for exceptions noted in the documentation.

Pegasus is open source and is covered under the MIT open-source license.

Pegasus is being developed and maintained under the auspices of The Open Group. Pegasus is maintained under the license defined in the doc directory (LICENSE) of this release. This licensing is intended to support as wide a distribution as possible with minimal demands on the users.

More information on this project, access to the CVS, and documentation on Pegasus are available from the OpenGroup WEB site.

http://www.openpegaus.org

There are a number of separate documents representing the status and each release of Pegasus

- What's new for this release - See the PEPs (Pegasus Enhancement Procedures) release notes on the Pegasus web site and duplicated in the source top level directory.
- What's Broken and what was fixed - BUGS - See the ReleaseNotes for this release in the root directory and the web site as a Pegasus PEP and review the bugs in the Pegasus bug list maintained in bugzilla on the Pegasus web site.

The release notes for each release are available on the WEB site as Pegasus PEP documents and in the CVS top level directory for each release. See the release notes PEP for a definition of what is new or different for each Pegasus release

Release | Release Notes PEP
2.0 | None
2.1 | None
2.2 | PEP 57
2.3 | PEP 98
2.3.2 | PEP 150

# Availability of Pegasus

Pegasus is distributed as open source under the MIT open-source license. The distribution is available via CVS and snapshot images in tar and zip file formats on the web site. The source code from CVS can be found at the following Open Group CVS server;

cvs.opengroup.org:/cvs/MSB

using the password authenticating server option (pserve).

Anonymous access for read is with the name and password "anon" as follows:

> %export CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB

> %cvs login

When requested, enter the password "anon". The source tree is in the directory pegasus. To check out the complete Pegasus source tree just type:

cvs co pegasus

A Pegasus directory will be created under the current directory and populated with the complete source tree and documentation. To get the latest updates after a checkout just type this from Pegasus root:

cvs update -d

Active contributors to Pegasus have write access to the CVS repository. If you are interested in contributing back to the Pegasus project, (i.e. write (checkin) access to CVS) please request access from either Martin Kirk (m.kirk@opengroup.org) or Karl Schopmeyer (k.schopmeyer@opengroup.org).

# Pegasus Major Components

The major components of Pegasus are:

- Pegasus Server - WBEM/CIM Server with interfaces for providers and clients. The Pegasus server handles DMTF CIM Operations, DMTF CIM Indications in conjunction with providers. It provides overall management of the server iteself, the repository and providers that have been registered with the server.
- Pegasus Repositories - Today Pegasus provides a defined class repository interface and a simple file based class repository. It also includes an instance repository. Note that these repository were created for functionality, not efficiency. It is expected that they will be replaced with other implementations of the repository function as the need arises.
- Pegasus Client Library - Tools for building Pegasus clients based on the Pegasus C++ interfaces and using the WBEM HTTP/XML protocols or directly interfacing with Pegasus.
- Pegasus Test Clients - Simple test clients being developed as part of the Pegasus development process. These can be seen in the src/Clients directory and its subdirectories
- Pegasus HTML Test Client - To aid in testing we created a test client for Pegasus that uses a WEB server (ex. Apache) with a set of CGI modules and HTML to allow the entry of Pegasus operations from a WEB browser as forms and the receipt of the response as WEB pages. This has proven useful as a test tool and can be used for a wide variety of demonstrations.
- Pegasus Provider Managers - Pegasus incorporates the concept of pluggable provider managers allowing multiple provider managers with different provider interfaces. Today Pegasus includes the C++ provider interfaces and the CMPI C provider interface.
- Pegasus C++ Provider Interface Library - Interfaces for building Pegasus providers using the Pegasus C++ interfaces.
- Pegasus CMPI Provider Interface Library - Interfaces for building Pegasus providers using the CMPI defined C interfaces.
- Pegasus Providers - Providers to illustrate the use of Pegasus services including providers for test and demonstration. In addition to sample and test providers, there are a number of operational providers that manage particular DMTF defined classes such as the CIM_ComputerSystem class.
- Pegasus Control Providers - Special providers that require direct access back to the server for information -- these are considered Pegasus internal providers. There are several of this type of provider defined including configuration information, the DMTF interop classes ( Including namespace management).
- Pegasus MOF Compiler - Pegasus includes a compiler (cimmof) that is used to install MOF into Pegasus. This compiler operates as a Pegasus client using the running CIM Server to install MOF definitions. This means that MOF input may be delivered directly to the repository or to providers for classes which are registered for providers. There is also a standalone compiler (cimmofl) that writes directly to the repository. WARNING: The cimmofl compiler should be used with caution because it puts all objects defined in the MOF directly into the repository bypassing any defined provider processing. There are several
  potential problems with using cimmofl including 1) bypasses any provider processing to put information directly into the
  repository, 2) can cause repository corruption if it is executed simultaneous with the CIM Server using the repository 3) may
  put information into repository that is not available until the CIM Server is stopped and restarted.

We strongly encourage the use of cimmof instead of cimmofl, particularly in production.

# Pegasus Supported Platforms

Pegasus is regularly tested against a variety of platforms by the development group. The set of platforms and exact set of compilers for any given release is documented in the Release notes for that release (see the CVS source tree root directory or the Pegasus PEP defining the ReleaseNotes for any particular release).

Generally Pegasus is supported on the following Platforms and Compilers.

Platform and OS | Compilers
AIX | VisualAge C++ Version
HP-UX | HP aC++
Linux Itanium | gcc
Linux IA-32 | gcc (versions 2.9x and 3.xx)
Windows 2000 | Microsoft Visual C++ Ver 6 and Microsoft .Net compiler Version 7
Windows XP | Microsoft Visual C++ Ver. 6 and Microsoft .Net compiler Version 7

# Pegasus Dependencies

We have worked to minimize the dependence of Pegasus on other software packages and tools. Currently the Pegasus build process has the following dependencies:

1. GNUMAKE - To simplify the building of Pegasus across multiple platforms we have standardized on a set of build tools including: GNUMAKE. We are using GNUMAKE 3.79.1 successfully both in Windows and Linux environments.

GNUMAKE is available from :

http://www.gnu.org

NOTE: A set of the required tools for windows platforms is available on the openpegasus web site.

2. MU.EXE - To minimize the difference between Linux and Windows for GNUMAKE, we have created a utility called MU.exe. This utility is required for Pegasus make with ONLY Windows environment. It is provided as an alternative to requiring a number of UNIX utilities (SH, RM, etc.) on the windows platform and effectively provides the functions of these utilities that GNUMAKE needs. MU is not required on UNIX or LINUX platforms.

NOTE: The binary for MU.EXE is not distributed in the Pegasus bin directory. You must build it separately. MU source code is part of the distribution in the directory src/utils/MU with its own make file. You must compile MU before you initiate the Pegausu make.

NOTE: A copy of the binary is made available as a zip file on the Pegasus WEB site.

Again, MU is used ONLY if you are using Windows.

3. FLEX and BISON - These tools were used to develop the MOF compiler and WQL parser. Anybody intending to recompile the compiler or parser from scratch will be required to have these tools. They are only required if changes need to be made to the files for parsing and compiling.

4. DOC++ - The Pegasus documentation is taken from a combination of text files and the Pegasus header files themselves. This documentation is formatted with DOC++ and GAWK. These tools are required if the documentation is to be recreated but we expect that only the core team will be recreating documentation.

5. ICU Internationalization libraries - These libraries are used as the basis for message catalogs for message internationalization. See the ICU website (http://oss.software.ibm.com/icu/) for more information on these libraries

6. OpenSSL - If it is intended to use SSL on the communication protocol, the OpenSSL libraries are required.

# The Pegasus Directory Structure

Pegasus is distributed as a complete source directory structure that should be installed either from one of the snapshots or from CVS.

This structure is generally as follows:

Pegasus Source Structure

Pegasus Root directory (PEGASUS_ROOT environment variable)

- cgi Source for the Pegasus WEB Based Test client
  - cgi-bin CGI Directories for WEB demonstration. This directory is normally empty but can be populated from the runtime with the make from cgi.
  - htdocs HTML Pages for Pegasus WEB demonstration
- doc Miscellaneous Pegasus Documents.
  - apidoc - Source for the public api documentation.
  - DevManual Source and build files for developers' manual mak General make files (used by other makes)
- mak - Common make files for Pegasus compilation
- Dummy -
- InterfaceArchive -
- rpm - files for rpm installation for Linux
- Schemas - Schemas used in the installation of Pegasus. This includes currently released versions of the DMTF schemas in subdirectories (ex. CIM27) and Pegasus local Schemas (ex.
- src All Pegasus Source Files
  - ACEExample Test directrory with examples of the use of ACE (obsolete).
  - Clients Source for various test clients and demonstration clients.
  - CGICLIENT Pegasus test client that uses a WEB browser JAVA Java Client support modules
  - Pegasus - Core pegasus modules.
    - Client Pegasus Client API Tests depends tests
    - Common Pegasus Common Functions (C++ source and headers tests Test programs for the common functions
    - Compiler Pegasus MOF compiler
    - Config Pegasus Configuration functions
    - Consumer Indication Consumer class header
    - ControlProviders Implementation of Pegasus internal providers
    - ExportClient Client connect code for export of indications
    - ExportServer Server code for import of indications
    - Handler Indication handlers. Today this includes cimxml, SNMP and email handlers
    - HandlerService Common code for indication handler service
    - IndicationService Common service functions for indication subscription processing
    - Listener Common code that allows CIM Listeners to be created and connected.
    - Protocol Pegasus Client HTTP/XML Protocol Modules depends
    - Provider Pegasus Provider interface functions
    - ProviderManager Provider Manager service that manages providers
    - ProviderManager2 Pluggable Provider Manager service. Today this is not enabled by default It will become the Pegasus standard provider manager at some time in the future but for now, see the release notes if you want to enable it.
    - Repository Pegasus Repository Interfaces and Simple Repository tests
      - Tests for Repository Functions
    - Security Authentication and user support functions.
    - Server Pegasus Server Modules
    - WQL the WQL query language interpreter.
- Providers Pegasus test and required providers
  - generic A number of cross-platform providers
  - IndicationConsumer - Provider that consumes indications
  - Linux - A number of linux providers
  - ManagedSystem Providers associated with managing the Pegasus System
  - slp - Provider for slp service agent support
  - statistic - Providers for Pegasus statistics.
  - sample Sample providers for the major provider types.
  - testproviders
- Server Pegasus executable build
- slp - SLP agent libraries and test tools.
- Standard Includes -
- test - Directory of end-end tests that are regularly conducted on Pegasus
- tools MU and other utilities written for Pegasus support
- Unsupported Code that is made available but is not supported or included in the normal make.
- WMIMapper Pegasus implementation that provides mapping to Microsoft WMI objects.

Pegasus Run Time directory structure (PEGASUS_HOME environment variable). Home directory for runtime. All compiler, linker documentation creation, etc. are put here.

- bin - Destination for executable and DLL modules from Pegasus build. This directory should be make public so that the test functions, clients, and cimserver can be executed with minimum effort.
- DevManualHTML - HTML output of the Pegasus Manual. This is only created when the make file for this manual is executed (doc/DevManual) and then contains the html representing the document.
- apidochtml - HTML output of the creation of the public API document. This only exists when the make file for the api document is executed (see doc/apidoc/Makefile)
- lib - Destination for Pegasus LIB modules
- log - Standard location for Pegasus Logs
- obj - Destination for object modules. Note that today, the trace file is located in the PEGASUS_HOME directory, not in the log directory if Pegasus internal tracing is enabled.
- repository - This directory contains the created repository

# Pegasus Installation

Pegasus today is provided only as a source distribution. Note that there is code for a Linux RPM distribution but the project is not yet releasing binaies.

To install Pegasus, you must check it out using CVS (Common Version System) or download a snapshot. You download, compile, and use it.

For the snapshot, the installation of Pegasus involves expanding the snapshot distribution files, building the runtime, the test files and test clients, and building the repository.

# Building Pegasus

1. Check that you have requisite programs (listed in Pegasus Dependencies). These include GNU Make, MU.EXE (if using Windows), Flex, and Bison (Flex and Bison only required if changes will be made to the MOF compiler or WQL parser).

Be sure these are on the path.

2. Define the following three environment variables:

- PEGASUS_ROOT - this should be the "pegasus" directory you've pulled from CVS
- PEGASUS_HOME - to point to a directory to contain output binary files (e.g., set it to $HOME/pegasus_home). Then the output will go into $HOME/pegasus_home/bin and $HOME/pegasus_home/lib
- PEGASUS_PLATFORM - this must be set to a supported platform identifier.

> This identifier has the following form:

> <Operating-System>_<Architecture>_<Compiler>

> For example (Linux on IA32 platform using the GNU Compiler): LINUX_IX86_GNU

> For a complete list of platforms supported and platform support keywords, refer to the platform make files found in directory pegasus/mak

Note: if you plan on doing parallel builds, you might consider setting PEGASUS_HOME to something like this:

$HOME/pegasus_home_LINUX_IX86_GNU

That way, the output of each build will be placed in its own directory.

3. Now place $PEGASUS_HOME/bin on your path

and

Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only). For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib

4. Change to the root of the Pegasus distribution and type "make" (where make refers to GNU make).

5. Then create the repository, which is needed to serve data. "make repository". Note that to create the additional namespaces, etc. that represent the test support you can also execute "make testrepository:

6. To test the build type "make tests". The following make targets are supported:

- <default> - Build everything.
- clean - Clean out all objects, libs, and executables.
- depend - Create the dependencies.
- repository - Create the repository in $PEGASUS_HOME/repository
- tests - Execute all tests (except client server tests).
- rebuild - clean, depend, <default>
- world - depend, <default>

The Pegasus Client server tests are executed separately from the above because they require the initiation of separate process for the Pegasus server and Pegasus client. To execute these tests please refer to the scripts in pegasus/mak/BuildMakefile - refer to the prestarttests and poststarttests.

For information on particular installation characteristics, tools, etc. for each platform see the appropriate sections below:

Generally the build commands are as follows:

1. There is a Makefile in the Pegasus root directory. Simply executing make in the Pegasus root directory will make everything. "make rebuild" will clean and rebuild everything. The "make rebuild" will also populate the repository with the current CIM Schemas.
2. To test a fresh release, go to the pegasus root and type "make world". This will build dependencies, build binaries, and then run all tests except the Client/Server tests.
3. To execute the basic test suite that is shipped with pegasus type "make tests". This also reinstalls the repository. Running "make -s tests" suppresses extraneous output such as the enter/leave directory messages.
4. "make clean" removes all object and library files from the structure.
5. A new build system has been added to Pegasus where a new CVS checkout is done, built, and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild"

# Populating the Pegasus Repository

Before using Pegasus you must populate the repository.. The makefile does it all for you, but in case you are wondering what it does or how to do it manually:

1. Register the MOF (Managed Object Format) file describing the skeleton of the object.
2. Register a second MOF which only points out which lib*.so file to be loaded when a specific object is activated.

This is done automatically for the providers included in Pegasus by doing: make repository.

The 'make repository' in pegasus/Schemas does three things Runs MOF compiler (cimmofl) on: -Schema v2.7 Generates the CIM Schema v2.7 in the repository (skeleton of CIM objects) -PG_InterOp Internal to Pegasus schema for operating (shutdown, add users, etc) CIM_Indication’s (SNMP, Events, Alert, Threshold, etc) -PG_ManagedSystem Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, … ) in Pegasus (which are located in src/Providers)

For more information about using the MOF compiler, refer to user's manual on the openpegasus.org.

# Testing a Pegasus Installation

Pegasus includes an extensive set of test facilities as part of the CVS enviromentthat can be executed including:

- Test Clients - There are several clients that have been built specifically to test Pegasus or parts of Pegasus including TestClient, Client, CLI, ipinfo, osinfo, WbemEsec, etc. See the src/Clients directory for more information. These programs require a server complete with repository to be running. Note that some of these tests use classes and instances that are only installed with the "make testrepository" functions including test namespaces and extra classes and instances in those namespaces and additional providers from the providers/sample and proviers/testproviders directories.
- Sample and test providers - Test providers exist for the major provider types in the providers/sample directories and the providers/testProviders directory
- Unit Tests - Most Pegasus functions include unit tests for the functions. These are normally executed with the "make tests" command which can be executed at many different levels of the source tree from the top level to execute all of the unit tests to individual directories. Usually the unit test functions can be found in test directories immediately below their corresponding source code (i.e common/tests is the unit test functions for the common directory). Unit tests are executed without the server being operational and normally do not require the existence of a Class repository.
- An end-to-end Test Suite - the directory "test" contains a set of operations tests that cover the major CIM operations. See the make file TestMakefile in the PEGASUS_ROOT directory to execute these tests. This set of tests executes an extensive set of fixed tests and compares the results against predefined results.

# Registering Providers in the Pegasus Environment

Pegasus registers providers with a set of provider registration classes, not using the provider qualifier as is done in most DMTF CIM CIMOM implementations today. This set of classes is close to but not exactly the same as the current DMTF definition (See the DMTF Interop schema, experimental versions starting with 2.6). This will be harmonized in the future when the DMTF scheme is moved to final status.

Registration is performed by defining a MOF for the instances of the registration classes that represent the provider module, providers, classes, etc. to be registered. The easiest way to create a new registration today is to copy from one of the existing registration MOFs. See the providers/sample/load directory for examples of several registration instance implementations that do work with Pegasus today.

# The MU Utility

In order to provide a consistent build structure across multiple platforms, we developed a small utility to provide a consistent set of small utilities across these platforms. The MU utilityis a simple utility that contains many commands. For example:

C:\> mu rm myfile.cpp yourfile.cpp

You may type "mu" to get a list of valid commands. Here are some of them:

rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare depend

The MU utility supports globing (expansion of wildcards) so you can do things like this:

C:\> mu rm *.obj *.exe

MU is required to build under the Windows environment. MU is available as part of the distribution of Pegasus.

# Notes about Building Pegasus on Linux

No problem. Just make sure you have the environment variables set (PEASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM. For 32 bit linux, the defintion of PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

# Notes about Building Pegasus with SSL

To build with SSL you need the OpenSSL libraries and header files. They are NOT distributed with Pegasus. Make sure you have them in a standard directory so Pegasus can find them. If that's not the case, set the environment variable OPENSSL_HOME= to point where your OpenSSL installation is.

Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make' in Pegasus directory and you will have Pegasus with SSL enabled. See section "Creating SSL certificates" for more information of how to use SSL.

# Building Pegasus on Windows 2k or Windows XP with Microsoft Visual C++

Use of Windows 2000 SP3 or later is recommended. Pegasus is regularly tested on both Windows 2000 and Windows XP using the Microsoft compilers.

Today we build Pegasus on Windows using a set of make files contained in the source distribution, the Microsoft compilers (DevStudio 5.x is not supported, Visual Studio 6.0, SP5 is supported) and the GNUMAKE make utility. Note that you MUST have the Pegasus mu.exe utility compiled and available before trying to compile Pegasus on the normal windows platform. The following is the basic setup steps for the environment.

Setup the environment variables and path for the Micrososft Visual C compiler. Typically this can be done by running the VCVARS32.BAT file supplied with Microsoft Visual C++. (contained in the same directory as cl.exe).

For Windows, try the following for an example environment:

>     REM call the standard Microsoft .bat for VC 6 setup.
>     call 'C:/Program Files/Microsoft Visual Studio/VC98/Bin/Vcvars32.bat'
>     REM Set debug to something if you want compile in debug mode
>     set PEGASUS_DEBUG=true
>     REM set PEGASUS_ROOT to top of source tree
>     set PEGASUS_ROOT=C:/cimom/pegasus
>     REM set PEGASUS_HOME to where you want repository and executables
>     set PEGASUS_HOME=%PEGASUS_ROOT%
>     REM setup the path to the runtime files.
>     set path=%path%;%PEGASUS_HOME%/bin

# Installing the Pegasus HTML Test Client

This is a separate test tool that allows Pegasus requests to be initiated from any WEB browser and that uses a WEB browser, CGI scripts and HTML pages for the formatting and connections. It requires a WEB server, etc. The instructions for setting up this environment are maintained in a separate readme in the Pegasus CGI directory.

# Development with Pegasus and Pegasus Tools

ATTN: This section is incomplete today. For more information on developing clients and providers for Pegasus see the Pegasus Workshop presentations available on the Pegasus web site.

## Client Development

ATTN: Incomplete today.

## Provider Development

ATTN: Incomplete today.

### Debugging Providers

To debug providers you should be running the Pegasus CIMServer in a non-forked mode (not as a daemon or service). The configuration option 'daemon' defines such behavior. You can set this by either running cimserver as:
cimserver daemon=false
Or use the cimconfig to turn this option on:
cimconfig -s daemon=false -p
When running in production, make sure to turn it back to true.

# Commands

The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on CVS)

To see simple help for each of the commands, use the "-h" flag.

>     Examples:
>     bin/cimserver –s (Shuts it down)
>     bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags)
>     bin/cimprovider –l –s (lists providers and their status)
>     bin/cimprovider –e –m OperatingSystemModule (enables the OperatingSystem provider)
>     bin/cimuser –a –u guest –w ThePassword
>     bin/cimuser –l (lists the users)
>     bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type)

# Creating SSL certifications

Please follow section Notes on building Pegasus with SSL before embarking on this endeavour.
Type these commands in your shell to create the SSL certifications. The PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective installation and source directory.

>     CN="Common Name"
>     EMAIL="test@email.address"
>     HOSTNAME=`uname -n`
>     sed -e "s/$CN/$HOSTNAME/" \
>     -e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/ssl.cnf \
>     > $PEGASUS_HOME/ssl.cnf
>     chmod 644 $PEGASUS_HOME/ssl.cnf
>     chown bin $PEGASUS_HOME/ssl.cnf
>     chgrp bin $PEGASUS_HOME/ssl.cnf

>     /usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \
>     -nodes -config $PEGASUS_HOME/ssl.cnf \
>     -keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem

>     cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem
>     rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem
>     cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem

# Configuring Pegasus to use SSL

Please follow section Notes on building Pegasus with SSL and Creating SSL certifications before embarking on this endeavour.
To configure Pegasus to take advantage of SSL, configure CIMServer to have the following configuration options set to:

>     	sslTrustFilePath=client.pem
>     	sslCertificateFilePath=server.pem
>     	sslKeyFilePath=file.pem
>     	httpsPort=5989
>     	enableHttpsConnection=true

using the cimconfig utility:

>     	cimconfig -p -s enableHttpsConnection=true

(The client.pem and server.pem are the certifications files created per the steps in the earlier section). For good riddance you might consider closing down the cleartext 5988 port. Modify your CIMServer configuration to include:

>     	enableHttpConnection=false

using cimconfig.

# Configuring Pegasus to use PAM

In order to use PAM Authentication you have to compile Pegasus with one extra enviroment flags:

>     	PEGASUS_PAM_AUTHENTICATION=1

You can also set the PEGASUS_ALWAYS_USE_PAM=1 flag to disable Pegasus password authentication using a flag text-file (recommended).
After compiling (refer to section Building Pegasus for details), follow these two important steps:

a). Copy the rpm/wbem file in-to /etc/pam.d directory. This notifies PAM what kind of libraries to use when authenticating Pegasus.

b). Modify CIMServer configuration options:

>     	usePAMAuthentication=true
>     	enableAuthentication=true

And if you want to allow 'root' to login (*not recommended*)

>     	enableRemotePrivilegedUserAccess=true

using the cimconfig utility, such as:

>     	cimconfig -p -s usePAMAuthentication=true

The user is authenticated using HTTP Basic method, thererfore it is strongly suggested you use SSL connection instead of normal HTTP connection. Refer to section Configuring Pegasus to use SSL for more details on creating and using SSL keys.

# Testing with ICU enabled

ICU (International Components for Unicode) refers to the set of libraries that Pegasus uses to run globalized. For example: these libraries are used to load messages in different languages, format currency and numbers according to a specific locale etc. In order to enable globalization in Pegasus, Pegasus must be built with ICU enabled, ie. the right environment variables must be set prior to running "make". Refer to the GlobalizationHOWTO.htm in the docs directory for details. That said, when users run "make poststarttests" to verify the integrity of a Pegasus download, a series of tests are run that require the cimserver to be running. These tests currently depend on specific messages returned from the server. When ICU is enabled, all messages come from the resource bundles and these usually do not match the hardcoded default messages within Pegasus. These hardcoded default messages are what the various test programs expect in order to complete successfully. If the ICU enabled server is started without disabling message loading from the bundles, "make poststartests" will fail. In order to run "make poststarttests" successfully with ICU enabled, an environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist prior to starting the server. Once this is defined, when the cimserver starts, all messages generated will be the default hardcoded messages. This will enable "make poststarttests" to complete successfully. Once "make poststarttests" is complete, you should stop the cimserver and then undefine PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined, Pegasus will not be able to load messages using ICU resource bundles.

# Pegasus Documentation

The documentation is currently in preparation. Much of Pegasus is documented in the PEGASUS PEPs which are the basis for approval of Pegasus functionality, changes, plans, etc. These documents are openly available on the PEGASUS web site. The preliminary documentation is not provided with this release. The current documentation is maintained both as a manual created under the tool DOC++ in the runtime subdirectory manual/html (see doc/devManual to create), as an api document also creatable from the source tree (see doc/apidoc) and as other miscellaneous documentation in the doc directory. Also there is a set of release notes. Normally the release notes for the current release are available in the root source directory of CVS.

Note that the Pegasus WEB site at The Open Group will be the source of most documentation in the future and today is the source of most discussion and design documentation.

# Participate!

We are looking for people who want to join the Pegasus work group and contribute to effort of getting this Pegasus off the ground. Please join the mailing list by visiting www.openpegasus.org, and click on Mailing Lists.