pegasus/doc/PegasusSSLGuidelines.htm - diff

Return to PegasusSSLGuidelines.htm CVS log

Up to [Pegasus] / pegasus / doc

Diff for /pegasus/doc/PegasusSSLGuidelines.htm between version 1.2 and 1.4.4.2

version 1.2, 2005/09/02 18:32:28

version 1.4.4.2, 2006/12/19 10:49:51

Line 1

<HTML>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<TITLE>OpenPegasus SSL Guidelines</TITLE>

<html xmlns:v="urn:schemas-microsoft-com:vml"

xmlns:o="urn:schemas-microsoft-com:office:office"

xmlns:w="urn:schemas-microsoft-com:office:word"

xmlns:st1="urn:schemas-microsoft-com:office:smarttags"

xmlns="http://www.w3.org/TR/REC-html40" xmlns:o>

<head>

<!--[if !mso]>

<style>

v\:* {behavior:url(#default#VML);}

o\:* {behavior:url(#default#VML);}

w\:* {behavior:url(#default#VML);}

.shape {behavior:url(#default#VML);}

</style>

<![endif]-->

<title>OpenPegasus SSL Guidelines</title>

<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"

name="date"/>

<!--[if gte mso 9]><xml>

<o:DocumentProperties>

<o:Author>IBM_USER</o:Author>

<o:LastAuthor>IBM_USER</o:LastAuthor>

<o:Revision>2</o:Revision>

<o:TotalTime>6</o:TotalTime>

<o:Created>2006-12-19T07:20:00Z</o:Created>

<o:LastSaved>2006-12-19T07:26:00Z</o:LastSaved>

<o:Pages>1</o:Pages>

<o:Words>5126</o:Words>

<o:Characters>29220</o:Characters>

<o:Company>IBM</o:Company>

<o:Lines>243</o:Lines>

<o:Paragraphs>68</o:Paragraphs>

<o:CharactersWithSpaces>34278</o:CharactersWithSpaces>

<o:Version>10.3501</o:Version>

</o:DocumentProperties>

</xml><![endif]--><!--[if gte mso 9]><xml>

<w:WordDocument>

<w:SpellingState>Clean</w:SpellingState>

<w:GrammarState>Clean</w:GrammarState>

<w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>

</w:WordDocument>

</xml><![endif]--><!--[if !mso]><object

classid="clsid:38481807-CA0E-42D2-BF39-B33AF135CC4D" id=ieooui></object>

<style>

st1\:*{behavior:url(#ieooui) }

</style>

<![endif]-->

<style>

<!--

/* Font Definitions */

@font-face

{font-family:Courier;

panose-1:2 7 4 9 2 2 5 2 4 4;

mso-font-charset:0;

mso-generic-font-family:modern;

mso-font-format:other;

mso-font-pitch:fixed;

mso-font-signature:3 0 0 0 1 0;}

@font-face

{font-family:Wingdings;

panose-1:5 0 0 0 0 0 0 0 0 0;

mso-font-charset:2;

mso-generic-font-family:auto;

mso-font-pitch:variable;

mso-font-signature:0 268435456 0 0 -2147483648 0;}

@font-face

{font-family:Times;

panose-1:2 2 6 3 5 4 5 2 3 4;

mso-font-charset:0;

mso-generic-font-family:roman;

mso-font-pitch:variable;

mso-font-signature:536902279 -2147483648 8 0 511 0;}

/* Style Definitions */

p.MsoNormal, li.MsoNormal, div.MsoNormal

{mso-style-parent:"";

margin:0in;

margin-bottom:.0001pt;

mso-pagination:widow-orphan;

font-size:12.0pt;

font-family:"Times New Roman";

mso-fareast-font-family:"Times New Roman";}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

mso-outline-level:2;

font-size:18.0pt;

font-family:"Times New Roman";

font-weight:bold;}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

mso-outline-level:3;

font-size:13.5pt;

font-family:"Times New Roman";

font-weight:bold;}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

mso-outline-level:4;

font-size:12.0pt;

font-family:"Times New Roman";

font-weight:bold;}

a:link, span.MsoHyperlink

{color:blue;

text-decoration:underline;

text-underline:single;}

a:visited, span.MsoHyperlinkFollowed

{color:blue;

text-decoration:underline;

text-underline:single;}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

font-size:12.0pt;

font-family:"Times New Roman";

mso-fareast-font-family:"Times New Roman";}

span.spelle

{mso-style-name:spelle;}

span.SpellE

{mso-style-name:"";

mso-spl-e:yes;}

span.GramE

{mso-style-name:"";

mso-gram-e:yes;}

@page Section1

{size:8.5in 11.0in;

margin:1.0in 1.25in 1.0in 1.25in;

mso-header-margin:.5in;

mso-footer-margin:.5in;

mso-paper-source:0;}

div.Section1

{page:Section1;}

/* List Definitions */

@list l0

{mso-list-id:51972189;

mso-list-template-ids:81668992;}

@list l0:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l1

{mso-list-id:257178838;

mso-list-template-ids:1636469146;}

@list l1:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l2

{mso-list-id:335961387;

mso-list-template-ids:303987346;}

@list l2:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l3

{mso-list-id:432287186;

mso-list-template-ids:401260786;}

@list l3:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l4

{mso-list-id:448670368;

mso-list-template-ids:342922132;}

@list l4:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l5

{mso-list-id:605886313;

mso-list-template-ids:2101529026;}

@list l5:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l6

{mso-list-id:610279438;

mso-list-template-ids:-795200846;}

@list l6:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l7

{mso-list-id:620840603;

mso-list-template-ids:-1801667564;}

@list l7:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l8

{mso-list-id:633027112;

mso-list-template-ids:-1360881254;}

@list l8:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l9

{mso-list-id:902104985;

mso-list-template-ids:750025012;}

@list l9:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l10

{mso-list-id:958562085;

mso-list-template-ids:-55920690;}

@list l10:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l11

{mso-list-id:1106390704;

mso-list-template-ids:-953544102;}

@list l11:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l11:level2

{mso-level-number-format:bullet;

mso-level-text:o;

mso-level-tab-stop:1.0in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:"Courier New";

mso-bidi-font-family:"Times New Roman";}

@list l11:level3

{mso-level-number-format:bullet;

mso-level-text:\F0A7;

mso-level-tab-stop:1.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Wingdings;}

@list l12

{mso-list-id:1409960379;

mso-list-template-ids:-1094543752;}

@list l12:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l13

{mso-list-id:1721326241;

mso-list-template-ids:644010464;}

@list l13:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l14

{mso-list-id:1731073149;

mso-list-template-ids:-2060307636;}

@list l14:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l15

{mso-list-id:1950238906;

mso-list-template-ids:-1705468504;}

@list l15:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

{margin-bottom:0in;}

-->

</style>

<!--[if gte mso 10]>

<style>

/* Style Definitions */

table.MsoNormalTable

{mso-style-name:"Table Normal";

mso-tstyle-rowband-size:0;

mso-tstyle-colband-size:0;

mso-style-noshow:yes;

mso-style-parent:"";

mso-padding-alt:0in 5.4pt 0in 5.4pt;

mso-para-margin:0in;

mso-para-margin-bottom:.0001pt;

mso-pagination:widow-orphan;

font-size:10.0pt;

font-family:"Times New Roman";}

</style>

<![endif]-->

</head>

<h2>OpenPegasus 2.6 SSL Guidelines</h2>

Version: 1.2

Created: <st1:date Year="2005" Day="20" Month="7">July 20, 2005</st1:date>

Updated: <st1:date Year="2006" Day="19"

Month="12">December 19, 2006</st1:date>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#OVERVIEW">Overview</a>

</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#RELATED">Related

Information</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#BUILDING">Building

Pegasus with SSL</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CERTS">Creating SSL

Certificates</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CONFIGURE">Configuring

Pegasus for SSL</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#DESIGN">SSL Design

Question List</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#TRUSTSTORE"><span

class=SpellE>Truststore Management</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CLI"><span

class=SpellE>cimtrust & cimcrl CLI</a>

</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CLIENT">Configuring

the Pegasus CIM Client for SSL</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#AUTH">SSL

Authorization</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#EXT">Critical

Extension Handling</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#RESOURCES">Resources</a>

</li>

</ul>

<BODY>

<h3><a name=OVERVIEW>Overview</a></h3>

<H2>OpenPegasus 2.5 SSL Guidelines</H2>

Version: 1.0

The following document serves as a guide on how to build and configure

Created: July 20, 2005

Pegasus for SSL support. It also discusses how to utilize a certificate-based

<UL>

infrastructure and configure the Pegasus CIM client.

<LI><A HREF="#OVERVIEW">Overview</A>

This guide requires a basic understanding of SSL, OpenSSL,

<LI><A HREF="#RELATED">Related Information</A>

and basic authentication. This guide is intended to help developers and

<LI><A HREF="#BUILDING">Building Pegasus with SSL</A>

administrators make the right decisions about how to use SSL for their

<LI><A HREF="#CERTS">Creating SSL Certificates</A>

particular application. It is not intended to be a primary source of education

<LI><A HREF="#CONFIGURE">Configuring Pegasus for SSL</A>

on SSL. If you are not familiar with these technologies,

<LI><A HREF="#DESIGN">SSL Design Question List</A>

consult the sources in the <a href="#RESOURCES">Resources</a> section at the

<LI><A HREF="#TRUSTSTORE">Truststore Management</A>

bottom.

<LI><A HREF="#CLI">ssltrustmgr CLI</A>

<LI><A HREF="#CLIENT">Configuring the Pegasus CIM Client for SSL</A>

Note: In this document, the term "trust" refers only to

<LI><A HREF="#AUTH">SSL Authorization</A>

authentication. It does not imply full trust in the traditional sense, because

<LI><A HREF="#RESOURCES">Resources</A>

it does not take into account authorization checks. It remains the

</UL>

responsibility of providers and clients to perform authorization, and therefore

establish real trust. Likewise, the term "Trust Store" can be

misleading since the "store" is only a source of authentication

<H3><A NAME="OVERVIEW">Overview</A></H3>

credentials. Please bear this in mind when documenting recommended deployments

or building clients or providers.

The following document serves as a guide on how to build and configure Pegasus for SSL support. It also discusses how to utilize a certificate-based

<h3><a name=RELATED>Related Information</a></h3>

infrastructure and configure the Pegasus CIM client.

A significant portion of the information in this document is

This guide requires a basic understanding of SSL, OpenSSL, and basic authentication. This guide is intended to help developers

taken from various PEP's.

and administrators make the right decisions about how to use SSL for their particular application.

This document attempts to bring all of this information together in a cohesive

It is not intended to be a primary source of education on SSL. If you are not familiar with these technologies,

and simplified format.

consult the sources in the <A HREF="#RESOURCES">Resources</A> section at the bottom.

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

Note:

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#035 - Add support for

In this document, the term "trust" refers only to authentication. It does not imply full trust in the traditional sense, because

/dev/random in SSLContext </li>

it does not take into account authorization checks. It remains the responsibility of providers and clients to perform authorization,

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

and therefore establish real trust. Likewise, the term "Trust Store" can be misleading since the "store" is only a source of

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#060 - SSL support in

authentication credentials. Please bear this in mind when documenting recommended deployments or building clients or providers.

CIM/XML indication delivery </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#074 - <span

<H3><A NAME="RELATED">Related Information</A></H3>

class=SpellE>SSLContext and Certificate verification interface

A significant portion of the information in this document is taken from various PEP's.

enhancement </li>

This document attempts to bring all of this information

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

together in a cohesive and simplified format.

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#165 - SSL Client

Verification </li>

<UL>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<LI>PEP#035 - Add support for /dev/random in SSLContext</LI>

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#187 - SSL Certificate

<LI>PEP#060 - SSL support in CIM/XML indication delivery</LI>

Management Enhancements </li>

<LI>PEP#074 - SSLContext and Certificate verification interface enhancement</LI>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<LI>PEP#155 - Support for Client SSL Certificate Verification in CIM Server for CIMExport requests</LI>

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#200 - Recommended <span

<LI>PEP#165 - SSL Client Verification</LI>

class=SpellE>OpenPegasus 2.5 Build and Configuration Options for

<LI>PEP#187 - SSL Certificate Management Enhancements</LI>

Selected Platforms</li>

<LI>PEP#200 - Recommended OpenPegasus 2.5 Build and Configuration Options for Selected Platforms</LI>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

</UL>

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#268 � SSL Client Certificate

Propagation</li>

</ul>

<H3><A NAME="BUILDING">Building Pegasus with SSL</A></H3>

To build Pegasus with HTTPS support, you will need to build against the <A HREF="http://www.openssl.org">OpenSSL

package</A>. The SSL support outlined here has been tested against recent releases of the major verions 0.9.6X and 0.9.7X (most notably, 0.9.7d).

It has not been tested against major version 0.9.8, which came out in July 2005. Some tests have found that versions of 0.9.6X prior to 0.9.6c

do not contain the certificate revocation list (CRL) support that the OpenPegasus 2.5 utilizes.

Because this is an open source project, the SSL support has been tested with many versions of OpenSSL,

but we cannot guarantee it has been tested with every version on every platform.

A list of recent OpenSSL releases, and important-to-review security advisories and fixes, can

be found on the <A HREF="http://www.openssl.org/news">OpenSSL News page</A>.

After grabbing the OpenSSL source tarball, you need to set the following environment variables before building Pegasus:

<UL>

<LI>PEGASUS_HAS_SSL=1</LI>

<LI>OPENSSL_HOME=<location of the SDK package> This directory must contain

the OpenSSL include directory, $(OPENSSL_HOME)/include, and the OpenSSL library

directory, $(OPENSSL_HOME)/lib.</LI>

<LI>OPENSSL_BIN=<location of the binary package> This only needs to be

set if the OpenSSL binaries are not in $(OPENSSL_HOME)/bin.</LI>

</UL>

Note that Pegasus supports SSLv3 and TLSv1 by default. It does NOT support SSLv2.

To turn on SSLv2 support, enable the additional environment variable:

<UL>

<LI> PEGASUS_ENABLE_SSLV2=1 </LI>

</UL>

It is not recommended to enable this protocol, as there have been many security weaknesses associated with it. Unless you are dealing

with very outdated clients, you probably do not need to enable it.

After setting these variables, proceed as normal with the build instructions in the readme file.

<H3><A NAME="CERTS">Creating SSL Certificates</A></H3>

There are two options for creating the CIMOM's certificate:

<UL>

<LI>Self-signed certificate</LI>

<LI>Certificate issued by a third-party certificate authority</LI>

</UL>

To generate a self-signed certificate, you must create a private key, a certificate signing request (CSR), and finally the public x509 certificate.

You also need an SSL configuration file that defines the parameters of the Distinguished Name (DN). You can use the one that comes with Pegasus,

ssl.cnf in the root directory, or generate your own. For a self-signed certificate, the subject

is the same as the issuer. Execute the following commands to create a self-signed certificate.

The PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective installation and source directory. You will also need an OpenSSL configuration

file. There is a sample configuration file that comes with the OpenSSL package.

<UL>

<LI>To generate a private key, execute the following:

openssl genrsa -out myserver.key 1024

Set the "sslKeyFilePath" configuration property to point to this key file.

</LI>

<LI>To generate a certificate signing request, execute the following:

openssl req -config openssl.cnf -new -key myserver.key -out myserver.csr

</LI>

<LI> At this point, the certificate sigining request can be sent out to a third-party certificate authority for signing,

or a self-signed certificate can be generated. To generate a self-signed certificate, execute the following:

openssl x509 -in myserver.csr -out myserver.cert -req -signkey myserver.key -days 365

Set the "sslCertificateFilePath" configuration property to point to this certificate file. The above CSR file can be discarded

after the certificate is created.

</LI>

</UL>

After creating the keypair, make sure you protect the information sufficiently by changing permissions on the files and/or directories.

The following table shows the recommended privileges:

<TBODY>

<TR><TH>SSL file</TH><TH>Pegasus Config property</TH><TH>Permissions</TH></TR>

<TR><TD>Private key</td><TD>sslKeyFilePath</TD><TD>rwx------</TD></TR>

<TR><TD>Public certificate</td><TD>sslCertificateFilePath</TD> <TD>rwxr-xr-x</TD></TR>

<TR><TD>Truststore</td><TD>sslTrustStore, exportSSLTruststore</TD> <TD>rwxr-xr-x</TD></TR>

<TR><TD>CRL store </td><TD>crlStore</TD> <TD>rwxr-xr-x</TD></TR>

</TBODY>

</TABLE>

The administrator is responsible for ensuring that the above file permissions are set correctly.

The administrator should also ensure that all containing directories all the way up to the base directory are not world-writeable. Pegasus only checks the following conditions when starting up:

<UL>

<LI>The sslKeyFilePath and the sslCertificateFilePath are readable by the CIMOM.</LI>

<LI>The sslTrustStore, exportSSLTrustStore, and crlStore are readable by the CIMOM if they are a single file.</LI>

<LI>The sslTrustStore, exportSSLTrustStore, and crlStore are readable and writable by the CIMOM if they are a directory.</LI>

</UL>

These same file permissions should be used for protecting a client's private key, public key, truststore, and crl store as well.

For more information on generating keys and certificates, consult the <A HRef="http://www.openssl.org/docs/HOWTO/">OpenSSL

HOW-TO documentation</A>.

<H3><A NAME="CONFIGURE">Configuring Pegasus for SSL</A></H3>

There are many environment variable settings associated with SSL. Here is a brief discussion of the subtleties of these options and how they work together to

create a more secure environment. More information on the default and recommended settings can be found in

PEP#200 Recommended OpenPegasus 2.5 Build and Configuration Options for Selected Platforms. Additionally, the section on

<A HREF="#DESIGN">Design Question List</A> should help determine what these settings should be for a given application.

enableHttpsConnection

This is disabled by default on most platforms. It is recommended that

all remote communication be done over the HTTPS port. However, if you are sending cleartext

passwords over the wire, it is imperative that you only use the secure port.

For added security, the HTTP port can be disabled to prevent clients from connecting

to it.

The HTTPS connection is enabled by default only on the following platforms:

<UL>

<LI>LINUX</LI>

<LI>HP_UX (if PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true)</LI>

<LI>VMS (if PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true)</LI>

</UL>

httpsPort

The default setting is 5989, the official WBEM secure port.

sslCertificateFilePath

This is the path to the x509 server certificate.

The server certificate may be a chain in which case the file should contain PEM encoded certificates beginning with the server certificate

and followed by each signing certificate authority (CA) including the root CA. If the server certificate is a self signed certificate,

the file only contains the self-signed certificate in PEM format.

The certificate cannot be encrypted because there is currently no mechanism for decrypting the certificate using a user-supplied password.

This property must be defined if enableHttpsConnection is true.

Any failure in finding this file will result in the cimserver failing to start.

See <A HREF="#CERTS">Creating SSL Certificates</A> for more information.

sslKeyFilePath

This is the path to the server's private key. All keys should be at least 1024 bytes long. This property must be defined if

enableHttpsConnection is true. Any failure in finding this file will result in the cimserver failing to start.

See <A HREF="#CERTS">Creating SSL Certificate</A> for more information.

sslClientVerificationMode

This setting controls how the cimserver (i.e. the HTTPS port) is configured.

It does not control the configuration of the export connection. There are three

possible settings: disabled, required, optional. There is no "right" setting

for this property. The default is disabled and it is fine to

leave the setting as disabled if you are going to use basic authentication to

authenticate all client requests. In many applications where a physical person

is there to supply a username and password, basic authentication is sufficient.

Other

environments may be heterogeneous, in which case it makes sense to allow both

basic authentication and SSL certificate verification. The setting of this variable

also impacts what happens during the OpenSSL handshake:

<UL>

<LI>"required" -- The server requires that the client certificate be trusted in order for the handshake to continue.

If the client fails to send a certificate or sends an untrusted certificate, the handshake is immediately terminated.</LI>

<LI>"optional" -- The server will request that a client certificate be sent, but will continue the handshake even if no certificate is

received. If authentication is enabled, the server will seek to authenticate the client via an alternative method of authentication.</LI>

<LI>"disabled" -- The server will not prompt the client for a certificate. This is the default.</LI>

</UL>

Pegasus currently ties a certificate to a valid OS user. Multiple certificates may be registered to the same user. When a certificate is

authenticated, Pegasus views it in the same way as if a user was authenticated via basic authentication. The providers

receive the username that the certificate was mapped to. See the SSL Authorization section

for more information.

sslTrustStore

This setting controls the truststore for the cimserver's HTTPS connection. It can be

either a directory or a single root CA file. When set to a directory, it is recommended that you use the ssltrustmgr CLI

to populate the truststore as there are strict naming requirements for trusted certificate files. See the <A HREF="#CLI">ssltrustmgr CLI</A>

section for further information.

sslTrustStoreUserName

This setting is only utilized if the sslTrustStore is a single CA file. It is not used if the sslTrustStore setting is a directory,

but it still must be set to a valid system user. This is because the validation of the property is done independently of the sslTrustStore

setting. This property represents the valid OS user that corresponds to the root certificate. All requests authenticated with a certificate

under the root CA will be associated with this user and the username will be propagated to providers. If applications desire for there to

be a one-to-one correspondence between users and certificates, it is recommended that each certificate be registered individually using the

<A HREF="#CLI">ssltrustmgr CLI</A>.

crlStore

This is where the CRL (Certificate Revocation List) store resides. There is

only one CRL store for all truststores. Currently, only two truststores are

supported (cimserver and export) and these both share the same CRL store. It

is important to note that certificates are checked first against the CRL (if

specified) and then against the truststore. The <A Href="#CLI">ssltrustmgr CLI</A>

should be used for CRL management.

enableSSLExportClientVerification

This setting controls whether an ADDITIONAL port is used to listen for incoming indications. This port is used only as a CIM indication listener

and only supports HTTPS. The port number of the export connection is currently not configurable; the port is determined by looking

in /etc/services for the service name wbem-exp-https.

The export port is primarily used as a way to authenticate client indication requests. Because indications are generated by providers

and do not have a username/password associated with them, traditional basic authentication cannot be sent in the export request. To work

around this, a truststore can be configured to authenticate incoming requests. This truststore is configured like the "required"

setting of sslClientVerificationMode.

exportSSLTrustStore

This setting controls the truststore for the export connection. It may be the same as the sslTrustStore. Additionally, it can be

either a directory or a single root CA file. When set to a directory, it is recommended that you use the <A HREF="#CLI">ssltrustmgr CLI</A>

to populate the truststore as there are strict naming requirements for trusted certificate files.

<H4>Configuration Limitations</H4>

The following are configuration limitations:

<UL>

<LI>The x509 server certificate file cannot be encrypted. The reason for this is that there is currently no mechanism in Pegasus to grab the

password needed to unencrypt it. Therefore, the best way to secure the file is to follow the file permissions settings specified in <A HREF="#CERTS">Creating SSL Certificates.</A></LI>

<LI>There is no property to specify supported cipher lists at this time. Pegasus uses the default OpenSSL cipher list. The cipher lists can be found at

<A HREF="http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_</A> and

<A HREF="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</A></LI>

<LI>The verification depth cannot be specified. Pegasus uses the default OpenSSL depth of 9. This means the OpenSSL will only accept client

certificate chains up to 9 levels deep.</LI>

<LI>No hostname checking is performed to ensure that the subject field of the distinguished name (DN) matches the hostname.</LI>

</UL>

<H3><A NAME="DESIGN">SSL Design Question List</A></H3>

The following questions may be helpful in determining how to configure Pegasus CIM Server.

Should I enable the HTTPS port?

Yes, especially if you are sending passwords with requests. The HTTP port can be disabled for additional security if desired.

Should I enable the export port?

Currently, the export connection provides the only way to authenticate incoming CIM indication requests.

Because basic authentication cannot be used with these requests, the export connection should be enabled if

there is a concern over rogue client export requests. Otherwise, the export requests can still be sent over

HTTPS using the standard port; the information will be encrypted but the client's identity will not be validated.

Should I configure the CIMOM to use a truststore?

This depends on the infrastructure of the application. If all clients are using basic authentication over the secure port

(and the passwords are secured), then a truststore may not be needed. If an application does not want to store user/pw information,

then it is a good idea to use a certificate-based infrastructure. If a CIMOM certificate is compromised, the cimserver and the providers

of the system are compromised. The severity of this scenario is dependent on the resources the providers have access to.

If an OS password is compromised, the entire system may be compromised.

If using peer verification, it is important to ensure that 1) the cimserver is properly configured to use a truststore,

2) the truststore is loaded properly and protected, and 3) authorization checks are performed after a certificate is verified.

These same conditions also apply to a client that is verifying a server.

Should I use a self-signed certificate or one issued by a third-party certificate authority?

Generally, scalability will determine whether it's appropriate to use a self-signed certificate or one issued by Verisign

or another third-party certificate authority.

If an administrator administrates their self-signed certificates correctly, they are

no less secure than one issued by a CA. What a CA buys you is scalability. An up front cost of

setting up a CA relationship will be offset by the convenience of having that

CA "vouch" for certs it has signed, in large deployments. In small deployments

the incremental cost might never outweigh the initial CA-setup cost.

One important thing to remember is that

you should not use the same certificate for multiple CIMOMs. If using a self-signed

certificate, a different one should be generated for each CIMOM, using some unique

piece of data to make them different. That way, if one of the certificates is

compromised, the other ones remain secure.

Should the truststore be a single root CA file or a directory?

If you only anticipate connections from a narrowly defined set of clients, then a single root CA certificate file should be sufficient.

Alternatively, multiple trusted certificates may be stored in PEM format inside of a single CA file.

If you anticipate getting requests from a heterogeneous set of clients, then it probably makes sense to use the directory option

to allow flexibility in the future. In the latter scenario, the same single root CA file can still be used with the additional step of using ssltrustmgr to register it.

It's important to note that when registering a root CA, only one user can be associated with ALL certificates under that CA. Following the principle of

least privilege, it is not a good idea to register a root CA to a privileged user if lesser privileged users will be connecting with it.

How do I protect the keystore and the truststore?

The server's private key should always be protected; it is private for a reason.

Only the system administrator should be able to see it. The public certificate

can be viewed by anyone, however, it should be protected from alteration by system

users. Similarly, any truststore or CRL file or directory should also be protected

from alteration. See <A HREF="#CERTS">Creating SSL Certificates</A> for the recommended

file privileges.

When do I need to use a CRL?

Certificate Revocation Lists are regularly issued by CA's. They contain a list

of certificates that have been revoked. Any application using a CA certificate

in its truststore should also implement CRLs (if the CA supports them). Pegasus itself

does not check CRL validity dates during startup. Therefore, it is the responsibility of the administrator

to regularly download or acquire the CRL and import it into the CRL store using the <A Href="#CLI">ssltrustmgr CLI</A>.

If using self-signed certificates, however, a CRL is most likely not needed (You can create a self-signed CRL but it is not really

necessary). Because of this, the certificate deletion option available via ssltrusmgr is primarily intended for self-signed certificates.

Technically, CRL's are the correct way to revoke compromised or invalid certificates.

What is the order of operations for certificate verification?

The certificate is checked against any CRLs first before going through the rest of the verification process. Verification starts with the

root certificate and continues down to the peer certificate. If verification fails at any of these points, the certificate is considered

untrusted and the verification process reports an error.

<H3><A NAME="TRUSTSTORE">Truststore Management</A></H3>

There are two directions of trust in an SSL client-server handshake: The client trusts the server. The server trusts the client. Pegasus

provides a way to implement one or both of these relationships. Ideally, an application should support both levels of trust for maximum

security and this is the implementation Pegasus recommends. However, in some scenarios it may make sense to only implement one of these;

in that case, it is possible to override the client or the server to "trust all certificates." For example, if all clients will be using

basic authentication over HTTPS, then the server can be setup to "trust all client certificates."

To tell the cimserver to require that all clients be trusted, simply set the

sslClientVerification property to "required."

To tell the cimserver to trust all clients, set the sslClientVerification property

to "disabled" or "optional".

The SSL verification in Pegasus is independent of any other authentication mechanism. It can still be utilized when authentication is disabled.

When authentication is enabled, the first line of defense is SSL client verification.

In situations where a client is not authenticated by SSL and the setting is "optional", the server will attempt to authenticate the client

via another method of authentication. In this case, the authentication mechanism specified by the configuration property "httpAuthType" will be used

for remote connections and local authentication will be used for local connections.

See the <A HREF="#CLIENT">Configuring the Pegasus CIM Client for SSL</A> section below on how to setup the client's truststore.

<H3><A NAME="CLI">ssltrustmgr CLI</A></H3>

Pegasus 2.5 comes with a new CLI, ssltrustmgr, that should be used to manage the cimserver's truststore, the export truststore, and the CRL store.

The CLI interfaces with a certificate control provider that runs as part of Pegasus's core. It operates on the PG_SSLCertificate and PG_SSLCertificateRevocationList

classes in root/pg_internal.

It is recommended that this CLI be used in place of manual configuration for several reasons:

<UL>

<LI>OpenSSL places strict naming restrictions on certificates and CRLs in a directory (the files are looked up via a subject hash code)</LI>

<LI>Certificate instances are stored in the repository along with the corresponding username. If the certificate is not properly registered,

the username mapping will fail.</LI>

<LI>The CLI allows for dynamic deletion of certificates by resetting the SSL context. Normally, you would need to stop and start

the cimserver to accomplish this.</LI>

<LI>The CLI, or more correctly the provider it operates on, performs a ton of error checking you would not get by manually configuring

the stores. This alerts the administrator to various error conditions (e.g. the certificate expired) associated with a certificate or CRL.</LI>

</UL>

The CIMOM must be up and running while executing ssltrustmgr. The ssltrustmgr manpage provides more information on commands and syntax.

<H3><A NAME="CLIENT">Configuring the Pegasus CIM Client for SSL</A></H3>

A Pegasus CIM client can be configured to use SSL by using a constructor that

takes an SSLContext. The construction of the SSLContext is really what controls

the behavior of the client during the SSL handshake. Without going into minute

details about what happens under the covers, here is a description of the various

SSLContext constructor parameters. The descriptions are written from a client

perspective even though the same constructors are utilized by the cimserver

HTTPS port and export port.

Here's a code snippet that shows how to call a client constructor that connects to a server over SSL and can present its own trusted certificate if

the server requests it. In this scenario, the client also checks the server certificate against its truststore and specifies an additional

callback in addition to the default one (the user-specified callback is optional and can be set to null).

<UL>

client.connect(

hostname,

port,

SSLContext(trustStore, certPath, keyPath, verifyCert, randomFile),

username,

password);

</UL>

Here's a code snippet that shows how to call a client constructor that connects to a server over SSL and does not possess its own trusted certificate.

In this scenario, the client also checks the server certificate against its truststore.

<UL>

client.connect(

hostname,

port,

SSLContext(trustStore, NULL, randomFile),

username

password);

</UL>

<UL>

<LI>trustStore -- This specifies the truststore that the client uses to verify server certificates. It can be String::EMPTY if no truststore exists. </LI>

<LI>certPath -- This specifies the x509 certificate of the client that will be sent during an SSL handshake. Note that this certificate will

only be sent if the server requests it. If this option is specified, the keyPath parameter must also be specified.</LI>

<LI>keyPath -- This specifies the private key of the client. If this option is specified, the certPath parameter must also be specified.</LI>

<LI>crlPath -- This specifies an optional CRL store path. The client checks the CRL list first, before attempting any further authentication,

including the user-specified callback.</LI>

<LI>verifyCert -- This is a user-specified verification callback. If this is set to null, the default OpenSSL verification callback will

be executed. You can implement this method to "trust all servers" or to perform additional authentication checks that OpenSSL does not perform

by default.</LI>

<LI>randomFile -- A file to seed the pseudo random number generator (PRNG).</LI>

</UL>

Here are some general guidelines on implementing peer verification for the client:

<UL>

<LI>The client should enable peer verification by specifying a truststore and (optionally) a user-specified callback function.</LI>

<LI>The client should employ a truststore in order to properly verify the server. The truststore should contain a file or directory of

trusted CA certificates. The ssltrustmgr CLI cannot be used to configure client truststores. The trusted certificate(s) should be placed

in a protected file or directory specified by the trustStore parameter. Keep in mind that the SSL context generally has to be reloaded

to pick up any truststore changes.</LI>

<LI>The client could also use a user-specified callback in addition to the default verification callback, if additional verifications are desired over the normal checks that OpenSSL performs.

In most cases, the default verification callback is sufficient for checking server certificates.</LI>

<LI>The client should ensure that adequate entropy is attained.</LI>

<LI>The client should use a CRL store if the truststore contains CA certificates that support one.</LI>

<LI>The client should only use the SSLv3 and TLSv1 protocols. By default, Pegasus is not built with SSLv2 support.</LI>

<li>The client should terform post-connection checks. </li>

<ul>

<li>Ensure a certificate was received.</li>

<ul>

<li>WARNING:  In some implementations of SSL

a NULL server certificate is perfectly valid and authenticates against

all trust stores.  If the client does not ensure a certificate

exists then the client is not providing server authentication and could

have a security bulletin class defect.</li>

</ul>

<li>Validate that the certificate received was issued to the

host for which the client was attempting to connect.</li>

<ul>

<li>Ensure that the common name (CN) in the server’s

certificate subject matches the host name of the server.  For X509v3

certificates, the “SubjectAltName”

fields in the certificate's extended attributes are also valid host names

for the certificate. </li>

<li>WARNING:  If the client does not ensure

the host name of the server is the same as one of the host names explicitly

described in the server’s certificate, you have not authenticated

the server’s identity.  Any other server which was issued

a certificate from the same trusted CA can masquerade as the server

unless the client performs the host name check.</li>

</ul>

<li>Ensure that certificate verification methods/routines

return no errors.</li>

</ul>

</UL>

Because only the above arguments can be passed into the Pegasus SSLContext, there are some limitations in the client configuration:

<UL>

<LI>The verification depth cannot be specified. Pegasus uses the default OpenSSL depth of 9.</LI>

<LI>The cipher list cannot be specified. Pegasus uses the default OpenSSL cipher list. The cipher lists can be found at

<A HREF="http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_</A> and

<A HREF="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</A></LI>

<LI>No hostname checking is performed to ensure that the subject field of the distinguished name (DN) matches the hostname. If desired, a user-specified callback should be configured

to perform this check or any additional checks relevant to the application.</LI>

</UL>

<H3><A NAME="AUTH">SSL Authorization</A></H3>

The following paragraphs concern authorization of users authenticated by certificate on the cimserver's HTTPS port.

It is important to note that SSL certificates are verified during the initial

handshake, BEFORE any further authentication takes place. If a certificate fails,

the connection can be terminated immediately, resulting in a connection exception.

This scenario will occur if the sslClientVerification property is set to "required"

and no certificate or an untrusted certificate is sent. The export connection

will also terminate the connection if an untrusted certificate is presented.

Once a certificate is verified, no further authentication is attempted.

This effectively results in any basic or local authentication headers being

ignored.

Further authorization checks must be performed when validating

the user that is mapped to the certificate. First, the user that is registered to the certificate

is validated as a valid system user and a valid cimuser (if the cimuser function has been configured).

Additionally, if Pegasus was configured to use PAM, the pam_acct_mgmt function will be called with the

user that is mapped to the certificate. This ensures that any login conditions that would have been placed

on a user authenticated via basic authentication are still applied to a user authenticated via certificate.

The pam_authenticate method will NOT be called. Lastly, the providers must authorize the user. They receive the

username that was mapped to the certificate in the OperationContext.

<H3><A NAME="RESOURCES">Resources</A></H3>

For OpenSSL information pick up a copy of O'Reilly's Network Security with OpenSSL or go to the OpenSSL Site:

<A HREF="http://www.openssl.org">http://www.openssl.org</A>

A really fabulous guide on certificate management and installation with OpenSSL:

<A HREF="http://www.gagravarr.org/writing/openssl-certs/index.shtml">http://www.gagravarr.org/writing/openssl-certs/index.shtml</A>

x509 Certificate and CRL RFC:

<A HREF="http://www.ietf.org/rfc/rfc2459.txt?number=2459">http://www.ietf.org/rfc/rfc2459.txt?number=2459</A>

SSLv3 RFC:

<A HREF="http://wp.netscape.com/eng/ssl3/">http://wp.netscape.com/eng/ssl3</A>

TLSv1 RFC:

Basic Authentication RFC:

<hr>

<h3><a name=BUILDING>Building Pegasus with SSL</a></h3>

Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation

To build Pegasus with HTTPS support, you will need to build against the <a

href="http://www.openssl.org">OpenSSL package</a>. <span

style='color:black'>The SSL support outlined here has been tested against

recent releases of the major versions 0.9.7X and 0.9.8X (most notably, 0.9.7d).

Because some versions of 0.9.6X do not contain full support for the security

functions that Pegasus utilizes (for example, certificate-based authentication

is not fully supported by some versions of 0.9.6X), Pegasus does not officially

support major version 0.9.6. See Bugzilla 4048 for

more information. Because this is an open source project, the SSL

support has been tested with many versions of OpenSSL,

but we cannot guarantee it has been tested with every version on every

platform. A list of recent OpenSSL releases, and

important-to-review security advisories and fixes, can be found on the <a

href="http://www.openssl.org/news">OpenSSL News page</a>.

After grabbing the OpenSSL source <span

class=SpellE>tarball, you need to set the following environment

variables before building Pegasus:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l14 level1 lfo3;tab-stops:list .5in'>PEGASUS_HAS_SSL=1 </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l14 level1 lfo3;tab-stops:list .5in'>OPENSSL_HOME=<location of

the SDK package> This directory must contain

the OpenSSL include directory,

$(OPENSSL_HOME)/include, and the OpenSSL library

directory, $(OPENSSL_HOME)/lib. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l14 level1 lfo3;tab-stops:list .5in'>OPENSSL_BIN=<location of

the binary package> This only needs to be set

if the OpenSSL binaries are not in

$(OPENSSL_HOME)/bin.</li>

</ul>

Note that Pegasus supports SSLv3 and TLSv1 by default. It

does NOT support SSLv2. To turn on SSLv2 support, enable the additional

environment variable:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l9 level1 lfo4;tab-stops:list .5in'>PEGASUS_ENABLE_SSLV2=1 </li>

</ul>

Permission is hereby granted, free of charge, to any person

It is not recommended to enable this protocol, as there have been many

security weaknesses associated with it. Unless you are dealing with very

outdated clients, you probably do not need to enable it.

After setting these variables, proceed as normal with the build instructions

in the readme file.

<h3><a name=CERTS>Creating SSL Certificates</a></h3>

There are two options for creating the CIMOM's

certificate:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l5 level1 lfo5;tab-stops:list .5in'>Self-signed certificate </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l5 level1 lfo5;tab-stops:list .5in'>Certificate issued by a

third-party certificate authority</li>

</ul>

obtaining a copy  of this software and associated documentation files (the

To generate a self-signed certificate, you must create a private key, a

certificate signing request (CSR), and finally the public x509 certificate. You

also need an SSL configuration file that defines the parameters of the

Distinguished Name (DN). You can use the one that comes with Pegasus, <span

class=SpellE>ssl.cnf in the root directory, or generate your own. For a

self-signed certificate, the subject is the same as the issuer. Execute the

following commands to create a self-signed certificate. The PEGASUS_ROOT and

PEGASUS_HOME have to be set to your respective installation and source

directory. You will also need an OpenSSL

configuration file. There is a sample configuration file that comes with the <span

class=SpellE>OpenSSL package.

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l12 level1 lfo6;tab-stops:list .5in'>To generate a private key,

execute the following:

openssl<span

style='font-family:Courier;color:#009900'> genrsa

-out myserver.key 1024

Set the "sslKeyFilePath" configuration

property to point to this key file. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l12 level1 lfo6;tab-stops:list .5in'>To generate a certificate

signing request, execute the following:

openssl<span

style='font-family:Courier;color:#009900'> req -<span

class=SpellE>config openssl.cnf -new -key

myserver.key -out myserver.csr

</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l12 level1 lfo6;tab-stops:list .5in'>At this point, the

certificate signing request can be sent out to a third-party certificate

authority for signing, or a self-signed certificate can be generated. To

generate a self-signed certificate, execute the following<span

class=GramE>:

openssl<span

style='font-family:Courier;color:#009900'> x509 -in myserver.csr

-out myserver.cert -req

-signkey myserver.key

-days 365

Set the "sslCertificateFilePath"

configuration property to point to this certificate file. The above CSR

file can be discarded after the certificate is created. </li>

</ul>

"Software"), to deal in the Software without restriction, including without

After creating the keypair, make sure you protect

the information sufficiently by changing permissions on the files and/or

directories. The following table shows the recommended privileges:

<table class=MsoNormalTable border=1 cellspacing=1 cellpadding=0 width="30%"

style='width:30.0%;mso-cellspacing:.7pt'>

SSL file<o:p></o:p>

</td>

Pegasus <span

class=SpellE>Config property<o:p></o:p>

</td>

Permissions<o:p></o:p>

</td>

</tr>

Private key

</td>

sslKeyFilePath

</td>

rwx------

</td>

</tr>

Public certificate

</td>

sslCertificateFilePath

</td>

rwxr-xr-x

</td>

</tr>

Truststore

</td>

sslTrustStore

</td>

rwxr-xr-x

</td>

</tr>

CRL store

</td>

crlStore

</td>

rwxr-xr-x

</td>

</tr>

</table>

The administrator is responsible for ensuring that the above file

permissions are set correctly. The administrator should also ensure that all

containing directories all the way up to the base directory are not

world-writable. Pegasus only checks the following conditions when starting up:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l1 level1 lfo7;tab-stops:list .5in'>The sslKeyFilePath

and the sslCertificateFilePath are readable by

the CIMOM. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l1 level1 lfo7;tab-stops:list .5in'>The sslTrustStore

and crlStore are readable by the CIMOM if they

are a single file. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l1 level1 lfo7;tab-stops:list .5in'>The sslTrustStore

and crlStore are readable and writable by the

CIMOM if they are a directory.</li>

</ul>

limitation the rights to use, copy, modify, merge, publish, distribute,

These same file permissions should be used for protecting a client's private

key, public key, truststore, and crl

store as well.

For more information on generating keys and certificates, consult the <a

href="http://www.openssl.org/docs/HOWTO/">OpenSSL

HOW-TO documentation</a>.

<h3><a name=CONFIGURE>Configuring Pegasus for SSL</a></h3>

There are many environment variable settings associated with

SSL. Here is a brief discussion of the subtleties of these options and how they

work together to create a more secure environment. More information on the

default and recommended settings can be found in PEP#200 Recommended <span

class=SpellE>OpenPegasus 2.5 Build and Configuration Options for

Selected Platforms. Additionally, the section on <a href="#DESIGN">Design

Question List</a> should help determine what these settings should be for a

given application.

enableHttpsConnection

This is disabled by default on most platforms. It is recommended that all

remote communication be done over the HTTPS port. However, if you are sending <span

class=SpellE>cleartext passwords over the wire, it is imperative that

you only use the secure port. For added security, the HTTP port can be disabled

to prevent clients from connecting to it. The HTTPS connection is enabled by

default only on the following platforms:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>LINUX </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>OS-400 </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>HP_UX (if

PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true) </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>VMS (if

PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true)</li>

</ul>

sublicense, and/or sell copies of the Software, and to permit persons to whom

httpsPort

The default setting is 5989, the official WBEM secure port.

the Software is furnished to do so, subject to the following conditions:

sslCertificateFilePath

This is the path to the x509 server certificate. The server certificate may be

a chain in which case the file should contain PEM encoded certificates

beginning with the server certificate and followed by each signing certificate

authority (CA) including the root CA. If the server certificate is a self

signed certificate, the file only contains the self-signed certificate in PEM

format. The certificate cannot be encrypted because there is currently no

mechanism for decrypting the certificate using a user-supplied password. This

property must be defined if enableHttpsConnection is

true. Any failure in finding this file will result in the cimserver

failing to start. See <a href="#CERTS">Creating SSL Certificates</a> for more

information.

sslKeyFilePath

This is the path to the server's private key. All keys should be at least 1024

bytes long. This property must be defined if enableHttpsConnection

is true. Any failure in finding this file will result in the <span

class=SpellE>cimserver failing to start. See <a href="#CERTS">Creating

SSL Certificate</a> for more information.

sslClientVerificationMode

This setting controls how the cimserver (i.e. the

HTTPS port) is configured. There are three possible settings: disabled,

required, optional. There is no "right" setting for this property.

The default is disabled and it is fine to leave the setting as disabled if you

are going to use basic authentication to authenticate all client requests. In

many applications where a physical person is there to supply a username and

password, basic authentication is sufficient. Other environments may be

heterogeneous, in which case it makes sense to allow both basic authentication

and SSL certificate verification. The setting of this variable also impacts

what happens during the OpenSSL handshake:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l4 level1 lfo9;tab-stops:list .5in'>"required"

-- The server requires that the client certificate be trusted in order for

the handshake to continue. If the client fails to send a certificate or

sends an untrusted certificate, the handshake is

immediately terminated. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l4 level1 lfo9;tab-stops:list .5in'>"optional"

-- The server will request that a client certificate be sent, but will

continue the handshake even if no certificate is received. If

authentication is enabled, the server will seek to authenticate the client

via an alternative method of authentication. As

of 2.5.1, if a certificate is sent but it is not validated, the handshake

will fail. Before 2.5.1,the handshake would

have continued and basic authentication would have proceeded. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l4 level1 lfo9;tab-stops:list .5in'>"disabled"

-- The server will not prompt the client for a certificate. This is the

default.</li>

</ul>

Pegasus currently ties a certificate to a valid OS user.

Multiple certificates may be registered to the same user. When a certificate is

authenticated, Pegasus views it in the same way as if a user was authenticated

via basic authentication. The providers receive the username that the

certificate was mapped to. See the SSL Authorization section for more

information.

sslTrustStore

This setting controls the truststore for the <span

class=SpellE>cimserver's HTTPS connection. It can be either a directory

or a single root CA file. When set to a directory, it is recommended that you

use the cimtrust CLI to populate the <span

class=SpellE>truststore as there are strict naming requirements for

trusted certificate files. See the <a href="#CLI">cimtrust

& cimcrl CLI</a> section for further information.

sslTrustStoreUserName

This setting is only utilized if the sslTrustStore is

a single CA file. It is not used if the sslTrustStore

setting is a directory, but it still must be set to a valid system user. This

is because the validation of the property is done independently of the <span

class=SpellE>sslTrustStore setting. This property represents the valid

OS user that corresponds to the root certificate. All requests authenticated

with a certificate under the root CA will be associated with this user and the

username will be propagated to providers. If applications desire for there to

be a one-to-one correspondence between users and certificates, it is

recommended that each certificate be registered individually using the <a

href="#CLI">cimtrust CLI</a>.

crlStore

This is where the CRL (Certificate Revocation List) store resides. It is important

to note that certificates are checked first against the CRL (if specified) and

then against the server truststore. The <a href="#CLI"><span

class=SpellE>cimcrl CLI</a> should be used for CRL management.

<h4>Configuration Limitations</h4>

The following are configuration limitations:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l2 level1 lfo10;tab-stops:list .5in'>The x509 server certificate

file cannot be encrypted. The reason for this is that there is currently

no mechanism in Pegasus to grab the password needed to unencrypt

it. Therefore, the best way to secure the file is to follow the file

permissions settings specified in <a href="#CERTS">Creating SSL

Certificates.</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l2 level1 lfo10;tab-stops:list .5in'>There is no property to

specify supported cipher lists at this time. Pegasus uses the default <span

class=SpellE>OpenSSL cipher list. The cipher lists can be found at <a

href="http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_</a>

and <a

href="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</a>

</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l2 level1 lfo10;tab-stops:list .5in'>The verification depth

cannot be specified. Pegasus uses the default OpenSSL

depth of 9. This means the OpenSSL will only

accept client certificate chains up to 9 levels deep. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l2 level1 lfo10;tab-stops:list .5in'>No hostname checking is

performed to ensure that the subject field of the distinguished name (DN)

matches the hostname.</li>

</ul>

<h3><a name=DESIGN>SSL Design Question List</a></h3>

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN ALL

The following questions may be helpful in determining how to configure

Pegasus CIM Server.

COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED 

Should I enable the HTTPS port?

"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

Yes, especially if you are sending passwords with requests. The HTTP port can

be disabled for additional security if desired.

Should I configure the CIMOM to use a truststore?

This depends on the infrastructure of the application. If all clients are using

basic authentication over the secure port (and the passwords are secured), then

a truststore may not be needed. If an application

does not want to store user/pw information, then it

is a good idea to use a certificate-based infrastructure. If a CIMOM

certificate is compromised, the cimserver and the

providers of the system are compromised. The severity of this scenario is

dependent on the resources the providers have access to. If an OS password is

compromised, the entire system may be compromised. If using peer verification,

it is important to ensure that 1) the cimserver is

properly configured to use a truststore, 2) the <span

class=SpellE>truststore is loaded properly and protected, and 3)

authorization checks are performed after a certificate is verified. These same

conditions also apply to a client that is verifying a server.

Should I use a self-signed certificate or one issued by a third-party

certificate authority?

Generally, scalability will determine whether it's appropriate to use a self-signed

certificate or one issued by Verisign or another

third-party certificate authority. If an administrator administrates their

self-signed certificates correctly, they are no less secure than one issued by

a CA. What a CA buys you is scalability. An up front cost of setting up a CA

relationship will be offset by the convenience of having that CA

"vouch" for certs it has signed, in large

deployments. In small deployments the incremental cost might never outweigh the

initial CA-setup cost.

One important thing to remember is that you should not use the same certificate

for multiple CIMOMs. If using a self-signed

certificate, a different one should be generated for each CIMOM, using some

unique piece of data to make them different. That way, if one of the

certificates is compromised, the other ones remain secure.

Should the truststore be a single root CA file or

a directory?

If you only anticipate connections from a narrowly defined set of clients, then

a single root CA certificate file should be sufficient. Alternatively, multiple

trusted certificates may be stored in PEM format inside of a single CA file. If

you anticipate getting requests from a heterogeneous set of clients, then it

probably makes sense to use the directory option to allow flexibility in the

future. In the latter scenario, the same single root CA file can still be used

with the additional step of using cimtrust to

user can be associated with ALL certificates under that CA. Following the

principle of least privilege, it is not a good idea to register a root CA to a

privileged user if lesser privileged users will be connecting with it.

How do I protect the keystore and the <span

class=SpellE>truststore?

The server's private key should always be protected; it is private for a

reason. Only the system administrator should be able to see it. The public

certificate can be viewed by anyone, however, it

should be protected from alteration by system users. Similarly, any <span

class=SpellE>truststore or CRL file or directory should also be

protected from alteration. See <a href="#CERTS">Creating SSL Certificates</a>

for the recommended file privileges.

When do I need to use a CRL?

Certificate Revocation Lists are regularly issued by CA's. They contain a list

of certificates that have been revoked. Any application using a CA certificate

in its truststore should also implement <span

class=SpellE>CRLs (if the CA supports them). Pegasus itself does not

check CRL validity dates during startup. Therefore, it is the responsibility of

the administrator to regularly download or acquire the CRL and import it into

the CRL store using the <a href="#CLI">cimcrl CLI</a>.

CRLs<span

style='color:black'> are not checked for expiration during the SSL callback.

This means that if a CRL for a particular issuer has expired, Pegasus still

accepts certificates from the issuer and uses the expired CRL as the latest.

Again, it is the responsibility of the administrator to ensure the CRL is up to

date. CRLs are not checked for critical extensions

during CRL verification. If a CRL contains a critical extension it will be

ignored.

If using self-signed certificates, however, a CRL is most likely not needed

(You can create a self-signed CRL but it is not really necessary). Because of

this, the certificate deletion option available via cimtrust

is primarily intended for self-signed certificates. Technically, <span

class=SpellE>CRL's are the correct way to revoke compromised or invalid

certificates.

What is the order of operations for certificate verification?

The certificate is checked against any CRLs first

before going through the rest of the verification process. Verification starts

with the root certificate and continues down to the peer certificate. If

verification fails at any of these points, the certificate is considered <span

class=SpellE>untrusted and the verification process reports an error.

<h3><a name=TRUSTSTORE></a>Truststore<span

style='mso-bookmark:TRUSTSTORE'> Management</h3>

There are two directions of trust in an SSL client-server

handshake: The client trusts the server. The server trusts the client. Pegasus

provides a way to implement one or both of these relationships. Ideally, an

application should support both levels of trust for maximum security and this

is the implementation Pegasus recommends. However, in some scenarios it may

make sense to only implement one of these; in that case, it is possible to override

the client or the server to "trust all certificates." For example, if

all clients will be using basic authentication over HTTPS, then the server can

be setup to "trust all client certificates."

To tell the cimserver to require that all clients

be trusted, simply set the sslClientVerification<span

style='color:black'>Mode property to "required."

To tell the cimserver to trust all clients, set the <span

class=SpellE>sslClientVerificationMode

property to "disabled" or "optional".

The SSL verification in Pegasus is independent of any other authentication

mechanism. It can still be utilized when authentication is disabled. When

authentication is enabled, the first line of defense is SSL client

verification. In situations where a client is not

authenticated by SSL because the client sent no certificate and the setting is

"optional", the server will attempt to authenticate the client via

another method of authentication . In this case, the

authentication mechanism specified by the configuration property "<span

class=SpellE>httpAuthType" will be used for remote connections and

local authentication will be used for local connections. In situations where a

client is not authenticated by SSL because the client certificate was invalid,

the handshake will be terminated.

Note: Before 2.5.1, in the latter case, authentication would have proceeded

in the same way as if the client had sent no certificate. To enable the legacy

behavior, the compile-time flag PEGASUS_OVERRIDE_SSL_CERT_VERIFICATION_RESULT

should be defined.

See the <a href="#CLIENT">Configuring the Pegasus CIM Client for SSL</a>

section below on how to setup the client's truststore.

<h3><a name=CLI></a><span

style='mso-bookmark:CLI'>cimtrust<span style='mso-bookmark:

CLI'> & cimcrl CLI</h3>

cimtrust

CLI may be used to add, remove or list X509 certificates in a PEM format <span

class=SpellE>truststore. cimcrl

CLI may be used to add, remove or list X509 Certificate Revocation Lists in a

PEM format CRL store. The CLIs interface with a

Certificate control provider that runs as part of Pegasus's core. It operates

on the PG_SSLCertificate and PG_SSLCertificateRevocationList

classes in root/PG_Internal. It is recommended that

the CLIs be used in place of manual configuration for

several reasons:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l13 level1 lfo11;tab-stops:list .5in'>OpenSSL

places strict naming restrictions on certificates and CRLs

in a directory (the files are looked up via a subject hash code) </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l13 level1 lfo11;tab-stops:list .5in'>Certificate instances are

stored in the repository along with the corresponding username. If the

certificate is not properly registered, the username mapping will fail.<span

style='color:fuchsia'> <span

style='color:black'>cimtrust

CLI supports the ability to register a certificate without a username for

root certificates and intermediate certificates, since these certificates

represent a collection of users. In this scenario, each leaf certificate

must be registered to an individual user. See the Authorization section

for more information on username validation. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l13 level1 lfo11;tab-stops:list .5in'>The

CLIs, or more correctly the provider they

operate on, supports dynamic deletion of certificates by resetting the <span

class=SpellE>cimserver's SSL context.<span style='color:

fuchsia'> Normally, you would need to stop and start the <span

class=SpellE>cimserver to accomplish this. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l13 level1 lfo11;tab-stops:list .5in'>The CLIs,

or more correctly the provider they operate on, performs a ton of error

checking you would not get by manually configuring the stores. This alerts

the administrator to various error conditions (e.g. the certificate

expired) associated with a certificate or CRL.</li>

</ul>

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE

The CIMOM must be up and running while executing <span

class=SpellE>cimtrust/cimcrl CLI. The cimtrust

and cimcrl manpages provide

more information on commands and syntax.

<h3><a name=CLIENT>Configuring the Pegasus CIM Client for SSL</a></h3>

A Pegasus CIM client can be configured to use SSL by using a constructor

that takes an SSLContext. The construction of the <span

class=SpellE>SSLContext is really what controls the behavior of the

client during the SSL handshake. Without going into minute details about what

happens under the covers, here is a description of the various <span

class=SpellE>SSLContext constructor parameters.

Here's a code snippet that shows how to call a client constructor that

connects to a server over SSL and can present its own trusted certificate if

the server requests it. In this scenario, the client also checks the server

certificate against its truststore and specifies an

additional callback in addition to the default one (the user-specified callback

is optional and can be set to null).

<span

class=GramE>client.connect<span

class=GramE>(<span

style='font-family:Courier'> hostname, port, SSLContext(<span

class=SpellE>trustStore, certPath, <span

class=SpellE>keyPath, verifyCert, <span

class=SpellE>randomFile), username, password);

Here's a code snippet that shows how to call a client constructor that

connects to a server over SSL and does not possess its own trusted certificate.

In this scenario, the client also checks the server certificate against its <span

class=SpellE>truststore.

<span

class=GramE>client.connect<span

class=GramE>(<span

style='font-family:Courier'> hostname, port, SSLContext(<span

class=SpellE>trustStore, NULL, randomFile),

username password);

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>trustStore -- This specifies the <span

class=SpellE>truststore that the client uses to verify server

certificates. It can be String::EMPTY if no <span

class=SpellE>truststore exists. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>certPath -- This specifies the x509

certificate of the client that will be sent during an SSL handshake. Note

that this certificate will only be sent if the server requests it. If this

option is specified, the keyPath parameter must

also be specified. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>keyPath -- This specifies the private key

of the client. If this option is specified, the certPath

parameter must also be specified. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>crlPath -- This specifies an optional CRL

store path. The client checks the CRL list first, before attempting any

further authentication, including the user-specified callback. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>verifyCert -- This is a user-specified

verification callback. If this is set to null, the default <span

class=SpellE>OpenSSL verification callback will be executed. You

can implement this method to "trust all servers" or to perform

additional authentication checks that OpenSSL

does not perform by default. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>randomFile -- A file to seed the pseudo

random number generator (PRNG).</li>

</ul>

AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

Here are some general guidelines on implementing peer verification for the

client:

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should enable

peer verification by specifying a truststore and

(optionally) a user-specified callback function. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should employ a <span

class=SpellE>truststore in order to properly verify the server. The

truststore should contain a file or directory of

trusted CA certificates. The cimtrust CLI cannot

be used to configure client truststores. The

trusted certificate(s) should be placed in a protected file or directory

specified by the trustStore parameter. Keep in

mind that the SSL context generally has to be reloaded to pick up any <span

class=SpellE>truststore changes. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client could also use a

user-specified callback in addition to the default verification callback,

if additional verifications are desired over the normal checks that <span

class=SpellE>OpenSSL performs. In most cases, the default

verification callback is sufficient for checking server certificates. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should ensure

that adequate entropy is attained. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should use a CRL

store if the truststore contains CA certificates

that support one. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should only use

the SSLv3 and TLSv1 protocols. By default, Pegasus is not built with SSLv2

support. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should perform

post-connection checks. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level2 lfo15;tab-stops:list 1.0in'>Ensure a certificate

was received. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level3 lfo15;tab-stops:list 1.5in'>WARNING:  In

some implementations of SSL a NULL server certificate is perfectly valid

and authenticates against all trust stores.  If the client does not

ensure a certificate exists then the client is not providing server

authentication and could have a security bulletin class defect.</li>

</ul>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level2 lfo15;tab-stops:list 1.0in'>Validate that the

certificate received was issued to the host for which the client was attempting

to connect. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level3 lfo15;tab-stops:list 1.5in'>Ensure that the

common name (CN) in the server�s certificate subject matches the host

name of the server.  For X509v3 certificates, the �<span

class=SpellE>SubjectAltName� fields in

the certificate's extended attributes are also valid host names for the

certificate. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level3 lfo15;tab-stops:list 1.5in'>WARNING:  If

the client does not ensure the host name of the server is the same as

one of the host names explicitly described in the server�s certificate,

you have not authenticated the server�s identity.  Any other server

which was issued a certificate from the same trusted CA can masquerade

as the server unless the client performs the host name check.</li>

</ul>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level2 lfo15;tab-stops:list 1.0in'>Ensure that

certificate verification methods/routines return no errors.</li>

</ul>

CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

Because only the above arguments can be passed into the Pegasus <span

class=SpellE>SSLContext, there are some limitations in the client

configuration:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l10 level1 lfo16;tab-stops:list .5in'>The verification depth

cannot be specified. Pegasus uses the default OpenSSL

depth of 9. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l10 level1 lfo16;tab-stops:list .5in'>The cipher list cannot be

specified. Pegasus uses the default OpenSSL

cipher list. The cipher lists can be found at <a

href="http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_</a>

and <a

href="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</a>

</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l10 level1 lfo16;tab-stops:list .5in'>No hostname checking is

performed to ensure that the subject field of the distinguished name (DN)

matches the hostname. If desired, a user-specified callback should be

configured to perform this check or any additional checks relevant to the

application.</li>

</ul>

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

<h3><a name=AUTH>SSL Authorization</a></h3>

<hr>

The following paragraphs concern authorization of users authenticated by

certificate on the cimserver's HTTPS port.

</BODY>

It is important to note that SSL certificates are verified during the

</HTML>

initial handshake, BEFORE any further authentication takes place. If a

certificate fails, the connection can be terminated immediately, resulting in a

connection exception. This scenario will occur if the sslClientVerification

property is set to "required" and no certificate or an <span

class=SpellE>untrusted certificate is sent.

Further authorization checks must be performed when validating

the user that is mapped to the certificate. First, the user that is registered

to the certificate is validated as a valid system user and a valid <span

class=SpellE>cimuser (if the cimuser function

has been configured). In the case of a certificate

chain, the username authorization starts with the leaf certificate. If it

successfully finds a mapping for the leaf certificate, it continues; if there

is no username for the leaf certificate, the validation proceeds up to the root

certificate. If the root certificate is reached and there is still no mapped

username, the authorization fails. Additionally,

if Pegasus was configured to use PAM, the pam_acct_mgmt

function will be called with the user that is mapped to the certificate. This

ensures that any login conditions that would have been placed on a user

authenticated via basic authentication are still applied to a user

authenticated via certificate. The pam_authenticate

method will NOT be called. Lastly, the providers must authorize the user. They

receive the username that was mapped to the certificate in the <span

class=SpellE>OperationContext.

A provider may request the client's certificate chain information through

its provider registration MOF. The "RequestedOperationContextContainers"

property of PG_Provider should be set to include the

"SSLCertificateChain" by setting the value �0�.

If a client is authenticated via trusted certificate, then the container will

include a certificate for each level in the client's certificate chain, up to a

maximum depth of seven.

The behavior of this property is dependent

on the overall CIMOM settings. The "enableHttpsConnection"

configuration property must be set to true for the property to have any effect.

Additionally, the "sslClientVerificationMode"

configuration property must be set to either "required" or

"optional". If "required" is specified, then the container

will always be populated. If "optional" is specified, the container

will be populated only if the client is authenticated via trusted certificate,

as opposed to another mechanism such as basic authentication. Because the

container may not always be included in the OperationContext,

providers should always check for its existence before performing operations on

it. See the SSLCertificateInfo class in

Pegasus/Common/SSLContext.h for a full list of

certificate parameters that the SSLCertificateChainContainer

supports. <u1:p></u1:p>

<h3><a name=EXT>Critical Extension Handling</a></h3>

The extensions defined for X.509 v3 certificates

provide methods for associating additional attributes with users or public keys

and for managing the certification hierarchy. Each extension in a certificate

may be designated as critical or non-critical. Pegasus relies on the underlying

OpenSSL implementation to handle critical extensions

specified in a certificate. Please refer to the OpenSSL

documentation for more information on currently supported extensions in <span

class=SpellE>OpenSSL and on the behavior of OpenSSL

in the case of unhandled critical extensions.

<h3><a name=RESOURCES>Resources</a></h3>

For OpenSSL information pick up a copy of

O'Reilly's Network Security with OpenSSL or go to the

OpenSSL Site:

<a href="http://www.openssl.org">http://www.openssl.org</a>

A really fabulous guide on certificate management and installation with <span

class=SpellE>OpenSSL:

<a href="http://www.gagravarr.org/writing/openssl-certs/index.shtml">http://www.gagravarr.org/writing/openssl-certs/index.shtml</a>

x509 Certificate and CRL RFC:

<a href="http://www.ietf.org/rfc/rfc2459.txt?number=2459">http://www.ietf.org/rfc/rfc2459.txt?number=2459</a>

SSLv3 RFC:

<a href="http://wp.netscape.com/eng/ssl3/">http://wp.netscape.com/eng/ssl3</a>

TLSv1 RFC:

Basic Authentication RFC:

</div>

Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group; VERITAS

Software Corporation

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.

</div>

</body>

</html>

Legend:

Removed from v.1.2
changed lines
	Added in v.1.4.4.2

No CVS admin address has been configured